FactoryManager

All Superinterfaces:

AttributeRepository, AttributeStore, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, PortForwardingEventListenerManager, PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, SignatureFactoriesManager, UnknownChannelReferenceHandlerManager

All Known Subinterfaces:

ClientFactoryManager, ServerFactoryManager

All Known Implementing Classes:

AbstractFactoryManager, SshClient, SshServer
```
public interface FactoryManager
extends KexFactoryManager, SessionListenerManager, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, ChannelListenerManager, ChannelStreamPacketWriterResolverManager, UnknownChannelReferenceHandlerManager, PortForwardingEventListenerManager, IoServiceEventListenerManager, AttributeStore, SessionHeartbeatController
```
This interface allows retrieving all the NamedFactory used in the SSH protocol.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository
  AttributeRepository.AttributeKey<T>
- Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
  SessionHeartbeatController.HeartbeatType

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AGENT_FORWARDING_TYPE` The request type of agent forwarding.
`static java.lang.String`	`AGENT_FORWARDING_TYPE_IETF` The agent forwarding type defined by IETF (https://tools.ietf.org/html/draft-ietf-secsh-agent-02).
`static java.lang.String`	`AGENT_FORWARDING_TYPE_OPENSSH` The agent forwarding type defined by OpenSSH.
`static java.lang.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 - in milliseconds.
`static java.lang.String`	`CHANNEL_CLOSE_TIMEOUT` Key used to configure the timeout used when writing a close request on a channel.
`static long`	`DEFAULT_AUTH_TIMEOUT` Default value for "auth-timeout" if none set
`static long`	`DEFAULT_CHANNEL_CLOSE_TIMEOUT` Default "channel-close-timeout" value if none set
`static long`	`DEFAULT_DISCONNECT_TIMEOUT` Default value for "disconnect-timeout" if none set
`static long`	`DEFAULT_IDLE_TIMEOUT` Default value for "idle-timeout" if none set
`static long`	`DEFAULT_IGNORE_MESSAGE_FREQUENCY` Default value of "ignore-message-frequency" if none set.
`static int`	`DEFAULT_IGNORE_MESSAGE_SIZE` Value of "ignore-message-size" if none configured
`static int`	`DEFAULT_IGNORE_MESSAGE_VARIANCE` Default value for "ignore-message-variance" if none configured
`static long`	`DEFAULT_LIMIT_PACKET_SIZE` Default "max-packet-size" if none set
`static int`	`DEFAULT_MAX_IDENTIFICATION_SIZE` Default value for "max-identification-size" if none set
`static long`	`DEFAULT_MAX_PACKET_SIZE` Default "packet-size" if none set
`static int`	`DEFAULT_NIO_WORKERS` Default number of worker threads to use if none set - the number of available processors + 1
`static long`	`DEFAULT_NIO2_MIN_WRITE_TIMEOUT` Default value for "nio2-min-write-timeout" if none set
`static long`	`DEFAULT_NIO2_READ_TIMEOUT` Default value for "nio2-read-timeout" if none set
`static long`	`DEFAULT_REKEY_BYTES_LIMIT` Default value for "rekey-bytes-limit" if no override
`static long`	`DEFAULT_REKEY_PACKETS_LIMIT` Default value for "rekey-packets-limit" if none specified
`static long`	`DEFAULT_REKEY_TIME_LIMIT` Default value for "rekey-time-limit" if none specified
`static long`	`DEFAULT_STOP_WAIT_TIME` Default value for "stop-wait-time" if none specified
`static java.lang.String`	`DEFAULT_VERSION` The default `REPORTED_VERSION` of `getVersion()` if the built-in version information cannot be accessed
`static long`	`DEFAULT_WINDOW_SIZE` Default "window-size" if none set
`static long`	`DEFAULT_WINDOW_TIMEOUT` Default "window-timeout" value
`static java.lang.String`	`DISCONNECT_TIMEOUT` Key used to retrieve the value of the disconnect timeout which is used when a disconnection is attempted.
`static java.lang.String`	`IDLE_TIMEOUT` Key used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.
`static java.lang.String`	`IGNORE_MESSAGE_FREQUENCY` Average number of packets to be skipped before an `SSH_MSG_IGNORE` message is inserted in the stream.
`static java.lang.String`	`IGNORE_MESSAGE_SIZE` Minimum size of `SSH_MSG_IGNORE` payload to send if feature enabled.
`static java.lang.String`	`IGNORE_MESSAGE_VARIANCE` The variance to be used around the configured "ignore-message-frequency" value in order to avoid insertion at a set frequency.
`static java.lang.String`	`LIMIT_PACKET_SIZE` A safety value that is designed to avoid an attack that uses large channel packet sizes
`static java.lang.String`	`MAX_IDENTIFICATION_SIZE` Maximum allowed size of the initial identification text sent during the handshake
`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`	`NIO2_MIN_WRITE_TIMEOUT` Minimum NIO2 write wait timeout for a single outgoing packet - in milliseconds
`static java.lang.String`	`NIO2_READ_BUFFER_SIZE` Read buffer size for NIO2 sessions See `Nio2Session`
`static java.lang.String`	`NIO2_READ_TIMEOUT` Key used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.
`static java.lang.String`	`REKEY_BLOCKS_LIMIT` Key re-exchange will be automatically performed after the specified number of cipher blocks has been processed - positive 64-bit value.
`static java.lang.String`	`REKEY_BYTES_LIMIT` Key re-exchange will be automatically performed after the session has sent or received the given amount of bytes.
`static java.lang.String`	`REKEY_PACKETS_LIMIT` Key re-exchange will be automatically performed after the specified number of packets has been exchanged - positive 64-bit value.
`static java.lang.String`	`REKEY_TIME_LIMIT` Key re-exchange will be automatically performed after the specified amount of time has elapsed since the last key exchange - in milliseconds.
`static java.lang.String`	`SOCKET_BACKLOG` Socket backlog.
`static java.lang.String`	`SOCKET_KEEPALIVE` Socket keep-alive.
`static java.lang.String`	`SOCKET_LINGER` Socket linger.
`static java.lang.String`	`SOCKET_RCVBUF` Socket receive buffer size.
`static java.lang.String`	`SOCKET_REUSEADDR` Socket reuse address.
`static java.lang.String`	`SOCKET_SNDBUF` Socket send buffer size.
`static java.lang.String`	`STOP_WAIT_TIME` Timeout (milliseconds) to wait for client / server stop request if immediate stop requested.
`static java.lang.String`	`TCP_NODELAY` Socket tcp no-delay.
`static java.lang.String`	`WINDOW_SIZE` Key used to retrieve the value of the channel window size in the configuration properties map.
`static java.lang.String`	`WINDOW_TIMEOUT` Key used to retrieve timeout (msec.) to wait for data to become available when reading from a channel.

Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver
NONE

