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

Class AbstractFileTransfer

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

All Implemented Interfaces:

FileTransfer

Direct Known Subclasses:

PathFileTransfer, ProtocolFileTransfer

public class AbstractFileTransfer
implements FileTransfer

Constructor Detail

AbstractFileTransfer

public AbstractFileTransfer(@NotNull
                            AemExtension aem)

Method Detail

getEnabled

public boolean getEnabled()

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

setEnabled

public void setEnabled(boolean p)

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.

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

truncate

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

Deletes all files 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.

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.

downloader

@NotNull
public FileDownloader downloader()

uploader

@NotNull
public FileUploader uploader()

getAem

@NotNull
protected AemExtension getAem()