org.apache.sshd.common.helpers

Class AbstractFactoryManager

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.common.util.closeable.AbstractInnerCloseable

org.apache.sshd.common.kex.AbstractKexFactoryManager

org.apache.sshd.common.helpers.AbstractFactoryManager

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AttributeStore, ChannelListenerManager, FactoryManager, PortForwardingEventListenerManager, KexFactoryManager, KeyPairProviderHolder, PropertyResolver, ReservedSessionMessagesManager, SessionListenerManager, SignatureFactoriesManager

Direct Known Subclasses:

SshClient, SshServer

public abstract class AbstractFactoryManager
extends AbstractKexFactoryManager
implements FactoryManager

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeStore

AttributeStore.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected SshAgentFactory	agentFactory
protected List<NamedFactory<Channel>>	channelFactories
protected ChannelListener	channelListenerProxy
protected Collection<ChannelListener>	channelListeners
protected ScheduledExecutorService	executor
protected FileSystemFactory	fileSystemFactory
protected List<RequestHandler<ConnectionService>>	globalRequestHandlers
protected IoServiceFactory	ioServiceFactory
protected IoServiceFactoryFactory	ioServiceFactoryFactory
protected Factory<Random>	randomFactory
protected List<ServiceFactory>	serviceFactories
protected SessionListener	sessionListenerProxy
protected Collection<SessionListener>	sessionListeners
protected SessionTimeoutListener	sessionTimeoutListener
protected boolean	shutdownExecutor
protected TcpipForwarderFactory	tcpipForwarderFactory
protected ForwardingFilter	tcpipForwardingFilter
protected ScheduledFuture<?>	timeoutListenerFuture
protected PortForwardingEventListener	tunnelListenerProxy
protected Collection<PortForwardingEventListener>	tunnelListeners

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, state

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

log

Fields inherited from interface org.apache.sshd.common.FactoryManager

AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_AUTH_TIMEOUT, DEFAULT_CHANNEL_CLOSE_TIMEOUT, DEFAULT_DISCONNECT_TIMEOUT, DEFAULT_IDLE_TIMEOUT, DEFAULT_IGNORE_MESSAGE_FREQUENCY, DEFAULT_IGNORE_MESSAGE_SIZE, DEFAULT_IGNORE_MESSAGE_VARIANCE, DEFAULT_LIMIT_PACKET_SIZE, DEFAULT_MAX_IDENTIFICATION_SIZE, DEFAULT_MAX_PACKET_SIZE, DEFAULT_NIO_WORKERS, DEFAULT_NIO2_MIN_WRITE_TIMEOUT, DEFAULT_NIO2_READ_TIMEOUT, DEFAULT_REKEY_BYTES_LIMIT, DEFAULT_REKEY_PACKETS_LIMIT, DEFAULT_REKEY_TIME_LIMIT, DEFAULT_STOP_WAIT_TIME, DEFAULT_VERSION, DEFAULT_WINDOW_SIZE, DEFAULT_WINDOW_TIMEOUT, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, IGNORE_MESSAGE_FREQUENCY, IGNORE_MESSAGE_SIZE, IGNORE_MESSAGE_VARIANCE, LIMIT_PACKET_SIZE, MAX_IDENTIFICATION_SIZE, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_MIN_WRITE_TIMEOUT, NIO2_READ_BUFFER_SIZE, NIO2_READ_TIMEOUT, REKEY_BLOCKS_LIMIT, REKEY_BYTES_LIMIT, REKEY_PACKETS_LIMIT, REKEY_TIME_LIMIT, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, STOP_WAIT_TIME, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFactoryManager()

Method Summary

