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

Class CustomFileTransfer

AbstractFileTransfer

ProtocolFileTransfer

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

All Implemented Interfaces:

FileTransfer

public class CustomFileTransfer
extends ProtocolFileTransfer

Represents dynamically created file transfer via build script.

Allows to implement file transfer supporting cloud storage like Amazon S3, Google Cloud Storage etc and use them for example:

• uploading AEM backups

• downloading AEM backups

• downloading CRX packages for instance satisfy task

Field Detail

name

@NotNull
public java.lang.String name

Unique identifier.

protocols

@NotNull
public java.util.List<java.lang.String> protocols

Constructor Detail

CustomFileTransfer

public CustomFileTransfer(@NotNull
                          AemExtension aem)

Represents dynamically created file transfer via build script.

Allows to implement file transfer supporting cloud storage like Amazon S3, Google Cloud Storage etc and use them for example:

• uploading AEM backups

• downloading AEM backups

• downloading CRX packages for instance satisfy task

Method Detail

getName

@NotNull
public java.lang.String getName()

Unique identifier.

setName

public void setName(@NotNull
                    java.lang.String p)

Unique identifier.

getProtocols

@NotNull
public java.util.List<java.lang.String> getProtocols()

setProtocols

public void setProtocols(@NotNull
                         java.util.List<java.lang.String> p)

getParallelable

public boolean getParallelable()

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

setParallelable

public void setParallelable(boolean p)

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

download

public void download(@NotNull
                     kotlin.jvm.functions.Function3<? super java.lang.String,? super java.lang.String,? super java.io.File,kotlin.Unit> callback)

Register callback responsible for downloading file.

upload

public void upload(@NotNull
                   kotlin.jvm.functions.Function3<? super java.lang.String,? super java.lang.String,? super java.io.File,kotlin.Unit> callback)

Register callback responsible for uploading file.

list

public void list(@NotNull
                 kotlin.jvm.functions.Function1<? super java.lang.String,? extends java.util.List<com.cognifide.gradle.aem.common.file.transfer.FileEntry>> callback)

Register callback responsible for listing files.

delete

public void delete(@NotNull
                   kotlin.jvm.functions.Function2<? super java.lang.String,? super java.lang.String,kotlin.Unit> callback)

Register callback responsible for deleting file.

truncate

public void truncate(@NotNull
                     kotlin.jvm.functions.Function1<? super java.lang.String,kotlin.Unit> callback)

Register callback responsible for deleting files.

exists

public void exists(@NotNull
                   kotlin.jvm.functions.Function2<? super java.lang.String,? super java.lang.String,java.lang.Boolean> callback)

Register callback responsible for checking file existence.

downloadFrom

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

Downloads file with given name from directory available 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 available at specified URL and set given name.

deleteFrom

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

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

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.

truncate

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

Deletes all files in directory available at specified URL.

exists

public boolean exists(@NotNull
                      java.lang.String dirUrl,
                      @NotNull
                      java.lang.String fileName)

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