org.apache.sshd.client.scp

Interface ScpClient

All Known Implementing Classes:

AbstractScpClient, DefaultScpClient

public interface ScpClient

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_OPEN_TIMEOUT
static 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
void	download(String[] remote, Path local, Collection<ScpClient.Option> options)
void	download(String[] remote, Path local, ScpClient.Option... options)
void	download(String[] remote, String local, Collection<ScpClient.Option> options)
void	download(String[] remote, String local, ScpClient.Option... options)
void	download(String remote, OutputStream local)
void	download(String remote, Path local, Collection<ScpClient.Option> options)
void	download(String remote, Path local, ScpClient.Option... options)
void	download(String remote, String local, Collection<ScpClient.Option> options)
void	download(String remote, String local, ScpClient.Option... options)
byte[]	downloadBytes(String remote)
void	upload(byte[] data, int offset, int len, String remote, Collection<PosixFilePermission> perms, ScpTimestamp time)
void	upload(byte[] data, String remote, Collection<PosixFilePermission> perms, ScpTimestamp time)
void	upload(InputStream local, String remote, long size, Collection<PosixFilePermission> perms, ScpTimestamp time)
void	upload(Path[] local, String remote, Collection<ScpClient.Option> options)
void	upload(Path[] local, String remote, ScpClient.Option... options)
void	upload(Path local, String remote, Collection<ScpClient.Option> options)
void	upload(Path local, String remote, ScpClient.Option... options)
void	upload(String[] local, String remote, Collection<ScpClient.Option> options)
void	upload(String[] local, String remote, ScpClient.Option... options)
void	upload(String local, String remote, Collection<ScpClient.Option> options)
void	upload(String local, String remote, ScpClient.Option... options)

Field Detail

SCP_EXEC_CHANNEL_OPEN_TIMEOUT

static final 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

Method Detail

download

void download(String remote,
              String local,
              ScpClient.Option... options)
       throws IOException

Throws:

IOException

download

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

Throws:

IOException

download

void download(String remote,
              Path local,
              ScpClient.Option... options)
       throws IOException

Throws:

IOException

download

void download(String remote,
              Path local,
              Collection<ScpClient.Option> options)
       throws IOException

Throws:

IOException

download

void download(String remote,
              OutputStream local)
       throws IOException

Throws:

IOException

downloadBytes

byte[] downloadBytes(String remote)
              throws IOException

Throws:

IOException

download

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

Throws:

IOException

download

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

Throws:

IOException

download

void download(String[] remote,
              Path local,
              ScpClient.Option... options)
       throws IOException

Throws:

IOException

download

void download(String[] remote,
              Path local,
              Collection<ScpClient.Option> options)
       throws IOException

Throws:

IOException

upload

void upload(String local,
            String remote,
            ScpClient.Option... options)
     throws IOException

Throws:

IOException

upload

void upload(String local,
            String remote,
            Collection<ScpClient.Option> options)
     throws IOException

Throws:

IOException

upload

void upload(Path local,
            String remote,
            ScpClient.Option... options)
     throws IOException

Throws:

IOException

upload

void upload(Path local,
            String remote,
            Collection<ScpClient.Option> options)
     throws IOException

Throws:

IOException

upload

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

Throws:

IOException

upload

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

Throws:

IOException

upload

void upload(Path[] local,
            String remote,
            ScpClient.Option... options)
     throws IOException

Throws:

IOException

upload

void upload(Path[] local,
            String remote,
            Collection<ScpClient.Option> options)
     throws IOException

Throws:

IOException

upload

void upload(byte[] data,
            String remote,
            Collection<PosixFilePermission> perms,
            ScpTimestamp time)
     throws IOException

Throws:

IOException

upload

void upload(byte[] data,
            int offset,
            int len,
            String remote,
            Collection<PosixFilePermission> perms,
            ScpTimestamp time)
     throws IOException

Throws:

IOException

upload

void upload(InputStream local,
            String remote,
            long size,
            Collection<PosixFilePermission> perms,
            ScpTimestamp time)
     throws IOException

Throws:

IOException