Package 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, AttributeRepository, AttributeStore, ChannelListenerManager, ChannelStreamWriterResolver, ChannelStreamWriterResolverManager, Closeable, FactoryManager, PortForwardingEventListenerManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, UnknownChannelReferenceHandlerManager, SignatureFactoriesHolder, 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.AttributeRepository

AttributeRepository.AttributeKey<T extends Object>

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

SessionHeartbeatController.HeartbeatType

Field Summary

Fields

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

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

closeFuture, futureLock, state

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

log

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver

NONE

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

DEFAULT_VERSION

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFactoryManager()

Method Summary

Modifier and Type	Method	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.
Collection<AttributeRepository.AttributeKey<?>>	attributeKeys()
protected void	checkConfig()
void	clearAttributes()
<T> T	computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key, Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver)
protected SessionTimeoutListener	createSessionTimeoutListener()
SshAgentFactory	getAgentFactory()	Retrieve the agent factory for creating SshAgent objects.
<T> T	getAttribute(AttributeRepository.AttributeKey<T> key)
int	getAttributesCount()
List<? extends ChannelFactory>	getChannelFactories()	Retrieve the list of named factories for Channel objects.
ChannelListener	getChannelListenerProxy()
ChannelStreamWriterResolver	getChannelStreamWriterResolver()
FileSystemFactory	getFileSystemFactory()	Retrieve the FileSystemFactory to be used to traverse the file system.
ForwarderFactory	getForwarderFactory()	Retrieve the forwarder factory used to support forwarding.
ForwardingFilter	getForwardingFilter()	Retrieve the ForwardingFilter to be used by the SSH server.
List<RequestHandler<ConnectionService>>	getGlobalRequestHandlers()	Retrieve the list of global request handlers.
IoServiceEventListener	getIoServiceEventListener()
IoServiceFactory	getIoServiceFactory()
IoServiceFactoryFactory	getIoServiceFactoryFactory()
int	getNioWorkers()
PropertyResolver	getParentPropertyResolver()
PortForwardingEventListener	getPortForwardingEventListenerProxy()
Map<String,Object>	getProperties()
Factory<? extends Random>	getRandomFactory()	Retrieve the Random factory to be used.
ReservedSessionMessagesHandler	getReservedSessionMessagesHandler()
ScheduledExecutorService	getScheduledExecutorService()	Retrieve the ScheduledExecutorService to be used.
List<? extends ServiceFactory>	getServiceFactories()	Retrieve the list of SSH Service factories.
SessionDisconnectHandler	getSessionDisconnectHandler()
SessionListener	getSessionListenerProxy()
UnknownChannelReferenceHandler	getUnknownChannelReferenceHandler()
String	getVersion()	An upper case string identifying the version of the software used on client or server side.
<T> T	removeAttribute(AttributeRepository.AttributeKey<T> key)
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)
UnknownChannelReferenceHandler	resolveUnknownChannelReferenceHandler()	Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)
void	setAgentFactory(SshAgentFactory agentFactory)
<T> T	setAttribute(AttributeRepository.AttributeKey<T> key, T value)
void	setChannelFactories(List<? extends ChannelFactory> channelFactories)
void	setChannelStreamWriterResolver(ChannelStreamWriterResolver resolver)
void	setFileSystemFactory(FileSystemFactory fileSystemFactory)
void	setForwarderFactory(ForwarderFactory forwarderFactory)
void	setForwardingFilter(ForwardingFilter forwardingFilter)
void	setGlobalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)
void	setIoServiceEventListener(IoServiceEventListener listener)
void	setIoServiceFactoryFactory(IoServiceFactoryFactory ioServiceFactory)
void	setNioWorkers(int nioWorkers)
void	setParentPropertyResolver(PropertyResolver parent)
void	setRandomFactory(Factory<? extends Random> randomFactory)
void	setReservedSessionMessagesHandler(ReservedSessionMessagesHandler handler)
void	setScheduledExecutorService(ScheduledExecutorService executor)
void	setScheduledExecutorService(ScheduledExecutorService executor, boolean shutdownExecutor)
void	setServiceFactories(List<? extends ServiceFactory> serviceFactories)
void	setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)
void	setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)
protected void	setupSessionTimeout(AbstractSessionFactory<?,?> sessionFactory)
protected void	stopSessionTimeoutListener(AbstractSessionFactory<?,?> sessionFactory)

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

getCipherFactories, getCompressionFactories, getDelegate, getKexExtensionHandler, getKeyExchangeFactories, getMacFactories, getSignatureFactories, resolveEffectiveFactories, resolveEffectiveProvider, setCipherFactories, setCompressionFactories, setKexExtensionHandler, setKeyExchangeFactories, 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, getFutureLock, isClosed, isClosing, preClose, removeCloseFutureListener

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

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

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager

