Uses of Interface
org.apache.sshd.client.session.ClientSession
Packages that use ClientSession
Package
Description
-
Uses of ClientSession in org.apache.sshd.client
Methods in org.apache.sshd.client with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected voidSshClient.setupDefaultSessionIdentities(ClientSession session, KeyIdentityProvider extraIdentities) -
Uses of ClientSession in org.apache.sshd.client.auth
Fields in org.apache.sshd.client.auth declared as ClientSessionMethods in org.apache.sshd.client.auth that return ClientSessionModifier and TypeMethodDescriptionAbstractUserAuth.getClientSession()AbstractUserAuth.getSession()Methods in org.apache.sshd.client.auth with parameters of type ClientSessionModifier and TypeMethodDescriptionvoidAbstractUserAuth.init(ClientSession session, String service) voidUserAuth.init(ClientSession session, String service) protected abstract booleanAbstractUserAuth.processAuthDataRequest(ClientSession session, String service, Buffer buffer) protected abstract booleanAbstractUserAuth.sendAuthDataRequest(ClientSession session, String service) default voidUserAuth.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) Signals reception ofSSH_MSG_USERAUTH_FAILUREmessagedefault voidUserAuth.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) Signal reception ofSSH_MSG_USERAUTH_SUCCESSmessage -
Uses of ClientSession in org.apache.sshd.client.auth.hostbased
Methods in org.apache.sshd.client.auth.hostbased with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected byte[]UserAuthHostBased.appendSignature(ClientSession session, String service, String keyType, PublicKey key, byte[] keyBytes, String clientHostname, String clientUsername, Signature verifier, Buffer buffer) UserAuthHostBasedFactory.createUserAuth(ClientSession session) voidUserAuthHostBased.init(ClientSession session, String service) protected booleanUserAuthHostBased.processAuthDataRequest(ClientSession session, String service, Buffer buffer) protected StringUserAuthHostBased.resolveClientHostname(ClientSession session) protected StringUserAuthHostBased.resolveClientUsername(ClientSession session) protected booleanUserAuthHostBased.sendAuthDataRequest(ClientSession session, String service) default voidHostBasedAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String hostname, String username, byte[] signature) Sending the initial request to use host based authenticationdefault voidHostBasedAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service, String hostname, String username) Signals end of host based attempts and optionally switching to other authentication methods.default voidHostBasedAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, String hostname, String username, boolean partial, List<String> serverMethods) default voidHostBasedAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity, String hostname, String username) voidUserAuthHostBased.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) voidUserAuthHostBased.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 ClientSessionModifier and TypeMethodDescriptionUserAuthKeyboardInteractiveFactory.createUserAuth(ClientSession session) protected StringUserAuthKeyboardInteractive.getExchangeLanguageTag(ClientSession session) protected StringUserAuthKeyboardInteractive.getExchangeSubMethods(ClientSession session) UserInteraction.getUpdatedPassword(ClientSession session, String prompt, String lang) Invoked when the server returns anSSH_MSG_USERAUTH_PASSWD_CHANGEREQresponse indicating that the password should be changed - e.g., expired or not strong enough (as per the server's policy).voidUserAuthKeyboardInteractive.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 booleanUserInteraction.isInteractionAllowed(ClientSession session) protected booleanUserAuthKeyboardInteractive.processAuthDataRequest(ClientSession session, String service, Buffer buffer) default StringUserInteraction.resolveAuthPasswordAttempt(ClientSession session) Invoked during password authentication when no more pre-registered passwords are availabledefault KeyPairUserInteraction.resolveAuthPublicKeyIdentityAttempt(ClientSession session) Invoked during public key authentication when no more pre-registered keys are availableprotected booleanUserAuthKeyboardInteractive.sendAuthDataRequest(ClientSession session, String service) default voidUserInteraction.serverVersionInfo(ClientSession session, List<String> lines) Called if the server sent any extra information beyond the standard version lineprotected booleanUserAuthKeyboardInteractive.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 booleanUserAuthKeyboardInteractive.verifyTrialsCount(ClientSession session, String service, int cmd, int nbTrials, int maxAllowed) default voidUserInteraction.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 ClientSessionModifier and TypeMethodDescriptionUserAuthPasswordFactory.createUserAuth(ClientSession session) voidUserAuthPassword.init(ClientSession session, String service) protected booleanUserAuthPassword.processAuthDataRequest(ClientSession session, String service, Buffer buffer) protected StringUserAuthPassword.resolveAttemptedPassword(ClientSession session, String service) protected booleanUserAuthPassword.sendAuthDataRequest(ClientSession session, String service) protected IoWriteFutureUserAuthPassword.sendPassword(Buffer buffer, ClientSession session, String oldPassword, String newPassword) Sends the password via aSSH_MSG_USERAUTH_REQUESTmessage.default voidPasswordAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, String oldPassword, boolean modified, String newPassword) default voidPasswordAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service) Signals end of passwords attempts and optionally switching to other authentication methods.default voidPasswordAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, String password, boolean partial, List<String> serverMethods) default voidPasswordAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, String password) voidUserAuthPassword.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) voidUserAuthPassword.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) -
Uses of ClientSession in org.apache.sshd.client.auth.pubkey
Fields in org.apache.sshd.client.auth.pubkey declared as ClientSessionMethods in org.apache.sshd.client.auth.pubkey that return ClientSessionModifier and TypeMethodDescriptionfinal ClientSessionAbstractKeyPairIterator.getClientSession()final ClientSessionAbstractKeyPairIterator.getSession()Methods in org.apache.sshd.client.auth.pubkey with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected 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) UserAuthPublicKeyFactory.createUserAuth(ClientSession session) protected StringUserAuthPublicKey.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.voidUserAuthPublicKey.init(ClientSession session, String service) protected Iterable<KeyAgentIdentity> UserAuthPublicKeyIterator.initializeAgentIdentities(ClientSession session) protected Iterable<KeyPairIdentity> UserAuthPublicKeyIterator.initializeSessionIdentities(ClientSession session, SignatureFactoriesManager signatureFactories) protected booleanUserAuthPublicKey.processAuthDataRequest(ClientSession session, String service, Buffer buffer) protected PublicKeyIdentityUserAuthPublicKey.resolveAttemptedPublicKeyIdentity(ClientSession session, String service) protected PublicKeyIdentityUserAuthPublicKey.resolveAttemptedPublicKeyIdentity(ClientSession session, String service, PublicKeyAuthenticationReporter reporter) protected booleanUserAuthPublicKey.sendAuthDataRequest(ClientSession session, String service) default voidPublicKeyAuthenticationReporter.signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) Sending the initial request to use public key authenticationdefault voidPublicKeyAuthenticationReporter.signalAuthenticationExhausted(ClientSession session, String service) Signals end of public key attempts and optionally switching to other authentication methods.default voidPublicKeyAuthenticationReporter.signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) default voidPublicKeyAuthenticationReporter.signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) voidUserAuthPublicKey.signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) voidUserAuthPublicKey.signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) default voidPublicKeyAuthenticationReporter.signalIdentitySkipped(ClientSession session, String service, KeyPair identity) AKeyPairis is present, but is not attempted because no signature factory for it could be found.default voidPublicKeyAuthenticationReporter.signalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed) Sending the signed response to the server's challengeConstructors in org.apache.sshd.client.auth.pubkey with parameters of type ClientSessionModifierConstructorDescriptionprotectedAbstractKeyPairIterator(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 -
Uses of ClientSession in org.apache.sshd.client.future
Methods in org.apache.sshd.client.future that return ClientSessionModifier and TypeMethodDescriptiondefault ClientSessionConnectFuture.getClientSession()DefaultConnectFuture.getSession()Methods in org.apache.sshd.client.future with parameters of type ClientSessionModifier and TypeMethodDescriptionvoidConnectFuture.setSession(ClientSession session) Sets the newly connected session and notifies all threads waiting for this future.voidDefaultConnectFuture.setSession(ClientSession session) -
Uses of ClientSession in org.apache.sshd.client.keyverifier
Methods in org.apache.sshd.client.keyverifier with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected booleanKnownHostsServerKeyVerifier.acceptIncompleteHostKeys(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Throwable reason) Called if failed to reload known hosts - by default invokesKnownHostsServerKeyVerifier.acceptUnknownHostKey(ClientSession, SocketAddress, PublicKey)protected booleanKnownHostsServerKeyVerifier.acceptKnownHostEntries(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts) booleanKnownHostsServerKeyVerifier.acceptModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, KnownHostEntry entry, PublicKey expected, PublicKey actual) booleanModifiedServerKeyAcceptor.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 booleanKnownHostsServerKeyVerifier.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 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 hashingKnownHostsServerKeyVerifier.getKnownHostSupplier(ClientSession clientSession, Path file) protected voidStaticServerKeyVerifier.handleAcceptance(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey) protected voidKnownHostsServerKeyVerifier.handleKnownHostsFileUpdateFailure(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Path file, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, Throwable reason) Invoked whenKnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)fails - by default just issues a warning.protected voidKnownHostsServerKeyVerifier.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 voidStaticServerKeyVerifier.handleRejection(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey) protected KnownHostEntryKnownHostsServerKeyVerifier.prepareKnownHostEntry(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey) Invoked byKnownHostsServerKeyVerifier.updateKnownHostsFile(ClientSession, SocketAddress, PublicKey, Path, Collection)in order to generate the host entry to be writtenprotected StringKnownHostsServerKeyVerifier.prepareModifiedServerKeyLine(ClientSession clientSession, SocketAddress remoteAddress, KnownHostEntry entry, String curLine, PublicKey expected, 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 List<KnownHostsServerKeyVerifier.HostEntryPair> DefaultKnownHostsServerKeyVerifier.reloadKnownHosts(ClientSession session, Path file) protected List<KnownHostsServerKeyVerifier.HostEntryPair> KnownHostsServerKeyVerifier.reloadKnownHosts(ClientSession session, Path file) protected PublicKeyKnownHostsServerKeyVerifier.resolveHostKey(ClientSession session, KnownHostEntry entry, PublicKeyEntryResolver resolver) Recover the associated public key from a known host entryprotected 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 KnownHostEntryKnownHostsServerKeyVerifier.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 fileprotected voidKnownHostsServerKeyVerifier.updateModifiedServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey, Collection<KnownHostsServerKeyVerifier.HostEntryPair> knownHosts, KnownHostsServerKeyVerifier.HostEntryPair match) protected voidKnownHostsServerKeyVerifier.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 andKnownHostsServerKeyVerifier.acceptModifiedServerKey(ClientSession, SocketAddress, KnownHostEntry, PublicKey, PublicKey)returnedtrue.booleanDelegatingServerKeyVerifier.verifyServerKey(ClientSession session, SocketAddress remoteAddress, PublicKey serverKey) booleanKnownHostsServerKeyVerifier.verifyServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey) booleanRequiredServerKeyVerifier.verifyServerKey(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey) booleanServerKeyVerifier.verifyServerKey(ClientSession clientSession, SocketAddress remoteAddress, PublicKey serverKey) Verify that the server key provided is really the one of the host.final booleanStaticServerKeyVerifier.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 ClientSessionModifier and TypeClassDescriptionclassProvides default implementations ofClientSessionrelated methodsclassThe default implementation of aClientSessionMethods in org.apache.sshd.client.session that return ClientSessionModifier and TypeMethodDescriptionfinal ClientSessionClientConnectionService.getClientSession()ClientSessionHolder.getClientSession()ClientUserAuthService.getClientSession()ClientUserAuthService.getSession()Methods in org.apache.sshd.client.session with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected AuthFutureClientUserAuthService.createAuthFuture(ClientSession session, String service) ClientSession.passwordIteratorOf(ClientSession session) Creates a "unified"Iteratorof passwords out of the registered passwords and the extra available ones as a single iterator of passwordsstatic KeyIdentityProviderClientSession.providerOf(ClientSession session) Creates a "unified"KeyIdentityProviderof key pairs out of the registeredKeyPairidentities and the extra available ones as a single iterator of key pairsvoidClientProxyConnector.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 IoWriteFutureClientUserAuthService.sendInitialAuthRequest(ClientSession session, String service) protected AuthFutureClientUserAuthService.updateCurrentAuthFuture(ClientSession session, String service) -
Uses of ClientSession in org.apache.sshd.client.session.forward
Fields in org.apache.sshd.client.session.forward declared as ClientSessionMethods in org.apache.sshd.client.session.forward that return ClientSessionModifier and TypeMethodDescriptionPortForwardingTracker.getClientSession()PortForwardingTracker.getSession()Constructors in org.apache.sshd.client.session.forward with parameters of type ClientSessionModifierConstructorDescriptionDynamicPortForwardingTracker(ClientSession session, SshdSocketAddress localAddress, SshdSocketAddress boundAddress) ExplicitPortForwardingTracker(ClientSession session, boolean localForwarding, SshdSocketAddress localAddress, SshdSocketAddress remoteAddress, SshdSocketAddress boundAddress) protectedPortForwardingTracker(ClientSession session, SshdSocketAddress localAddress, SshdSocketAddress boundAddress) -
Uses of ClientSession in org.apache.sshd.client.simple
Methods in org.apache.sshd.client.simple that return ClientSessionModifier and TypeMethodDescriptionprotected ClientSessionAbstractSimpleClientSessionCreator.authSession(ConnectFuture future, String password) protected ClientSessionAbstractSimpleClientSessionCreator.authSession(ConnectFuture future, KeyPair identity) protected ClientSessionAbstractSimpleClientSessionCreator.authSession(ClientSession clientSession) protected ClientSessionAbstractSimpleClientSessionCreator.loginSession(ConnectFuture future, String password) protected ClientSessionAbstractSimpleClientSessionCreator.loginSession(ConnectFuture future, KeyPair identity) AbstractSimpleClientSessionCreator.sessionLogin(String uri, String password) AbstractSimpleClientSessionCreator.sessionLogin(String uri, KeyPair identity) AbstractSimpleClientSessionCreator.sessionLogin(SocketAddress target, String username, String password) AbstractSimpleClientSessionCreator.sessionLogin(SocketAddress target, String username, KeyPair identity) default ClientSessionSimpleSessionClient.sessionLogin(String host, int port, String username, String password) Creates a session and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(String host, int port, String username, KeyPair identity) Creates a session and logs in using the provided credentialsSimpleSessionClient.sessionLogin(String uri, String password) Creates a session and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(String host, String username, String password) Creates a session on the default port and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(String host, String username, KeyPair identity) Creates a session on the default port and logs in using the provided credentialsSimpleSessionClient.sessionLogin(String uri, KeyPair identity) Creates a session and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(InetAddress host, int port, String username, String password) Creates a session and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(InetAddress host, int port, String username, KeyPair identity) Creates a session and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(InetAddress host, String username, String password) Creates a session on the default port and logs in using the provided credentialsdefault ClientSessionSimpleSessionClient.sessionLogin(InetAddress host, String username, KeyPair identity) Creates a session on the default port and logs in using the provided credentialsSimpleSessionClient.sessionLogin(SocketAddress target, String username, String password) Creates a session and logs in using the provided credentialsSimpleSessionClient.sessionLogin(SocketAddress target, String username, KeyPair identity) Creates a session and logs in using the provided credentialsMethods in org.apache.sshd.client.simple with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected ClientSessionAbstractSimpleClientSessionCreator.authSession(ClientSession clientSession) -
Uses of ClientSession in org.apache.sshd.client.subsystem
Methods in org.apache.sshd.client.subsystem that return ClientSession -
Uses of ClientSession in org.apache.sshd.scp.client
Fields in org.apache.sshd.scp.client declared as ClientSessionModifier and TypeFieldDescriptionprivate final ClientSessionDefaultScpClient.clientSessionprivate final ClientSessionScpRemote2RemoteTransferHelper.destSessionprivate final ClientSessionScpRemote2RemoteTransferHelper.sourceSessionMethods in org.apache.sshd.scp.client that return ClientSessionModifier and TypeMethodDescriptionDefaultScpClient.getClientSession()ScpRemote2RemoteTransferHelper.getDestinationSession()default ClientSessionScpClient.getSession()ScpRemote2RemoteTransferHelper.getSourceSession()Methods in org.apache.sshd.scp.client with parameters of type ClientSessionModifier and TypeMethodDescriptionDefaultScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener) default ScpClientScpClientCreator.createScpClient(ClientSession session) Create an SCP client from this session.default ScpClientScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener) Create an SCP client from this session.ScpClientCreator.createScpClient(ClientSession session, ScpFileOpener opener, ScpTransferEventListener listener) Create an SCP client from this session.default ScpClientScpClientCreator.createScpClient(ClientSession session, ScpTransferEventListener listener) Create an SCP client from this session.protected CloseableScpClientSimpleScpClientImpl.createScpClient(ClientSession session) voidScpRemote2RemoteTransferListener.endDirectDirectoryTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details, Throwable thrown) Indicates end of direct file transfervoidScpRemote2RemoteTransferListener.endDirectFileTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details, long xferSize, Throwable thrown) Indicates end of direct file transferprotected ChannelExecAbstractScpClient.openCommandChannel(ClientSession session, String cmd) voidScpRemote2RemoteTransferListener.startDirectDirectoryTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveDirCommandDetails details) Indicates start of direct directory transfervoidScpRemote2RemoteTransferListener.startDirectFileTransfer(ClientSession srcSession, String source, ClientSession dstSession, String destination, ScpTimestampCommandDetails timestamp, ScpReceiveFileCommandDetails details) Indicates start of direct file transferMethod parameters in org.apache.sshd.scp.client with type arguments of type ClientSessionModifier and TypeMethodDescriptionprotected CloseableScpClientSimpleScpClientImpl.createScpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider) Constructors in org.apache.sshd.scp.client with parameters of type ClientSessionModifierConstructorDescriptionDefaultScpClient(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 ClientSessionModifier and TypeMethodDescriptionvoidCommandStatusHandler.handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus) Invoked by the variousupload/downloadmethods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote serverstatic voidScpIoUtils.handleCommandExitStatus(ClientSession session, String cmd, Integer exitStatus, org.slf4j.Logger log) Invoked by the variousupload/downloadmethods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote serverstatic voidScpIoUtils.handleCommandExitStatus(ClientSession session, String cmd, ClientChannel channel, CommandStatusHandler handler, org.slf4j.Logger log) Invoked by the variousupload/downloadmethods after having successfully completed the remote copy command and (optionally) having received an exit status from the remote server.static ChannelExecScpIoUtils.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 ClientSessionModifier and TypeMethodDescriptiondefault SftpClientSftpClientFactory.createSftpClient(ClientSession session) Create an SFTP client from this session.default SftpClientSftpClientFactory.createSftpClient(ClientSession session, int version) Creates an SFTP client using the specified versiondefault SftpClientSftpClientFactory.createSftpClient(ClientSession session, SftpErrorDataHandler errorDataHandler) Create an SFTP client from this session.default SftpClientSftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector) SftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session, int version) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session, int readBufferSize, int writeBufferSize) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session, int version, int readBufferSize, int writeBufferSize) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector) default SftpFileSystemSftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, int readBufferSize, int writeBufferSize) SftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize) intSftpVersionSelector.NamedVersionSelector.selectVersion(ClientSession session, boolean initial, int current, List<Integer> available) intSftpVersionSelector.selectVersion(ClientSession session, boolean initial, int current, List<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 ClientSessionModifier and TypeFieldDescriptionprivate AtomicReference<ClientSession> SftpFileSystem.clientSessionprivate AtomicReference<ClientSession> SftpFileSystemProvider.SessionProvider.currentSessionprivate final IOFunction<Boolean, ClientSession> SftpFileSystemAutomatic.sessionProviderMethods in org.apache.sshd.sftp.client.fs that return ClientSessionModifier and TypeMethodDescriptionRetrieves the currentClientSessionand optionally creates a new one if there is no current session yet, or if it is not open.private ClientSessionSftpFileSystemProvider.SessionProvider.create()default ClientSessionSftpFileSystemClientSessionInitializer.createClientSession(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context) Invoked by theSftpFileSystemProvider.newFileSystem(java.net.URI, Map)method in order to obtain an initial (non-authenticated)ClientSession.SftpFileSystem.getClientSession()SftpFileSystem.Wrapper.getClientSession()SftpFileSystemAutomatic.getClientSession()SftpFileSystem.getSession()protected ClientSessionSftpFileSystem.sessionForSftpClient()protected ClientSessionSftpFileSystemAutomatic.sessionForSftpClient()Methods in org.apache.sshd.sftp.client.fs with parameters of type ClientSessionModifier and TypeMethodDescriptiondefault voidSftpFileSystemClientSessionInitializer.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 SftpFileSystemSftpFileSystemClientSessionInitializer.createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) Deprecated.since 2.10.1static StringSftpFileSystemProvider.getFileSystemIdentifier(ClientSession session) Uses the remote host address, port and current username to create a unique identifierSftpFileSystemProvider.newFileSystem(ClientSession session) protected voidSftpFileSystem.setClientSession(ClientSession newSession) Method parameters in org.apache.sshd.sftp.client.fs with type arguments of type ClientSessionModifier and TypeMethodDescriptiondefault SftpFileSystemSftpFileSystemClientSessionInitializer.createSftpFileSystem(SftpFileSystemProvider provider, SftpFileSystemInitializationContext context, IOFunction<Boolean, ClientSession> sessionProvider, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) Invoked by theSftpFileSystemProvider.newFileSystem(java.net.URI, Map)method in order to create theSftpFileSystemonce session has been authenticated.Constructors in org.apache.sshd.sftp.client.fs with parameters of type ClientSessionModifierConstructorDescriptionSftpFileSystem(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 ClientSessionModifierConstructorDescriptionSftpFileSystemAutomatic(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 ClientSessionMethods in org.apache.sshd.sftp.client.impl that return ClientSessionMethods in org.apache.sshd.sftp.client.impl with parameters of type ClientSessionModifier and TypeMethodDescriptionprotected DefaultSftpClientDefaultSftpClientFactory.createDefaultSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) protected ChannelSubsystemDefaultSftpClient.createSftpChannelSubsystem(ClientSession clientSession) DefaultSftpClientFactory.createSftpClient(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler) protected SftpClientSimpleSftpClientImpl.createSftpClient(ClientSession session) DefaultSftpClientFactory.createSftpFileSystem(ClientSession session, SftpVersionSelector selector, SftpErrorDataHandler errorDataHandler, int readBufferSize, int writeBufferSize) protected voidDefaultSftpClient.init(ClientSession session, SftpVersionSelector initialVersionSelector, Duration initializationTimeout) Method parameters in org.apache.sshd.sftp.client.impl with type arguments of type ClientSessionModifier and TypeMethodDescriptionprotected SftpClientSimpleSftpClientImpl.createSftpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider) Constructors in org.apache.sshd.sftp.client.impl with parameters of type ClientSessionModifierConstructorDescriptionDefaultSftpClient(ClientSession clientSession, SftpVersionSelector initialVersionSelector, SftpErrorDataHandler errorDataHandler)