Uses of Interface
org.apache.sshd.client.session.ClientSession

Packages that use ClientSession

Package	Description
org.apache.sshd.client
org.apache.sshd.client.auth
org.apache.sshd.client.auth.hostbased
org.apache.sshd.client.auth.keyboard
org.apache.sshd.client.auth.password
org.apache.sshd.client.auth.pubkey
org.apache.sshd.client.channel
org.apache.sshd.client.future
org.apache.sshd.client.keyverifier
org.apache.sshd.client.session
org.apache.sshd.client.session.forward
org.apache.sshd.client.simple
org.apache.sshd.client.subsystem

Uses of ClientSession in org.apache.sshd.client

Methods in org.apache.sshd.client with parameters of type ClientSession

Modifier and Type	Method	Description
protected void	SshClient.setupDefaultSessionIdentities(ClientSession session, KeyIdentityProvider extraIdentities)

Uses of ClientSession in org.apache.sshd.client.auth

Methods in org.apache.sshd.client.auth that return ClientSession

Modifier and Type	Method	Description
ClientSession	AbstractUserAuth.getClientSession()
ClientSession	AbstractUserAuth.getSession()

Methods in org.apache.sshd.client.auth with parameters of type ClientSession

Modifier and Type	Method	Description
void	AbstractUserAuth.init(ClientSession session, String service)
void	UserAuth.init(ClientSession session, String service)
protected abstract boolean	AbstractUserAuth.processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected abstract boolean	AbstractUserAuth.sendAuthDataRequest(ClientSession session, String service)
default void	UserAuth.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer)	Signals reception of SSH_MSG_USERAUTH_FAILURE message
default void	UserAuth.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer)	Signal reception of SSH_MSG_USERAUTH_SUCCESS message

Uses of ClientSession in org.apache.sshd.client.auth.hostbased

Methods in org.apache.sshd.client.auth.hostbased with parameters of type ClientSession

Modifier and Type	Method	Description
protected byte[]	UserAuthHostBased.appendSignature(ClientSession session, String service, String keyType, PublicKey key, byte[] keyBytes, String clientHostname, String clientUsername, Signature verifier, Buffer buffer)
UserAuthHostBased	UserAuthHostBasedFactory.createUserAuth(ClientSession session)
void	UserAuthHostBased.init(ClientSession session, String service)
protected boolean	UserAuthHostBased.processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected String	UserAuthHostBased.resolveClientHostname(ClientSession session)
protected String	UserAuthHostBased.resolveClientUsername(ClientSession session)
protected boolean	UserAuthHostBased.sendAuthDataRequest(ClientSession session, String service)
default void	HostBasedAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String hostname, String username, byte[] signature)	Sending the initial request to use host based authentication
default void	HostBasedAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service, String hostname, String username)	Signals end of host based attempts and optionally switching to other authentication methods.
default void	HostBasedAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, String hostname, String username, boolean partial, List<String> serverMethods)
default void	HostBasedAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity, String hostname, String username)
void	UserAuthHostBased.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer)
void	UserAuthHostBased.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer)

Uses of ClientSession in org.apache.sshd.client.auth.keyboard

Methods in org.apache.sshd.client.auth.keyboard with parameters of type ClientSession

