org.apache.sshd.server.command

Class ScpCommand

java.lang.Object

org.apache.sshd.server.command.ScpCommand

All Implemented Interfaces:

Runnable, FileSystemAware, Command

public class ScpCommand
extends Object
implements Command, Runnable, FileSystemAware

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 InputStream	in
protected static org.slf4j.Logger	log
protected String	name
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 FileSystemView	root
protected int	sendBufferSize
protected boolean	shutdownExecutor

Constructor Summary

Constructors

Constructor and Description
ScpCommand(String command) Simple constructor - uses an ad-hoc ExecutorService to run the command as well as default send / receive buffer sizes
ScpCommand(String command, ExecutorService executorService)
ScpCommand(String command, ExecutorService executorService, boolean shutdownOnExit)
ScpCommand(String command, ExecutorService executorService, boolean shutdownOnExit, int bufferSize)
ScpCommand(String command, ExecutorService executorService, boolean shutdownOnExit, int sendSize, int receiveSize)
ScpCommand(String command, ExecutorService executorService, int bufferSize)
ScpCommand(String command, int bufferSize) Uses an ad-hoc ExecutorService to run the command

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the shell.
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	setFileSystemView(FileSystemView view) 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	start(Environment env) Starts the shell.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

name

protected String name

optR

protected boolean optR

optT

protected boolean optT

optF

protected boolean optF

optD

protected boolean optD

optP

protected boolean optP

root

protected FileSystemView root

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

sendBufferSize

protected int sendBufferSize

receiveBufferSize

protected int receiveBufferSize

Constructor Detail

ScpCommand

public ScpCommand(String command)

Simple constructor - uses an ad-hoc ExecutorService to run the command as well as default send / receive buffer sizes

Parameters:

command - The command to be executed

See Also:

ScpCommand(String, ExecutorService, boolean, int, int), ScpHelper.DEFAULT_COPY_BUFFER_SIZE

ScpCommand

public ScpCommand(String command,
          int bufferSize)

Uses an ad-hoc ExecutorService to run the command

Parameters:

command - The command to be executed

bufferSize - Size (in bytes) of buffer to be used for both sending and receiving files

See Also:

ScpCommand(String, ExecutorService, int)

ScpCommand

public ScpCommand(String command,
          ExecutorService executorService,
          int bufferSize)

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. Note: the executor service will not be shutdown when command terminates unless it is the ad-hoc service

bufferSize - Size (in bytes) of buffer to be used for both sending and receiving files

See Also:

ScpCommand(String, ExecutorService, boolean, int, int)

ScpCommand

public ScpCommand(String command,
          ExecutorService executorService)

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. Note: the executor service will not be shutdown when command terminates unless it is the ad-hoc service

See Also:

ScpCommand(String, ExecutorService, boolean, int)

ScpCommand

public ScpCommand(String command,
          ExecutorService executorService,
          boolean shutdownOnExit)

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

See Also:

ScpCommand(String, ExecutorService, boolean, int), ScpHelper.DEFAULT_COPY_BUFFER_SIZE

ScpCommand

public ScpCommand(String command,
          ExecutorService executorService,
          boolean shutdownOnExit,
          int bufferSize)

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

bufferSize - Size (in bytes) of buffer to be used for both sending and receiving files

See Also:

ScpCommand(String, ExecutorService, boolean, int, int)

ScpCommand

public ScpCommand(String command,
          ExecutorService executorService,
          boolean shutdownOnExit,
          int sendSize,
          int receiveSize)

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

See Also:

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

Method Detail

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

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

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

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

setFileSystemView

public void setFileSystemView(FileSystemView view)

Description copied from interface: FileSystemAware

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

Specified by:

setFileSystemView in interface FileSystemAware

start

public void start(Environment env)
           throws IOException

Description copied from interface: Command

Starts the shell. 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 Command

Throws:

IOException

destroy

public void destroy()

Description copied from interface: Command

Destroy the shell. This method can be called by the SSH server to destroy the shell because the client has disconnected somehow.

Specified by:

destroy in interface Command

run

public void run()

Specified by:

run in interface Runnable

toString

public String toString()

Overrides:

toString in class Object