public interface FactoryManager extends KexFactoryManager, SessionListenerManager, ReservedSessionMessagesManager, ChannelListenerManager, ChannelStreamPacketWriterResolverManager, UnknownChannelReferenceHandlerManager, PortForwardingEventListenerManager, IoServiceEventListenerManager, AttributeStore, PropertyResolver
NamedFactory
used
in the SSH protocol.AttributeRepository.AttributeKey<T>
Modifier and Type | Field and Description |
---|---|
static String |
AGENT_FORWARDING_TYPE
The request type of agent forwarding.
|
static String |
AGENT_FORWARDING_TYPE_IETF
The agent forwarding type defined by IETF (https://tools.ietf.org/html/draft-ietf-secsh-agent-02).
|
static String |
AGENT_FORWARDING_TYPE_OPENSSH
The agent forwarding type defined by OpenSSH.
|
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 - in milliseconds.
|
static 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 String |
DEFAULT_VERSION
The default 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 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 - in milliseconds.
|
static String |
IGNORE_MESSAGE_FREQUENCY
Average number of packets to be skipped before an
SSH_MSG_IGNORE
message is inserted in the stream. |
static String |
IGNORE_MESSAGE_SIZE
Minimum size of
SSH_MSG_IGNORE payload to send if feature enabled. |
static 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 String |
LIMIT_PACKET_SIZE
A safety value that is designed to avoid an attack that
uses large channel packet sizes
|
static String |
MAX_IDENTIFICATION_SIZE
Maximum allowed size of the initial identification text sent during
the handshake
|
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_MIN_WRITE_TIMEOUT
Minimum NIO2 write wait timeout for a single outgoing
packet - in milliseconds
|
static String |
NIO2_READ_BUFFER_SIZE
Read buffer size for NIO2 sessions
See
Nio2Session |
static String |
NIO2_READ_TIMEOUT
Key used to retrieve the value of the socket read timeout
for NIO2 session implementation - in milliseconds.
|
static 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 String |
REKEY_BYTES_LIMIT
Key re-exchange will be automatically performed after the session
has sent or received the given amount of bytes.
|
static 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 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 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 |
STOP_WAIT_TIME
Timeout (milliseconds) to wait for client / server stop request
if immediate stop requested.
|
static String |
TCP_NODELAY
Socket tcp no-delay.
|
static String |
WINDOW_SIZE
Key used to retrieve the value of the channel 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.
|
NONE
EMPTY
Modifier and Type | Method and Description |
---|---|
SshAgentFactory |
getAgentFactory()
Retrieve the agent factory for creating
SshAgent objects. |
default AgentForwardingFilter |
getAgentForwardingFilter() |
List<NamedFactory<Channel>> |
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. |
List<RequestHandler<ConnectionService>> |
getGlobalRequestHandlers()
Retrieve the list of global request handlers.
|
IoServiceFactory |
getIoServiceFactory() |
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. |
default TcpForwardingFilter |
getTcpForwardingFilter() |
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) |
getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames
getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames
addSessionListener, getSessionListenerProxy, removeSessionListener
getReservedSessionMessagesHandler, setReservedSessionMessagesHandler
addChannelListener, getChannelListenerProxy, removeChannelListener
getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener
getIoServiceEventListener, setIoServiceEventListener
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute
attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair
getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty
static final String WINDOW_SIZE
DEFAULT_WINDOW_SIZE
,
Constant Field Valuesstatic final long DEFAULT_WINDOW_SIZE
static final String WINDOW_TIMEOUT
DEFAULT_WINDOW_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_WINDOW_TIMEOUT
static final String MAX_PACKET_SIZE
DEFAULT_MAX_PACKET_SIZE
,
Constant Field Valuesstatic final long DEFAULT_MAX_PACKET_SIZE
static final String LIMIT_PACKET_SIZE
DEFAULT_LIMIT_PACKET_SIZE
,
Constant Field Valuesstatic final long DEFAULT_LIMIT_PACKET_SIZE
static final String NIO_WORKERS
DEFAULT_NIO_WORKERS
,
Constant Field Valuesstatic final int DEFAULT_NIO_WORKERS
static final String AUTH_TIMEOUT
DEFAULT_AUTH_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_AUTH_TIMEOUT
static final String IDLE_TIMEOUT
DEFAULT_IDLE_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_IDLE_TIMEOUT
static final String NIO2_READ_TIMEOUT
DEFAULT_NIO2_READ_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_NIO2_READ_TIMEOUT
static final String NIO2_MIN_WRITE_TIMEOUT
static final long DEFAULT_NIO2_MIN_WRITE_TIMEOUT
static final String DISCONNECT_TIMEOUT
DEFAULT_DISCONNECT_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_DISCONNECT_TIMEOUT
static final String CHANNEL_CLOSE_TIMEOUT
DEFAULT_AUTH_TIMEOUT
,
Constant Field Valuesstatic final long DEFAULT_CHANNEL_CLOSE_TIMEOUT
static final String STOP_WAIT_TIME
DEFAULT_STOP_WAIT_TIME
,
Constant Field Valuesstatic final long DEFAULT_STOP_WAIT_TIME
static final String SOCKET_BACKLOG
AsynchronousServerSocketChannel.bind(java.net.SocketAddress, int)
static final String SOCKET_KEEPALIVE
StandardSocketOptions.SO_KEEPALIVE
static final String SOCKET_SNDBUF
StandardSocketOptions.SO_SNDBUF
static final String SOCKET_RCVBUF
StandardSocketOptions.SO_RCVBUF
static final String SOCKET_REUSEADDR
StandardSocketOptions.SO_REUSEADDR
static final String SOCKET_LINGER
StandardSocketOptions.SO_LINGER
static final String TCP_NODELAY
StandardSocketOptions.TCP_NODELAY
static final String NIO2_READ_BUFFER_SIZE
Nio2Session
static final String DEFAULT_VERSION
getVersion()
if the built-in
version information cannot be accessedstatic final String MAX_IDENTIFICATION_SIZE
static final int DEFAULT_MAX_IDENTIFICATION_SIZE
static final String REKEY_BYTES_LIMIT
static final long DEFAULT_REKEY_BYTES_LIMIT
static final String REKEY_TIME_LIMIT
static final long DEFAULT_REKEY_TIME_LIMIT
static final String REKEY_PACKETS_LIMIT
static final long DEFAULT_REKEY_PACKETS_LIMIT
static final String REKEY_BLOCKS_LIMIT
static final String IGNORE_MESSAGE_FREQUENCY
SSH_MSG_IGNORE
message is inserted in the stream. If non-positive, then feature is disabledstatic final long DEFAULT_IGNORE_MESSAGE_FREQUENCY
static final String IGNORE_MESSAGE_VARIANCE
static final int DEFAULT_IGNORE_MESSAGE_VARIANCE
static final String IGNORE_MESSAGE_SIZE
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 valuestatic final String AGENT_FORWARDING_TYPE
static final String AGENT_FORWARDING_TYPE_IETF
static final String AGENT_FORWARDING_TYPE_OPENSSH
static final int DEFAULT_IGNORE_MESSAGE_SIZE
String getVersion()
SSHD-CORE-1.0
IoServiceFactory getIoServiceFactory()
Factory<Random> getRandomFactory()
Random
factory to be used.Random
factory, never null
List<NamedFactory<Channel>> getChannelFactories()
Channel
objects.Channel
factories, never null
SshAgentFactory getAgentFactory()
SshAgent
objects.SshAgentFactory
ScheduledExecutorService getScheduledExecutorService()
ScheduledExecutorService
to be used.ScheduledExecutorService
, never null
ForwardingFilter getForwardingFilter()
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.ForwardingFilter
or null
default TcpForwardingFilter getTcpForwardingFilter()
default AgentForwardingFilter getAgentForwardingFilter()
default X11ForwardingFilter getX11ForwardingFilter()
ForwardingFilterFactory getForwarderFactory()
ForwardingFilterFactory
FileSystemFactory getFileSystemFactory()
FileSystemFactory
to be used to traverse the file system.FileSystemFactory
instance or null
if file based
interactions are not supported on this serverList<ServiceFactory> getServiceFactories()
Service
factories.Service
factories, never null
List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()
GlobalRequestHandler
default <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key)
AttributeRepository
resolveAttribute
in interface AttributeRepository
T
- The generic attribute typekey
- The key of the attribute; must not be null
.null
if there is no value associated with the specified key
either in this repository or any of its ancestors (if any available)static <T> T resolveAttribute(FactoryManager manager, AttributeRepository.AttributeKey<T> key)
T
- The generic attribute typemanager
- The FactoryManager
- ignored if null
key
- The attribute key - never null
null
if not foundCopyright © 2008–2022 The Apache Software Foundation. All rights reserved.