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

Class PathFileTransfer

AbstractFileTransfer

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

All Implemented Interfaces:

FileTransfer

public class PathFileTransfer
extends AbstractFileTransfer

File transfer which is copying files instead of using them directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathFileTransfer.Companion

Nested classes/interfaces inherited from interface com.cognifide.gradle.aem.common.file.transfer.FileTransfer

FileTransfer.DefaultImpls

Field Summary

Fields

Modifier and Type	Field and Description
static PathFileTransfer.Companion	Companion
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
PathFileTransfer(AemExtension aem) File transfer which is copying files instead of using them directly.

Method Summary

Modifier and Type	Method and Description
void	deleteFrom(java.lang.String dirUrl, java.lang.String fileName) Deletes file of given name in directory available at specified URL.
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.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.
void	truncate(java.lang.String dirUrl) Deletes all files in directory available at 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.

Methods inherited from class com.cognifide.gradle.aem.common.file.transfer.AbstractFileTransfer

deleteFrom, download, downloadFrom, downloader, getAem, getEnabled, list, setEnabled, stat, truncate, uploadTo, uploader

Methods inherited from interface com.cognifide.gradle.aem.common.file.transfer.FileTransfer

delete, deleteFrom, download, download, downloadFrom, downloadTo, exists, exists, getEnabled, getName, handles, list, stat, stat, truncate, upload, uploadTo, uploadTo

Field Detail

NAME

@NotNull
public static java.lang.String NAME

See Also:

Constant Field Values

Companion

public static PathFileTransfer.Companion Companion

Constructor Detail

PathFileTransfer

public PathFileTransfer(@NotNull
                        AemExtension aem)

File transfer which is copying files instead of using them directly.

Method Detail

getName

@NotNull
public java.lang.String getName()

Unique identifier.

handles

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

Checks if supports particular URL

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.

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