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

Class SmbFileTransfer

AbstractFileTransfer

ProtocolFileTransfer

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

All Implemented Interfaces:

FileTransfer

public class SmbFileTransfer
extends ProtocolFileTransfer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmbFileTransfer.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 SmbFileTransfer.Companion	Companion
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
SmbFileTransfer(AemExtension aem)

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.
jcifs.smb.SmbFile	dir(java.lang.String dirUrl)
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.
jcifs.smb.SmbFile	file(java.lang.String dirUrl, java.lang.String fileName)
java.lang.String	getDomain()
java.lang.String	getName() Unique identifier.
java.lang.String	getPassword()
java.util.List<java.lang.String>	getProtocols()
java.lang.String	getUser()
java.util.List<com.cognifide.gradle.aem.common.file.transfer.FileEntry>	list(java.lang.String dirUrl) Lists files in directory available at specified URL.
void	setDomain(java.lang.String p)
void	setPassword(java.lang.String p)
void	setUser(java.lang.String p)
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.ProtocolFileTransfer

getProtocols, handles

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

Constructor Detail

SmbFileTransfer

public SmbFileTransfer(@NotNull
                       AemExtension aem)

Method Detail

getDomain

@Nullable
public java.lang.String getDomain()

setDomain

public void setDomain(@Nullable
                      java.lang.String p)

getUser

@Nullable
public java.lang.String getUser()

setUser

public void setUser(@Nullable
                    java.lang.String p)

getPassword

@Nullable
public java.lang.String getPassword()

setPassword

public void setPassword(@Nullable
                        java.lang.String p)

getName

@NotNull
public java.lang.String getName()

Unique identifier.

getProtocols

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

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.

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.

file

@NotNull
public jcifs.smb.SmbFile file(@NotNull
                                        java.lang.String dirUrl,
                                        @NotNull
                                        java.lang.String fileName)

dir

@NotNull
public jcifs.smb.SmbFile dir(@NotNull
                                       java.lang.String dirUrl)