org.apache.sshd.server

Interface ServerFactoryManager

All Superinterfaces:

AttributeRepository, AttributeStore, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, FactoryManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, KeyPairProviderHolder, PortForwardingEventListenerManager, PropertyResolver, ReservedSessionMessagesManager, ServerAuthenticationManager, ServerProxyAcceptorHolder, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, SignatureFactoriesManager, UnknownChannelReferenceHandlerManager, UserAuthFactoriesManager<ServerSession,UserAuth,UserAuthFactory>

All Known Implementing Classes:

SshServer

public interface ServerFactoryManager
extends FactoryManager, ServerProxyAcceptorHolder, ServerAuthenticationManager

The ServerFactoryManager enable the retrieval of additional configuration needed specifically for the server side.

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	COMMAND_EXIT_TIMEOUT Key used to configure the timeout used when receiving a close request on a channel to wait until the command cleanly exits after setting an EOF on the input stream.
static long	DEFAULT_COMMAND_EXIT_TIMEOUT Default "command-exit-timeout" if not set
static java.lang.String	MAX_CONCURRENT_SESSIONS Key used to retrieve the value of the maximum concurrent open session count per username.
static java.lang.String	MODULI_URL A URL pointing to the moduli file.
static char	SERVER_EXTRA_IDENT_LINES_SEPARATOR Separator used in the "server-extra-identification-lines" configuration string to indicate new line break
static java.lang.String	SERVER_EXTRA_IDENTIFICATION_LINES Key used to retrieve any extra lines to be sent during initial protocol handshake before the identification.
static java.lang.String	SERVER_IDENTIFICATION Key used to retrieve the value of the server identification string.

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

AGENT_FORWARDING_TYPE, AGENT_FORWARDING_TYPE_IETF, AGENT_FORWARDING_TYPE_OPENSSH, AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_AUTH_TIMEOUT, DEFAULT_CHANNEL_CLOSE_TIMEOUT, DEFAULT_DISCONNECT_TIMEOUT, DEFAULT_IDLE_TIMEOUT, DEFAULT_IGNORE_MESSAGE_FREQUENCY, DEFAULT_IGNORE_MESSAGE_SIZE, DEFAULT_IGNORE_MESSAGE_VARIANCE, DEFAULT_LIMIT_PACKET_SIZE, DEFAULT_MAX_IDENTIFICATION_SIZE, DEFAULT_MAX_PACKET_SIZE, DEFAULT_NIO_WORKERS, DEFAULT_NIO2_MIN_WRITE_TIMEOUT, DEFAULT_NIO2_READ_TIMEOUT, DEFAULT_REKEY_BYTES_LIMIT, DEFAULT_REKEY_PACKETS_LIMIT, DEFAULT_REKEY_TIME_LIMIT, DEFAULT_STOP_WAIT_TIME, DEFAULT_VERSION, DEFAULT_WINDOW_SIZE, DEFAULT_WINDOW_TIMEOUT, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, IGNORE_MESSAGE_FREQUENCY, IGNORE_MESSAGE_SIZE, IGNORE_MESSAGE_VARIANCE, LIMIT_PACKET_SIZE, MAX_IDENTIFICATION_SIZE, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_MIN_WRITE_TIMEOUT, NIO2_READ_BUFFER_SIZE, NIO2_READ_TIMEOUT, REKEY_BLOCKS_LIMIT, REKEY_BYTES_LIMIT, REKEY_PACKETS_LIMIT, REKEY_TIME_LIMIT, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, STOP_WAIT_TIME, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT

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

Fields inherited from interface org.apache.sshd.server.ServerAuthenticationManager

AUTH_METHODS, AUTO_WELCOME_BANNER_VALUE, DEFAULT_BANNER_PHASE, DEFAULT_MAX_AUTH_REQUESTS, DEFAULT_USER_AUTH_GSS_FACTORY, DEFAULT_USER_AUTH_KB_INTERACTIVE_FACTORY, DEFAULT_USER_AUTH_PASSWORD_FACTORY, DEFAULT_USER_AUTH_PUBLIC_KEY_FACTORY, DEFAULT_WELCOME_BANNER_LANGUAGE, MAX_AUTH_REQUESTS, WELCOME_BANNER, WELCOME_BANNER_CHARSET, WELCOME_BANNER_LANGUAGE, WELCOME_BANNER_PHASE

