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
org.apache.sshd.scp.client
org.apache.sshd.scp.common.helpers
org.apache.sshd.sftp.client
org.apache.sshd.sftp.client.fs
org.apache.sshd.sftp.client.impl

Uses of ClientSession in org.apache.sshd.client

Subinterfaces with type arguments of type ClientSession in org.apache.sshd.client

Modifier and Type	Interface	Description
interface	ClientAuthenticationManager	Holds information required for the client to perform authentication with the server

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

Subclasses with type arguments of type ClientSession in org.apache.sshd.client.auth

Modifier and Type	Class	Description
class	AbstractUserAuthFactory

Subinterfaces with type arguments of type ClientSession in org.apache.sshd.client.auth

Modifier and Type	Interface	Description
interface	UserAuth	Represents a user authentication mechanism
interface	UserAuthFactory

Fields in org.apache.sshd.client.auth declared as ClientSession

Modifier and Type	Field	Description
private ClientSession	AbstractUserAuth.clientSession

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

Classes in org.apache.sshd.client.auth.pubkey that implement interfaces with type arguments of type ClientSession

Modifier and Type	Class	Description
class	AbstractKeyPairIterator<I extends PublicKeyIdentity>

Fields in org.apache.sshd.client.auth.pubkey declared as ClientSession

Modifier and Type	Field	Description
private final ClientSession	AbstractKeyPairIterator.session

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

Modifier and Type	Method	Description
final ClientSession	AbstractKeyPairIterator.getClientSession()
final 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

Modifier	Constructor	Description
protected	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

Subinterfaces with type arguments of type ClientSession in org.apache.sshd.client.future

Modifier and Type	Interface	Description
interface	ConnectFuture	An SshFuture for asynchronous connections requests.

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 void	KnownHostsServerKeyVerifier.handleRevokedKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey)	Invoked if any matching host entry has a 'revoked' marker
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.
final 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
final 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

Classes in org.apache.sshd.client.session.forward that implement interfaces with type arguments of type ClientSession

Modifier and Type	Class	Description
class	PortForwardingTracker

Fields in org.apache.sshd.client.session.forward declared as ClientSession

Modifier and Type	Field	Description
private final ClientSession	PortForwardingTracker.session

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

Modifier	Constructor	Description
	DynamicPortForwardingTracker(ClientSession session, SshdSocketAddress localAddress, SshdSocketAddress boundAddress)
	ExplicitPortForwardingTracker(ClientSession session, boolean localForwarding, SshdSocketAddress localAddress, SshdSocketAddress remoteAddress, SshdSocketAddress boundAddress)
protected	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

Subinterfaces with type arguments of type ClientSession in org.apache.sshd.client.subsystem

Modifier and Type	Interface	Description
interface	SubsystemClient

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

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

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

Subinterfaces with type arguments of type ClientSession in org.apache.sshd.scp.client

Modifier and Type	Interface	Description
interface	ScpClient

Fields in org.apache.sshd.scp.client declared as ClientSession

Modifier and Type	Field	Description
private final ClientSession	DefaultScpClient.clientSession
private final ClientSession	ScpRemote2RemoteTransferHelper.destSession
private final ClientSession	ScpRemote2RemoteTransferHelper.sourceSession

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

Modifier and Type	Method	Description
ClientSession	DefaultScpClient.getClientSession()
ClientSession	ScpRemote2RemoteTransferHelper.getDestinationSession()
default ClientSession	ScpClient.getSession()
ClientSession	ScpRemote2RemoteTransferHelper.getSourceSession()

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

