org.apache.sshd.server.command

Class ScpCommandFactory

java.lang.Object

org.apache.sshd.server.command.ScpCommandFactory

All Implemented Interfaces:

Cloneable, ExecutorServiceCarrier, ExecutorServiceConfigurer, CommandFactory

public class ScpCommandFactory
extends Object
implements CommandFactory, Cloneable, ExecutorServiceConfigurer

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScpCommandFactory.Builder A useful ObjectBuilder for ScpCommandFactory

Constructor Summary

Constructors

Constructor and Description
ScpCommandFactory()

Method Summary

Modifier and Type	Method and Description
boolean	addEventListener(ScpTransferEventListener listener)
ScpCommandFactory	clone()
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()
boolean	removeEventListener(ScpTransferEventListener listener)
void	setDelegateCommandFactory(CommandFactory factory)
void	setExecutorService(ExecutorService service)
void	setReceiveBufferSize(int receiveSize)
void	setSendBufferSize(int sendSize)
void	setShutdownOnExit(boolean shutdown)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCommandFactory

public ScpCommandFactory()

Method Detail

getDelegateCommandFactory

public CommandFactory getDelegateCommandFactory()

setDelegateCommandFactory

public void setDelegateCommandFactory(CommandFactory factory)

Parameters:

factory - 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

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

setExecutorService

public void setExecutorService(ExecutorService service)

Specified by:

setExecutorService in interface ExecutorServiceConfigurer

Parameters:

service - 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

isShutdownOnExit

public boolean isShutdownOnExit()

Specified by:

isShutdownOnExit in interface ExecutorServiceCarrier

Returns:

If true then the ExecutorService.shutdownNow() will be called (unless it is an internally allocated service which is always closed)

setShutdownOnExit

public void setShutdownOnExit(boolean shutdown)

Specified by:

setShutdownOnExit in interface ExecutorServiceConfigurer

Parameters:

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

getSendBufferSize

public int getSendBufferSize()

setSendBufferSize

public void setSendBufferSize(int sendSize)

Parameters:

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

See Also:

ScpHelper.MIN_SEND_BUFFER_SIZE

getReceiveBufferSize

public int getReceiveBufferSize()

setReceiveBufferSize

public void setReceiveBufferSize(int receiveSize)

Parameters:

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

See Also:

ScpHelper.MIN_RECEIVE_BUFFER_SIZE

addEventListener

public boolean addEventListener(ScpTransferEventListener listener)

Parameters:

listener - The ScpTransferEventListener to add

Returns:

true if this is a new listener instance, false if the listener is already registered

Throws:

IllegalArgumentException - if null listener

removeEventListener

public boolean removeEventListener(ScpTransferEventListener listener)

Parameters:

listener - The ScpTransferEventListener to remove

Returns:

true if the listener was registered and removed, false if the listener was not registered to begin with

Throws:

IllegalArgumentException - if null listener

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:

ScpHelper.SCP_COMMAND_PREFIX

clone

public ScpCommandFactory clone()

Overrides:

clone in class Object