Package org.apache.sshd.common
Interface 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 theNamedFactory
used in the SSH protocol.- Author:
- Apache MINA SSHD Project
-
-
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 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 setstatic long
DEFAULT_CHANNEL_CLOSE_TIMEOUT
Default "channel-close-timeout" value if none setstatic long
DEFAULT_DISCONNECT_TIMEOUT
Default value for "disconnect-timeout" if none setstatic long
DEFAULT_IDLE_TIMEOUT
Default value for "idle-timeout" if none setstatic 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 configuredstatic int
DEFAULT_IGNORE_MESSAGE_VARIANCE
Default value for "ignore-message-variance" if none configuredstatic long
DEFAULT_LIMIT_PACKET_SIZE
Default "max-packet-size" if none setstatic int
DEFAULT_MAX_IDENTIFICATION_SIZE
Default value for "max-identification-size" if none setstatic long
DEFAULT_MAX_PACKET_SIZE
Default "packet-size" if none setstatic int
DEFAULT_NIO_WORKERS
Default number of worker threads to use if none set - the number of available processors + 1static long
DEFAULT_NIO2_MIN_WRITE_TIMEOUT
Default value for "nio2-min-write-timeout" if none setstatic long
DEFAULT_NIO2_READ_TIMEOUT
Default value for "nio2-read-timeout" if none setstatic long
DEFAULT_REKEY_BYTES_LIMIT
Default value for "rekey-bytes-limit" if no overridestatic long
DEFAULT_REKEY_PACKETS_LIMIT
Default value for "rekey-packets-limit" if none specifiedstatic long
DEFAULT_REKEY_TIME_LIMIT
Default value for "rekey-time-limit" if none specifiedstatic long
DEFAULT_STOP_WAIT_TIME
Default value for "stop-wait-time" if none specifiedstatic String
DEFAULT_VERSION
The defaultREPORTED_VERSION
ofgetVersion()
if the built-in version information cannot be accessedstatic long
DEFAULT_WINDOW_SIZE
Default "window-size" if none setstatic long
DEFAULT_WINDOW_TIMEOUT
Default "window-timeout" valuestatic 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 anSSH_MSG_IGNORE
message is inserted in the stream.static String
IGNORE_MESSAGE_SIZE
Minimum size ofSSH_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 sizesstatic String
MAX_IDENTIFICATION_SIZE
Maximum allowed size of the initial identification text sent during the handshakestatic 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 millisecondsstatic String
NIO2_READ_BUFFER_SIZE
Read buffer size for NIO2 sessions SeeNio2Session
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.-
Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver
NONE
-
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
Fields inherited from interface org.apache.sshd.common.session.SessionHeartbeatController
DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SshAgentFactory
getAgentFactory()
Retrieve the agent factory for creatingSshAgent
objects.default AgentForwardingFilter
getAgentForwardingFilter()
List<ChannelFactory>
getChannelFactories()
Retrieve the list of named factories forChannel
objects.FileSystemFactory
getFileSystemFactory()
Retrieve theFileSystemFactory
to be used to traverse the file system.ForwardingFilterFactory
getForwarderFactory()
Retrieve the forwarder factory used to support forwarding.ForwardingFilter
getForwardingFilter()
Retrieve theForwardingFilter
to be used by the SSH server.List<RequestHandler<ConnectionService>>
getGlobalRequestHandlers()
Retrieve the list of global request handlers.IoServiceFactory
getIoServiceFactory()
Factory<Random>
getRandomFactory()
Retrieve theRandom
factory to be used.ScheduledExecutorService
getScheduledExecutorService()
Retrieve theScheduledExecutorService
to be used.List<ServiceFactory>
getServiceFactories()
Retrieve the list of SSHService
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)
-
Methods inherited from interface org.apache.sshd.common.AttributeRepository
attributeKeys, getAttribute, getAttributesCount
-
Methods inherited from interface org.apache.sshd.common.AttributeStore
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute
-
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.io.IoServiceEventListenerManager
getIoServiceEventListener, setIoServiceEventListener
-
Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager
getKexExtensionHandler, setKexExtensionHandler
-
Methods inherited from interface org.apache.sshd.common.kex.KexFactoryManager
getCipherFactories, getCipherFactoriesNameList, getCipherFactoriesNames, getCompressionFactories, getCompressionFactoriesNameList, getCompressionFactoriesNames, getKeyExchangeFactories, getMacFactories, getMacFactoriesNameList, getMacFactoriesNames, setCipherFactories, setCipherFactoriesNameList, setCipherFactoriesNames, setCipherFactoriesNames, setCompressionFactories, setCompressionFactoriesNameList, setCompressionFactoriesNames, setCompressionFactoriesNames, setKeyExchangeFactories, setMacFactories, setMacFactoriesNameList, setMacFactoriesNames, setMacFactoriesNames
-
Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager
addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener
-
Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty
-
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.session.SessionHeartbeatController
disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat
-
Methods inherited from interface org.apache.sshd.common.session.SessionListenerManager
addSessionListener, getSessionListenerProxy, removeSessionListener
-
Methods inherited from interface org.apache.sshd.common.signature.SignatureFactoriesManager
getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames
-
Methods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager
getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler
-
-
-
-
Field Detail
-
WINDOW_SIZE
static final 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 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 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 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 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 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 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 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 String NIO2_MIN_WRITE_TIMEOUT
Minimum NIO2 write wait timeout for a single outgoing packet - in milliseconds
-
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 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 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 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 String SOCKET_BACKLOG
Socket backlog. SeeAsynchronousServerSocketChannel.bind(java.net.SocketAddress, int)
- See Also:
- Constant Field Values
-
SOCKET_KEEPALIVE
static final String SOCKET_KEEPALIVE
Socket keep-alive. SeeStandardSocketOptions.SO_KEEPALIVE
- See Also:
- Constant Field Values
-
SOCKET_SNDBUF
static final String SOCKET_SNDBUF
Socket send buffer size. SeeStandardSocketOptions.SO_SNDBUF
- See Also:
- Constant Field Values
-
SOCKET_RCVBUF
static final String SOCKET_RCVBUF
Socket receive buffer size. SeeStandardSocketOptions.SO_RCVBUF
- See Also:
- Constant Field Values
-
SOCKET_REUSEADDR
static final String SOCKET_REUSEADDR
Socket reuse address. SeeStandardSocketOptions.SO_REUSEADDR
- See Also:
- Constant Field Values
-
SOCKET_LINGER
static final String SOCKET_LINGER
Socket linger. SeeStandardSocketOptions.SO_LINGER
- See Also:
- Constant Field Values
-
TCP_NODELAY
static final String TCP_NODELAY
Socket tcp no-delay. SeeStandardSocketOptions.TCP_NODELAY
- See Also:
- Constant Field Values
-
NIO2_READ_BUFFER_SIZE
static final String NIO2_READ_BUFFER_SIZE
Read buffer size for NIO2 sessions SeeNio2Session
- See Also:
- Constant Field Values
-
DEFAULT_VERSION
static final String DEFAULT_VERSION
The defaultREPORTED_VERSION
ofgetVersion()
if the built-in version information cannot be accessed- See Also:
- Constant Field Values
-
MAX_IDENTIFICATION_SIZE
static final 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 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 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 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 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 String IGNORE_MESSAGE_FREQUENCY
Average number of packets to be skipped before anSSH_MSG_IGNORE
message is inserted in the stream. If non-positive, then feature is disabled
-
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 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 String IGNORE_MESSAGE_SIZE
Minimum size ofSSH_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 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 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 String AGENT_FORWARDING_TYPE_OPENSSH
The agent forwarding type defined by OpenSSH.- See Also:
- Constant Field Values
-
-
Method Detail
-
getVersion
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 theRandom
factory to be used.- Returns:
- The
Random
factory, nevernull
-
getChannelFactories
List<ChannelFactory> getChannelFactories()
Retrieve the list of named factories forChannel
objects.- Returns:
- A list of
ChannelFactory
-ies, nevernull
-
getAgentFactory
SshAgentFactory getAgentFactory()
Retrieve the agent factory for creatingSshAgent
objects.- Returns:
- The
SshAgentFactory
-
getScheduledExecutorService
ScheduledExecutorService getScheduledExecutorService()
Retrieve theScheduledExecutorService
to be used.- Returns:
- The
ScheduledExecutorService
, nevernull
-
getForwardingFilter
ForwardingFilter getForwardingFilter()
Retrieve theForwardingFilter
to be used by the SSH server. If no filter has been configured (i.e. this method returnsnull
), then all forwarding requests will be rejected.- Returns:
- The
ForwardingFilter
ornull
-
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 theFileSystemFactory
to be used to traverse the file system.- Returns:
- a valid
FileSystemFactory
instance ornull
if file based interactions are not supported on this server
-
getServiceFactories
List<ServiceFactory> getServiceFactories()
Retrieve the list of SSHService
factories.- Returns:
- a list of named
Service
factories, nevernull
-
getGlobalRequestHandlers
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 interfaceAttributeRepository
- Type Parameters:
T
- The generic attribute type- Parameters:
key
- The key of the attribute; must not benull
.- 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
- TheFactoryManager
- ignored ifnull
key
- The attribute key - nevernull
- Returns:
- Associated value -
null
if not found
-
-