All Implemented Interfaces:

com.cognifide.gradle.common.file.transfer.FileTransfer
```
public final class FileTransferManager
 implements FileTransfer 
                    
```
Facade for transferring files over multiple protocols HTTP/SFTP/SMB and custom.Handles locking files for avoiding uncompleted downloads. Prevents unnecessary download if file on local server already exist. Prevents unnecessary uploads if file on remote servers already exist.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`user`
`private final Property<String>`	`password`
`private final Property<String>`	`domain`
`private final Pair<String, String>`	`credentials`
`private final String`	`credentialsString`
`private final FileTransferFactory`	`factory`
`private final HttpFileTransfer`	`http`
`private final SftpFileTransfer`	`sftp`
`private final SmbFileTransfer`	`smb`
`private final ResolveFileTransfer`	`resolve`
`private final UrlFileTransfer`	`url`
`private final PathFileTransfer`	`path`

Constructor Summary

Constructors
Constructor	Description
`FileTransferManager(CommonExtension common)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`credentials(String user, String password, String domain)`	Shorthand method to enforce credentials for all protocols requiring it.
`final Unit`	`http(Function1<HttpFileTransfer, Unit> options)`
`final Unit`	`sftp(Function1<SftpFileTransfer, Unit> options)`
`final Unit`	`smb(Function1<SmbFileTransfer, Unit> options)`
`final Unit`	`resolve(Function1<ResolveFileTransfer, Unit> options)`
`final Unit`	`url(Function1<UrlFileTransfer, Unit> options)`
`final Unit`	`path(Function1<PathFileTransfer, Unit> options)`
`File`	`download(String fileUrl)`	Downloads file from specified URL to temporary directory with preserving file name.
`Unit`	`downloadFrom(String dirUrl, String fileName, File target)`	Downloads file of given name from directory at specified URL.
`final Unit`	`downloadUsing(FileTransfer transfer, String fileUrl, File target)`	Downloads file from specified URL using dedicated transfer type.
`final Unit`	`downloadUsing(FileTransfer transfer, String dirUrl, String fileName, File target)`	Downloads file of given name from directory at specified URL using dedicated transfer type.
`Unit`	`uploadTo(String dirUrl, String fileName, File source)`	Uploads file to directory at specified URL and set given name.
`final Unit`	`uploadUsing(FileTransfer transfer, String fileUrl, File source)`	Uploads file to file at specified URL using dedicated transfer type.
`final Unit`	`uploadUsing(FileTransfer transfer, String dirUrl, String fileName, File source)`	Uploads file to directory at specified URL and set given name using dedicated transfer type.
`List<FileEntry>`	`list(String dirUrl)`	Lists files in directory available at specified URL.
`Unit`	`deleteFrom(String dirUrl, String fileName)`	Deletes file of given name in directory at specified URL.
`Unit`	`truncate(String dirUrl)`	Deletes all files in directory available at specified URL.
`FileEntry`	`stat(String dirUrl, String fileName)`	Gets file status of given name in directory at specified URL.
`Boolean`	`handles(String fileUrl)`	Check if there is any file transfer supporting specified URL.
`final FileTransferHandler`	`handling(String fileUrl)`	Get file transfer supporting specified URL.
`final Unit`	`custom(String name, Function1<CustomFileTransfer, Unit> definition)`	Register custom file transfer for e.g downloading / uploading files from cloud storages like: Amazon S3, Google Cloud Storage etc.
`final FileTransfer`	`named(String name)`	Get custom (or built-in) file transfer by name.
`final Property<String>`	`getUser()`
`final Property<String>`	`getPassword()`
`final Property<String>`	`getDomain()`
`final Pair<String, String>`	`getCredentials()`
`final String`	`getCredentialsString()`
`final FileTransferFactory`	`getFactory()`
`final HttpFileTransfer`	`getHttp()`
`final SftpFileTransfer`	`getSftp()`
`final SmbFileTransfer`	`getSmb()`
`final ResolveFileTransfer`	`getResolve()`
`final UrlFileTransfer`	`getUrl()`
`final PathFileTransfer`	`getPath()`

Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransferManager
delete, download, downloadTo, exists, exists, stat, upload, uploadTo
Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransfer
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTransferManager

FileTransferManager(CommonExtension common)

Method Detail

credentials

 final Unit credentials(String user, String password, String domain)

Shorthand method to enforce credentials for all protocols requiring it.

http

 final Unit http(Function1<HttpFileTransfer, Unit> options)

sftp

 final Unit sftp(Function1<SftpFileTransfer, Unit> options)

smb

 final Unit smb(Function1<SmbFileTransfer, Unit> options)

resolve

 final Unit resolve(Function1<ResolveFileTransfer, Unit> options)

url

 final Unit url(Function1<UrlFileTransfer, Unit> options)

path

 final Unit path(Function1<PathFileTransfer, Unit> options)

download
```
 File download(String fileUrl)
