org.apache.sshd.server.scp

Class ScpCommand

java.lang.Object

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

org.apache.sshd.server.scp.ScpCommand

All Implemented Interfaces:

Runnable, FileSystemAware, SessionHolder<Session>, Command, CommandLifecycle, ServerSessionHolder, SessionAware

public class ScpCommand
extends AbstractLoggingBean
implements Command, Runnable, FileSystemAware, SessionAware, SessionHolder<Session>, ServerSessionHolder

This commands provide SCP support on both server and client side. Permissions and preservation of access / modification times on files are not supported.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
protected ExitCallback	callback
protected OutputStream	err
protected IOException	error
protected ExecutorService	executors
protected FileSystem	fileSystem
protected InputStream	in
protected ScpTransferEventListener	listener
protected String	name
protected ScpFileOpener	opener
protected boolean	optD
protected boolean	optF
protected boolean	optP
protected boolean	optR
protected boolean	optT
protected OutputStream	out
protected String	path
protected Future<?>	pendingFuture
protected int	receiveBufferSize
protected int	sendBufferSize
protected ServerSession	serverSession
protected boolean	shutdownExecutor

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

log

Constructor Summary

Constructors

Constructor and Description
ScpCommand(String command, ExecutorService executorService, boolean shutdownOnExit, int sendSize, int receiveSize, ScpFileOpener fileOpener, ScpTransferEventListener eventListener)

Method Summary

Modifier and Type	Method and Description
void	destroy() This method is called by the SSH server to destroy the command because the client has disconnected somehow.
ServerSession	getServerSession()
Session	getSession()
void	run()
void	setErrorStream(OutputStream err) Set the error stream that can be used by the shell to write its errors.
void	setExitCallback(ExitCallback callback) Set the callback that the shell has to call when it is closed.
void	setFileSystem(FileSystem fs) Set the file system in which this shell will be executed.
void	setInputStream(InputStream in) Set the input stream that can be used by the shell to read input.
void	setOutputStream(OutputStream out) Set the output stream that can be used by the shell to write its output.
void	setSession(ServerSession session)
void	start(Environment env) Starts the command execution.
String	toString()
protected void	writeCommandResponseMessage(String command, int exitValue, String exitMessage)

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, wait, wait, wait

Field Detail

name

protected final String name

sendBufferSize

protected final int sendBufferSize

receiveBufferSize

protected final int receiveBufferSize

opener

protected final ScpFileOpener opener

optR

protected boolean optR

optT

protected boolean optT

optF

protected boolean optF

optD

protected boolean optD

optP

protected boolean optP

fileSystem

protected FileSystem fileSystem

path

protected String path

in

protected InputStream in

out

protected OutputStream out

err

protected OutputStream err

callback

protected ExitCallback callback

error

protected IOException error

executors

protected ExecutorService executors

shutdownExecutor

protected boolean shutdownExecutor

pendingFuture

protected Future<?> pendingFuture

listener

protected ScpTransferEventListener listener

serverSession

protected ServerSession serverSession

Constructor Detail

ScpCommand

public ScpCommand(String command,
                  ExecutorService executorService,
                  boolean shutdownOnExit,
                  int sendSize,
                  int receiveSize,
                  ScpFileOpener fileOpener,
                  ScpTransferEventListener eventListener)

Parameters:

command - The command to be executed

executorService - An ExecutorService to be used when start(Environment)-ing execution. If null an ad-hoc single-threaded service is created and used.

shutdownOnExit - If true the ExecutorService.shutdownNow() will be called when command terminates - unless it is the ad-hoc service, which will be shutdown regardless

sendSize - Size (in bytes) of buffer to use when sending files

receiveSize - Size (in bytes) of buffer to use when receiving files

fileOpener - The ScpFileOpener - if null then DefaultScpFileOpener is used

eventListener - An ScpTransferEventListener - may be null

See Also:

ThreadUtils.newSingleThreadExecutor(String), ScpHelper.MIN_SEND_BUFFER_SIZE, ScpHelper.MIN_RECEIVE_BUFFER_SIZE

Method Detail

getSession

public Session getSession()

Specified by:

getSession in interface SessionHolder<Session>

getServerSession

public ServerSession getServerSession()

Specified by:

getServerSession in interface ServerSessionHolder

Returns:

The underlying ServerSession used

setSession

public void setSession(ServerSession session)

Specified by:

setSession in interface SessionAware

Parameters:

session - The ServerSession in which this shell will be executed.

setInputStream

public void setInputStream(InputStream in)

Description copied from interface: Command

Set the input stream that can be used by the shell to read input.

Specified by:

setInputStream in interface Command

Parameters:

in - The InputStream used by the shell to read input.

setOutputStream

public void setOutputStream(OutputStream out)

Description copied from interface: Command

Set the output stream that can be used by the shell to write its output.

Specified by:

setOutputStream in interface Command

Parameters:

out - The OutputStream used by the shell to write its output

setErrorStream

public void setErrorStream(OutputStream err)

Description copied from interface: Command

Set the error stream that can be used by the shell to write its errors.

Specified by:

setErrorStream in interface Command

Parameters:

err - The OutputStream used by the shell to write its errors

setExitCallback

public void setExitCallback(ExitCallback callback)

Description copied from interface: Command

Set the callback that the shell has to call when it is closed.

Specified by:

setExitCallback in interface Command

Parameters:

callback - The ExitCallback to call when shell is closed

setFileSystem

public void setFileSystem(FileSystem fs)

Description copied from interface: FileSystemAware

Set the file system in which this shell will be executed.

Specified by:

setFileSystem in interface FileSystemAware

Parameters:

fs - the file system

start

public void start(Environment env)
           throws IOException

Description copied from interface: CommandLifecycle

Starts the command execution. All streams must have been set before calling this method. The command should implement Runnable, and this method should spawn a new thread like:

  Thread(this).start(); 
 

Specified by:

start in interface CommandLifecycle

Parameters:

env - The Environment

Throws:

IOException - If failed to start

destroy

public void destroy()

Description copied from interface: CommandLifecycle

This method is called by the SSH server to destroy the command because the client has disconnected somehow.

Specified by:

destroy in interface CommandLifecycle

run

public void run()

Specified by:

run in interface Runnable

writeCommandResponseMessage

protected void writeCommandResponseMessage(String command,
                                           int exitValue,
                                           String exitMessage)
                                    throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object