org.apache.sshd.client.scp

Interface ScpClient

All Superinterfaces:

ClientSessionHolder, SessionContextHolder, SessionHolder<ClientSession>

All Known Subinterfaces:

CloseableScpClient

All Known Implementing Classes:

AbstractScpClient, DefaultScpClient

public interface ScpClient
extends SessionHolder<ClientSession>, ClientSessionHolder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScpClient.Option

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
static long	DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT
static java.lang.String	SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT Configurable value of the FactoryManager for controlling the wait timeout for waiting on a channel exit status' for an SCP command in milliseconds.
static java.lang.String	SCP_EXEC_CHANNEL_OPEN_TIMEOUT Configurable value of the FactoryManager for controlling the wait timeout for opening a channel for an SCP command in milliseconds.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createReceiveCommand(java.lang.String remote, java.util.Collection<ScpClient.Option> options)
static java.lang.String	createSendCommand(java.lang.String remote, java.util.Collection<ScpClient.Option> options)
void	download(java.lang.String[] remote, java.nio.file.Path local, java.util.Collection<ScpClient.Option> options)
default void	download(java.lang.String[] remote, java.nio.file.Path local, ScpClient.Option... options)
void	download(java.lang.String[] remote, java.lang.String local, java.util.Collection<ScpClient.Option> options)
default void	download(java.lang.String[] remote, java.lang.String local, ScpClient.Option... options)
void	download(java.lang.String remote, java.io.OutputStream local)
void	download(java.lang.String remote, java.nio.file.Path local, java.util.Collection<ScpClient.Option> options)
default void	download(java.lang.String remote, java.nio.file.Path local, ScpClient.Option... options)
void	download(java.lang.String remote, java.lang.String local, java.util.Collection<ScpClient.Option> options)
default void	download(java.lang.String remote, java.lang.String local, ScpClient.Option... options)
default byte[]	downloadBytes(java.lang.String remote)
default ClientSession	getSession()
default void	upload(byte[] data, int offset, int len, java.lang.String remote, java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms, ScpTimestamp time)
default void	upload(byte[] data, java.lang.String remote, java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms, ScpTimestamp time)
void	upload(java.io.InputStream local, java.lang.String remote, long size, java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms, ScpTimestamp time)
void	upload(java.nio.file.Path[] local, java.lang.String remote, java.util.Collection<ScpClient.Option> options)
default void	upload(java.nio.file.Path[] local, java.lang.String remote, ScpClient.Option... options)
default void	upload(java.nio.file.Path local, java.lang.String remote, java.util.Collection<ScpClient.Option> options)
default void	upload(java.nio.file.Path local, java.lang.String remote, ScpClient.Option... options)
void	upload(java.lang.String[] local, java.lang.String remote, java.util.Collection<ScpClient.Option> options)
default void	upload(java.lang.String[] local, java.lang.String remote, ScpClient.Option... options)
default void	upload(java.lang.String local, java.lang.String remote, java.util.Collection<ScpClient.Option> options)
default void	upload(java.lang.String local, java.lang.String remote, ScpClient.Option... options)

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Methods inherited from interface org.apache.sshd.client.session.ClientSessionHolder

getClientSession

Field Detail

SCP_EXEC_CHANNEL_OPEN_TIMEOUT

static final java.lang.String SCP_EXEC_CHANNEL_OPEN_TIMEOUT

Configurable value of the FactoryManager for controlling the wait timeout for opening a channel for an SCP command in milliseconds. If not specified, then DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT value is used

See Also:

Constant Field Values

DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT

static final long DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT

SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT

static final java.lang.String SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT

Configurable value of the FactoryManager for controlling the wait timeout for waiting on a channel exit status' for an SCP command in milliseconds. If not specified, then DEFAULT_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT value is used. If non-positive, then no wait is performed and the command is assumed to have completed successfully.

See Also:

Constant Field Values

DEFAULT_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT

static final long DEFAULT_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT

Method Detail

getSession

default ClientSession getSession()

Specified by:

getSession in interface SessionHolder<ClientSession>

download

default void download(java.lang.String remote,
                      java.lang.String local,
                      ScpClient.Option... options)
               throws java.io.IOException

Throws:

java.io.IOException

download

void download(java.lang.String remote,
              java.lang.String local,
              java.util.Collection<ScpClient.Option> options)
       throws java.io.IOException

Throws:

java.io.IOException

download

default void download(java.lang.String remote,
                      java.nio.file.Path local,
                      ScpClient.Option... options)
               throws java.io.IOException

Throws:

java.io.IOException

download

void download(java.lang.String remote,
              java.nio.file.Path local,
              java.util.Collection<ScpClient.Option> options)
       throws java.io.IOException

Throws:

java.io.IOException

download

void download(java.lang.String remote,
              java.io.OutputStream local)
       throws java.io.IOException

Throws:

java.io.IOException

downloadBytes

default byte[] downloadBytes(java.lang.String remote)
                      throws java.io.IOException

Throws:

java.io.IOException

download

default void download(java.lang.String[] remote,
                      java.lang.String local,
                      ScpClient.Option... options)
               throws java.io.IOException

Throws:

java.io.IOException

download

default void download(java.lang.String[] remote,
                      java.nio.file.Path local,
                      ScpClient.Option... options)
               throws java.io.IOException

Throws:

java.io.IOException

download

void download(java.lang.String[] remote,
              java.lang.String local,
              java.util.Collection<ScpClient.Option> options)
       throws java.io.IOException

Throws:

java.io.IOException

download

void download(java.lang.String[] remote,
              java.nio.file.Path local,
              java.util.Collection<ScpClient.Option> options)
       throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.lang.String local,
                    java.lang.String remote,
                    ScpClient.Option... options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.lang.String local,
                    java.lang.String remote,
                    java.util.Collection<ScpClient.Option> options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.nio.file.Path local,
                    java.lang.String remote,
                    ScpClient.Option... options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.nio.file.Path local,
                    java.lang.String remote,
                    java.util.Collection<ScpClient.Option> options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.lang.String[] local,
                    java.lang.String remote,
                    ScpClient.Option... options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

void upload(java.lang.String[] local,
            java.lang.String remote,
            java.util.Collection<ScpClient.Option> options)
     throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(java.nio.file.Path[] local,
                    java.lang.String remote,
                    ScpClient.Option... options)
             throws java.io.IOException

Throws:

java.io.IOException

upload

void upload(java.nio.file.Path[] local,
            java.lang.String remote,
            java.util.Collection<ScpClient.Option> options)
     throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(byte[] data,
                    java.lang.String remote,
                    java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms,
                    ScpTimestamp time)
             throws java.io.IOException

Throws:

java.io.IOException

upload

default void upload(byte[] data,
                    int offset,
                    int len,
                    java.lang.String remote,
                    java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms,
                    ScpTimestamp time)
             throws java.io.IOException

Throws:

java.io.IOException

upload

void upload(java.io.InputStream local,
            java.lang.String remote,
            long size,
            java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms,
            ScpTimestamp time)
     throws java.io.IOException

Throws:

java.io.IOException

createSendCommand

static java.lang.String createSendCommand(java.lang.String remote,
                                          java.util.Collection<ScpClient.Option> options)

createReceiveCommand

static java.lang.String createReceiveCommand(java.lang.String remote,
                                             java.util.Collection<ScpClient.Option> options)