Modifier and Type	Method	Description
UserAuthKeyboardInteractive	UserAuthKeyboardInteractiveFactory.createUserAuth(ClientSession session)
protected String	UserAuthKeyboardInteractive.getExchangeLanguageTag(ClientSession session)
protected String	UserAuthKeyboardInteractive.getExchangeSubMethods(ClientSession session)
String	UserInteraction.getUpdatedPassword(ClientSession session, String prompt, String lang)	Invoked when the server returns an SSH_MSG_USERAUTH_PASSWD_CHANGEREQ response indicating that the password should be changed - e.g., expired or not strong enough (as per the server's policy).
void	UserAuthKeyboardInteractive.init(ClientSession session, String service)
String[]	UserInteraction.interactive(ClientSession session, String name, String instruction, String lang, String[] prompt, boolean[] echo)	Invoked when "keyboard-interactive" authentication mechanism is used in order to provide responses for the server's challenges (a.k.a.
default boolean	UserInteraction.isInteractionAllowed(ClientSession session)
protected boolean	UserAuthKeyboardInteractive.processAuthDataRequest(ClientSession session, String service, Buffer buffer)
default String	UserInteraction.resolveAuthPasswordAttempt(ClientSession session)	Invoked during password authentication when no more pre-registered passwords are available
default KeyPair	UserInteraction.resolveAuthPublicKeyIdentityAttempt(ClientSession session)	Invoked during public key authentication when no more pre-registered keys are available
protected boolean	UserAuthKeyboardInteractive.sendAuthDataRequest(ClientSession session, String service)
default void	UserInteraction.serverVersionInfo(ClientSession session, List<String> lines)	Called if the server sent any extra information beyond the standard version line
protected boolean	UserAuthKeyboardInteractive.useCurrentPassword(ClientSession session, String password, String name, String instruction, String lang, String[] prompt, boolean[] echo)	Checks if we have a candidate password and exactly one prompt is requested with no echo, and the prompt matches a configurable pattern.
protected boolean	UserAuthKeyboardInteractive.verifyTrialsCount(ClientSession session, String service, int cmd, int nbTrials, int maxAllowed)
default void	UserInteraction.welcome(ClientSession session, String banner, String lang)	Displays the welcome banner to the user.

Uses of ClientSession in org.apache.sshd.client.auth.password

Methods in org.apache.sshd.client.auth.password with parameters of type ClientSession

Modifier and Type	Method	Description
UserAuthPassword	UserAuthPasswordFactory.createUserAuth(ClientSession session)
void	UserAuthPassword.init(ClientSession session, String service)
protected boolean	UserAuthPassword.processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected String	UserAuthPassword.resolveAttemptedPassword(ClientSession session, String service)
protected boolean	UserAuthPassword.sendAuthDataRequest(ClientSession session, String service)
protected IoWriteFuture	UserAuthPassword.sendPassword(Buffer buffer, ClientSession session, String oldPassword, String newPassword)	Sends the password via a SSH_MSG_USERAUTH_REQUEST message.
default void	PasswordAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, String oldPassword, boolean modified, String newPassword)
default void	PasswordAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service)	Signals end of passwords attempts and optionally switching to other authentication methods.
default void	PasswordAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, String password, boolean partial, List<String> serverMethods)
default void	PasswordAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, String password)
void	UserAuthPassword.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer)
void	UserAuthPassword.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer)

Uses of ClientSession in org.apache.sshd.client.auth.pubkey

Methods in org.apache.sshd.client.auth.pubkey that return ClientSession

Modifier and Type	Method	Description
ClientSession	AbstractKeyPairIterator.getClientSession()
ClientSession	AbstractKeyPairIterator.getSession()

Methods in org.apache.sshd.client.auth.pubkey with parameters of type ClientSession

Modifier and Type	Method	Description
protected byte[]	UserAuthPublicKey.appendSignature(ClientSession session, String service, String name, String username, String algo, PublicKey key, PublicKey serverKey, Buffer buffer)
protected Iterator<PublicKeyIdentity>	UserAuthPublicKey.createPublicKeyIterator(ClientSession session, SignatureFactoriesManager manager)
UserAuthPublicKey	UserAuthPublicKeyFactory.createUserAuth(ClientSession session)
protected String	UserAuthPublicKey.getDefaultSignatureAlgorithm(ClientSession session, String service, PublicKeyIdentity identity, KeyPair keyPair, String keyType)	Determines a signature algorithm name to use for the authentication request if none could be determined from the installed signature factories.
void	UserAuthPublicKey.init(ClientSession session, String service)
protected Iterable<KeyAgentIdentity>	UserAuthPublicKeyIterator.initializeAgentIdentities(ClientSession session)
protected Iterable<KeyPairIdentity>	UserAuthPublicKeyIterator.initializeSessionIdentities(ClientSession session, SignatureFactoriesManager signatureFactories)
protected boolean	UserAuthPublicKey.processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected PublicKeyIdentity	UserAuthPublicKey.resolveAttemptedPublicKeyIdentity(ClientSession session, String service)
protected PublicKeyIdentity	UserAuthPublicKey.resolveAttemptedPublicKeyIdentity(ClientSession session, String service, PublicKeyAuthenticationReporter reporter)
protected boolean	UserAuthPublicKey.sendAuthDataRequest(ClientSession session, String service)
default void	PublicKeyAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature)	Sending the initial request to use public key authentication
default void	PublicKeyAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service)	Signals end of public key attempts and optionally switching to other authentication methods.
default void	PublicKeyAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods)
default void	PublicKeyAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity)
void	UserAuthPublicKey.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer)
void	UserAuthPublicKey.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer)
default void	PublicKeyAuthenticationReporter.signalIdentitySkipped(ClientSession session, String service, KeyPair identity)	A KeyPair is is present, but is not attempted because no signature factory for it could be found.
default void	PublicKeyAuthenticationReporter.signalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed)	Sending the signed response to the server's challenge

