org.apache.sshd.client.scp

Class AbstractScpClient

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.scp.AbstractScpClient

All Implemented Interfaces:

ScpClient, ClientSessionHolder, SessionHolder<ClientSession>

Direct Known Subclasses:

DefaultScpClient

public abstract class AbstractScpClient
extends AbstractLoggingBean
implements ScpClient

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractScpClient.ScpOperationExecutor<T>

Nested classes/interfaces inherited from interface org.apache.sshd.client.scp.ScpClient

ScpClient.Option

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.client.scp.ScpClient

DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT, SCP_EXEC_CHANNEL_OPEN_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScpClient()

Method Summary

Modifier and Type	Method and Description
protected Collection<ScpClient.Option>	addTargetIsDirectory(Collection<ScpClient.Option> options)
static String	createReceiveCommand(String remote, Collection<ScpClient.Option> options)
static String	createSendCommand(String remote, Collection<ScpClient.Option> options)
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)
protected abstract void	download(String remote, FileSystem fs, Path local, Collection<ScpClient.Option> options)
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)
ClientSession	getSession()
protected ChannelExec	openCommandChannel(ClientSession session, String cmd)
protected abstract <T> void	runUpload(String remote, Collection<ScpClient.Option> options, Collection<T> local, AbstractScpClient.ScpOperationExecutor<T> executor)
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(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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.client.scp.ScpClient

download, upload

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

getClientSession

Constructor Detail

AbstractScpClient

protected AbstractScpClient()

Method Detail

getSession

public final ClientSession getSession()

Specified by:

getSession in interface SessionHolder<ClientSession>

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Specified by:

download in interface ScpClient

Throws:

IOException

download

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

Throws:

IOException

downloadBytes

public byte[] downloadBytes(String remote)
                     throws IOException

Specified by:

downloadBytes in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

upload

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

Specified by:

upload in interface ScpClient

Throws:

IOException

runUpload

protected abstract <T> void runUpload(String remote,
                                      Collection<ScpClient.Option> options,
                                      Collection<T> local,
                                      AbstractScpClient.ScpOperationExecutor<T> executor)
                               throws IOException

Throws:

IOException

addTargetIsDirectory

protected Collection<ScpClient.Option> addTargetIsDirectory(Collection<ScpClient.Option> options)

openCommandChannel

protected ChannelExec openCommandChannel(ClientSession session,
                                         String cmd)
                                  throws IOException

Throws:

IOException

createSendCommand

public static String createSendCommand(String remote,
                                       Collection<ScpClient.Option> options)

createReceiveCommand

public static String createReceiveCommand(String remote,
                                          Collection<ScpClient.Option> options)