org.apache.sshd.server

Interface ServerFactoryManager

All Superinterfaces:

FactoryManager

All Known Implementing Classes:

SshServer

public interface ServerFactoryManager
extends FactoryManager

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

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TIMEOUT Key used to retrieve the value of the timeout after which the server will close the connection if the client has not been authenticated.
static String	IDLE_TIMEOUT Key used to retrieve the value of idle timeout after which the server will close the connection.
static String	MAX_AUTH_REQUESTS Key used to retrieve the value in the configuration properties map of the maximum number of failed authentication requests before the server closes the connection.
static String	MAX_CONCURRENT_SESSIONS Key used to retrieve the value of the maximum concurrent open session count per username
static String	SERVER_IDENTIFICATION Key used to retrieve the value of the server identification string if not default.

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

DEFAULT_NIO_WORKERS, MAX_PACKET_SIZE, NIO_WORKERS, WINDOW_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
CommandFactory	getCommandFactory() Retrieve the CommandFactory to be used to process commands requests.
FileSystemFactory	getFileSystemFactory() Retrieve the FileSystemFactory to be used to traverse the file system.
ForwardingFilter	getForwardingFilter() Retrieve the ForwardingFilter to be used by the SSH server.
GSSAuthenticator	getGSSAuthenticator() Retrieve the GSSAuthenticator to be used by the SSH server.
PasswordAuthenticator	getPasswordAuthenticator() Retrieve the PasswordAuthenticator to be used by the SSH server.
PublickeyAuthenticator	getPublickeyAuthenticator() Retrieve the PublickeyAuthenticator to be used by SSH server.
ScheduledExecutorService	getScheduledExecutorService() Retrieve the ScheduledExecutorService to be used.
Factory<Command>	getShellFactory() Retrieve the ShellFactory object to be used to create shells.
List<NamedFactory<Command>>	getSubsystemFactories() Retrieve the list of named factories for CommandFactory.Command to be used to create subsystems.
ForwardingAcceptorFactory	getTcpipForwardingAcceptorFactory() Retrieve the IoAcceptor factory to be used to accept incoming connections to port forwards.
List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve the list of named factories for UserAuth objects.
ForwardingAcceptorFactory	getX11ForwardingAcceptorFactory() Retrieve the IoAcceptor factory to be used to accept incoming connections for X11 Forwards.

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

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getSignatureFactories, getVersion

Field Detail

MAX_CONCURRENT_SESSIONS

static final String MAX_CONCURRENT_SESSIONS

Key used to retrieve the value of the maximum concurrent open session count per username

See Also:

Constant Field Values

SERVER_IDENTIFICATION

static final String SERVER_IDENTIFICATION

Key used to retrieve the value of the server identification string if not default.

See Also:

Constant Field Values

MAX_AUTH_REQUESTS

static final String MAX_AUTH_REQUESTS

Key used to retrieve the value in the configuration properties map of the maximum number of failed authentication requests before the server closes the connection.

See Also:

Constant Field Values

AUTH_TIMEOUT

static final String AUTH_TIMEOUT

Key used to retrieve the value of the timeout after which the server will close the connection if the client has not been authenticated.

See Also:

Constant Field Values

IDLE_TIMEOUT

static final String IDLE_TIMEOUT

Key used to retrieve the value of idle timeout after which the server will close the connection. In milliseconds.

See Also:

Constant Field Values

Method Detail

getUserAuthFactories

List<NamedFactory<UserAuth>> getUserAuthFactories()

Retrieve the list of named factories for UserAuth objects.

Returns:

a list of named UserAuth factories, never null

getPublickeyAuthenticator

PublickeyAuthenticator getPublickeyAuthenticator()

Retrieve the PublickeyAuthenticator to be used by SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on keys will be rejected.

Returns:

the PublickeyAuthenticato or null

getPasswordAuthenticator

PasswordAuthenticator getPasswordAuthenticator()

Retrieve the PasswordAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on passwords will be rejected.

Returns:

the PasswordAuthenticator or null

getGSSAuthenticator

GSSAuthenticator getGSSAuthenticator()

Retrieve the GSSAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on gssapi will be rejected.

Returns:

the GSSAuthenticator or 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

getShellFactory

Factory<Command> 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

getFileSystemFactory

FileSystemFactory getFileSystemFactory()

Retrieve the FileSystemFactory to be used to traverse the file system.

Returns:

a valid FileSystemFactory object or null if commands are not supported on this server

getSubsystemFactories

List<NamedFactory<Command>> getSubsystemFactories()

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

Returns:

a list of named CommandFactory.Command factories or null if subsystems are not supported on this server

getTcpipForwardingAcceptorFactory

ForwardingAcceptorFactory getTcpipForwardingAcceptorFactory()

Retrieve the IoAcceptor factory to be used to accept incoming connections to port forwards.

Returns:

A ForwardNioAcceptorFactory

getX11ForwardingAcceptorFactory

ForwardingAcceptorFactory getX11ForwardingAcceptorFactory()

Retrieve the IoAcceptor factory to be used to accept incoming connections for X11 Forwards.

Returns:

A ForwardNioAcceptorFactory

getScheduledExecutorService

ScheduledExecutorService getScheduledExecutorService()

Retrieve the ScheduledExecutorService to be used.

Returns:

the ScheduledExecutorService, never null