org.apache.sshd.client.scp

Class DefaultScpClient

java.lang.Object

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

org.apache.sshd.client.scp.AbstractScpClient

org.apache.sshd.client.scp.DefaultScpClient

All Implemented Interfaces:

ScpClient, ClientSessionHolder, SessionHolder<ClientSession>

public class DefaultScpClient
extends AbstractScpClient

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.client.scp.AbstractScpClient

AbstractScpClient.ScpOperationExecutor<T>

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

ScpClient.Option

Field Summary

Fields

Modifier and Type	Field and Description
protected ScpTransferEventListener	listener
protected ScpFileOpener	opener
static String	SCP_PORT_OPTION Command line option used to indicate a non-default port

Fields inherited from class org.apache.sshd.client.scp.AbstractScpClient

COMMAND_WAIT_EVENTS

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_EXIT_STATUS_TIMEOUT, DEFAULT_EXEC_CHANNEL_OPEN_TIMEOUT, SCP_EXEC_CHANNEL_EXIT_STATUS_TIMEOUT, SCP_EXEC_CHANNEL_OPEN_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DefaultScpClient(ClientSession clientSession, ScpFileOpener fileOpener, ScpTransferEventListener eventListener)

Method Summary

Modifier and Type	Method and Description
protected void	download(String remote, FileSystem fs, Path local, Collection<ScpClient.Option> options)
void	download(String remote, OutputStream local)
ClientSession	getClientSession()
static void	main(String[] args)
protected <T> void	runUpload(String remote, Collection<ScpClient.Option> options, Collection<T> local, AbstractScpClient.ScpOperationExecutor<T> executor)
void	upload(InputStream local, String remote, long size, Collection<PosixFilePermission> perms, ScpTimestamp time)

Methods inherited from class org.apache.sshd.client.scp.AbstractScpClient

addTargetIsDirectory, download, download, download, download, getSession, handleCommandExitStatus, handleCommandExitStatus, openCommandChannel, upload, upload

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

getSimplifiedLogger

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

createReceiveCommand, createSendCommand, download, download, download, download, downloadBytes, upload, upload, upload, upload, upload, upload, upload, upload

Field Detail

SCP_PORT_OPTION

public static final String SCP_PORT_OPTION

Command line option used to indicate a non-default port

See Also:

Constant Field Values

opener

protected final ScpFileOpener opener

listener

protected final ScpTransferEventListener listener

Constructor Detail

DefaultScpClient

public DefaultScpClient(ClientSession clientSession,
                        ScpFileOpener fileOpener,
                        ScpTransferEventListener eventListener)

Method Detail

getClientSession

public ClientSession getClientSession()

Returns:

The underlying ClientSession used

download

public void download(String remote,
                     OutputStream local)
              throws IOException

Throws:

IOException

download

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

Specified by:

download in class AbstractScpClient

Throws:

IOException

upload

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

Throws:

IOException

runUpload

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

Specified by:

runUpload in class AbstractScpClient

Throws:

IOException

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception