org.apache.sshd.client

Interface ClientFactoryManager

All Superinterfaces:

AttributeRepository, AttributeStore, ChannelListenerManager, ChannelStreamPacketWriterResolver, ChannelStreamPacketWriterResolverManager, ClientAuthenticationManager, ClientIdentityLoaderHolder, ClientIdentityLoaderManager, ClientProxyConnectorHolder, FactoryManager, FilePasswordProviderHolder, FilePasswordProviderManager, IoServiceEventListenerManager, KexExtensionHandlerManager, KexFactoryManager, KeyIdentityProviderHolder, PortForwardingEventListenerManager, PropertyResolver, ReservedSessionMessagesManager, SessionDisconnectHandlerManager, SessionHeartbeatController, SessionListenerManager, SignatureFactoriesManager, UnknownChannelReferenceHandlerManager, UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>

All Known Implementing Classes:

SshClient

public interface ClientFactoryManager
extends FactoryManager, ClientProxyConnectorHolder, FilePasswordProviderManager, ClientIdentityLoaderManager, 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.AttributeRepository

AttributeRepository.AttributeKey<T>

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

SessionHeartbeatController.HeartbeatType

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 long	DEFAULT_HEARTBEAT_REPLY_WAIT Default value for "heartbeat-reply-wait" if none is 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 boolean	DEFAULT_SEND_IMMEDIATE_IDENTIFICATION Value of "send-immediate-identification" if none configured
static boolean	DEFAULT_SEND_KEXINIT
static String	HEARTBEAT_INTERVAL Key used to set the heartbeat interval in milliseconds (0 to disable = default)
static String	HEARTBEAT_REPLY_WAIT Key used to indicate that the heartbeat request is also expecting a reply - time in milliseconds to wait for the reply.
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
static String	SEND_IMMEDIATE_IDENTIFICATION Whether to send the identification string immediately upon session connection being established or wait for the server's identification before sending our own.
static String	SEND_IMMEDIATE_KEXINIT Whether to send SSH_MSG_KEXINIT immediately after sending the client identification string or wait until the severer's one has been received.

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

AGENT_FORWARDING_TYPE, AGENT_FORWARDING_TYPE_IETF, AGENT_FORWARDING_TYPE_OPENSSH, 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.channel.throttle.ChannelStreamPacketWriterResolver

NONE

Fields inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

DEFAULT_CONNECTION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_INTERVAL, SESSION_HEARTBEAT_TYPE

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
HostConfigEntryResolver	getHostConfigEntryResolver()
void	setHostConfigEntryResolver(HostConfigEntryResolver resolver)

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

getAgentFactory, getAgentForwardingFilter, getChannelFactories, getFileSystemFactory, getForwarderFactory, getForwardingFilter, getGlobalRequestHandlers, getIoServiceFactory, getRandomFactory, getScheduledExecutorService, getServiceFactories, getTcpForwardingFilter, getVersion, getX11ForwardingFilter, resolveAttribute, resolveAttribute

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.signature.SignatureFactoriesManager

getSignatureFactories, getSignatureFactories, getSignatureFactoriesNameList, getSignatureFactoriesNames, resolveSignatureFactories, setSignatureFactories, setSignatureFactoriesNameList, setSignatureFactoriesNames, setSignatureFactoriesNames

Methods inherited from interface org.apache.sshd.common.kex.extension.KexExtensionHandlerManager

getKexExtensionHandler, setKexExtensionHandler

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.session.SessionDisconnectHandlerManager

getSessionDisconnectHandler, setSessionDisconnectHandler

Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager

addChannelListener, getChannelListenerProxy, removeChannelListener

Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager

getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver

Methods inherited from interface org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager

getUnknownChannelReferenceHandler, resolveUnknownChannelReferenceHandler, setUnknownChannelReferenceHandler

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

addPortForwardingEventListener, getPortForwardingEventListenerProxy, removePortForwardingEventListener

Methods inherited from interface org.apache.sshd.common.io.IoServiceEventListenerManager

getIoServiceEventListener, setIoServiceEventListener

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

clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute

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

attributeKeys, getAttribute, getAttributesCount, ofAttributesMap, ofKeyValuePair

Methods inherited from interface org.apache.sshd.common.session.SessionHeartbeatController

disableSessionHeartbeat, getSessionHeartbeatInterval, getSessionHeartbeatType, setSessionHeartbeat

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

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

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

getClientProxyConnector, setClientProxyConnector

Methods inherited from interface org.apache.sshd.common.config.keys.FilePasswordProviderManager

setFilePasswordProvider

Methods inherited from interface org.apache.sshd.common.config.keys.FilePasswordProviderHolder

getFilePasswordProvider, providerHolderOf

Methods inherited from interface org.apache.sshd.client.config.keys.ClientIdentityLoaderManager

setClientIdentityLoader

Methods inherited from interface org.apache.sshd.client.config.keys.ClientIdentityLoaderHolder

getClientIdentityLoader, loaderHolderOf

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

addPasswordIdentity, addPublicKeyIdentity, getPasswordIdentityProvider, getRegisteredIdentities, getServerKeyVerifier, getUserInteraction, removePasswordIdentity, removePublicKeyIdentity, setPasswordIdentityProvider, setServerKeyVerifier, setUserAuthFactoriesNames, setUserInteraction

Methods inherited from interface org.apache.sshd.common.auth.UserAuthFactoriesManager

getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames

Methods inherited from interface org.apache.sshd.common.keyprovider.KeyIdentityProviderHolder

getKeyIdentityProvider, setKeyIdentityProvider

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 artifact name and version in uppercase - e.g., "SSH-2.0-APACHE-SSHD-1.0.0"

See Also:

Constant Field Values

SEND_IMMEDIATE_IDENTIFICATION

static final String SEND_IMMEDIATE_IDENTIFICATION

Whether to send the identification string immediately upon session connection being established or wait for the server's identification before sending our own.

See Also:

RFC 4253 - section 4.2 - Protocol Version Exchange, Constant Field Values

DEFAULT_SEND_IMMEDIATE_IDENTIFICATION

static final boolean DEFAULT_SEND_IMMEDIATE_IDENTIFICATION

Value of "send-immediate-identification" if none configured

See Also:

Constant Field Values

SEND_IMMEDIATE_KEXINIT

static final String SEND_IMMEDIATE_KEXINIT

Whether to send SSH_MSG_KEXINIT immediately after sending the client identification string or wait until the severer's one has been received.

See Also:

SEND_IMMEDIATE_IDENTIFICATION, Constant Field Values

DEFAULT_SEND_KEXINIT

static final boolean DEFAULT_SEND_KEXINIT

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

HEARTBEAT_REPLY_WAIT

static final String HEARTBEAT_REPLY_WAIT

Key used to indicate that the heartbeat request is also expecting a reply - time in milliseconds to wait for the reply. If non-positive then no reply is expected (nor requested).

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_REPLY_WAIT

static final long DEFAULT_HEARTBEAT_REPLY_WAIT

Default value for "heartbeat-reply-wait" if none is 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(org.apache.sshd.common.NamedResource), 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)