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 int`	`DEFAULT_NIO_WORKERS` Default number of worker threads to use.
`static java.lang.String`	`MAX_PACKET_SIZE` Key used to retrieve the value of the maximum packet size in the configuration properties map.
`static java.lang.String`	`NIO_WORKERS` Number of NIO worker threads to use.
`static java.lang.String`	`WINDOW_SIZE` Key used to retrieve the value of the window size in the configuration properties map.

Method Summary

Methods
Modifier and Type	Method and Description
`SshAgentFactory`	`getAgentFactory()` Retrieve the agent factory for creating `SshAgent` objects.
`java.util.List<NamedFactory<Channel>>`	`getChannelFactories()` Retrieve the list of named factories for `Channel` objects.
`java.util.List<NamedFactory<Cipher>>`	`getCipherFactories()` Retrieve the list of named factories for `Cipher`.
`java.util.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.
`java.util.List<RequestHandler<ConnectionService>>`	`getGlobalRequestHandlers()` Retrieve the list of global request handlers.
`IoServiceFactory`	`getIoServiceFactory()`
`java.util.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.
`java.util.List<NamedFactory<Mac>>`	`getMacFactories()` Retrieve the list of named factories for `Mac`.
`java.util.Map<java.lang.String,java.lang.String>`	`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.
`java.util.concurrent.ScheduledExecutorService`	`getScheduledExecutorService()` Retrieve the `ScheduledExecutorService` to be used.
`java.util.List<ServiceFactory>`	`getServiceFactories()` Retrieve the list of SSH `Service` factories.
`java.util.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.
`java.lang.String`	`getVersion()` An upper case string identifying the version of the software used on client or server side.

- Field Detail
  - WINDOW_SIZE
```
static final java.lang.String WINDOW_SIZE
```
    Key used to retrieve the value of the window size in the configuration properties map.
    
    See Also:
    Constant Field Values
  - MAX_PACKET_SIZE
```
static final java.lang.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 java.lang.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.
- Method Detail
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> 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.
    
    Returns:
    a valid Map containing configuration values, never null
  - getVersion
```
java.lang.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: SSHD-1.0
    
    Returns:
    the version of the software
  - getIoServiceFactory
```
IoServiceFactory getIoServiceFactory()
```
  - getKeyExchangeFactories
```
java.util.List<NamedFactory<KeyExchange>> getKeyExchangeFactories()
```
    Retrieve the list of named factories for KeyExchange.
    
    Returns:
    a list of named KeyExchange factories, never null
  - getCipherFactories
```
java.util.List<NamedFactory<Cipher>> getCipherFactories()
```
    Retrieve the list of named factories for Cipher.
    
    Returns:
    a list of named Cipher factories, never null
  - getCompressionFactories
```
java.util.List<NamedFactory<Compression>> getCompressionFactories()
```
    Retrieve the list of named factories for Compression.
    
    Returns:
    a list of named Compression factories, never null
  - getMacFactories
```
java.util.List<NamedFactory<Mac>> getMacFactories()
```
    Retrieve the list of named factories for Mac.
    
    Returns:
    a list of named Mac factories, never null
  - getSignatureFactories
```
java.util.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
```
java.util.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
```
java.util.concurrent.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
```
java.util.List<ServiceFactory> getServiceFactories()
```
    Retrieve the list of SSH Service factories.
    
    Returns:
    a list of named Service factories, never null
  - getGlobalRequestHandlers
```
java.util.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

MAX_PACKET_SIZE

NIO_WORKERS

DEFAULT_NIO_WORKERS

Method Detail

getProperties

getVersion

getIoServiceFactory

getKeyExchangeFactories

getCipherFactories

getCompressionFactories

getMacFactories

getSignatureFactories

getKeyPairProvider

getRandomFactory

getChannelFactories

getAgentFactory

getScheduledExecutorService

getTcpipForwardingFilter

getTcpipForwarderFactory

getFileSystemFactory

getServiceFactories

getGlobalRequestHandlers