Fields inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`SshAgentFactory`	`getAgentFactory()` Retrieve the agent factory for creating `SshAgent` objects.
`default AgentForwardingFilter`	`getAgentForwardingFilter()`
`java.util.List<ChannelFactory>`	`getChannelFactories()` Retrieve the list of named factories for `Channel` objects.
`FileSystemFactory`	`getFileSystemFactory()` Retrieve the `FileSystemFactory` to be used to traverse the file system.
`ForwardingFilterFactory`	`getForwarderFactory()` Retrieve the forwarder factory used to support forwarding.
`ForwardingFilter`	`getForwardingFilter()` Retrieve the `ForwardingFilter` to be used by the SSH server.
`java.util.List<RequestHandler<ConnectionService>>`	`getGlobalRequestHandlers()` Retrieve the list of global request handlers.
`IoServiceFactory`	`getIoServiceFactory()`
`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.
`default TcpForwardingFilter`	`getTcpForwardingFilter()`
`java.lang.String`	`getVersion()` An upper case string identifying the version of the software used on client or server side.
`default X11ForwardingFilter`	`getX11ForwardingFilter()`
`default <T> T`	`resolveAttribute(AttributeRepository.AttributeKey<T> key)` Attempts to resolve the associated value by going up the store's hierarchy (if any)
`static <T> T`	`resolveAttribute(FactoryManager manager, AttributeRepository.AttributeKey<T> key)`

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.kex.extension.KexExtensionHandlerManager
getKexExtensionHandler, setKexExtensionHandler

Methods inherited from interface org.apache.sshd.common.session.SessionListenerManager
addSessionListener, getSessionListenerProxy, removeSessionListener

Methods inherited from interface org.apache.sshd.common.session.ReservedSessionMessagesManager
getReservedSessionMessagesHandler, setReservedSessionMessagesHandler

Methods inherited from interface org.apache.sshd.common.session.SessionDisconnectHandlerManager
getSessionDisconnectHandler, setSessionDisconnectHandler

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager
getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

Methods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.io.IoServiceEventListenerManager
getIoServiceEventListener, setIoServiceEventListener

Methods inherited from interface org.apache.sshd.common.AttributeStore
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

Methods inherited from interface org.apache.sshd.common.AttributeRepository
attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat, setSessionHeartbeat

Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty

- Field Detail
  - WINDOW_SIZE
```
static final java.lang.String WINDOW_SIZE
```
    Key used to retrieve the value of the channel window size in the configuration properties map.
    
    See Also:
    
    DEFAULT_WINDOW_SIZE, Constant Field Values
  - DEFAULT_WINDOW_SIZE
```
static final long DEFAULT_WINDOW_SIZE
```
    Default "window-size" if none set
    
    See Also:
    
    Constant Field Values
  - WINDOW_TIMEOUT
```
static final java.lang.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:
    
    DEFAULT_WINDOW_TIMEOUT, Constant Field Values
  - DEFAULT_WINDOW_TIMEOUT
