Package org.apache.sshd.scp.server

Class ScpCommandFactory

java.lang.Object

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

org.apache.sshd.server.command.AbstractDelegatingCommandFactory

org.apache.sshd.scp.server.ScpCommandFactory

All Implemented Interfaces:

java.lang.Cloneable, ExecutorServiceProvider, ManagedExecutorServiceSupplier, ScpFileOpenerHolder, CommandFactory, ShellFactory, ShellFactorySelector

public class ScpCommandFactory
extends AbstractDelegatingCommandFactory
implements ManagedExecutorServiceSupplier, ScpFileOpenerHolder, java.lang.Cloneable, ShellFactory, ShellFactorySelector

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

See Also:

ScpCommand, ScpShell

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private ShellFactory	delegateShellFactory
private java.util.function.Supplier<? extends CloseableExecutorService>	executorsProvider
private ScpFileOpener	fileOpener
private ScpTransferEventListener	listenerProxy
private java.util.Collection<ScpTransferEventListener>	listeners
private int	receiveBufferSize
static java.lang.String	SCP_FACTORY_NAME
private int	sendBufferSize

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

log

Constructor Summary

Constructors

Constructor	Description
ScpCommandFactory()

Method Summary

Modifier and Type	Method	Description
boolean	addEventListener(ScpTransferEventListener listener)
ScpCommandFactory	clone()
Command	createShell(ChannelSession channel)
protected Command	executeSupportedCommand(ChannelSession channel, java.lang.String command)
ShellFactory	getDelegateShellFactory()
java.util.function.Supplier<? extends CloseableExecutorService>	getExecutorServiceProvider()
int	getReceiveBufferSize()
ScpFileOpener	getScpFileOpener()
int	getSendBufferSize()
boolean	isSupportedCommand(ChannelSession channel, java.lang.String command)
boolean	removeEventListener(ScpTransferEventListener listener)
protected CloseableExecutorService	resolveExecutorService(java.lang.String command)
ShellFactory	selectShellFactory(ChannelSession channelSession)
void	setDelegateShellFactory(ShellFactory delegateShellFactory)
void	setExecutorServiceProvider(java.util.function.Supplier<? extends CloseableExecutorService> provider)
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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.util.threads.ExecutorServiceProvider

resolveExecutorService

Field Detail

SCP_FACTORY_NAME

public static final java.lang.String SCP_FACTORY_NAME

See Also:

Constant Field Values

executorsProvider

private java.util.function.Supplier<? extends CloseableExecutorService> executorsProvider

fileOpener

private ScpFileOpener fileOpener

delegateShellFactory

private ShellFactory delegateShellFactory

sendBufferSize

private int sendBufferSize

receiveBufferSize

private int receiveBufferSize

listeners

private java.util.Collection<ScpTransferEventListener> listeners

listenerProxy

private ScpTransferEventListener listenerProxy

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

getExecutorServiceProvider

public java.util.function.Supplier<? extends CloseableExecutorService> getExecutorServiceProvider()

Specified by:

getExecutorServiceProvider in interface ExecutorServiceProvider

Returns:

A Supplier of CloseableExecutorService to be used when asynchronous execution required. If null then a single-threaded ad-hoc service is used.

setExecutorServiceProvider

public void setExecutorServiceProvider(java.util.function.Supplier<? extends CloseableExecutorService> provider)

Specified by:

setExecutorServiceProvider in interface ManagedExecutorServiceSupplier

Parameters:

provider - The Supplier of CloseableExecutorService-s to be used when asynchronous execution is required. If null then a single-threaded ad-hoc service is used.

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:

java.lang.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:

java.lang.IllegalArgumentException - if null listener

isSupportedCommand

public boolean isSupportedCommand(ChannelSession channel,
                                  java.lang.String command)

Specified by:

isSupportedCommand in class AbstractDelegatingCommandFactory

Parameters:

channel - The ChannelSession through which the command was received

command - The command about to be executed

Returns:

true if this command is supported by the command factory, false if it will be passed on to the delegate factory

executeSupportedCommand

protected Command executeSupportedCommand(ChannelSession channel,
                                          java.lang.String command)

Specified by:

executeSupportedCommand in class AbstractDelegatingCommandFactory

getDelegateShellFactory

public ShellFactory getDelegateShellFactory()

Returns:

The delegate ShellFactory to use if selectShellFactory(ChannelSession) decides not to use itself as the ShellFactory - default=InteractiveProcessShellFactory.

See Also:

setDelegateShellFactory(ShellFactory)

setDelegateShellFactory

public void setDelegateShellFactory(ShellFactory delegateShellFactory)

Parameters:

delegateShellFactory - The ShellFactory to use if selectShellFactory(ChannelSession) decides not to use itself as the ShellFactory. If null then it will always decide to use itself regardless of the ChannelSession

See Also:

selectShellFactory(ChannelSession)

selectShellFactory

public ShellFactory selectShellFactory(ChannelSession channelSession)
                                throws java.io.IOException

Specified by:

selectShellFactory in interface ShellFactorySelector

Parameters:

channelSession - The ChannelSession

Returns:

The ShellFactory to use for the channel - null if none

Throws:

java.io.IOException - If failed the selection

createShell

public Command createShell(ChannelSession channel)
                    throws java.io.IOException

Specified by:

createShell in interface ShellFactory

Parameters:

channel - The ChannelSession through which the command has been received

Returns:

The Command representing the shell to be executed

Throws:

java.io.IOException - If failed to create the shell

resolveExecutorService

protected CloseableExecutorService resolveExecutorService(java.lang.String command)

clone

public ScpCommandFactory clone()

Overrides:

clone in class java.lang.Object