Modifier and Type	Method and Description
void	addChannelListener(ChannelListener listener) Add a channel listener
void	addPortForwardingEventListener(PortForwardingEventListener listener) Add a port forwarding listener
void	addSessionListener(SessionListener listener) Add a session listener.
protected void	checkConfig()
protected SessionTimeoutListener	createSessionTimeoutListener()
SshAgentFactory	getAgentFactory() Retrieve the agent factory for creating SshAgent objects.
<T> T	getAttribute(AttributeStore.AttributeKey<T> key) Returns the value of the user-defined attribute.
List<NamedFactory<Channel>>	getChannelFactories() Retrieve the list of named factories for Channel objects.
ChannelListener	getChannelListenerProxy()
FileSystemFactory	getFileSystemFactory() Retrieve the FileSystemFactory to be used to traverse the file system.
List<RequestHandler<ConnectionService>>	getGlobalRequestHandlers() Retrieve the list of global request handlers.
IoServiceFactory	getIoServiceFactory()
IoServiceFactoryFactory	getIoServiceFactoryFactory()
int	getNioWorkers()
PropertyResolver	getParentPropertyResolver()
PortForwardingEventListener	getPortForwardingEventListenerProxy()
Map<String,Object>	getProperties() A map of properties that can be used to configure the SSH server or client.
Factory<Random>	getRandomFactory() Retrieve the Random factory to be used.
ReservedSessionMessagesHandler	getReservedSessionMessagesHandler()
ScheduledExecutorService	getScheduledExecutorService() Retrieve the ScheduledExecutorService to be used.
List<ServiceFactory>	getServiceFactories() Retrieve the list of SSH Service factories.
SessionListener	getSessionListenerProxy()
TcpipForwarderFactory	getTcpipForwarderFactory() Retrieve the tcpip forwarder factory used to support tcpip forwarding.
ForwardingFilter	getTcpipForwardingFilter() Retrieve the ForwardingFilter to be used by the SSH server.
String	getVersion() An upper case string identifying the version of the software used on client or server side.
<T> T	removeAttribute(AttributeStore.AttributeKey<T> key) Removes the user-defined attribute
void	removeChannelListener(ChannelListener listener) Remove a channel listener
void	removePortForwardingEventListener(PortForwardingEventListener listener) Remove a port forwarding listener
void	removeSessionListener(SessionListener listener) Remove a session listener.
protected void	removeSessionTimeout(AbstractSessionFactory<?,?> sessionFactory)
<T> T	resolveAttribute(AttributeStore.AttributeKey<T> key) Attempts to resolve the associated value by going up the store's hierarchy (if any)
void	setAgentFactory(SshAgentFactory agentFactory)
<T> T	setAttribute(AttributeStore.AttributeKey<T> key, T value) Sets a user-defined attribute.
void	setChannelFactories(List<NamedFactory<Channel>> channelFactories)
void	setFileSystemFactory(FileSystemFactory fileSystemFactory)
void	setGlobalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)
void	setIoServiceFactoryFactory(IoServiceFactoryFactory ioServiceFactory)
void	setNioWorkers(int nioWorkers)
void	setParentPropertyResolver(PropertyResolver parent)
void	setRandomFactory(Factory<Random> randomFactory)
void	setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)
void	setScheduledExecutorService(ScheduledExecutorService executor)
void	setScheduledExecutorService(ScheduledExecutorService executor, boolean shutdownExecutor)
void	setServiceFactories(List<ServiceFactory> serviceFactories)
void	setTcpipForwarderFactory(TcpipForwarderFactory tcpipForwarderFactory)
void	setTcpipForwardingFilter(ForwardingFilter tcpipForwardingFilter)
protected void	setupSessionTimeout(AbstractSessionFactory<?,?> sessionFactory)
protected void	stopSessionTimeoutListener(AbstractSessionFactory<?,?> sessionFactory)

Methods inherited from class org.apache.sshd.common.kex.AbstractKexFactoryManager

getCipherFactories, getCompressionFactories, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKeyExchangeFactories, setKeyPairProvider, setMacFactories, setSignatureFactories

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately, getInnerCloseable

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, isClosed, isClosing, preClose, removeCloseFutureListener

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.kex.KexFactoryManager

getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager

getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface org.apache.sshd.common.AttributeStore

resolveAttribute, resolveAttribute, resolveAttribute

Methods inherited from interface org.apache.sshd.common.PropertyResolver

getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty

Methods inherited from interface org.apache.sshd.common.Closeable

close, close, getMaxCloseWaitTime, isOpen

Field Detail

ioServiceFactoryFactory

protected IoServiceFactoryFactory ioServiceFactoryFactory

ioServiceFactory

protected IoServiceFactory ioServiceFactory

randomFactory

protected Factory<Random> randomFactory

channelFactories

protected List<NamedFactory<Channel>> channelFactories

agentFactory

protected SshAgentFactory agentFactory

executor

protected ScheduledExecutorService executor

shutdownExecutor

protected boolean shutdownExecutor

tcpipForwarderFactory

protected TcpipForwarderFactory tcpipForwarderFactory

tcpipForwardingFilter

protected ForwardingFilter tcpipForwardingFilter

fileSystemFactory

protected FileSystemFactory fileSystemFactory

serviceFactories

protected List<ServiceFactory> serviceFactories

globalRequestHandlers

protected List<RequestHandler<ConnectionService>> globalRequestHandlers

sessionTimeoutListener

protected SessionTimeoutListener sessionTimeoutListener

timeoutListenerFuture

protected ScheduledFuture<?> timeoutListenerFuture

sessionListeners

protected final Collection<SessionListener> sessionListeners

sessionListenerProxy

protected final SessionListener sessionListenerProxy

channelListeners

protected final Collection<ChannelListener> channelListeners

channelListenerProxy

protected final ChannelListener channelListenerProxy

tunnelListeners

protected final Collection<PortForwardingEventListener> tunnelListeners

tunnelListenerProxy

protected final PortForwardingEventListener tunnelListenerProxy

Constructor Detail

AbstractFactoryManager

protected AbstractFactoryManager()

Method Detail

getIoServiceFactory

public IoServiceFactory getIoServiceFactory()

Specified by:

getIoServiceFactory in interface FactoryManager

getIoServiceFactoryFactory

public IoServiceFactoryFactory getIoServiceFactoryFactory()

setIoServiceFactoryFactory

public void setIoServiceFactoryFactory(IoServiceFactoryFactory ioServiceFactory)

getRandomFactory

public Factory<Random> getRandomFactory()

Description copied from interface: FactoryManager

Retrieve the Random factory to be used.

Specified by:

getRandomFactory in interface FactoryManager

Returns:

The Random factory, never null

setRandomFactory

public void setRandomFactory(Factory<Random> randomFactory)

getProperties

public Map<String,Object> getProperties()

Description copied from interface: PropertyResolver

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.

Note: the type of the mapped property should match the expected configuration value type - Long, Integer, Boolean, String, etc.... If it doesn't, the toString() result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is a long then it will be parsed into one. Also, if the mapped value is an Integer but a long is expected, then it will be converted into one.

Specified by:

getProperties in interface PropertyResolver

Returns:

a valid Map containing configuration values, never null

getAttribute

public <T> T getAttribute(AttributeStore.AttributeKey<T> key)

Description copied from interface: AttributeStore

Returns the value of the user-defined attribute.

Specified by:

getAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

null if there is no value associated with the specified key

setAttribute

public <T> T setAttribute(AttributeStore.AttributeKey<T> key,
                          T value)

Description copied from interface: AttributeStore

Sets a user-defined attribute.

Specified by:

setAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

value - The value of the attribute; must not be null.

Returns:

The old value of the attribute; null if it is new.

removeAttribute

public <T> T removeAttribute(AttributeStore.AttributeKey<T> key)

Description copied from interface: AttributeStore

Removes the user-defined attribute

Specified by:

removeAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

