org.apache.sshd.server.scp

Class ScpCommandFactory

java.lang.Object

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

org.apache.sshd.server.command.AbstractDelegatingCommandFactory

org.apache.sshd.server.scp.ScpCommandFactory

All Implemented Interfaces:

Cloneable, ScpFileOpenerHolder, org.apache.sshd.common.util.threads.ExecutorServiceCarrier, CommandFactory

public class ScpCommandFactory
extends AbstractDelegatingCommandFactory
implements ScpFileOpenerHolder, Cloneable, org.apache.sshd.common.util.threads.ExecutorServiceCarrier

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCP_FACTORY_NAME

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

log

Constructor Summary

Constructors

Constructor and Description
ScpCommandFactory()

Method Summary

Modifier and Type	Method and Description
boolean	addEventListener(ScpTransferEventListener listener)
ScpCommandFactory	clone()
protected Command	executeSupportedCommand(String command)
org.apache.sshd.common.util.threads.CloseableExecutorService	getExecutorService()
int	getReceiveBufferSize()
ScpFileOpener	getScpFileOpener()
int	getSendBufferSize()
boolean	isSupportedCommand(String command)
boolean	removeEventListener(ScpTransferEventListener listener)
void	setExecutorService(org.apache.sshd.common.util.threads.CloseableExecutorService service)
void	setReceiveBufferSize(int receiveSize)
void	setScpFileOpener(ScpFileOpener fileOpener)
void	setSendBufferSize(int sendSize)

Methods inherited from class org.apache.sshd.server.command.AbstractDelegatingCommandFactory

createCommand, createUnsupportedCommand, getDelegateCommandFactory, setDelegateCommandFactory, toString

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Field Detail

SCP_FACTORY_NAME

public static final String SCP_FACTORY_NAME

See Also:

Constant Field Values

Constructor Detail

ScpCommandFactory

public ScpCommandFactory()

Method Detail

getScpFileOpener

public ScpFileOpener getScpFileOpener()

Specified by:

getScpFileOpener in interface ScpFileOpenerHolder

Returns:

The last ScpFileOpener set via call to ScpFileOpenerHolder.setScpFileOpener(ScpFileOpener)

setScpFileOpener

public void setScpFileOpener(ScpFileOpener fileOpener)

Specified by:

setScpFileOpener in interface ScpFileOpenerHolder

Parameters:

fileOpener - The default ScpFileOpener to use - if null then a default opener is used

getExecutorService

public org.apache.sshd.common.util.threads.CloseableExecutorService getExecutorService()

Specified by:

getExecutorService in interface org.apache.sshd.common.util.threads.ExecutorServiceCarrier

setExecutorService

public void setExecutorService(org.apache.sshd.common.util.threads.CloseableExecutorService service)

Parameters:

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

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

isSupportedCommand

public boolean isSupportedCommand(String command)

Specified by:

isSupportedCommand in class AbstractDelegatingCommandFactory

executeSupportedCommand

protected Command executeSupportedCommand(String command)

Specified by:

executeSupportedCommand in class AbstractDelegatingCommandFactory

clone

public ScpCommandFactory clone()

Overrides:

clone in class Object