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

Interface FileTransfer

All Known Implementing Classes:

AbstractFileTransfer, CustomFileTransfer, FileTransferManager, HttpFileTransfer, PathFileTransfer, ProtocolFileTransfer, SftpFileTransfer, SmbFileTransfer, UrlFileTransfer

public FileTransfer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileTransfer.DefaultImpls

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String fileUrl) Deletes file available at specified URL.
void	deleteFrom(java.lang.String dirUrl, java.lang.String fileName) Deletes file of given name in directory available at specified URL.
void	download(java.lang.String fileUrl, java.io.File target) Downloads file from specified URL.
void	download(java.lang.String fileUrl) Downloads file from specified URL to temporary directory with preserving file name.
void	downloadFrom(java.lang.String dirUrl, java.lang.String fileName, java.io.File target) Downloads file with given name from directory available at specified URL.
java.io.File	downloadTo(java.lang.String fileUrl, java.io.File dir) Downloads file from specified URL to specified directory with preserving file name.
boolean	exists(java.lang.String fileUrl) Checks if file at specified URL exists.
boolean	exists(java.lang.String dirUrl, java.lang.String fileName) Checks if file with given name exists in directory at specified URL.
boolean	getEnabled() When enabled, transfer will be considered when finding transfer handling particular URL.
java.lang.String	getName() Unique identifier.
boolean	handles(java.lang.String fileUrl) Checks if supports particular URL
java.util.List<com.cognifide.gradle.aem.common.file.transfer.FileEntry>	list(java.lang.String dirUrl) Lists files in directory available at specified URL.
FileEntry	stat(java.lang.String dirUrl, java.lang.String fileName) Gets file status of given name in directory at specified URL.
FileEntry	stat(java.lang.String fileUrl) Gets file status at specified URL.
void	truncate(java.lang.String dirUrl) Deletes all files in directory available at specified URL.
void	upload(java.lang.String fileUrl, java.io.File source) Uploads file to specified URL.
void	uploadTo(java.lang.String dirUrl, java.lang.String fileName, java.io.File source) Uploads file to directory available at specified URL and set given name.
void	uploadTo(java.lang.String dirUrl, java.io.File source) Uploads file to directory available at specified URL.

Method Detail

getName

@NotNull
java.lang.String getName()

Unique identifier.

getEnabled

boolean getEnabled()

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

handles

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

Checks if supports particular URL

downloadFrom

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.

download

void download(@NotNull
              java.lang.String fileUrl,
              @NotNull
              java.io.File target)

Downloads file from specified URL.

download

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

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

downloadTo

@NotNull
java.io.File downloadTo(@NotNull
                                  java.lang.String fileUrl,
                                  @NotNull
                                  java.io.File dir)

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

uploadTo

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.

uploadTo

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

Uploads file to directory available at specified URL.

upload

void upload(@NotNull
            java.lang.String fileUrl,
            @NotNull
            java.io.File source)

Uploads file to specified URL.

deleteFrom

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

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

delete

void delete(@NotNull
            java.lang.String fileUrl)

Deletes file available at specified URL.

list

@NotNull
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

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

Deletes all files in directory available at specified URL.

exists

boolean exists(@NotNull
               java.lang.String fileUrl)

Checks if file at specified URL exists.

exists

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

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

stat

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

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

stat

@Nullable
FileEntry stat(@NotNull
                          java.lang.String fileUrl)

Gets file status at specified URL.