Uses of Interface
org.apache.sshd.client.session.ClientSession
-
-
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
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, java.lang.String service)
void
UserAuth. init(ClientSession session, java.lang.String service)
protected abstract boolean
AbstractUserAuth. processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected abstract boolean
AbstractUserAuth. sendAuthDataRequest(ClientSession session, java.lang.String service)
default void
UserAuth. signalAuthMethodFailure(ClientSession session, java.lang.String service, boolean partial, java.util.List<java.lang.String> serverMethods, Buffer buffer)
Signals reception ofSSH_MSG_USERAUTH_FAILURE
messagedefault void
UserAuth. signalAuthMethodSuccess(ClientSession session, java.lang.String service, Buffer buffer)
Signal reception ofSSH_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, java.lang.String service, java.lang.String keyType, java.security.PublicKey key, byte[] keyBytes, java.lang.String clientHostname, java.lang.String clientUsername, Signature verifier, Buffer buffer)
UserAuthHostBased
UserAuthHostBasedFactory. createUserAuth(ClientSession session)
void
UserAuthHostBased. init(ClientSession session, java.lang.String service)
protected boolean
UserAuthHostBased. processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected java.lang.String
UserAuthHostBased. resolveClientHostname(ClientSession session)
protected java.lang.String
UserAuthHostBased. resolveClientUsername(ClientSession session)
protected boolean
UserAuthHostBased. sendAuthDataRequest(ClientSession session, java.lang.String service)
default void
HostBasedAuthenticationReporter. signalAuthenticationAttempt(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username, byte[] signature)
Sending the initial request to use host based authenticationdefault void
HostBasedAuthenticationReporter. signalAuthenticationExhausted(ClientSession session, java.lang.String service, java.lang.String hostname, java.lang.String username)
Signals end of host based attempts and optionally switching to other authentication methods.default void
HostBasedAuthenticationReporter. signalAuthenticationFailure(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username, boolean partial, java.util.List<java.lang.String> serverMethods)
default void
HostBasedAuthenticationReporter. signalAuthenticationSuccess(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String hostname, java.lang.String username)
void
UserAuthHostBased. signalAuthMethodFailure(ClientSession session, java.lang.String service, boolean partial, java.util.List<java.lang.String> serverMethods, Buffer buffer)
void
UserAuthHostBased. signalAuthMethodSuccess(ClientSession session, java.lang.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 java.lang.String
UserAuthKeyboardInteractive. getExchangeLanguageTag(ClientSession session)
protected java.lang.String
UserAuthKeyboardInteractive. getExchangeSubMethods(ClientSession session)
java.lang.String
UserInteraction. getUpdatedPassword(ClientSession session, java.lang.String prompt, java.lang.String lang)
Invoked when the server returns anSSH_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, java.lang.String service)
java.lang.String[]
UserInteraction. interactive(ClientSession session, java.lang.String name, java.lang.String instruction, java.lang.String lang, java.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, java.lang.String service, Buffer buffer)
default java.lang.String
UserInteraction. resolveAuthPasswordAttempt(ClientSession session)
Invoked during password authentication when no more pre-registered passwords are availabledefault java.security.KeyPair
UserInteraction. resolveAuthPublicKeyIdentityAttempt(ClientSession session)
Invoked during public key authentication when no more pre-registered keys are availableprotected boolean
UserAuthKeyboardInteractive. sendAuthDataRequest(ClientSession session, java.lang.String service)
default void
UserInteraction. serverVersionInfo(ClientSession session, java.util.List<java.lang.String> lines)
Called if the server sent any extra information beyond the standard version lineprotected boolean
UserAuthKeyboardInteractive. useCurrentPassword(ClientSession session, java.lang.String password, java.lang.String name, java.lang.String instruction, java.lang.String lang, java.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, java.lang.String service, int cmd, int nbTrials, int maxAllowed)
default void
UserInteraction. welcome(ClientSession session, java.lang.String banner, java.lang.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, java.lang.String service)
protected boolean
UserAuthPassword. processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected java.lang.String
UserAuthPassword. resolveAttemptedPassword(ClientSession session, java.lang.String service)
protected boolean
UserAuthPassword. sendAuthDataRequest(ClientSession session, java.lang.String service)
protected IoWriteFuture
UserAuthPassword. sendPassword(Buffer buffer, ClientSession session, java.lang.String oldPassword, java.lang.String newPassword)
Sends the password via aSSH_MSG_USERAUTH_REQUEST
message.default void
PasswordAuthenticationReporter. signalAuthenticationAttempt(ClientSession session, java.lang.String service, java.lang.String oldPassword, boolean modified, java.lang.String newPassword)
default void
PasswordAuthenticationReporter. signalAuthenticationExhausted(ClientSession session, java.lang.String service)
Signals end of passwords attempts and optionally switching to other authentication methods.default void
PasswordAuthenticationReporter. signalAuthenticationFailure(ClientSession session, java.lang.String service, java.lang.String password, boolean partial, java.util.List<java.lang.String> serverMethods)
default void
PasswordAuthenticationReporter. signalAuthenticationSuccess(ClientSession session, java.lang.String service, java.lang.String password)
void
UserAuthPassword. signalAuthMethodFailure(ClientSession session, java.lang.String service, boolean partial, java.util.List<java.lang.String> serverMethods, Buffer buffer)
void
UserAuthPassword. signalAuthMethodSuccess(ClientSession session, java.lang.String service, Buffer buffer)
-
Uses of ClientSession in org.apache.sshd.client.auth.pubkey
Fields in org.apache.sshd.client.auth.pubkey declared as ClientSession Modifier and Type Field Description private ClientSession
AbstractKeyPairIterator. session
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, java.lang.String service, java.lang.String name, java.lang.String username, java.lang.String algo, java.security.PublicKey key, java.security.PublicKey serverKey, Buffer buffer)
protected java.util.Iterator<PublicKeyIdentity>
UserAuthPublicKey. createPublicKeyIterator(ClientSession session, SignatureFactoriesManager manager)
UserAuthPublicKey
UserAuthPublicKeyFactory. createUserAuth(ClientSession session)
protected java.lang.String
UserAuthPublicKey. getDefaultSignatureAlgorithm(ClientSession session, java.lang.String service, PublicKeyIdentity identity, java.security.KeyPair keyPair, java.lang.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, java.lang.String service)
protected java.lang.Iterable<KeyAgentIdentity>
UserAuthPublicKeyIterator. initializeAgentIdentities(ClientSession session)
protected java.lang.Iterable<KeyPairIdentity>
UserAuthPublicKeyIterator. initializeSessionIdentities(ClientSession session, SignatureFactoriesManager signatureFactories)
protected boolean
UserAuthPublicKey. processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected PublicKeyIdentity
UserAuthPublicKey. resolveAttemptedPublicKeyIdentity(ClientSession session, java.lang.String service)
protected PublicKeyIdentity
UserAuthPublicKey. resolveAttemptedPublicKeyIdentity(ClientSession session, java.lang.String service, PublicKeyAuthenticationReporter reporter)
protected boolean
UserAuthPublicKey. sendAuthDataRequest(ClientSession session, java.lang.String service)
default void
PublicKeyAuthenticationReporter. signalAuthenticationAttempt(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String signature)
Sending the initial request to use public key authenticationdefault void
PublicKeyAuthenticationReporter. signalAuthenticationExhausted(ClientSession session, java.lang.String service)
Signals end of public key attempts and optionally switching to other authentication methods.default void
PublicKeyAuthenticationReporter. signalAuthenticationFailure(ClientSession session, java.lang.String service, java.security.KeyPair identity, boolean partial, java.util.List<java.lang.String> serverMethods)
default void
PublicKeyAuthenticationReporter. signalAuthenticationSuccess(ClientSession session, java.lang.String service, java.security.KeyPair identity)
void
UserAuthPublicKey. signalAuthMethodFailure(ClientSession session, java.lang.String service, boolean partial, java.util.List<java.lang.String> serverMethods, Buffer buffer)
void
UserAuthPublicKey. signalAuthMethodSuccess(ClientSession session, java.lang.String service, Buffer buffer)
default void
PublicKeyAuthenticationReporter. signalIdentitySkipped(ClientSession session, java.lang.String service, java.security.KeyPair identity)
AKeyPair
is is present, but is not attempted because no signature factory for it could be found.default void
PublicKeyAuthenticationReporter. signalSignatureAttempt(ClientSession session, java.lang.String service, java.security.KeyPair identity, java.lang.String signature, byte[] signed)
Sending the signed response to the server's challengeConstructors in org.apache.sshd.client.auth.pubkey with parameters of type ClientSession Constructor Description AbstractKeyPairIterator(ClientSession session)
SessionKeyPairIterator(ClientSession session, SignatureFactoriesManager signatureFactories, java.util.Iterator<java.security.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, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey, java.lang.Throwable reason)
Called if failed to reload known hosts - by default invokesKnownHostsServerKeyVerifier.acceptUnknownHostKey(ClientSession, SocketAddress, PublicKey)
protected boolean
KnownHostsServerKeyVerifier. acceptKnownHostEntries(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
boolean
KnownHostsServerKeyVerifier. acceptModifiedServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, KnownHostEntry entry, java.security.PublicKey expected, java.security.PublicKey actual)
boolean
ModifiedServerKeyAcceptor. acceptModifiedServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, KnownHostEntry entry, java.security.PublicKey expected, java.security.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, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
Invoked if none of the known hosts matches the current one - by default invokes the delegate.protected java.util.List<KnownHostsServerKeyVerifier.HostEntryPair>
KnownHostsServerKeyVerifier. findKnownHostEntries(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
protected NamedFactory<Mac>
KnownHostsServerKeyVerifier. getHostValueDigester(ClientSession clientSession, java.net.SocketAddress remoteAddress, SshdSocketAddress hostIdentity)
Invoked byKnownHostsServerKeyVerifier.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 returnsnull
- i.e., no hashingprotected java.util.function.Supplier<java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair>>
KnownHostsServerKeyVerifier. getKnownHostSupplier(ClientSession clientSession, java.nio.file.Path file)
protected void
StaticServerKeyVerifier. handleAcceptance(ClientSession sshClientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
protected void
KnownHostsServerKeyVerifier. handleKnownHostsFileUpdateFailure(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey, java.nio.file.Path file, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, java.lang.Throwable reason)
Invoked whenKnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)
fails - by default just issues a warning.protected void
KnownHostsServerKeyVerifier. handleModifiedServerKeyUpdateFailure(ClientSession clientSession, java.net.SocketAddress remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair match, java.security.PublicKey serverKey, java.nio.file.Path file, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, java.lang.Throwable reason)
Invoked if#updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path)
throws an exception.protected void
StaticServerKeyVerifier. handleRejection(ClientSession sshClientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
protected KnownHostEntry
KnownHostsServerKeyVerifier. prepareKnownHostEntry(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
Invoked byKnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)
in order to generate the host entry to be writtenprotected java.lang.String
KnownHostsServerKeyVerifier. prepareModifiedServerKeyLine(ClientSession clientSession, java.net.SocketAddress remoteAddress, KnownHostEntry entry, java.lang.String curLine, java.security.PublicKey expected, java.security.PublicKey actual)
Invoked byKnownHostsServerKeyVerifier.updateModifiedServerKey(ClientSession, SocketAddress, HostEntryPair, PublicKey, Path, Collection)
in order to prepare the replacement - by default it replaces the key part with the new oneprotected java.util.List<KnownHostsServerKeyVerifier.HostEntryPair>
DefaultKnownHostsServerKeyVerifier. reloadKnownHosts(ClientSession session, java.nio.file.Path file)
protected java.util.List<KnownHostsServerKeyVerifier.HostEntryPair>
KnownHostsServerKeyVerifier. reloadKnownHosts(ClientSession session, java.nio.file.Path file)
protected java.security.PublicKey
KnownHostsServerKeyVerifier. resolveHostKey(ClientSession session, KnownHostEntry entry, PublicKeyEntryResolver resolver)
Recover the associated public key from a known host entryprotected java.util.Collection<SshdSocketAddress>
KnownHostsServerKeyVerifier. resolveHostNetworkIdentities(ClientSession clientSession, java.net.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, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey, java.nio.file.Path file, java.util.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 fileprotected void
KnownHostsServerKeyVerifier. updateModifiedServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, KnownHostsServerKeyVerifier.HostEntryPair match)
protected void
KnownHostsServerKeyVerifier. updateModifiedServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, KnownHostsServerKeyVerifier.HostEntryPair match, java.security.PublicKey actual, java.nio.file.Path file, java.util.Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts)
Invoked if a matching host entry was found, but the key did not match andKnownHostsServerKeyVerifier.acceptModifiedServerKey(ClientSession, SocketAddress, KnownHostEntry, PublicKey, PublicKey)
returnedtrue
.boolean
DelegatingServerKeyVerifier. verifyServerKey(ClientSession session, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
boolean
KnownHostsServerKeyVerifier. verifyServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
boolean
RequiredServerKeyVerifier. verifyServerKey(ClientSession sshClientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
boolean
ServerKeyVerifier. verifyServerKey(ClientSession clientSession, java.net.SocketAddress remoteAddress, java.security.PublicKey serverKey)
Verify that the server key provided is really the one of the host.boolean
StaticServerKeyVerifier. verifyServerKey(ClientSession sshClientSession, java.net.SocketAddress remoteAddress, java.security.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 ofClientSession
related methodsclass
ClientSessionImpl
The default implementation of aClientSession
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, java.lang.String service)
static java.util.Iterator<java.lang.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 passwordsstatic KeyIdentityProvider
ClientSession. providerOf(ClientSession session)
Creates a "unified"KeyIdentityProvider
of key pairs out of the registeredKeyPair
identities and the extra available ones as a single iterator of key pairsvoid
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, java.lang.String service)
protected AuthFuture
ClientUserAuthService. updateCurrentAuthFuture(ClientSession session, java.lang.String service)
-
Uses of ClientSession in org.apache.sshd.client.session.forward
Fields in org.apache.sshd.client.session.forward declared as ClientSession Modifier and Type Field Description private 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 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, java.lang.String password)
protected ClientSession
AbstractSimpleClientSessionCreator. authSession(ConnectFuture future, java.security.KeyPair identity)
protected ClientSession
AbstractSimpleClientSessionCreator. authSession(ClientSession clientSession)
protected ClientSession
AbstractSimpleClientSessionCreator. loginSession(ConnectFuture future, java.lang.String password)
protected ClientSession
AbstractSimpleClientSessionCreator. loginSession(ConnectFuture future, java.security.KeyPair identity)
ClientSession
AbstractSimpleClientSessionCreator. sessionLogin(java.lang.String uri, java.lang.String password)
ClientSession
AbstractSimpleClientSessionCreator. sessionLogin(java.lang.String uri, java.security.KeyPair identity)
ClientSession
AbstractSimpleClientSessionCreator. sessionLogin(java.net.SocketAddress target, java.lang.String username, java.lang.String password)
ClientSession
AbstractSimpleClientSessionCreator. sessionLogin(java.net.SocketAddress target, java.lang.String username, java.security.KeyPair identity)
default ClientSession
SimpleSessionClient. sessionLogin(java.lang.String host, int port, java.lang.String username, java.lang.String password)
Creates a session and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.lang.String host, int port, java.lang.String username, java.security.KeyPair identity)
Creates a session and logs in using the provided credentialsClientSession
SimpleSessionClient. sessionLogin(java.lang.String uri, java.lang.String password)
Creates a session and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.lang.String host, java.lang.String username, java.lang.String password)
Creates a session on the default port and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.lang.String host, java.lang.String username, java.security.KeyPair identity)
Creates a session on the default port and logs in using the provided credentialsClientSession
SimpleSessionClient. sessionLogin(java.lang.String uri, java.security.KeyPair identity)
Creates a session and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.net.InetAddress host, int port, java.lang.String username, java.lang.String password)
Creates a session and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.net.InetAddress host, int port, java.lang.String username, java.security.KeyPair identity)
Creates a session and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.net.InetAddress host, java.lang.String username, java.lang.String password)
Creates a session on the default port and logs in using the provided credentialsdefault ClientSession
SimpleSessionClient. sessionLogin(java.net.InetAddress host, java.lang.String username, java.security.KeyPair identity)
Creates a session on the default port and logs in using the provided credentialsClientSession
SimpleSessionClient. sessionLogin(java.net.SocketAddress target, java.lang.String username, java.lang.String password)
Creates a session and logs in using the provided credentialsClientSession
SimpleSessionClient. sessionLogin(java.net.SocketAddress target, java.lang.String username, java.security.KeyPair identity)
Creates a session and logs in using the provided credentialsMethods 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()
-
Uses of ClientSession in org.apache.sshd.scp.client
Fields in org.apache.sshd.scp.client declared as ClientSession Modifier and Type Field Description private ClientSession
DefaultScpClient. clientSession
private ClientSession
ScpRemote2RemoteTransferHelper. destSession
private 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, java.lang.String source, ClientSession dstSession, java.lang.String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details, java.lang.Throwable thrown)
Indicates end of direct file transfervoid
ScpRemote2RemoteTransferListener. endDirectFileTransfer(ClientSession srcSession, java.lang.String source, ClientSession dstSession, java.lang.String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details, long xferSize, java.lang.Throwable thrown)
Indicates end of direct file transferprotected ChannelExec
AbstractScpClient. openCommandChannel(ClientSession session, java.lang.String cmd)
void
ScpRemote2RemoteTransferListener. startDirectDirectoryTransfer(ClientSession srcSession, java.lang.String source, ClientSession dstSession, java.lang.String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details)
Indicates start of direct directory transfervoid
ScpRemote2RemoteTransferListener. startDirectFileTransfer(ClientSession srcSession, java.lang.String source, ClientSession dstSession, java.lang.String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details)
Indicates start of direct file transferMethod 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 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, java.lang.String cmd, java.lang.Integer exitStatus)
Invoked by the variousupload/download
methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote serverstatic void
ScpIoUtils. handleCommandExitStatus(ClientSession session, java.lang.String cmd, java.lang.Integer exitStatus, org.slf4j.Logger log)
Invoked by the variousupload/download
methods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote serverstatic void
ScpIoUtils. handleCommandExitStatus(ClientSession session, java.lang.String cmd, ClientChannel channel, CommandStatusHandler handler, org.slf4j.Logger log)
Invoked by the variousupload/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, java.lang.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 versiondefault 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, java.util.List<java.lang.Integer> available)
int
SftpVersionSelector. selectVersion(ClientSession session, boolean initial, int current, java.util.List<java.lang.Integer> available)
-
Uses of ClientSession in org.apache.sshd.sftp.client.fs
Fields in org.apache.sshd.sftp.client.fs with type parameters of type ClientSession Modifier and Type Field Description private java.util.concurrent.atomic.AtomicReference<ClientSession>
SftpFileSystem. clientSession
private java.util.concurrent.atomic.AtomicReference<ClientSession>
SftpFileSystemProvider.SessionProvider. currentSession
private IOFunction<java.lang.Boolean,ClientSession>
SftpFileSystemAutomatic. sessionProvider
Methods in org.apache.sshd.sftp.client.fs that return ClientSession Modifier and Type Method Description ClientSession
SftpFileSystemProvider.SessionProvider. apply(java.lang.Boolean create)
Retrieves the currentClientSession
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 theSftpFileSystemProvider.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 theSftpFileSystemProvider.newFileSystem(java.net.URI, Map)
method in order to authenticate the session obtained fromSftpFileSystemClientSessionInitializer.createClientSession(SftpFileSystemProvider, SftpFileSystemInitializationContext)
default SftpFileSystem
SftpFileSystemClientSessionInitializer. createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
Deprecated.since 2.10.1static java.lang.String
SftpFileSystemProvider. getFileSystemIdentifier(ClientSession session)
Uses the remote host address, port and current username to create a unique identifierSftpFileSystem
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<java.lang.Boolean,ClientSession> sessionProvider, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler)
Invoked by theSftpFileSystemProvider.newFileSystem(java.net.URI, Map)
method in order to create theSftpFileSystem
once session has been authenticated.Constructors in org.apache.sshd.sftp.client.fs with parameters of type ClientSession Constructor Description SftpFileSystem(SftpFileSystemProvider provider, java.lang.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 Constructor Description SftpFileSystemAutomatic(SftpFileSystemProvider provider, java.lang.String id, IOFunction<java.lang.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 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, java.time.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 Constructor Description DefaultSftpClient(ClientSession clientSession, SftpVersionSelector initialVersionSelector, SftpErrorDataHandler errorDataHandler)
-