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 long	DEFAULT_HEARTBEAT_INTERVAL Default value for HEARTBEAT_INTERVAL if none configured
static String	DEFAULT_KEEP_ALIVE_HEARTBEAT_STRING Default value for HEARTBEAT_REQUEST is none configured
static int	DEFAULT_PASSWORD_PROMPTS Default value for PASSWORD_PROMPTS if none configured
static String	HEARTBEAT_INTERVAL Key used to set the heartbeat interval in milliseconds (0 to disable = default)
static String	HEARTBEAT_REQUEST Key used to check the heartbeat request that should be sent to the server
static String	PASSWORD_PROMPTS Specifies the number of password prompts before giving up.
static String	PREFERRED_AUTHS Ordered comma separated list of authentications methods.

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

AUTH_TIMEOUT, CHANNEL_CLOSE_TIMEOUT, DEFAULT_NIO_WORKERS, DEFAULT_VERSION, DISCONNECT_TIMEOUT, IDLE_TIMEOUT, MAX_PACKET_SIZE, NIO_WORKERS, NIO2_READ_BUFFER_SIZE, SOCKET_BACKLOG, SOCKET_KEEPALIVE, SOCKET_LINGER, SOCKET_RCVBUF, SOCKET_REUSEADDR, SOCKET_SNDBUF, TCP_NODELAY, WINDOW_SIZE, WINDOW_TIMEOUT

Method Summary

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.
List<NamedFactory<UserAuth>>	getUserAuthFactories()
UserInteraction	getUserInteraction()

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

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

Field Detail

HEARTBEAT_INTERVAL

static final String HEARTBEAT_INTERVAL

Key used to set the heartbeat interval in milliseconds (0 to disable = default)

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_INTERVAL

static final long DEFAULT_HEARTBEAT_INTERVAL

Default value for HEARTBEAT_INTERVAL if none configured

See Also:

Constant Field Values

HEARTBEAT_REQUEST

static final String HEARTBEAT_REQUEST

Key used to check the heartbeat request that should be sent to the server

See Also:

Constant Field Values

DEFAULT_KEEP_ALIVE_HEARTBEAT_STRING

static final String DEFAULT_KEEP_ALIVE_HEARTBEAT_STRING

Default value for HEARTBEAT_REQUEST is none configured

See Also:

Constant Field Values

PREFERRED_AUTHS

static final String PREFERRED_AUTHS

Ordered comma separated list of authentications methods. Authentications methods accepted by the server will be tried in the given order. If not configured or null/empty, then the session's getUserAuthFactories() is used as-is

See Also:

Constant Field Values

PASSWORD_PROMPTS

static final String PASSWORD_PROMPTS

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

See Also:

Constant Field Values

DEFAULT_PASSWORD_PROMPTS

static final int DEFAULT_PASSWORD_PROMPTS

Default value for PASSWORD_PROMPTS if none configured

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

getUserInteraction

UserInteraction getUserInteraction()

Returns:

A UserInteraction object to communicate with the user (may be null to indicate that no such communication is allowed)

getUserAuthFactories

List<NamedFactory<UserAuth>> getUserAuthFactories()

Returns:

a List of UserAuth NamedFactory-ies - never null/empty