public interface ScpClient extends SessionHolder<ClientSession>, ClientSessionHolder
Modifier and Type | Interface and Description |
---|---|
static class |
ScpClient.Option |
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. |
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) |
getSessionContext
getClientSession
static final java.lang.String SCP_EXEC_CHANNEL_OPEN_TIMEOUT
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 usedstatic final long DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT
static final java.lang.String SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
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.static final long DEFAULT_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT
default ClientSession getSession()
getSession
in interface SessionHolder<ClientSession>
default void download(java.lang.String remote, java.lang.String local, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
void download(java.lang.String remote, java.lang.String local, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void download(java.lang.String remote, java.nio.file.Path local, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
void download(java.lang.String remote, java.nio.file.Path local, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
void download(java.lang.String remote, java.io.OutputStream local) throws java.io.IOException
java.io.IOException
default byte[] downloadBytes(java.lang.String remote) throws java.io.IOException
java.io.IOException
default void download(java.lang.String[] remote, java.lang.String local, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
default void download(java.lang.String[] remote, java.nio.file.Path local, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
void download(java.lang.String[] remote, java.lang.String local, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
void download(java.lang.String[] remote, java.nio.file.Path local, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void upload(java.lang.String local, java.lang.String remote, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
default void upload(java.lang.String local, java.lang.String remote, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void upload(java.nio.file.Path local, java.lang.String remote, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
default void upload(java.nio.file.Path local, java.lang.String remote, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void upload(java.lang.String[] local, java.lang.String remote, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
void upload(java.lang.String[] local, java.lang.String remote, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void upload(java.nio.file.Path[] local, java.lang.String remote, ScpClient.Option... options) throws java.io.IOException
java.io.IOException
void upload(java.nio.file.Path[] local, java.lang.String remote, java.util.Collection<ScpClient.Option> options) throws java.io.IOException
java.io.IOException
default void upload(byte[] data, java.lang.String remote, java.util.Collection<java.nio.file.attribute.PosixFilePermission> perms, ScpTimestamp time) throws java.io.IOException
java.io.IOException
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
java.io.IOException
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
java.io.IOException
static java.lang.String createSendCommand(java.lang.String remote, java.util.Collection<ScpClient.Option> options)
static java.lang.String createReceiveCommand(java.lang.String remote, java.util.Collection<ScpClient.Option> options)