org.apache.sshd.client

Interface ClientFactoryManager

All Superinterfaces:

AttributeStore, ChannelListenerManager, ClientAuthenticationManager, ClientProxyConnectorHolder, FactoryManager, KexFactoryManager, KeyPairProviderHolder, PortForwardingEventListenerManager, PropertyResolver, ReservedSessionMessagesManager, ScpFileOpenerHolder, SessionListenerManager, SignatureFactoriesManager

All Known Implementing Classes:

SshClient

public interface ClientFactoryManager
extends FactoryManager, ScpFileOpenerHolder, ClientProxyConnectorHolder, ClientAuthenticationManager

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

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeStore

AttributeStore.AttributeKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_IDENTIFICATION Key used to retrieve the value of the client identification string.
static long	DEFAULT_HEARTBEAT_INTERVAL Default value for "heartbeat-interval" if none configured
static boolean	DEFAULT_IGNORE_INVALID_IDENTITIES Default value of "ignore-invalid-identities" if none configured
static String	DEFAULT_KEEP_ALIVE_HEARTBEAT_STRING Default value for HEARTBEAT_REQUEST is 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	IGNORE_INVALID_IDENTITIES Whether to ignore invalid identities files when pre-initializing the client session

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

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

EMPTY

Fields inherited from interface org.apache.sshd.client.ClientAuthenticationManager

DEFAULT_PASSWORD_PROMPTS, PASSWORD_PROMPTS, PREFERRED_AUTHS

Method Summary

Modifier and Type	Method and Description
ClientIdentityLoader	getClientIdentityLoader()
FilePasswordProvider	getFilePasswordProvider()
HostConfigEntryResolver	getHostConfigEntryResolver()
void	setClientIdentityLoader(ClientIdentityLoader loader)
void	setFilePasswordProvider(FilePasswordProvider provider)
void	setHostConfigEntryResolver(HostConfigEntryResolver resolver)

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

getAgentFactory, getChannelFactories, getFileSystemFactory, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpipForwarderFactory, getTcpipForwardingFilter, getVersion

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

getKeyPairProvider, setKeyPairProvider

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

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.forward.PortForwardingEventListenerManager

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

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

getAttribute, removeAttribute, resolveAttribute, resolveAttribute, resolveAttribute, resolveAttribute, setAttribute

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

getBoolean, getBooleanProperty, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty

Methods inherited from interface org.apache.sshd.common.scp.ScpFileOpenerHolder

getScpFileOpener, setScpFileOpener

Methods inherited from interface org.apache.sshd.client.session.ClientProxyConnectorHolder

getClientProxyConnector, setClientProxyConnector

Methods inherited from interface org.apache.sshd.client.ClientAuthenticationManager

addPasswordIdentity, addPublicKeyIdentity, getPasswordIdentityProvider, getRegisteredIdentities, getServerKeyVerifier, getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, getUserInteraction, removePasswordIdentity, removePublicKeyIdentity, setPasswordIdentityProvider, setServerKeyVerifier, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames, setUserAuthFactoriesNames, setUserInteraction

Field Detail

CLIENT_IDENTIFICATION

static final String CLIENT_IDENTIFICATION

Key used to retrieve the value of the client 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 core artifact name and version in uppercase - e.g., "SSH-2.0-SSHD-CORE-1.0.0"

See Also:

Constant Field Values

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

IGNORE_INVALID_IDENTITIES

static final String IGNORE_INVALID_IDENTITIES

Whether to ignore invalid identities files when pre-initializing the client session

See Also:

ClientIdentityLoader.isValidLocation(String), Constant Field Values

DEFAULT_IGNORE_INVALID_IDENTITIES

static final boolean DEFAULT_IGNORE_INVALID_IDENTITIES

Default value of "ignore-invalid-identities" if none configured

See Also:

Constant Field Values

Method Detail

getHostConfigEntryResolver

HostConfigEntryResolver getHostConfigEntryResolver()

Returns:

The HostConfigEntryResolver to use in order to resolve the effective session parameters - never null

setHostConfigEntryResolver

void setHostConfigEntryResolver(HostConfigEntryResolver resolver)

getClientIdentityLoader

ClientIdentityLoader getClientIdentityLoader()

Returns:

The ClientIdentityLoader to use in order to load client key pair identities - never null

setClientIdentityLoader

void setClientIdentityLoader(ClientIdentityLoader loader)

getFilePasswordProvider

FilePasswordProvider getFilePasswordProvider()

Returns:

The FilePasswordProvider to use if need to load encrypted identities keys - never null

See Also:

FilePasswordProvider.EMPTY

setFilePasswordProvider

void setFilePasswordProvider(FilePasswordProvider provider)