The removed value; null if no previous value

resolveAttribute

public <T> T resolveAttribute(AttributeStore.AttributeKey<T> key)

Description copied from interface: AttributeStore

Attempts to resolve the associated value by going up the store's hierarchy (if any)

Specified by:

resolveAttribute in interface AttributeStore

Type Parameters:

T - The generic attribute type

Parameters:

key - The key of the attribute; must not be null.

Returns:

null if there is no value associated with the specified key

getParentPropertyResolver

public PropertyResolver getParentPropertyResolver()

Specified by:

getParentPropertyResolver in interface PropertyResolver

Returns:

The parent resolver that can be used to query for missing properties - null if no parent

setParentPropertyResolver

public void setParentPropertyResolver(PropertyResolver parent)

getVersion

public String getVersion()

Description copied from interface: FactoryManager

An upper case string identifying the version of the software used on client or server side. This version includes the name and version of the software and usually looks like this: SSHD-CORE-1.0

Specified by:

getVersion in interface FactoryManager

Returns:

the version of the software

getChannelFactories

public List<NamedFactory<Channel>> getChannelFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for Channel objects.

Specified by:

getChannelFactories in interface FactoryManager

Returns:

A list of named Channel factories, never null

setChannelFactories

public void setChannelFactories(List<NamedFactory<Channel>> channelFactories)

getNioWorkers

public int getNioWorkers()

setNioWorkers

public void setNioWorkers(int nioWorkers)

getAgentFactory

public SshAgentFactory getAgentFactory()

Description copied from interface: FactoryManager

Retrieve the agent factory for creating SshAgent objects.

Specified by:

getAgentFactory in interface FactoryManager

Returns:

The SshAgentFactory

setAgentFactory

public void setAgentFactory(SshAgentFactory agentFactory)

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

Description copied from interface: FactoryManager

Retrieve the ScheduledExecutorService to be used.

Specified by:

getScheduledExecutorService in interface FactoryManager

Returns:

The ScheduledExecutorService, never null

setScheduledExecutorService

public void setScheduledExecutorService(ScheduledExecutorService executor)

setScheduledExecutorService

public void setScheduledExecutorService(ScheduledExecutorService executor,
                                        boolean shutdownExecutor)

getTcpipForwarderFactory

public TcpipForwarderFactory getTcpipForwarderFactory()

Description copied from interface: FactoryManager

Retrieve the tcpip forwarder factory used to support tcpip forwarding.

Specified by:

getTcpipForwarderFactory in interface FactoryManager

Returns:

The TcpipForwarderFactory

setTcpipForwarderFactory

public void setTcpipForwarderFactory(TcpipForwarderFactory tcpipForwarderFactory)

getTcpipForwardingFilter

public ForwardingFilter getTcpipForwardingFilter()

Description copied from interface: FactoryManager

Retrieve the ForwardingFilter to be used by the SSH server. If no filter has been configured (i.e. this method returns null), then all forwarding requests will be rejected.

Specified by:

getTcpipForwardingFilter in interface FactoryManager

Returns:

The ForwardingFilter or null

setTcpipForwardingFilter

public void setTcpipForwardingFilter(ForwardingFilter tcpipForwardingFilter)

getFileSystemFactory

public FileSystemFactory getFileSystemFactory()

Description copied from interface: FactoryManager

Retrieve the FileSystemFactory to be used to traverse the file system.

Specified by:

getFileSystemFactory in interface FactoryManager

Returns:

a valid FileSystemFactory instance or null if file based interactions are not supported on this server

setFileSystemFactory

public void setFileSystemFactory(FileSystemFactory fileSystemFactory)

getServiceFactories

public List<ServiceFactory> getServiceFactories()

Description copied from interface: FactoryManager

Retrieve the list of SSH Service factories.

Specified by:

getServiceFactories in interface FactoryManager

Returns:

a list of named Service factories, never null

setServiceFactories