Constructors in org.apache.sshd.client.auth.pubkey with parameters of type ClientSession

Constructor	Description
AbstractKeyPairIterator(ClientSession session)
SessionKeyPairIterator(ClientSession session, SignatureFactoriesManager signatureFactories, Iterator<KeyPair> keys)
SshAgentPublicKeyIterator(ClientSession session, SshAgent agent)
UserAuthPublicKeyIterator(ClientSession session, SignatureFactoriesManager signatureFactories)

Uses of ClientSession in org.apache.sshd.client.channel

Methods in org.apache.sshd.client.channel that return ClientSession

Modifier and Type	Method	Description
default ClientSession	ClientChannel.getClientSession()

Uses of ClientSession in org.apache.sshd.client.future

Methods in org.apache.sshd.client.future that return ClientSession

Modifier and Type	Method	Description
default ClientSession	ConnectFuture.getClientSession()
ClientSession	DefaultConnectFuture.getSession()

Methods in org.apache.sshd.client.future with parameters of type ClientSession

Modifier and Type	Method	Description
void	ConnectFuture.setSession(ClientSession session)	Sets the newly connected session and notifies all threads waiting for this future.
void	DefaultConnectFuture.setSession(ClientSession session)

Uses of ClientSession in org.apache.sshd.client.keyverifier

Methods in org.apache.sshd.client.keyverifier with parameters of type ClientSession