```
static final long DEFAULT_WINDOW_TIMEOUT
```
    Default "window-timeout" value
    
    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:
    
    DEFAULT_MAX_PACKET_SIZE, Constant Field Values
  - DEFAULT_MAX_PACKET_SIZE
```
static final long DEFAULT_MAX_PACKET_SIZE
```
    Default "packet-size" if none set
    
    See Also:
    
    Constant Field Values
  - LIMIT_PACKET_SIZE
```
static final java.lang.String LIMIT_PACKET_SIZE
```
    A safety value that is designed to avoid an attack that uses large channel packet sizes
    
    See Also:
    
    DEFAULT_LIMIT_PACKET_SIZE, Constant Field Values
  - DEFAULT_LIMIT_PACKET_SIZE
```
static final long DEFAULT_LIMIT_PACKET_SIZE
```
    Default "max-packet-size" if none set
    
    See Also:
    
    Constant Field Values
  - NIO_WORKERS
```
static final java.lang.String NIO_WORKERS
```
    Number of NIO worker threads to use.
    
    See Also:
    
    DEFAULT_NIO_WORKERS, Constant Field Values
  - DEFAULT_NIO_WORKERS
```
static final int DEFAULT_NIO_WORKERS
```
    Default number of worker threads to use if none set - the number of available processors + 1
  - AUTH_TIMEOUT
```
static final java.lang.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 - in milliseconds.
    
    See Also:
    
    DEFAULT_AUTH_TIMEOUT, Constant Field Values
  - DEFAULT_AUTH_TIMEOUT
```
static final long DEFAULT_AUTH_TIMEOUT
```
    Default value for "auth-timeout" if none set
  - IDLE_TIMEOUT
```
static final java.lang.String IDLE_TIMEOUT
```
    Key used to retrieve the value of idle timeout after which it will close the connection - in milliseconds.
    
    See Also:
    
    DEFAULT_IDLE_TIMEOUT, Constant Field Values
  - DEFAULT_IDLE_TIMEOUT
```
static final long DEFAULT_IDLE_TIMEOUT
```
    Default value for "idle-timeout" if none set
  - NIO2_READ_TIMEOUT
```
static final java.lang.String NIO2_READ_TIMEOUT
```
    Key used to retrieve the value of the socket read timeout for NIO2 session implementation - in milliseconds.
    
    See Also:
    
    DEFAULT_NIO2_READ_TIMEOUT, Constant Field Values
  - DEFAULT_NIO2_READ_TIMEOUT
```
static final long DEFAULT_NIO2_READ_TIMEOUT
```
    Default value for "nio2-read-timeout" if none set
  - NIO2_MIN_WRITE_TIMEOUT
```
static final java.lang.String NIO2_MIN_WRITE_TIMEOUT
```
    Minimum NIO2 write wait timeout for a single outgoing packet - in milliseconds
    
    See Also:
    
    DEFAULT_NIO2_MIN_WRITE_TIMEOUT, Constant Field Values
  - DEFAULT_NIO2_MIN_WRITE_TIMEOUT
```
static final long DEFAULT_NIO2_MIN_WRITE_TIMEOUT
```
    Default value for "nio2-min-write-timeout" if none set
  - DISCONNECT_TIMEOUT
```
static final java.lang.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 - in milliseconds.
    
    See Also:
    
    DEFAULT_DISCONNECT_TIMEOUT, Constant Field Values
  - DEFAULT_DISCONNECT_TIMEOUT