```
Downloads file from specified URL to temporary directory with preserving file name.

downloadFrom

 Unit downloadFrom(String dirUrl, String fileName, File target)

Downloads file of given name from directory at specified URL.

downloadUsing

 final Unit downloadUsing(FileTransfer transfer, String fileUrl, File target)

Downloads file from specified URL using dedicated transfer type.

downloadUsing

 final Unit downloadUsing(FileTransfer transfer, String dirUrl, String fileName, File target)

Downloads file of given name from directory at specified URL using dedicated transfer type.

uploadTo

 Unit uploadTo(String dirUrl, String fileName, File source)

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

uploadUsing

 final Unit uploadUsing(FileTransfer transfer, String fileUrl, File source)

Uploads file to file at specified URL using dedicated transfer type.

uploadUsing

 final Unit uploadUsing(FileTransfer transfer, String dirUrl, String fileName, File source)

Uploads file to directory at specified URL and set given name using dedicated transfer type.

list
```
 List<FileEntry> list(String dirUrl)
```
Lists files in directory available at specified URL.

deleteFrom
```
 Unit deleteFrom(String dirUrl, String fileName)
```
Deletes file of given name in directory at specified URL.

truncate
```
 Unit truncate(String dirUrl)
```
Deletes all files in directory available at specified URL.

stat
```
 FileEntry stat(String dirUrl, String fileName)
```
Gets file status of given name in directory at specified URL.

handles
```
 Boolean handles(String fileUrl)
```
Check if there is any file transfer supporting specified URL.

handling

 final FileTransferHandler handling(String fileUrl)

Get file transfer supporting specified URL.

custom
```
 final Unit custom(String name, Function1<CustomFileTransfer, Unit> definition)
```
Register custom file transfer for e.g downloading / uploading files from cloud storages like: Amazon S3, Google Cloud Storage etc.

named
```
 final FileTransfer named(String name)
```
Get custom (or built-in) file transfer by name.

getUser
```
 final Property<String> getUser()
```

getPassword
```
 final Property<String> getPassword()
```

getDomain
```
 final Property<String> getDomain()
```

getCredentials

 final Pair<String, String> getCredentials()

getCredentialsString
```
 final String getCredentialsString()
```

getFactory
```
 final FileTransferFactory getFactory()
```

getHttp
```
 final HttpFileTransfer getHttp()
```

getSftp
```
 final SftpFileTransfer getSftp()
```

getSmb
```
 final SmbFileTransfer getSmb()
```

getResolve
```
 final ResolveFileTransfer getResolve()
```

getUrl
```
 final UrlFileTransfer getUrl()
```

getPath
```
 final PathFileTransfer getPath()
```

Class FileTransferManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransferManager

Methods inherited from class com.cognifide.gradle.common.file.transfer.FileTransfer

Methods inherited from class java.lang.Object

Constructor Detail

FileTransferManager

Method Detail

credentials

http

sftp

smb

resolve

url

path

download

downloadFrom

downloadUsing

downloadUsing

uploadTo

uploadUsing

uploadUsing

list

deleteFrom

truncate

stat

handles

handling

custom

named

getUser

getPassword

getDomain

getCredentials

getCredentialsString

getFactory

getHttp

getSftp

getSmb

getResolve

getUrl

getPath