Modifier and Type	Method	Description
ScpClient	DefaultScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener)
default ScpClient	ScpClientCreator.createScpClient(ClientSession session)	Create an SCP client from this session.
default ScpClient	ScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener)	Create an SCP client from this session.
ScpClient	ScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener)	Create an SCP client from this session.
default ScpClient	ScpClientCreator.createScpClient(ClientSession session, ScpTransferEventListener listener)	Create an SCP client from this session.
protected CloseableScpClient	SimpleScpClientImpl.createScpClient(ClientSession session)
void	ScpRemote2RemoteTransferListener.endDirectDirectoryTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details, Throwable thrown)	Indicates end of direct file transfer
void	ScpRemote2RemoteTransferListener.endDirectFileTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details, long xferSize, Throwable thrown)	Indicates end of direct file transfer
protected ChannelExec	AbstractScpClient.openCommandChannel(ClientSession session, String cmd)
void	ScpRemote2RemoteTransferListener.startDirectDirectoryTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details)	Indicates start of direct directory transfer
void	ScpRemote2RemoteTransferListener.startDirectFileTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details)	Indicates start of direct file transfer

Method parameters in org.apache.sshd.scp.client with type arguments of type ClientSession

Modifier and Type	Method	Description
protected CloseableScpClient	SimpleScpClientImpl.createScpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider)

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

Modifier	Constructor	Description
	DefaultScpClient(ClientSession clientSession)
	DefaultScpClient(ClientSession clientSession, ScpFileOpener fileOpener, ScpTransferEventListener eventListener)
	ScpRemote2RemoteTransferHelper(ClientSession sourceSession, ClientSession destSession)
	ScpRemote2RemoteTransferHelper(ClientSession sourceSession, ClientSession destSession, ScpRemote2RemoteTransferListener listener)

Uses of ClientSession in org.apache.sshd.scp.common.helpers

Methods in org.apache.sshd.scp.common.helpers with parameters of type ClientSession

Modifier and Type	Method	Description
void	CommandStatusHandler.handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus)	Invoked by the various upload/download methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server
static void	ScpIoUtils.handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus, org.slf4j.Logger log)	Invoked by the various upload/download methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server
static void	ScpIoUtils.handleCommandExitStatus(ClientSession session, String cmd, ClientChannel channel, CommandStatusHandler handler, org.slf4j.Logger log)	Invoked by the various upload/download methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server.
static ChannelExec	ScpIoUtils.openCommandChannel(ClientSession session, String cmd, org.slf4j.Logger log)

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

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

Modifier and Type	Method	Description
default SftpClient	SftpClientFactory.createSftpClient(ClientSession session)	Create an SFTP client from this session.
default SftpClient	SftpClientFactory.createSftpClient(ClientSession session, int version)	Creates an SFTP client using the specified version
default SftpClient	SftpClientFactory.createSftpClient(ClientSession session, SftpErrorDataHandler errorDataHandler)	Create an SFTP client from this session.
default SftpClient	SftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector)
SftpClient	SftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, int version)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, int readBufferSize, int writeBufferSize)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, int version, int readBufferSize, int writeBufferSize)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector)
default SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, int readBufferSize, int writeBufferSize)
SftpFileSystem	SftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize)
int	SftpVersionSelector.NamedVersionSelector.selectVersion(ClientSession session, boolean initial, int current, List<Integer> available)
int	SftpVersionSelector.selectVersion(ClientSession session, boolean initial, int current, List<Integer> available)

Uses of ClientSession in org.apache.sshd.sftp.client.fs

Classes in org.apache.sshd.sftp.client.fs that implement interfaces with type arguments of type ClientSession

