org.apache.sshd.common

Class AbstractFactoryManager

java.lang.Object

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

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.AbstractFactoryManager

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, FactoryManager

Direct Known Subclasses:

SshClient, SshServer

public abstract class AbstractFactoryManager
extends CloseableUtils.AbstractInnerCloseable
implements FactoryManager

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

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

CloseableUtils.AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected SshAgentFactory	agentFactory
protected List<NamedFactory<Channel>>	channelFactories
protected List<NamedFactory<Cipher>>	cipherFactories
protected List<NamedFactory<Compression>>	compressionFactories
protected ScheduledExecutorService	executor
protected FileSystemFactory	fileSystemFactory
protected List<RequestHandler<ConnectionService>>	globalRequestHandlers
protected IoServiceFactory	ioServiceFactory
protected IoServiceFactoryFactory	ioServiceFactoryFactory
protected List<NamedFactory<KeyExchange>>	keyExchangeFactories
protected KeyPairProvider	keyPairProvider
protected List<NamedFactory<Mac>>	macFactories
protected Map<String,Object>	properties
protected Factory<Random>	randomFactory
protected List<ServiceFactory>	serviceFactories
protected SessionTimeoutListener	sessionTimeoutListener
protected boolean	shutdownExecutor
protected List<NamedFactory<Signature>>	signatureFactories
protected TcpipForwarderFactory	tcpipForwarderFactory
protected ForwardingFilter	tcpipForwardingFilter
protected ScheduledFuture<?>	timeoutListenerFuture

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.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_NIO_WORKERS, DEFAULT_VERSION, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_READ_BUFFER_SIZE, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFactoryManager()

Method Summary

Modifier and Type	Method and Description
protected void	checkConfig()
protected SessionTimeoutListener	createSessionTimeoutListener()
SshAgentFactory	getAgentFactory() Retrieve the agent factory for creating SshAgent objects.
List<NamedFactory<Channel>>	getChannelFactories() Retrieve the list of named factories for Channel objects.
List<NamedFactory<Cipher>>	getCipherFactories() Retrieve the list of named factories for Cipher.
List<NamedFactory<Compression>>	getCompressionFactories() Retrieve the list of named factories for Compression.
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()
List<NamedFactory<KeyExchange>>	getKeyExchangeFactories() Retrieve the list of named factories for KeyExchange.
KeyPairProvider	getKeyPairProvider() Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.
List<NamedFactory<Mac>>	getMacFactories() Retrieve the list of named factories for Mac.
int	getNioWorkers()
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.
ScheduledExecutorService	getScheduledExecutorService() Retrieve the ScheduledExecutorService to be used.
List<ServiceFactory>	getServiceFactories() Retrieve the list of SSH Service factories.
List<NamedFactory<Signature>>	getSignatureFactories() Retrieve the list of named factories for Signature.
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.
protected void	removeSessionTimeout(AbstractSessionFactory sessionFactory)
void	setAgentFactory(SshAgentFactory agentFactory)
void	setChannelFactories(List<NamedFactory<Channel>> channelFactories)
void	setCipherFactories(List<NamedFactory<Cipher>> cipherFactories)
void	setCompressionFactories(List<NamedFactory<Compression>> compressionFactories)
void	setFileSystemFactory(FileSystemFactory fileSystemFactory)
void	setGlobalRequestHandlers(List<RequestHandler<ConnectionService>> globalRequestHandlers)
void	setIoServiceFactoryFactory(IoServiceFactoryFactory ioServiceFactory)
void	setKeyExchangeFactories(List<NamedFactory<KeyExchange>> keyExchangeFactories)
void	setKeyPairProvider(KeyPairProvider keyPairProvider)
void	setMacFactories(List<NamedFactory<Mac>> macFactories)
void	setNioWorkers(int nioWorkers)
void	setProperties(Map<String,Object> properties)
void	setRandomFactory(Factory<Random> randomFactory)
void	setScheduledExecutorService(ScheduledExecutorService executor)
void	setScheduledExecutorService(ScheduledExecutorService executor, boolean shutdownExecutor)
void	setServiceFactories(List<ServiceFactory> serviceFactories)
void	setSignatureFactories(List<NamedFactory<Signature>> signatureFactories)
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.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately, getInnerCloseable

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

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Map<String,Object> properties

ioServiceFactoryFactory

protected IoServiceFactoryFactory ioServiceFactoryFactory

ioServiceFactory

protected IoServiceFactory ioServiceFactory

keyExchangeFactories

protected List<NamedFactory<KeyExchange>> keyExchangeFactories

cipherFactories

protected List<NamedFactory<Cipher>> cipherFactories

compressionFactories

protected List<NamedFactory<Compression>> compressionFactories

macFactories

protected List<NamedFactory<Mac>> macFactories

signatureFactories

protected List<NamedFactory<Signature>> signatureFactories

randomFactory

protected Factory<Random> randomFactory

keyPairProvider

protected KeyPairProvider keyPairProvider

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

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)

getKeyExchangeFactories

public List<NamedFactory<KeyExchange>> getKeyExchangeFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for KeyExchange.

Specified by:

getKeyExchangeFactories in interface FactoryManager

Returns:

a list of named KeyExchange factories, never null

setKeyExchangeFactories

public void setKeyExchangeFactories(List<NamedFactory<KeyExchange>> keyExchangeFactories)

getCipherFactories

public List<NamedFactory<Cipher>> getCipherFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for Cipher.

Specified by:

getCipherFactories in interface FactoryManager

Returns:

a list of named Cipher factories, never null

setCipherFactories

public void setCipherFactories(List<NamedFactory<Cipher>> cipherFactories)

getCompressionFactories

public List<NamedFactory<Compression>> getCompressionFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for Compression.

Specified by:

getCompressionFactories in interface FactoryManager

Returns:

a list of named Compression factories, never null

setCompressionFactories

public void setCompressionFactories(List<NamedFactory<Compression>> compressionFactories)

getMacFactories

public List<NamedFactory<Mac>> getMacFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for Mac.

Specified by:

getMacFactories in interface FactoryManager

Returns:

a list of named Mac factories, never null

setMacFactories

public void setMacFactories(List<NamedFactory<Mac>> macFactories)

getSignatureFactories

public List<NamedFactory<Signature>> getSignatureFactories()

Description copied from interface: FactoryManager

Retrieve the list of named factories for Signature.

Specified by:

getSignatureFactories in interface FactoryManager

Returns:

a list of named Signature factories, never null

setSignatureFactories

public void setSignatureFactories(List<NamedFactory<Signature>> signatureFactories)

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)

getKeyPairProvider

public KeyPairProvider getKeyPairProvider()

Description copied from interface: FactoryManager

Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.

Specified by:

getKeyPairProvider in interface FactoryManager

Returns:

the KeyPairProvider, never null

setKeyPairProvider

public void setKeyPairProvider(KeyPairProvider keyPairProvider)

getProperties

public Map<String,Object> getProperties()

Description copied from interface: FactoryManager

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 FactoryManager

Returns:

a valid Map containing configuration values, never null

setProperties

public void setProperties(Map<String,Object> properties)

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 of the software and usually looks like this: SSHD-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 factory

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

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