```
static final long DEFAULT_DISCONNECT_TIMEOUT
```
    Default value for "disconnect-timeout" if none set
  - CHANNEL_CLOSE_TIMEOUT
```
static final java.lang.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:
    
    DEFAULT_AUTH_TIMEOUT, Constant Field Values
  - DEFAULT_CHANNEL_CLOSE_TIMEOUT
```
static final long DEFAULT_CHANNEL_CLOSE_TIMEOUT
```
    Default "channel-close-timeout" value if none set
  - STOP_WAIT_TIME
```
static final java.lang.String STOP_WAIT_TIME
```
    Timeout (milliseconds) to wait for client / server stop request if immediate stop requested.
    
    See Also:
    
    DEFAULT_STOP_WAIT_TIME, Constant Field Values
  - DEFAULT_STOP_WAIT_TIME
```
static final long DEFAULT_STOP_WAIT_TIME
```
    Default value for "stop-wait-time" if none specified
  - SOCKET_BACKLOG
```
static final java.lang.String SOCKET_BACKLOG
```
    Socket backlog. See AsynchronousServerSocketChannel.bind(java.net.SocketAddress, int)
    
    See Also:
    
    Constant Field Values
  - SOCKET_KEEPALIVE
```
static final java.lang.String SOCKET_KEEPALIVE
```
    Socket keep-alive. See StandardSocketOptions.SO_KEEPALIVE
    
    See Also:
    
    Constant Field Values
  - SOCKET_SNDBUF
```
static final java.lang.String SOCKET_SNDBUF
```
    Socket send buffer size. See StandardSocketOptions.SO_SNDBUF
    
    See Also:
    
    Constant Field Values
  - SOCKET_RCVBUF
```
static final java.lang.String SOCKET_RCVBUF
```
    Socket receive buffer size. See StandardSocketOptions.SO_RCVBUF
    
    See Also:
    
    Constant Field Values
  - SOCKET_REUSEADDR
```
static final java.lang.String SOCKET_REUSEADDR
```
    Socket reuse address. See StandardSocketOptions.SO_REUSEADDR
    
    See Also:
    
    Constant Field Values
  - SOCKET_LINGER
```
static final java.lang.String SOCKET_LINGER
```
    Socket linger. See StandardSocketOptions.SO_LINGER
    
    See Also:
    
    Constant Field Values
  - TCP_NODELAY
```
static final java.lang.String TCP_NODELAY
```
    Socket tcp no-delay. See StandardSocketOptions.TCP_NODELAY
    
    See Also:
    
    Constant Field Values
  - NIO2_READ_BUFFER_SIZE
```
static final java.lang.String NIO2_READ_BUFFER_SIZE
```
    Read buffer size for NIO2 sessions See Nio2Session
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VERSION
```
static final java.lang.String DEFAULT_VERSION
```
    The default REPORTED_VERSION of getVersion() if the built-in version information cannot be accessed
    
    See Also:
    
    Constant Field Values
  - MAX_IDENTIFICATION_SIZE
```
static final java.lang.String MAX_IDENTIFICATION_SIZE
```
    Maximum allowed size of the initial identification text sent during the handshake
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IDENTIFICATION_SIZE
```
static final int DEFAULT_MAX_IDENTIFICATION_SIZE
```
    Default value for "max-identification-size" if none set
    
    See Also:
    
    Constant Field Values
  - REKEY_BYTES_LIMIT
```
static final java.lang.String REKEY_BYTES_LIMIT
```
    Key re-exchange will be automatically performed after the session has sent or received the given amount of bytes. If non-positive, then disabled. The default value is 1073741824L
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REKEY_BYTES_LIMIT
```
static final long DEFAULT_REKEY_BYTES_LIMIT
```
    Default value for "rekey-bytes-limit" if no override
    
    See Also:
    
    RFC4253 section 9, Constant Field Values
  - REKEY_TIME_LIMIT
```
static final java.lang.String REKEY_TIME_LIMIT
```
    Key re-exchange will be automatically performed after the specified amount of time has elapsed since the last key exchange - in milliseconds. If non-positive then disabled. The default value is 3600000L
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REKEY_TIME_LIMIT
```
static final long DEFAULT_REKEY_TIME_LIMIT
```
    Default value for "rekey-time-limit" if none specified
    
    See Also:
    
    RFC4253 section 9, Constant Field Values
  - REKEY_PACKETS_LIMIT
```
static final java.lang.String REKEY_PACKETS_LIMIT
```
    Key re-exchange will be automatically performed after the specified number of packets has been exchanged - positive 64-bit value. If non-positive then disabled. The default is 2147483648L
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REKEY_PACKETS_LIMIT
```
static final long DEFAULT_REKEY_PACKETS_LIMIT
```
    Default value for "rekey-packets-limit" if none specified
    
    See Also:
    
    RFC4344 section 3.1, Constant Field Values
  - REKEY_BLOCKS_LIMIT
```
static final java.lang.String REKEY_BLOCKS_LIMIT
```
    Key re-exchange will be automatically performed after the specified number of cipher blocks has been processed - positive 64-bit value. If non-positive then disabled. The default is calculated according to RFC4344 section 3.2
    
    See Also:
    
    Constant Field Values
  - IGNORE_MESSAGE_FREQUENCY
```
static final java.lang.String IGNORE_MESSAGE_FREQUENCY
```
    Average number of packets to be skipped before an SSH_MSG_IGNORE message is inserted in the stream. If non-positive, then feature is disabled
    
    See Also:
    
    IGNORE_MESSAGE_VARIANCE, RFC4251 section 9.3.1, Constant Field Values
  - DEFAULT_IGNORE_MESSAGE_FREQUENCY
```
static final long DEFAULT_IGNORE_MESSAGE_FREQUENCY
```
    Default value of "ignore-message-frequency" if none set.
    
    See Also:
    
    Constant Field Values
  - IGNORE_MESSAGE_VARIANCE
```
static final java.lang.String IGNORE_MESSAGE_VARIANCE
```
    The variance to be used around the configured "ignore-message-frequency" value in order to avoid insertion at a set frequency. If zero, then exact frequency is used. If negative, then the absolute value is used. If greater or equal to the frequency, then assumed to be zero - i.e., no variance
    
    See Also:
    
    RFC4251 section 9.3.1, Constant Field Values
  - DEFAULT_IGNORE_MESSAGE_VARIANCE
```
static final int DEFAULT_IGNORE_MESSAGE_VARIANCE
```
    Default value for "ignore-message-variance" if none configured
    
    See Also:
    
    Constant Field Values
  - IGNORE_MESSAGE_SIZE
```
static final java.lang.String IGNORE_MESSAGE_SIZE
```
    Minimum size of SSH_MSG_IGNORE payload to send if feature enabled. If non-positive then no message is sent. Otherwise, the actual size is between this size and twice its value
    
    See Also:
    
    RFC4251 section 9.3.1, Constant Field Values
  - DEFAULT_IGNORE_MESSAGE_SIZE
```
static final int DEFAULT_IGNORE_MESSAGE_SIZE
```
    Value of "ignore-message-size" if none configured
    
    See Also:
    
    Constant Field Values
  - AGENT_FORWARDING_TYPE
```
static final java.lang.String AGENT_FORWARDING_TYPE
```
    The request type of agent forwarding. The value may be "auth-agent-req" or "auth-agent-req@openssh.com".
    
    See Also:
    
    Constant Field Values
  - AGENT_FORWARDING_TYPE_IETF
```
static final java.lang.String AGENT_FORWARDING_TYPE_IETF
```
    The agent forwarding type defined by IETF (https://tools.ietf.org/html/draft-ietf-secsh-agent-02).
    
    See Also:
    
    Constant Field Values
  - AGENT_FORWARDING_TYPE_OPENSSH
```
static final java.lang.String AGENT_FORWARDING_TYPE_OPENSSH
```
    The agent forwarding type defined by OpenSSH.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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 and version of the software and usually looks like this: SSHD-CORE-1.0
    
    Returns:
    
    the version of the software
  - getIoServiceFactory
```
IoServiceFactory getIoServiceFactory()
```
  - getRandomFactory
```
Factory<Random> getRandomFactory()
```
    Retrieve the Random factory to be used.
    
    Returns:
    
    The Random factory, never null
  - getChannelFactories
```
java.util.List<ChannelFactory> getChannelFactories()
```
    Retrieve the list of named factories for Channel objects.
    
    Returns:
    
    A list of ChannelFactory-ies, never null
  - getAgentFactory
```
SshAgentFactory getAgentFactory()
```
    Retrieve the agent factory for creating SshAgent objects.
    
    Returns:
    
    The SshAgentFactory
  - getScheduledExecutorService
```
java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
```
    Retrieve the ScheduledExecutorService to be used.
    
    Returns:
    
    The ScheduledExecutorService, never null
  - getForwardingFilter
```
ForwardingFilter getForwardingFilter()
```
    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
  - getTcpForwardingFilter
```
default TcpForwardingFilter getTcpForwardingFilter()
```
  - getAgentForwardingFilter
```
default AgentForwardingFilter getAgentForwardingFilter()
```
  - getX11ForwardingFilter
```
default X11ForwardingFilter getX11ForwardingFilter()
```
  - getForwarderFactory
```
ForwardingFilterFactory getForwarderFactory()
```
    Retrieve the forwarder factory used to support forwarding.
    
    Returns:
    
    The ForwardingFilterFactory
  - getFileSystemFactory
```
FileSystemFactory getFileSystemFactory()
```
    Retrieve the FileSystemFactory to be used to traverse the file system.
    
    Returns:
    
    a valid FileSystemFactory instance 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
  - resolveAttribute
```
default <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key)
```
    Description copied from interface: AttributeRepository
    
    Attempts to resolve the associated value by going up the store's hierarchy (if any)
    
    Specified by:
    
    resolveAttribute in interface AttributeRepository
    
    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 either in this repository or any of its ancestors (if any available)
  - resolveAttribute
```
static <T> T resolveAttribute(FactoryManager manager,
                              AttributeRepository.AttributeKey<T> key)
