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

Class SftpFileTransfer

AbstractFileTransfer

ProtocolFileTransfer

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

All Implemented Interfaces:

FileTransfer

public class SftpFileTransfer
extends ProtocolFileTransfer

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SftpFileTransfer(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
void	client(kotlin.jvm.functions.Function1<? super org.apache.sshd.client.SshClient,kotlin.Unit> options)
<T> T	connect(java.lang.String url, kotlin.jvm.functions.Function2<? super org.apache.sshd.client.subsystem.sftp.SftpClient,? super java.lang.String,? extends T> callback)
<T> T	connectDir(java.lang.String dirUrl, kotlin.jvm.functions.Function2<? super org.apache.sshd.client.subsystem.sftp.SftpClient,? super java.lang.String,? extends T> callback)
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.
kotlin.jvm.functions.Function1<org.apache.sshd.client.SshClient,kotlin.Unit>	getClientOptions()
java.lang.String	getName() Unique identifier.
java.lang.String	getPassword()
java.util.List<java.lang.String>	getProtocols()
kotlin.jvm.functions.Function1<org.apache.sshd.client.session.ClientSession,kotlin.Unit>	getSessionOptions()
long	getTimeout()
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	session(kotlin.jvm.functions.Function1<? super org.apache.sshd.client.session.ClientSession,kotlin.Unit> options)
void	setClientOptions(kotlin.jvm.functions.Function1<? super org.apache.sshd.client.SshClient,kotlin.Unit> p)
void	setPassword(java.lang.String p)
void	setSessionOptions(kotlin.jvm.functions.Function1<? super org.apache.sshd.client.session.ClientSession,kotlin.Unit> p)
void	setTimeout(long 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

PORT_DEFAULT

public static int PORT_DEFAULT

See Also:

Constant Field Values

Companion

public static SftpFileTransfer.Companion Companion

Constructor Detail

SftpFileTransfer

public SftpFileTransfer(@NotNull
                        AemExtension aem)

Method Detail

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)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long p)

getClientOptions

@NotNull
public kotlin.jvm.functions.Function1<org.apache.sshd.client.SshClient,kotlin.Unit> getClientOptions()

setClientOptions

public void setClientOptions(@NotNull
                             kotlin.jvm.functions.Function1<? super org.apache.sshd.client.SshClient,kotlin.Unit> p)

client

public void client(@NotNull
                   kotlin.jvm.functions.Function1<? super org.apache.sshd.client.SshClient,kotlin.Unit> options)

getSessionOptions

@NotNull
public kotlin.jvm.functions.Function1<org.apache.sshd.client.session.ClientSession,kotlin.Unit> getSessionOptions()

setSessionOptions

public void setSessionOptions(@NotNull
                              kotlin.jvm.functions.Function1<? super org.apache.sshd.client.session.ClientSession,kotlin.Unit> p)

session

public void session(@NotNull
                    kotlin.jvm.functions.Function1<? super org.apache.sshd.client.session.ClientSession,kotlin.Unit> options)

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.

connect

public <T> T connect(@NotNull
                     java.lang.String url,
                     @NotNull
                     kotlin.jvm.functions.Function2<? super org.apache.sshd.client.subsystem.sftp.SftpClient,? super java.lang.String,? extends T> callback)

connectDir

public <T> T connectDir(@NotNull
                        java.lang.String dirUrl,
                        @NotNull
                        kotlin.jvm.functions.Function2<? super org.apache.sshd.client.subsystem.sftp.SftpClient,? super java.lang.String,? extends T> callback)