Modifier and Type	Method	Description
protected boolean	KnownHostsServerKeyVerifier.acceptIncompleteHostKeys(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Throwable reason)	Called if failed to reload known hosts - by default invokes KnownHostsServerKeyVerifier.acceptUnknownHostKey(ClientSession, SocketAddress, PublicKey)
protected boolean	KnownHostsServerKeyVerifier.acceptKnownHostEntries(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
boolean	KnownHostsServerKeyVerifier.acceptModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, KnownHostEntry entry, PublicKey expected, PublicKey actual)
boolean	ModifiedServerKeyAcceptor.acceptModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, KnownHostEntry entry, PublicKey expected, PublicKey actual)	Invoked when a matching known host key was found but it does not match the presented one.
protected boolean	KnownHostsServerKeyVerifier.acceptUnknownHostKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey)	Invoked if none of the known hosts matches the current one - by default invokes the delegate.
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	KnownHostsServerKeyVerifier.findKnownHostEntries(ClientSession clientSession, SocketAddress remoteAddress, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
protected NamedFactory<Mac>	KnownHostsServerKeyVerifier.getHostValueDigester(ClientSession clientSession, SocketAddress remoteAddress, SshdSocketAddress hostIdentity)	Invoked by KnownHostsServerKeyVerifier.prepareKnownHostEntry(ClientSession, SocketAddress, PublicKey) in order to query whether to use a hashed value instead of a plain one for the written host name/address - default returns null - i.e., no hashing
protected Supplier<Collection<KnownHostsServerKeyVerifier.HostEntryPair>>	KnownHostsServerKeyVerifier.getKnownHostSupplier(ClientSession clientSession, Path file)
protected void	StaticServerKeyVerifier.handleAcceptance(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey)
protected void	KnownHostsServerKeyVerifier.handleKnownHostsFileUpdateFailure(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Path file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, Throwable reason)	Invoked when KnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection) fails - by default just issues a warning.
protected void	KnownHostsServerKeyVerifier.handleModifiedServerKeyUpdateFailure(ClientSession clientSession, SocketAddress remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair match, PublicKey serverKey, Path file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, Throwable reason)	Invoked if #updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path) throws an exception.
protected void	StaticServerKeyVerifier.handleRejection(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey)
protected KnownHostEntry	KnownHostsServerKeyVerifier.prepareKnownHostEntry(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey)	Invoked by KnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection) in order to generate the host entry to be written
protected String	KnownHostsServerKeyVerifier.prepareModifiedServerKeyLine(ClientSession clientSession, SocketAddress remoteAddress, KnownHostEntry entry, String curLine, PublicKey expected, PublicKey actual)	Invoked by KnownHostsServerKeyVerifier.updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path, Collection) in order to prepare the replacement - by default it replaces the key part with the new one
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	DefaultKnownHostsServerKeyVerifier.reloadKnownHosts(ClientSession session, Path file)
protected List<KnownHostsServerKeyVerifier.HostEntryPair>	KnownHostsServerKeyVerifier.reloadKnownHosts(ClientSession session, Path file)
protected PublicKey	KnownHostsServerKeyVerifier.resolveHostKey(ClientSession session, KnownHostEntry entry, PublicKeyEntryResolver resolver)	Recover the associated public key from a known host entry
protected Collection<SshdSocketAddress>	KnownHostsServerKeyVerifier.resolveHostNetworkIdentities(ClientSession clientSession, SocketAddress remoteAddress)	Retrieves the host identities to be used when matching or updating an entry for it - by default returns the reported remote address and the original connection target host name/address (if same, then only one value is returned)
protected KnownHostEntry	KnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Path file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)	Invoked if a new previously unknown host key has been accepted - by default appends a new entry at the end of the currently monitored known hosts file
protected void	KnownHostsServerKeyVerifier.updateModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, KnownHostsServerKeyVerifier.HostEntryPair match)
protected void	KnownHostsServerKeyVerifier.updateModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair match, PublicKey actual, Path file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)	Invoked if a matching host entry was found, but the key did not match and KnownHostsServerKeyVerifier.acceptModifiedServerKey(ClientSession, SocketAddress, KnownHostEntry, PublicKey, PublicKey) returned true.
boolean	DelegatingServerKeyVerifier.verifyServerKey(ClientSession session, SocketAddress remoteAddress, PublicKey serverKey)
boolean	KnownHostsServerKeyVerifier.verifyServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey)
boolean	RequiredServerKeyVerifier.verifyServerKey(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey)
boolean	ServerKeyVerifier.verifyServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey)	Verify that the server key provided is really the one of the host.
boolean	StaticServerKeyVerifier.verifyServerKey(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey)

Uses of ClientSession in org.apache.sshd.client.session

Classes in org.apache.sshd.client.session that implement ClientSession

Modifier and Type	Class	Description
class	AbstractClientSession	Provides default implementations of ClientSession related methods
class	ClientSessionImpl	The default implementation of a ClientSession

Methods in org.apache.sshd.client.session that return ClientSession

Modifier and Type	Method	Description
ClientSession	ClientConnectionService.getClientSession()
ClientSession	ClientSessionHolder.getClientSession()
ClientSession	ClientUserAuthService.getClientSession()
ClientSession	ClientUserAuthService.getSession()

Methods in org.apache.sshd.client.session with parameters of type ClientSession