```
    Type Parameters:
    
    T - The generic attribute type
    
    Parameters:
    
    manager - The FactoryManager - ignored if null
    
    key - The attribute key - never null
    
    Returns:
    
    Associated value - null if not found

Interface FactoryManager

Nested Class Summary

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

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

Field Summary

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

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

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

Method Summary

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

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

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

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

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

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

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

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

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

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

Methods inherited from interface org.apache.sshd.common.io.IoServiceEventListenerManager

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

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

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

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

Field Detail

WINDOW_SIZE

DEFAULT_WINDOW_SIZE

WINDOW_TIMEOUT

DEFAULT_WINDOW_TIMEOUT

MAX_PACKET_SIZE

DEFAULT_MAX_PACKET_SIZE

LIMIT_PACKET_SIZE

DEFAULT_LIMIT_PACKET_SIZE

NIO_WORKERS

DEFAULT_NIO_WORKERS

AUTH_TIMEOUT

DEFAULT_AUTH_TIMEOUT

IDLE_TIMEOUT

DEFAULT_IDLE_TIMEOUT

NIO2_READ_TIMEOUT

DEFAULT_NIO2_READ_TIMEOUT

NIO2_MIN_WRITE_TIMEOUT

DEFAULT_NIO2_MIN_WRITE_TIMEOUT

DISCONNECT_TIMEOUT

DEFAULT_DISCONNECT_TIMEOUT

CHANNEL_CLOSE_TIMEOUT

DEFAULT_CHANNEL_CLOSE_TIMEOUT

STOP_WAIT_TIME

DEFAULT_STOP_WAIT_TIME

SOCKET_BACKLOG

SOCKET_KEEPALIVE

SOCKET_SNDBUF

SOCKET_RCVBUF

SOCKET_REUSEADDR

SOCKET_LINGER

TCP_NODELAY

NIO2_READ_BUFFER_SIZE

DEFAULT_VERSION

MAX_IDENTIFICATION_SIZE

DEFAULT_MAX_IDENTIFICATION_SIZE

REKEY_BYTES_LIMIT

DEFAULT_REKEY_BYTES_LIMIT

REKEY_TIME_LIMIT

DEFAULT_REKEY_TIME_LIMIT

REKEY_PACKETS_LIMIT

DEFAULT_REKEY_PACKETS_LIMIT

REKEY_BLOCKS_LIMIT

IGNORE_MESSAGE_FREQUENCY

DEFAULT_IGNORE_MESSAGE_FREQUENCY

IGNORE_MESSAGE_VARIANCE

DEFAULT_IGNORE_MESSAGE_VARIANCE

IGNORE_MESSAGE_SIZE

DEFAULT_IGNORE_MESSAGE_SIZE

AGENT_FORWARDING_TYPE

AGENT_FORWARDING_TYPE_IETF

AGENT_FORWARDING_TYPE_OPENSSH

Method Detail

getVersion

getIoServiceFactory

getRandomFactory