FactoryManager (Apache Mina SSHD

All Known Subinterfaces:

ClientFactoryManager, ServerFactoryManager

All Known Implementing Classes:

AbstractFactoryManager, SshClient, SshServer
```
public interface FactoryManager
```
This interface allows retrieving all the NamedFactory used in the SSH protocol.

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_TIMEOUT` Key used to retrieve the value of the timeout after which it will close the connection if the other side has not been authenticated.
`static String`	`CHANNEL_CLOSE_TIMEOUT` Key used to configure the timeout used when writing a close request on a channel.
`static int`	`DEFAULT_NIO_WORKERS` Default number of worker threads to use.
`static String`	`DEFAULT_VERSION` The default reported version of `getVersion()` if the built-in version information cannot be accessed
`static String`	`DISCONNECT_TIMEOUT` Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.
`static String`	`IDLE_TIMEOUT` Key used to retrieve the value of idle timeout after which it will close the connection.
`static String`	`MAX_PACKET_SIZE` Key used to retrieve the value of the maximum packet size in the configuration properties map.
`static String`	`NIO_WORKERS` Number of NIO worker threads to use.
`static String`	`NIO2_READ_BUFFER_SIZE` Read buffer size for NIO2 sessions See `Nio2Session`
`static String`	`SOCKET_BACKLOG` Socket backlog.
`static String`	`SOCKET_KEEPALIVE` Socket keep-alive.
`static String`	`SOCKET_LINGER` Socket linger.
`static String`	`SOCKET_RCVBUF` Socket receive buffer size.
`static String`	`SOCKET_REUSEADDR` Socket reuse address.
`static String`	`SOCKET_SNDBUF` Socket send buffer size.
`static String`	`TCP_NODELAY` Socket tcp no-delay.
`static String`	`WINDOW_SIZE` Key used to retrieve the value of the window size in the configuration properties map.
`static String`	`WINDOW_TIMEOUT` Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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()`
`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`.
`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.

- Field Detail
  - WINDOW_SIZE
```
static final String WINDOW_SIZE
```
    Key used to retrieve the value of the window size in the configuration properties map.
    
    See Also:
    
    Constant Field Values
  - WINDOW_TIMEOUT
```
static final String WINDOW_TIMEOUT
```
    Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel. If not set or non-positive then infinite value is assumed
    
    See Also:
    
    Constant Field Values
  - MAX_PACKET_SIZE
```
static final String MAX_PACKET_SIZE
```
    Key used to retrieve the value of the maximum packet size in the configuration properties map.
    
    See Also:
    
    Constant Field Values
  - NIO_WORKERS
```
static final String NIO_WORKERS
```
    Number of NIO worker threads to use.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NIO_WORKERS
```
static final int DEFAULT_NIO_WORKERS
```
    Default number of worker threads to use.
  - AUTH_TIMEOUT
```
static final String AUTH_TIMEOUT
```
    Key used to retrieve the value of the timeout after which it will close the connection if the other side has not been authenticated.
    
    See Also:
    
    Constant Field Values
  - IDLE_TIMEOUT
```
static final String IDLE_TIMEOUT
```
    Key used to retrieve the value of idle timeout after which it will close the connection. In milliseconds.
    
    See Also:
    
    Constant Field Values
  - DISCONNECT_TIMEOUT
```
static final String DISCONNECT_TIMEOUT
```
    Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted. If the disconnect message has not been sent before the timeout, the underlying socket will be forcibly closed.
    
    See Also:
    
    Constant Field Values
  - CHANNEL_CLOSE_TIMEOUT
```
static final String CHANNEL_CLOSE_TIMEOUT
```
    Key used to configure the timeout used when writing a close request on a channel. If the message can not be written before the specified timeout elapses, the channel will be immediately closed. In milliseconds.
    
    See Also:
    
    Constant Field Values
  - SOCKET_BACKLOG
```
static final String SOCKET_BACKLOG
```
    Socket backlog. See AsynchronousServerSocketChannel.bind(java.net.SocketAddress, int)
    
    See Also:
    
    Constant Field Values
  - SOCKET_KEEPALIVE
```
static final String SOCKET_KEEPALIVE
```
    Socket keep-alive. See StandardSocketOptions.SO_KEEPALIVE
    
    See Also:
    
    Constant Field Values
  - SOCKET_SNDBUF
```
static final String SOCKET_SNDBUF
```
    Socket send buffer size. See StandardSocketOptions.SO_SNDBUF
    
    See Also:
    
    Constant Field Values
  - SOCKET_RCVBUF
```
static final String SOCKET_RCVBUF
```
    Socket receive buffer size. See StandardSocketOptions.SO_RCVBUF
    
    See Also:
    
    Constant Field Values
  - SOCKET_REUSEADDR
```
static final String SOCKET_REUSEADDR
```
    Socket reuse address. See StandardSocketOptions.SO_REUSEADDR
    
    See Also:
    
    Constant Field Values
  - SOCKET_LINGER
```
static final String SOCKET_LINGER
```
    Socket linger. See StandardSocketOptions.SO_LINGER
    
    See Also:
    
    Constant Field Values
  - TCP_NODELAY
```
static final String TCP_NODELAY
```
    Socket tcp no-delay. See StandardSocketOptions.TCP_NODELAY
    
    See Also:
    
    Constant Field Values
  - NIO2_READ_BUFFER_SIZE
```
static final String NIO2_READ_BUFFER_SIZE
```
    Read buffer size for NIO2 sessions See Nio2Session
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VERSION
```
static final String DEFAULT_VERSION
```
    The default reported version of getVersion() if the built-in version information cannot be accessed
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProperties
```
Map<String,Object> getProperties()
```
    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.
    
    Returns:
    
    a valid Map containing configuration values, never null
  - getVersion
```
String getVersion()
```
    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
    
    Returns:
    
    the version of the software
  - getIoServiceFactory
```
IoServiceFactory getIoServiceFactory()
```
  - getKeyExchangeFactories
```
List<NamedFactory<KeyExchange>> getKeyExchangeFactories()
```
    Retrieve the list of named factories for KeyExchange.
    
    Returns:
    
    a list of named KeyExchange factories, never null
  - getCipherFactories
```
List<NamedFactory<Cipher>> getCipherFactories()
```
    Retrieve the list of named factories for Cipher.
    
    Returns:
    
    a list of named Cipher factories, never null
  - getCompressionFactories
```
List<NamedFactory<Compression>> getCompressionFactories()
```
    Retrieve the list of named factories for Compression.
    
    Returns:
    
    a list of named Compression factories, never null
  - getMacFactories
```
List<NamedFactory<Mac>> getMacFactories()
```
    Retrieve the list of named factories for Mac.
    
    Returns:
    
    a list of named Mac factories, never null
  - getSignatureFactories
```
List<NamedFactory<Signature>> getSignatureFactories()
```
    Retrieve the list of named factories for Signature.
    
    Returns:
    
    a list of named Signature factories, never null
  - getKeyPairProvider
```
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.
    
    Returns:
    
    the KeyPairProvider, never null
  - getRandomFactory
```
Factory<Random> getRandomFactory()
```
    Retrieve the Random factory to be used.
    
    Returns:
    
    the Random factory, never null
  - getChannelFactories
```
List<NamedFactory<Channel>> getChannelFactories()
```
    Retrieve the list of named factories for Channel objects.
    
    Returns:
    
    a list of named Channel factories, never null
  - getAgentFactory
```
SshAgentFactory getAgentFactory()
```
    Retrieve the agent factory for creating SshAgent objects.
    
    Returns:
    
    the factory
  - getScheduledExecutorService
```
ScheduledExecutorService getScheduledExecutorService()
```
    Retrieve the ScheduledExecutorService to be used.
    
    Returns:
    
    the ScheduledExecutorService, never null
  - getTcpipForwardingFilter
```
ForwardingFilter getTcpipForwardingFilter()
```
    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.
    
    Returns:
    
    the ForwardingFilter or null
  - getTcpipForwarderFactory
```
TcpipForwarderFactory getTcpipForwarderFactory()
```
    Retrieve the tcpip forwarder factory used to support tcpip forwarding.
    
    Returns:
    
    the TcpipForwarderFactory
  - getFileSystemFactory
```
FileSystemFactory getFileSystemFactory()
```
    Retrieve the FileSystemFactory to be used to traverse the file system.
    
    Returns:
    
    a valid FileSystemFactory object or null if file based interactions are not supported on this server
  - getServiceFactories
```
List<ServiceFactory> getServiceFactories()
```
    Retrieve the list of SSH Service factories.
    
    Returns:
    
    a list of named Service factories, never null
  - getGlobalRequestHandlers
```
List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()
```
    Retrieve the list of global request handlers.
    
    Returns:
    
    a list of named GlobalRequestHandler

Interface FactoryManager

Field Summary

Method Summary

Field Detail

WINDOW_SIZE

WINDOW_TIMEOUT

MAX_PACKET_SIZE

NIO_WORKERS

DEFAULT_NIO_WORKERS

AUTH_TIMEOUT

IDLE_TIMEOUT

DISCONNECT_TIMEOUT

CHANNEL_CLOSE_TIMEOUT

SOCKET_BACKLOG

SOCKET_KEEPALIVE

SOCKET_SNDBUF

SOCKET_RCVBUF

SOCKET_REUSEADDR

SOCKET_LINGER

TCP_NODELAY

NIO2_READ_BUFFER_SIZE

DEFAULT_VERSION

Method Detail

getProperties

getVersion

getIoServiceFactory

getKeyExchangeFactories

getCipherFactories

getCompressionFactories

getMacFactories

getSignatureFactories

getKeyPairProvider

getRandomFactory

getChannelFactories

getAgentFactory

getScheduledExecutorService

getTcpipForwardingFilter

getTcpipForwarderFactory

getFileSystemFactory

getServiceFactories

getGlobalRequestHandlers