Modifier and Type	Method	Description
protected AuthFuture	ClientUserAuthService.createAuthFuture(ClientSession session, String service)
static Iterator<String>	ClientSession.passwordIteratorOf(ClientSession session)	Creates a "unified" Iterator of passwords out of the registered passwords and the extra available ones as a single iterator of passwords
static KeyIdentityProvider	ClientSession.providerOf(ClientSession session)	Creates a "unified" KeyIdentityProvider of key pairs out of the registered KeyPair identities and the extra available ones as a single iterator of key pairs
void	ClientProxyConnector.sendClientProxyMetadata(ClientSession session)	Invoked once initial connection has been established so that the proxy can open its channel and send the meta-data to its peer.
protected IoWriteFuture	ClientUserAuthService.sendInitialAuthRequest(ClientSession session, String service)
protected AuthFuture	ClientUserAuthService.updateCurrentAuthFuture(ClientSession session, String service)

Uses of ClientSession in org.apache.sshd.client.session.forward

Methods in org.apache.sshd.client.session.forward that return ClientSession

Modifier and Type	Method	Description
ClientSession	PortForwardingTracker.getClientSession()
ClientSession	PortForwardingTracker.getSession()

Constructors in org.apache.sshd.client.session.forward with parameters of type ClientSession

Constructor	Description
DynamicPortForwardingTracker(ClientSession session, SshdSocketAddress localAddress, SshdSocketAddress boundAddress)
ExplicitPortForwardingTracker(ClientSession session, boolean localForwarding, SshdSocketAddress localAddress, SshdSocketAddress remoteAddress, SshdSocketAddress boundAddress)
PortForwardingTracker(ClientSession session, SshdSocketAddress localAddress, SshdSocketAddress boundAddress)

Uses of ClientSession in org.apache.sshd.client.simple

Methods in org.apache.sshd.client.simple that return ClientSession

Modifier and Type	Method	Description
protected ClientSession	AbstractSimpleClientSessionCreator.authSession(ConnectFuture future, String password)
protected ClientSession	AbstractSimpleClientSessionCreator.authSession(ConnectFuture future, KeyPair identity)
protected ClientSession	AbstractSimpleClientSessionCreator.authSession(ClientSession clientSession)
protected ClientSession	AbstractSimpleClientSessionCreator.loginSession(ConnectFuture future, String password)
protected ClientSession	AbstractSimpleClientSessionCreator.loginSession(ConnectFuture future, KeyPair identity)
ClientSession	AbstractSimpleClientSessionCreator.sessionLogin(String uri, String password)
ClientSession	AbstractSimpleClientSessionCreator.sessionLogin(String uri, KeyPair identity)
ClientSession	AbstractSimpleClientSessionCreator.sessionLogin(SocketAddress target, String username, String password)
ClientSession	AbstractSimpleClientSessionCreator.sessionLogin(SocketAddress target, String username, KeyPair identity)
default ClientSession	SimpleSessionClient.sessionLogin(String host, int port, String username, String password)	Creates a session and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(String host, int port, String username, KeyPair identity)	Creates a session and logs in using the provided credentials
ClientSession	SimpleSessionClient.sessionLogin(String uri, String password)	Creates a session and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(String host, String username, String password)	Creates a session on the default port and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(String host, String username, KeyPair identity)	Creates a session on the default port and logs in using the provided credentials
ClientSession	SimpleSessionClient.sessionLogin(String uri, KeyPair identity)	Creates a session and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(InetAddress host, int port, String username, String password)	Creates a session and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(InetAddress host, int port, String username, KeyPair identity)	Creates a session and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(InetAddress host, String username, String password)	Creates a session on the default port and logs in using the provided credentials
default ClientSession	SimpleSessionClient.sessionLogin(InetAddress host, String username, KeyPair identity)	Creates a session on the default port and logs in using the provided credentials
ClientSession	SimpleSessionClient.sessionLogin(SocketAddress target, String username, String password)	Creates a session and logs in using the provided credentials
ClientSession	SimpleSessionClient.sessionLogin(SocketAddress target, String username, KeyPair identity)	Creates a session and logs in using the provided credentials

Methods in org.apache.sshd.client.simple with parameters of type ClientSession

Modifier and Type	Method	Description
protected ClientSession	AbstractSimpleClientSessionCreator.authSession(ClientSession clientSession)

Uses of ClientSession in org.apache.sshd.client.subsystem

Methods in org.apache.sshd.client.subsystem that return ClientSession

Modifier and Type	Method	Description
default ClientSession	SubsystemClient.getSession()