Modifier and Type	Class	Description
class	SftpFileSystem
private class	SftpFileSystemProvider.SessionProvider	A session provider that automatically creates a new session if the current one is no longer open (or if there isn't one yet).

Fields in org.apache.sshd.sftp.client.fs with type parameters of type ClientSession

Modifier and Type	Field	Description
private AtomicReference<ClientSession>	SftpFileSystem.clientSession
private AtomicReference<ClientSession>	SftpFileSystemProvider.SessionProvider.currentSession
private final IOFunction<Boolean, ClientSession>	SftpFileSystemAutomatic.sessionProvider

Methods in org.apache.sshd.sftp.client.fs that return ClientSession

Modifier and Type	Method	Description
ClientSession	SftpFileSystemProvider.SessionProvider.apply(Boolean create)	Retrieves the current ClientSession and optionally creates a new one if there is no current session yet, or if it is not open.
private ClientSession	SftpFileSystemProvider.SessionProvider.create()
default ClientSession	SftpFileSystemClientSessionInitializer.createClientSession(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to obtain an initial (non-authenticated) ClientSession.
ClientSession	SftpFileSystem.getClientSession()
ClientSession	SftpFileSystem.Wrapper.getClientSession()
ClientSession	SftpFileSystemAutomatic.getClientSession()
ClientSession	SftpFileSystem.getSession()
protected ClientSession	SftpFileSystem.sessionForSftpClient()
protected ClientSession	SftpFileSystemAutomatic.sessionForSftpClient()

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

Modifier and Type	Method	Description
default void	SftpFileSystemClientSessionInitializer.authenticateClientSession(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to authenticate the session obtained from SftpFileSystemClientSessionInitializer.createClientSession(SftpFileSystemProvider, SftpFileSystemInitializationContext)
default SftpFileSystem	SftpFileSystemClientSessionInitializer.createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)	Deprecated. since 2.10.1
static String	SftpFileSystemProvider.getFileSystemIdentifier(ClientSession session)	Uses the remote host address, port and current username to create a unique identifier
SftpFileSystem	SftpFileSystemProvider.newFileSystem(ClientSession session)
protected void	SftpFileSystem.setClientSession(ClientSession newSession)

Method parameters in org.apache.sshd.sftp.client.fs with type arguments of type ClientSession

Modifier and Type	Method	Description
default SftpFileSystem	SftpFileSystemClientSessionInitializer.createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, IOFunction<Boolean, ClientSession> sessionProvider, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)	Invoked by the SftpFileSystemProvider.newFileSystem(java.net.URI, Map) method in order to create the SftpFileSystem once session has been authenticated.

Constructors in org.apache.sshd.sftp.client.fs with parameters of type ClientSession

Modifier	Constructor	Description
	SftpFileSystem(SftpFileSystemProvider provider, String id, ClientSession session, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

Constructor parameters in org.apache.sshd.sftp.client.fs with type arguments of type ClientSession

Modifier	Constructor	Description
	SftpFileSystemAutomatic(SftpFileSystemProvider provider, String id, IOFunction<Boolean, ClientSession> sessionProvider, SftpClientFactory factory, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)

Uses of ClientSession in org.apache.sshd.sftp.client.impl

Fields in org.apache.sshd.sftp.client.impl declared as ClientSession

Modifier and Type	Field	Description
private final ClientSession	DefaultSftpClient.clientSession

Methods in org.apache.sshd.sftp.client.impl that return ClientSession

Modifier and Type	Method	Description
ClientSession	DefaultSftpClient.getClientSession()

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

Modifier and Type	Method	Description
protected DefaultSftpClient	DefaultSftpClientFactory.createDefaultSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
protected ChannelSubsystem	DefaultSftpClient.createSftpChannelSubsystem(ClientSession clientSession)
SftpClient	DefaultSftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
protected SftpClient	SimpleSftpClientImpl.createSftpClient(ClientSession session)
SftpFileSystem	DefaultSftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize)
protected void	DefaultSftpClient.init(ClientSession session, SftpVersionSelector initialVersionSelector, Duration initializationTimeout)

Method parameters in org.apache.sshd.sftp.client.impl with type arguments of type ClientSession

Modifier and Type	Method	Description
protected SftpClient	SimpleSftpClientImpl.createSftpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider)

Constructors in org.apache.sshd.sftp.client.impl with parameters of type ClientSession

Modifier	Constructor	Description
	DefaultSftpClient(ClientSession clientSession, SftpVersionSelector initialVersionSelector, SftpErrorDataHandler errorDataHandler)