org.apache.sshd.server.command

Class ScpCommandFactory

java.lang.Object

org.apache.sshd.server.command.ScpCommandFactory

All Implemented Interfaces:

CommandFactory

public class ScpCommandFactory
extends Object
implements CommandFactory

This CommandFactory can be used as a standalone command factory or can be used to augment another CommandFactory and provides SCP support.

Author:

Apache MINA SSHD Project

See Also:

ScpCommand

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCP_COMMAND_PREFIX Command prefix used to identify SCP commands

Constructor Summary

Constructors

Constructor and Description
ScpCommandFactory() Default constructor - uses an ad-hoc ExecutorService with no delegate CommandFactory and default send/receive buffer sizes
ScpCommandFactory(CommandFactory delegateFactory)
ScpCommandFactory(CommandFactory delegateFactory, ExecutorService executorService)
ScpCommandFactory(CommandFactory delegateFactory, ExecutorService executorService, boolean shutdownOnExit)
ScpCommandFactory(CommandFactory delegateFactory, ExecutorService executorService, boolean shutdownOnExit, int bufferSize)
ScpCommandFactory(CommandFactory delegateFactory, ExecutorService executorService, boolean shutdownOnExit, int sendSize, int receiveSize)
ScpCommandFactory(ExecutorService executorService)
ScpCommandFactory(int bufferSize) Uses an ad-hoc ExecutorService with no delegate CommandFactory

Method Summary

Methods

Modifier and Type	Method and Description
Command	createCommand(String command) Parses a command string and verifies that the basic syntax is correct.
CommandFactory	getDelegateCommandFactory()
ExecutorService	getExecutorService()
int	getReceiveBufferSize()
int	getSendBufferSize()
boolean	isShutdownOnExit()

Methods inherited from class java.lang.Object

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

Field Detail

SCP_COMMAND_PREFIX

public static final String SCP_COMMAND_PREFIX

Command prefix used to identify SCP commands

See Also:

Constant Field Values

Constructor Detail

ScpCommandFactory

public ScpCommandFactory()

Default constructor - uses an ad-hoc ExecutorService with no delegate CommandFactory and default send/receive buffer sizes

See Also:

ScpHelper.DEFAULT_COPY_BUFFER_SIZE

ScpCommandFactory

public ScpCommandFactory(int bufferSize)

Uses an ad-hoc ExecutorService with no delegate CommandFactory

Parameters:

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

See Also:

ScpCommandFactory(CommandFactory, ExecutorService, boolean, int, int)

ScpCommandFactory

public ScpCommandFactory(ExecutorService executorService)

Parameters:

executorService - An ExecutorService to be used when starting ScpCommand 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

ScpCommandFactory

public ScpCommandFactory(CommandFactory delegateFactory)

Parameters:

delegateFactory - A CommandFactory to be used if the command is not an SCP one. If null then an IllegalArgumentException will be thrown when attempting to invoke createCommand(String) with a non-SCP command

See Also:

SCP_COMMAND_PREFIX

ScpCommandFactory

public ScpCommandFactory(CommandFactory delegateFactory,
                 ExecutorService executorService)

Parameters:

delegateFactory - A CommandFactory to be used if the command is not an SCP one. If null then an IllegalArgumentException will be thrown when attempting to invoke createCommand(String) with a non-SCP command

executorService - An ExecutorService to be used when starting ScpCommand execution. If null then a single-threaded ad-hoc service is used. Note: the service will not be shutdown when the command is terminated - unless it is the ad-hoc service, which will be shutdown regardless

See Also:

ScpCommandFactory(CommandFactory, ExecutorService, boolean)

ScpCommandFactory

public ScpCommandFactory(CommandFactory delegateFactory,
                 ExecutorService executorService,
                 boolean shutdownOnExit)

Parameters:

delegateFactory - A CommandFactory to be used if the command is not an SCP one. If null then an IllegalArgumentException will be thrown when attempting to invoke createCommand(String) with a non-SCP command

executorService - An ExecutorService to be used when starting ScpCommand execution. If null then a single-threaded ad-hoc service is used. Note: the service will not be shutdown when the command is terminated - unless it is the ad-hoc service, which will be shutdown regardless

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:

ScpCommandFactory(CommandFactory, ExecutorService, boolean, int)

ScpCommandFactory

public ScpCommandFactory(CommandFactory delegateFactory,
                 ExecutorService executorService,
                 boolean shutdownOnExit,
                 int bufferSize)

Parameters:

delegateFactory - A CommandFactory to be used if the command is not an SCP one. If null then an IllegalArgumentException will be thrown when attempting to invoke createCommand(String) with a non-SCP command

executorService - An ExecutorService to be used when starting ScpCommand execution. If null then a single-threaded ad-hoc service is used. Note: the service will not be shutdown when the command is terminated - unless it is the ad-hoc service, which will be shutdown regardless

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:

ScpCommandFactory(CommandFactory, ExecutorService, boolean, int, int)

ScpCommandFactory

public ScpCommandFactory(CommandFactory delegateFactory,
                 ExecutorService executorService,
                 boolean shutdownOnExit,
                 int sendSize,
                 int receiveSize)

Parameters:

delegateFactory - A CommandFactory to be used if the command is not an SCP one. If null then an IllegalArgumentException will be thrown when attempting to invoke createCommand(String) with a non-SCP command

executorService - An ExecutorService to be used when starting ScpCommand execution. If null then a single-threaded ad-hoc service is used. Note: the service will not be shutdown when the command is terminated - unless it is the ad-hoc service, which will be shutdown regardless

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:

ScpHelper.MIN_SEND_BUFFER_SIZE, ScpHelper.MIN_RECEIVE_BUFFER_SIZE

Method Detail

getDelegateCommandFactory

public CommandFactory getDelegateCommandFactory()

getExecutorService

public ExecutorService getExecutorService()

isShutdownOnExit

public boolean isShutdownOnExit()

getSendBufferSize

public int getSendBufferSize()

getReceiveBufferSize

public int getReceiveBufferSize()

createCommand

public Command createCommand(String command)

Parses a command string and verifies that the basic syntax is correct. If parsing fails the responsibility is delegated to the configured CommandFactory instance; if one exist.

Specified by:

createCommand in interface CommandFactory

Parameters:

command - command to parse

Returns:

configured Command instance

Throws:

IllegalArgumentException - if not an SCP command and no delegate command factory is available

See Also:

SCP_COMMAND_PREFIX