resolveChannelStreamWriter, resolveChannelStreamWriterResolver

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

close, isOpen

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

getAgentForwardingFilter, getTcpForwardingFilter, getX11ForwardingFilter, resolveAttribute

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

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.PropertyResolver

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

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

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

getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames

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

setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Field Detail

ioServiceFactoryFactory

protected IoServiceFactoryFactory ioServiceFactoryFactory

ioServiceFactory

protected IoServiceFactory ioServiceFactory

randomFactory

protected Factory<? extends Random> randomFactory

channelFactories

protected List<? extends ChannelFactory> channelFactories

agentFactory

protected SshAgentFactory agentFactory

executor

protected ScheduledExecutorService executor

shutdownExecutor

protected boolean shutdownExecutor

forwarderFactory

protected ForwarderFactory forwarderFactory

forwardingFilter

protected ForwardingFilter forwardingFilter

fileSystemFactory

protected FileSystemFactory fileSystemFactory

serviceFactories

protected List<? extends 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)

getIoServiceEventListener

public IoServiceEventListener getIoServiceEventListener()

Specified by:

getIoServiceEventListener in interface IoServiceEventListenerManager

setIoServiceEventListener

public void setIoServiceEventListener(IoServiceEventListener listener)

Specified by:

setIoServiceEventListener in interface IoServiceEventListenerManager

getRandomFactory

public Factory<? extends 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<? extends Random> randomFactory)

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface PropertyResolver

getAttributesCount

public int getAttributesCount()

Specified by:

getAttributesCount in interface AttributeRepository

getAttribute

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

Specified by:

getAttribute in interface AttributeRepository

attributeKeys

public Collection<AttributeRepository.AttributeKey<?>> attributeKeys()

Specified by:

attributeKeys in interface AttributeRepository

computeAttributeIfAbsent

public <T> T computeAttributeIfAbsent(AttributeRepository.AttributeKey<T> key,
                                      Function<? super AttributeRepository.AttributeKey<T>,? extends T> resolver)

Specified by:

computeAttributeIfAbsent in interface AttributeStore

setAttribute

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

Specified by:

setAttribute in interface AttributeStore

removeAttribute

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

Specified by:

removeAttribute in interface AttributeStore

clearAttributes

public void clearAttributes()

Specified by:

clearAttributes in interface AttributeStore

getParentPropertyResolver

public PropertyResolver getParentPropertyResolver()

Specified by:

getParentPropertyResolver in interface PropertyResolver

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<? extends ChannelFactory> 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 ChannelFactory-ies, never null

setChannelFactories

public void setChannelFactories(List<? extends ChannelFactory> 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)

getForwarderFactory

public ForwarderFactory getForwarderFactory()

Description copied from interface: FactoryManager

Retrieve the forwarder factory used to support forwarding.

Specified by:

getForwarderFactory in interface FactoryManager

Returns:

The ForwarderFactory

setForwarderFactory

public void setForwarderFactory(ForwarderFactory forwarderFactory)

getForwardingFilter

public ForwardingFilter getForwardingFilter()

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:

getForwardingFilter in interface FactoryManager

Returns:

The ForwardingFilter or null

setForwardingFilter

public void setForwardingFilter(ForwardingFilter forwardingFilter)

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<? extends 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<? extends 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

getSessionDisconnectHandler

public SessionDisconnectHandler getSessionDisconnectHandler()

Specified by:

getSessionDisconnectHandler in interface SessionDisconnectHandlerManager

setSessionDisconnectHandler

public void setSessionDisconnectHandler(SessionDisconnectHandler sessionDisconnectHandler)

Specified by:

setSessionDisconnectHandler in interface SessionDisconnectHandlerManager

getChannelStreamWriterResolver

public ChannelStreamWriterResolver getChannelStreamWriterResolver()

Specified by:

getChannelStreamWriterResolver in interface ChannelStreamWriterResolverManager

setChannelStreamWriterResolver

public void setChannelStreamWriterResolver(ChannelStreamWriterResolver resolver)

Specified by:

setChannelStreamWriterResolver in interface ChannelStreamWriterResolverManager

getUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler getUnknownChannelReferenceHandler()

Specified by:

getUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

setUnknownChannelReferenceHandler

public void setUnknownChannelReferenceHandler(UnknownChannelReferenceHandler unknownChannelReferenceHandler)

Specified by:

setUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Parameters:

unknownChannelReferenceHandler - The UnknownChannelReferenceHandlerManager to use - if null then any reference to unknown channel causes an SshChannelNotFoundException

resolveUnknownChannelReferenceHandler

public UnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler()

Description copied from interface: UnknownChannelReferenceHandlerManager

Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)

Specified by:

resolveUnknownChannelReferenceHandler in interface UnknownChannelReferenceHandlerManager

Returns:

The resolved handler instance

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()