Method Summary

Modifier and Type	Method and Description
CommandFactory	getCommandFactory() Retrieve the CommandFactory to be used to process commands requests.
ShellFactory	getShellFactory() Retrieve the ShellFactory object to be used to create shells.
java.util.List<SubsystemFactory>	getSubsystemFactories() Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.

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

getAgentFactory, getAgentForwardingFilter, getChannelFactories, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpForwardingFilter, getVersion, getX11ForwardingFilter, resolveAttribute, resolveAttribute

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.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

Methods inherited from interface org.apache.sshd.server.session.ServerProxyAcceptorHolder

getServerProxyAcceptor, setServerProxyAcceptor

Methods inherited from interface org.apache.sshd.server.ServerAuthenticationManager

getGSSAuthenticator, getHostBasedAuthenticator, getHostKeyCertificateProvider, getKeyboardInteractiveAuthenticator, getPasswordAuthenticator, getPublickeyAuthenticator, resolveUserAuthFactories, resolveUserAuthFactories, setGSSAuthenticator, setHostBasedAuthenticator, setHostKeyCertificateProvider, setKeyboardInteractiveAuthenticator, setPasswordAuthenticator, setPublickeyAuthenticator, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.auth.UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyPairProviderHolder

getKeyPairProvider, setKeyPairProvider

Field Detail

MAX_CONCURRENT_SESSIONS

static final java.lang.String MAX_CONCURRENT_SESSIONS

Key used to retrieve the value of the maximum concurrent open session count per username. If not set, then unlimited

See Also:

Constant Field Values

SERVER_EXTRA_IDENTIFICATION_LINES

static final java.lang.String SERVER_EXTRA_IDENTIFICATION_LINES

Key used to retrieve any extra lines to be sent during initial protocol handshake before the identification. The configured string value should use 124 character to denote line breaks

See Also:

Constant Field Values

SERVER_EXTRA_IDENT_LINES_SEPARATOR

static final char SERVER_EXTRA_IDENT_LINES_SEPARATOR

Separator used in the "server-extra-identification-lines" configuration string to indicate new line break

See Also:

Constant Field Values

SERVER_IDENTIFICATION

static final java.lang.String SERVER_IDENTIFICATION

Key used to retrieve the value of the server identification string. If set, then it is appended to the (standard) "SSH-2.0-" prefix. Otherwise a default is sent that consists of "SSH-2.0-" plus the current SSHD artifact name and version in uppercase - e.g., "SSH-2.0-APACHE-SSHD-1.0.0"

See Also:

Constant Field Values

COMMAND_EXIT_TIMEOUT

static final java.lang.String COMMAND_EXIT_TIMEOUT

Key used to configure the timeout used when receiving a close request on a channel to wait until the command cleanly exits after setting an EOF on the input stream. In milliseconds.

See Also:

DEFAULT_COMMAND_EXIT_TIMEOUT, Constant Field Values

DEFAULT_COMMAND_EXIT_TIMEOUT

static final long DEFAULT_COMMAND_EXIT_TIMEOUT

Default "command-exit-timeout" if not set

MODULI_URL

static final java.lang.String MODULI_URL

A URL pointing to the moduli file. If not specified, the default internal file will be used.

See Also:

Constant Field Values

Method Detail

getShellFactory

ShellFactory getShellFactory()

Retrieve the ShellFactory object to be used to create shells.

Returns:

a valid ShellFactory object or null if shells are not supported on this server

getCommandFactory

CommandFactory getCommandFactory()

Retrieve the CommandFactory to be used to process commands requests.

Returns:

A valid CommandFactory object or null if commands are not supported on this server

getSubsystemFactories

java.util.List<SubsystemFactory> getSubsystemFactories()

Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.

Returns:

a list of named SubsystemFactory-ies or null/empty if subsystems are not supported on this server