com.cognifide.gradle.aem.common.file.transfer

Class FileTransferManager

com.cognifide.gradle.aem.common.file.transfer.FileTransferManager

All Implemented Interfaces:

FileTransfer

public 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.

Field Detail

NAME

@NotNull
public static java.lang.String NAME

See Also:

Constant Field Values

TMP_SUFFIX

@NotNull
public static java.lang.String TMP_SUFFIX

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.common.file.transfer.FileTransferManager.Companion Companion

Constructor Detail

FileTransferManager

public FileTransferManager(@NotNull
                           AemExtension aem)

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.

Method Detail

getFactory

@NotNull
public FileTransferFactory getFactory()

getHttp

@NotNull
public HttpFileTransfer getHttp()

http

public void http(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.http.HttpFileTransfer,kotlin.Unit> options)

getSftp

@NotNull
public SftpFileTransfer getSftp()

sftp

public void sftp(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.sftp.SftpFileTransfer,kotlin.Unit> options)

getSmb

@NotNull
public SmbFileTransfer getSmb()

smb

public void smb(@NotNull
                kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.smb.SmbFileTransfer,kotlin.Unit> options)

getResolve

@NotNull
public ResolveFileTransfer getResolve()

resolve

public void resolve(@NotNull
                    kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.resolve.ResolveFileTransfer,kotlin.Unit> options)

getUrl

@NotNull
public UrlFileTransfer getUrl()

url

public void url(@NotNull
                kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.generic.UrlFileTransfer,kotlin.Unit> options)

getPath

@NotNull
public PathFileTransfer getPath()

path

public void path(@NotNull
                 kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.generic.PathFileTransfer,kotlin.Unit> options)

download

public void download(@NotNull
                     java.lang.String fileUrl)

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

downloadFrom

public void downloadFrom(@NotNull
                         java.lang.String dirUrl,
                         @NotNull
                         java.lang.String fileName,
                         @NotNull
                         java.io.File target)

Downloads file of given name from directory at specified URL.

uploadTo

public void uploadTo(@NotNull
                     java.lang.String dirUrl,
                     @NotNull
                     java.lang.String fileName,
                     @NotNull
                     java.io.File source)

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

list

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.file.transfer.FileEntry> list(@NotNull
                                                                                             java.lang.String dirUrl)

Lists files in directory available at specified URL.

deleteFrom

public void deleteFrom(@NotNull
                       java.lang.String dirUrl,
                       @NotNull
                       java.lang.String fileName)

Deletes file of given name in directory at specified URL.

truncate

public void truncate(@NotNull
                     java.lang.String dirUrl)

Deletes all files in directory available at specified URL.

stat

@Nullable
public FileEntry stat(@NotNull
                                java.lang.String dirUrl,
                                @NotNull
                                java.lang.String fileName)

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

handles

public boolean handles(@NotNull
                       java.lang.String fileUrl)

Check if there is any file transfer supporting specified URL.

handling

@NotNull
public FileTransfer handling(@NotNull
                                      java.lang.String fileUrl)

Get file transfer supporting specified URL.

custom

public void custom(@NotNull
                   java.lang.String name,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.generic.CustomFileTransfer,kotlin.Unit> definition)

Register custom file transfer for e.g downloading / uploading files from cloud storages like: Amazon S3, Google Cloud Storage etc.

named

@NotNull
public FileTransfer named(@NotNull
                                   java.lang.String name)

Get custom (or built-in) file transfer by name.

credentials

public void credentials(@Nullable
                        java.lang.String user,
                        @Nullable
                        java.lang.String password,
                        @Nullable
                        java.lang.String domain)

Shorthand method to set same credentials for all protocols requiring it.

Useful only in specific cases, when e.g company storage offers accessing files via multiple protocols using same AD credentials.

getEnabled

public boolean getEnabled()

When enabled, transfer will be considered when finding transfer handling particular URL.

getParallelable

public boolean getParallelable()

Determines if operations using this transfer could be done in parallel.

getName

@NotNull
public java.lang.String getName()

Unique identifier.