org.apache.sshd.common
Interface FactoryManager

All Known Subinterfaces:

ClientFactoryManager, ServerFactoryManager

All Known Implementing Classes:

AbstractFactoryManager, SshClient, SshServer

public interface FactoryManager

This interface allows retrieving all the NamedFactory used in the SSH protocol.

Author:

Apache MINA SSHD Project

Field Summary

static int	DEFAULT_NIO_WORKERS Default number of worker threads to use.
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	WINDOW_SIZE Key used to retrieve the value of the window size in the configuration properties map.

Method Summary

SshAgentFactory	getAgentFactory() Retrieve the agent factory for creating SshAgent objects.
java.util.List<NamedFactory<Channel>>	getChannelFactories() Retrieve the list of named factories for Channel objects.
java.util.List<NamedFactory<Cipher>>	getCipherFactories() Retrieve the list of named factories for Cipher.
java.util.List<NamedFactory<Compression>>	getCompressionFactories() Retrieve the list of named factories for Compression.
java.util.List<NamedFactory<KeyExchange>>	getKeyExchangeFactories() Retrieve the list of named factories for KeyExchange.
KeyPairProvider	getKeyPairProvider() Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.
java.util.List<NamedFactory<Mac>>	getMacFactories() Retrieve the list of named factories for Mac.
java.util.Map<java.lang.String,java.lang.String>	getProperties() A map of properties that can be used to configure the SSH server or client.
Factory<Random>	getRandomFactory() Retrieve the Random factory to be used.
java.util.concurrent.ScheduledExecutorService	getScheduledExecutorService() Retrieve the ScheduledExecutorService to be used.
java.util.List<NamedFactory<Signature>>	getSignatureFactories() Retrieve the list of named factories for Signature.
ForwardingAcceptorFactory	getTcpipForwardingAcceptorFactory() Retrieve the IoAcceptor factory to be used to accept incoming connections to port forwards.
java.lang.String	getVersion() An upper case string identifying the version of the software used on client or server side.

Field Detail

WINDOW_SIZE

static final java.lang.String WINDOW_SIZE

Key used to retrieve the value of the window size in the configuration properties map.

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:

Constant Field Values

NIO_WORKERS

static final java.lang.String NIO_WORKERS

Number of NIO worker threads to use.

See Also:

Constant Field Values

DEFAULT_NIO_WORKERS

static final int DEFAULT_NIO_WORKERS

Default number of worker threads to use.

Method Detail

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.

Returns:

a valid Map containing configuration values, never null

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 of the software and usually looks like: SSHD-1.0

Returns:

the version of the software

getKeyExchangeFactories

java.util.List<NamedFactory<KeyExchange>> getKeyExchangeFactories()

Retrieve the list of named factories for KeyExchange.

Returns:

a list of named KeyExchange factories, never null

getCipherFactories

java.util.List<NamedFactory<Cipher>> getCipherFactories()

Retrieve the list of named factories for Cipher.

Returns:

a list of named Cipher factories, never null

getCompressionFactories

java.util.List<NamedFactory<Compression>> getCompressionFactories()

Retrieve the list of named factories for Compression.

Returns:

a list of named Compression factories, never null

getMacFactories

java.util.List<NamedFactory<Mac>> getMacFactories()

Retrieve the list of named factories for Mac.

Returns:

a list of named Mac factories, never null

getSignatureFactories

java.util.List<NamedFactory<Signature>> getSignatureFactories()

Retrieve the list of named factories for Signature.

Returns:

a list of named Signature factories, never null

getKeyPairProvider

KeyPairProvider getKeyPairProvider()

Retrieve the KeyPairProvider that will be used to find the host key to use on the server side or the user key on the client side.

Returns:

the KeyPairProvider, never null

getRandomFactory

Factory<Random> getRandomFactory()

Retrieve the Random factory to be used.

Returns:

the Random factory, never null

getChannelFactories

java.util.List<NamedFactory<Channel>> getChannelFactories()

Retrieve the list of named factories for Channel objects.

Returns:

a list of named Channel factories, never null

getAgentFactory

SshAgentFactory getAgentFactory()

Retrieve the agent factory for creating SshAgent objects.

Returns:

the factory

getScheduledExecutorService

java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()

Retrieve the ScheduledExecutorService to be used.

Returns:

the ScheduledExecutorService, never null

getTcpipForwardingAcceptorFactory

ForwardingAcceptorFactory getTcpipForwardingAcceptorFactory()

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

Returns:

A ForwardNioAcceptorFactory