org.apache.sshd.client

Interface ClientFactoryManager

All Superinterfaces:

FactoryManager

All Known Implementing Classes:

SshClient

public interface ClientFactoryManager
extends FactoryManager

The ClientFactoryManager enable the retrieval of additional configuration needed specifically for the client side.

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEARTBEAT_INTERVAL Key used to set the heartbeat interval in milliseconds (0 to disable which is the default value)
static java.lang.String	HEARTBEAT_REQUEST Key used to check the hearbeat request that should be sent to the server (default is keepalive@sshd.apache.org).
static java.lang.String	PASSWORD_PROMPTS Specifies the number of password prompts before giving up.
static java.lang.String	PREFERRED_AUTHS Ordered comma separated list of authentications methods.

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
ServerKeyVerifier	getServerKeyVerifier() Retrieve the server key verifier to be used to check the key when connecting to an ssh server.
TcpipForwarderFactory	getTcpipForwarderFactory() Retrieve the TcpipForwarder factory to be used to accept incoming connections and forward data.
java.util.List<NamedFactory<UserAuth>>	getUserAuthFactories() Retrieve a list of UserAuth factories.
UserInteraction	getUserInteraction() Retrieve the UserInteraction object to communicate with the user.

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

getAgentFactory, getChannelFactories, getCipherFactories, getCompressionFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getKeyExchangeFactories, getKeyPairProvider, getMacFactories, getProperties, getRandomFactory, getScheduledExecutorService, getServiceFactories, getSignatureFactories, getTcpipForwardingFilter, getVersion

Field Detail

HEARTBEAT_INTERVAL

static final java.lang.String HEARTBEAT_INTERVAL

Key used to set the heartbeat interval in milliseconds (0 to disable which is the default value)

See Also:

Constant Field Values

HEARTBEAT_REQUEST

static final java.lang.String HEARTBEAT_REQUEST

Key used to check the hearbeat request that should be sent to the server (default is keepalive@sshd.apache.org).

See Also:

Constant Field Values

PREFERRED_AUTHS

static final java.lang.String PREFERRED_AUTHS

Ordered comma separated list of authentications methods. Authentications methods accepted by the server will be tried in the given order.

See Also:

Constant Field Values

PASSWORD_PROMPTS

static final java.lang.String PASSWORD_PROMPTS

Specifies the number of password prompts before giving up. The argument to this keyword must be an integer. The default is 3.

See Also:

Constant Field Values

Method Detail

getServerKeyVerifier

ServerKeyVerifier getServerKeyVerifier()

Retrieve the server key verifier to be used to check the key when connecting to an ssh server.

Returns:

the server key verifier to use

getTcpipForwarderFactory

TcpipForwarderFactory getTcpipForwarderFactory()

Retrieve the TcpipForwarder factory to be used to accept incoming connections and forward data.

Specified by:

getTcpipForwarderFactory in interface FactoryManager

Returns:

A TcpipForwarderFactory

getUserInteraction

UserInteraction getUserInteraction()

Retrieve the UserInteraction object to communicate with the user.

Returns:

A UserInteraction or null

getUserAuthFactories

java.util.List<NamedFactory<UserAuth>> getUserAuthFactories()

Retrieve a list of UserAuth factories.

Returns:

a list of named UserAuth factories, never null