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

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 com.cognifide.gradle.aem.common.file.transfer.sftp.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)