common-plugin / com.cognifide.gradle.common.file.transfer / FileTransfer

FileTransfer

interface FileTransfer

Functions

delete

Deletes file available at specified URL.

open fun delete(fileUrl: String): Unit

deleteFrom

Deletes file of given name in directory available at specified URL.

abstract fun deleteFrom(dirUrl: String, fileName: String): Unit

download

Downloads file from specified URL.

open fun download(fileUrl: String, target: File): Unit

Downloads file from specified URL to temporary directory with preserving file name.

abstract fun download(fileUrl: String): File

downloadFrom

Downloads file with given name from directory available at specified URL.

abstract fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit

downloadTo

Downloads file from specified URL to specified directory with preserving file name.

open fun downloadTo(fileUrl: String, dir: File): File

exists

Checks if file at specified URL exists.

open fun exists(fileUrl: String): Boolean

Checks if file with given name exists in directory at specified URL.

open fun exists(dirUrl: String, fileName: String): Boolean

handles

Checks if supports particular URL

abstract fun handles(fileUrl: String): Boolean

list

Lists files in directory available at specified URL.

abstract fun list(dirUrl: String): List<FileEntry>

stat

Gets file status of given name in directory at specified URL.

abstract fun stat(dirUrl: String, fileName: String): FileEntry?

Gets file status at specified URL.

open fun stat(fileUrl: String): FileEntry?

truncate

Deletes all files in directory available at specified URL.

abstract fun truncate(dirUrl: String): Unit

upload

Uploads file to specified URL.

open fun upload(fileUrl: String, source: File): Unit

uploadTo

Uploads file to directory available at specified URL and set given name.

abstract fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

Uploads file to directory available at specified URL.

open fun uploadTo(dirUrl: String, source: File): Unit

Companion Object Functions

splitFileUrl

fun splitFileUrl(fileUrl: String): Pair<String, String>

Inheritors

FileTransferHandler

interface FileTransferHandler : FileTransfer

FileTransferManager

Facade for transferring files over multiple protocols HTTP/SFTP/SMB and custom.

class FileTransferManager : FileTransfer