public void setServiceFactories(List<ServiceFactory> serviceFactories)

getGlobalRequestHandlers

public List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()

Description copied from interface: FactoryManager

Retrieve the list of global request handlers.

Specified by:

getGlobalRequestHandlers in interface FactoryManager

Returns:

a list of named GlobalRequestHandler

setGlobalRequestHandlers

public void setGlobalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)

getReservedSessionMessagesHandler

public ReservedSessionMessagesHandler getReservedSessionMessagesHandler()

Specified by:

getReservedSessionMessagesHandler in interface ReservedSessionMessagesManager

Returns:

The currently registered ReservedSessionMessagesHandler - may be null

setReservedSessionMessagesHandler

public void setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)

Specified by:

setReservedSessionMessagesHandler in interface ReservedSessionMessagesManager

Parameters:

handler - The ReservedSessionMessagesHandler to use - may be null

addSessionListener

public void addSessionListener(SessionListener listener)

Description copied from interface: SessionListenerManager

Add a session listener.

Specified by:

addSessionListener in interface SessionListenerManager

Parameters:

listener - The SessionListener to add - not null

removeSessionListener

public void removeSessionListener(SessionListener listener)

Description copied from interface: SessionListenerManager

Remove a session listener.

Specified by:

removeSessionListener in interface SessionListenerManager

Parameters:

listener - The SessionListener to remove

getSessionListenerProxy

public SessionListener getSessionListenerProxy()

Specified by:

getSessionListenerProxy in interface SessionListenerManager

Returns:

A (never null proxy SessionListener that represents all the currently registered listeners. Any method invocation on the proxy is replicated to the currently registered listeners

addChannelListener

public void addChannelListener(ChannelListener listener)

Description copied from interface: ChannelListenerManager

Add a channel listener

Specified by:

addChannelListener in interface ChannelListenerManager

Parameters:

listener - The ChannelListener to add - not null

removeChannelListener

public void removeChannelListener(ChannelListener listener)

Description copied from interface: ChannelListenerManager

Remove a channel listener

Specified by:

removeChannelListener in interface ChannelListenerManager

Parameters:

listener - The ChannelListener to remove

getChannelListenerProxy

public ChannelListener getChannelListenerProxy()

Specified by:

getChannelListenerProxy in interface ChannelListenerManager

Returns:

A (never null proxy ChannelListener that represents all the currently registered listeners. Any method invocation on the proxy is replicated to the currently registered listeners

getPortForwardingEventListenerProxy

public PortForwardingEventListener getPortForwardingEventListenerProxy()

Specified by:

getPortForwardingEventListenerProxy in interface PortForwardingEventListenerManager

Returns:

A proxy listener representing all the currently registered listener through this manager

addPortForwardingEventListener

public void addPortForwardingEventListener(PortForwardingEventListener listener)

Description copied from interface: PortForwardingEventListenerManager

Add a port forwarding listener

Specified by:

addPortForwardingEventListener in interface PortForwardingEventListenerManager

Parameters:

listener - The PortForwardingEventListener to add - never null

removePortForwardingEventListener

public void removePortForwardingEventListener(PortForwardingEventListener listener)

Description copied from interface: PortForwardingEventListenerManager

Remove a port forwarding listener

Specified by:

removePortForwardingEventListener in interface PortForwardingEventListenerManager

Parameters:

listener - The PortForwardingEventListener to remove - ignored if null

setupSessionTimeout

protected void setupSessionTimeout(AbstractSessionFactory<?,?> sessionFactory)

removeSessionTimeout

protected void removeSessionTimeout(AbstractSessionFactory<?,?> sessionFactory)

createSessionTimeoutListener

protected SessionTimeoutListener createSessionTimeoutListener()

stopSessionTimeoutListener

protected void stopSessionTimeoutListener(AbstractSessionFactory<?,?> sessionFactory)

checkConfig

protected void checkConfig()