Uses of Interface
org.apache.sshd.common.session.Session
-
-
Uses of Session in org.apache.sshd.agent.common
Methods in org.apache.sshd.agent.common with parameters of type Session Modifier and Type Method Description protected SshAgentServer
DefaultAgentForwardSupport. createSshAgentServer(ConnectionService service, Session session)
-
Uses of Session in org.apache.sshd.agent.local
Methods in org.apache.sshd.agent.local with parameters of type Session Modifier and Type Method Description Channel
ChannelAgentForwardingFactory. createChannel(Session session)
-
Uses of Session in org.apache.sshd.client.global
Methods in org.apache.sshd.client.global with parameters of type Session Modifier and Type Method Description protected RequestHandler.Result
OpenSshHostKeysHandler. handleHostKeys(Session session, Collection<? extends PublicKey> keys, boolean wantReply, Buffer buffer)
-
Uses of Session in org.apache.sshd.client.kex
Constructors in org.apache.sshd.client.kex with parameters of type Session Constructor Description AbstractDHClientKeyExchange(Session session)
DHGClient(DHFactory factory, Session session)
DHGEXClient(DHFactory factory, Session session)
-
Uses of Session in org.apache.sshd.client.scp
Methods in org.apache.sshd.client.scp with parameters of type Session Modifier and Type Method Description InputStream
DefaultScpStreamResolver. resolveSourceStream(Session session, long length, Set<PosixFilePermission> permissions, OpenOption... options)
-
Uses of Session in org.apache.sshd.client.session
Subinterfaces of Session in org.apache.sshd.client.session Modifier and Type Interface Description interface
ClientSession
An authenticated session to a given SSH server.Classes in org.apache.sshd.client.session that implement Session 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 with parameters of type Session Modifier and Type Method Description Service
ClientConnectionServiceFactory. create(Session session)
Service
ClientUserAuthServiceFactory. create(Session session)
Constructors in org.apache.sshd.client.session with parameters of type Session Constructor Description ClientUserAuthService(Session s)
-
Uses of Session in org.apache.sshd.common
Methods in org.apache.sshd.common with parameters of type Session Modifier and Type Method Description static Service
ServiceFactory. create(Collection<? extends ServiceFactory> factories, String name, Session session)
Create an instance of the specified name by looking up the needed factory in the list (case insensitive.Service
ServiceFactory. create(Session session)
-
Uses of Session in org.apache.sshd.common.channel
Methods in org.apache.sshd.common.channel that return Session Modifier and Type Method Description Session
AbstractChannel. getSession()
Methods in org.apache.sshd.common.channel with parameters of type Session Modifier and Type Method Description Channel
ChannelFactory. createChannel(Session session)
static Channel
ChannelFactory. createChannel(Session session, Collection<? extends ChannelFactory> factories, String name)
void
AbstractChannel. init(ConnectionService service, Session session, int id)
void
Channel. init(ConnectionService service, Session session, int id)
Invoked when the local channel is initial created -
Uses of Session in org.apache.sshd.common.file
Methods in org.apache.sshd.common.file with parameters of type Session Modifier and Type Method Description FileSystem
FileSystemFactory. createFileSystem(Session session)
Create user specific file system. -
Uses of Session in org.apache.sshd.common.file.nativefs
Methods in org.apache.sshd.common.file.nativefs with parameters of type Session Modifier and Type Method Description FileSystem
NativeFileSystemFactory. createFileSystem(Session session)
-
Uses of Session in org.apache.sshd.common.file.virtualfs
Methods in org.apache.sshd.common.file.virtualfs with parameters of type Session Modifier and Type Method Description protected Path
VirtualFileSystemFactory. computeRootDir(Session session)
FileSystem
VirtualFileSystemFactory. createFileSystem(Session session)
-
Uses of Session in org.apache.sshd.common.forward
Methods in org.apache.sshd.common.forward that return Session Modifier and Type Method Description Session
DefaultForwardingFilter. getSession()
Methods in org.apache.sshd.common.forward with parameters of type Session Modifier and Type Method Description default void
PortForwardingEventListener. establishedDynamicTunnel(Session session, SshdSocketAddress local, SshdSocketAddress boundAddress, Throwable reason)
Signals a successful/failed attempt to establish a dynamic port forwardingdefault void
PortForwardingEventListener. establishedExplicitTunnel(Session session, SshdSocketAddress local, SshdSocketAddress remote, boolean localForwarding, SshdSocketAddress boundAddress, Throwable reason)
Signals a successful/failed attempt to establish a local/remote port forwardingdefault void
PortForwardingEventListener. establishingDynamicTunnel(Session session, SshdSocketAddress local)
Signals the attempt to establish a dynamic port forwardingdefault void
PortForwardingEventListener. establishingExplicitTunnel(Session session, SshdSocketAddress local, SshdSocketAddress remote, boolean localForwarding)
Signals the attempt to establish a local/remote port forwardingdefault void
PortForwardingEventListener. tearingDownDynamicTunnel(Session session, SshdSocketAddress address)
Signals a request to tear down a dynamic forwardingdefault void
PortForwardingEventListener. tearingDownExplicitTunnel(Session session, SshdSocketAddress address, boolean localForwarding, SshdSocketAddress remoteAddress)
Signals a request to tear down a local/remote port forwardingdefault void
PortForwardingEventListener. tornDownDynamicTunnel(Session session, SshdSocketAddress address, Throwable reason)
Signals a successful/failed request to tear down a dynamic port forwardingdefault void
PortForwardingEventListener. tornDownExplicitTunnel(Session session, SshdSocketAddress address, boolean localForwarding, SshdSocketAddress remoteAddress, Throwable reason)
Signals a successful/failed request to tear down a local/remote port forwarding -
Uses of Session in org.apache.sshd.common.global
Methods in org.apache.sshd.common.global with parameters of type Session Modifier and Type Method Description protected abstract RequestHandler.Result
AbstractOpenSshHostKeysHandler. handleHostKeys(Session session, Collection<? extends PublicKey> keys, boolean wantReply, Buffer buffer)
-
Uses of Session in org.apache.sshd.common.kex
Methods in org.apache.sshd.common.kex with parameters of type Session Modifier and Type Method Description KeyExchange
KeyExchangeFactory. createKeyExchange(Session session)
-
Uses of Session in org.apache.sshd.common.kex.dh
Methods in org.apache.sshd.common.kex.dh that return Session Modifier and Type Method Description Session
AbstractDHKeyExchange. getSession()
Constructors in org.apache.sshd.common.kex.dh with parameters of type Session Constructor Description AbstractDHKeyExchange(Session session)
-
Uses of Session in org.apache.sshd.common.kex.extension
Methods in org.apache.sshd.common.kex.extension with parameters of type Session Modifier and Type Method Description default boolean
KexExtensionHandler. handleKexCompressionMessage(Session session, Buffer buffer)
Parses theSSH_MSG_NEWCOMPRESS
message.default void
KexExtensionHandler. handleKexExtensionNegotiation(Session session, KexProposalOption option, String nValue, Map<KexProposalOption,String> c2sOptions, String cValue, Map<KexProposalOption,String> s2cOptions, String sValue)
Invoked during the KEX negotiation phase to inform about option being negotiated.boolean
DefaultClientKexExtensionHandler. handleKexExtensionRequest(Session session, int index, int count, String name, byte[] data)
default boolean
KexExtensionHandler. handleKexExtensionRequest(Session session, int index, int count, String name, byte[] data)
Invoked byKexExtensionHandler.handleKexExtensionsMessage(Session, Buffer)
in order to handle a specific extension.default boolean
KexExtensionHandler. handleKexExtensionsMessage(Session session, Buffer buffer)
Parses theSSH_MSG_EXT_INFO
message.void
DefaultClientKexExtensionHandler. handleKexInitProposal(Session session, boolean initiator, Map<KexProposalOption,String> proposal)
default void
KexExtensionHandler. handleKexInitProposal(Session session, boolean initiator, Map<KexProposalOption,String> proposal)
Invoked when a peer is ready to send the KEX options proposal or has received such a proposal.boolean
DefaultClientKexExtensionHandler. isKexExtensionsAvailable(Session session, KexExtensionHandler.AvailabilityPhase phase)
default boolean
KexExtensionHandler. isKexExtensionsAvailable(Session session, KexExtensionHandler.AvailabilityPhase phase)
int
DefaultClientKexExtensionHandler. resolvePreferredSignaturePosition(Session session, List<? extends NamedFactory<Signature>> factories, NamedFactory<Signature> factory)
List<NamedFactory<Signature>>
DefaultClientKexExtensionHandler. resolveRequestedSignatureFactories(Session session, Collection<String> extraAlgos)
NamedFactory<Signature>
DefaultClientKexExtensionHandler. resolveRequestedSignatureFactory(Session session, String name)
List<NamedFactory<Signature>>
DefaultClientKexExtensionHandler. resolveUpdatedSignatureFactories(Session session, List<NamedFactory<Signature>> available, Collection<String> extraAlgos)
Checks if the extra signature algorithms are already included in the available ones, and adds the extra ones (if supported).default void
KexExtensionHandler. sendKexExtensions(Session session, KexExtensionHandler.KexPhase phase)
Invoked in order to allow the handler to send anSSH_MSG_EXT_INFO
message.List<NamedFactory<Signature>>
DefaultClientKexExtensionHandler. updateAvailableSignatureFactories(Session session, Collection<String> extraAlgos)
List<NamedFactory<Signature>>
DefaultClientKexExtensionHandler. updateAvailableSignatureFactories(Session session, List<NamedFactory<Signature>> available, Collection<? extends NamedFactory<Signature>> toAdd)
-
Uses of Session in org.apache.sshd.common.scp
Methods in org.apache.sshd.common.scp that return Session Modifier and Type Method Description Session
ScpHelper. getSession()
Methods in org.apache.sshd.common.scp with parameters of type Session Modifier and Type Method Description default void
ScpFileOpener. closeRead(Session session, Path file, long size, Set<PosixFilePermission> permissions, InputStream stream)
Called when the stream obtained fromopenRead
is no longer required since data has been successfully copied.default void
ScpSourceStreamResolver. closeSourceStream(Session session, long fileSize, Set<PosixFilePermission> permissions, InputStream stream)
Called when the stream obtained fromresolveSourceStream
is no longer needed since since file copy was completed successfully.default void
ScpTargetStreamResolver. closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream)
Called when target stream received fromresolveTargetStream
call is no longer needed since copy is successfully completed.default void
ScpFileOpener. closeWrite(Session session, Path file, long size, Set<PosixFilePermission> permissions, OutputStream os)
Called when output stream obtained fromopenWrite
is no longer needed since data copying has been successfully completed.ScpSourceStreamResolver
ScpFileOpener. createScpSourceStreamResolver(Session session, Path path)
ScpTargetStreamResolver
ScpFileOpener. createScpTargetStreamResolver(Session session, Path path)
void
AbstractScpTransferEventListenerAdapter. endFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, Throwable thrown)
default void
ScpTransferEventListener. endFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms, Throwable thrown)
void
AbstractScpTransferEventListenerAdapter. endFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms, Throwable thrown)
default void
ScpTransferEventListener. endFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms, Throwable thrown)
default BasicFileAttributes
ScpFileOpener. getLocalBasicFileAttributes(Session session, Path path, LinkOption... options)
default Set<PosixFilePermission>
ScpFileOpener. getLocalFilePermissions(Session session, Path path, LinkOption... options)
default DirectoryStream<Path>
ScpFileOpener. getLocalFolderChildren(Session session, Path path)
Invoked when required to send all children of a local directorydefault Iterable<Path>
ScpFileOpener. getMatchingFilesToSend(Session session, Path basedir, String pattern)
Invoked when required to send a pattern of filesInputStream
ScpFileOpener. openRead(Session session, Path file, long size, Set<PosixFilePermission> permissions, OpenOption... options)
Create an input stream to read from a fileOutputStream
ScpFileOpener. openWrite(Session session, Path file, long size, Set<PosixFilePermission> permissions, OpenOption... options)
Create an output stream to write to a filevoid
ScpReceiveLineHandler. process(Session session, String line, boolean isDir, ScpTimestamp time)
default Path
ScpFileOpener. resolveIncomingFilePath(Session session, Path localPath, String name, boolean preserve, Set<PosixFilePermission> permissions, ScpTimestamp time)
Invoked when receiving a new file to via a directory commanddefault Path
ScpFileOpener. resolveIncomingReceiveLocation(Session session, Path path, boolean recursive, boolean shouldBeDir, boolean preserve)
Invoked when a request to receive something is processeddefault Path
ScpFileOpener. resolveLocalPath(Session session, FileSystem fileSystem, String commandPath)
default Path
ScpFileOpener. resolveOutgoingFilePath(Session session, Path localPath, LinkOption... options)
Called when there is a candidate file/folder for sendingInputStream
ScpSourceStreamResolver. resolveSourceStream(Session session, long fileSize, Set<PosixFilePermission> permissions, OpenOption... options)
OutputStream
ScpTargetStreamResolver. resolveTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OpenOption... options)
Called when receiving a file in order to obtain an output stream for the incoming datadefault boolean
ScpFileOpener. sendAsDirectory(Session session, Path path, LinkOption... options)
Invoked on a local path in order to decide whether it should be sent as a file or as a directorydefault boolean
ScpFileOpener. sendAsRegularFile(Session session, Path path, LinkOption... options)
Invoked on a local path in order to decide whether it should be sent as a file or as a directoryvoid
AbstractScpTransferEventListenerAdapter. startFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms)
default void
ScpTransferEventListener. startFileEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, long length, Set<PosixFilePermission> perms)
void
AbstractScpTransferEventListenerAdapter. startFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms)
default void
ScpTransferEventListener. startFolderEvent(Session session, ScpTransferEventListener.FileOperation op, Path file, Set<PosixFilePermission> perms)
Constructors in org.apache.sshd.common.scp with parameters of type Session Constructor Description ScpHelper(Session session, InputStream in, OutputStream out, FileSystem fileSystem, ScpFileOpener opener, ScpTransferEventListener eventListener)
-
Uses of Session in org.apache.sshd.common.scp.helpers
Methods in org.apache.sshd.common.scp.helpers with parameters of type Session Modifier and Type Method Description void
LocalFileScpSourceStreamResolver. closeSourceStream(Session session, long length, Set<PosixFilePermission> permissions, InputStream stream)
void
LocalFileScpTargetStreamResolver. closeTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OutputStream stream)
ScpSourceStreamResolver
DefaultScpFileOpener. createScpSourceStreamResolver(Session session, Path path)
ScpTargetStreamResolver
DefaultScpFileOpener. createScpTargetStreamResolver(Session session, Path path)
InputStream
DefaultScpFileOpener. openRead(Session session, Path file, long size, Set<PosixFilePermission> permissions, OpenOption... options)
OutputStream
DefaultScpFileOpener. openWrite(Session session, Path file, long size, Set<PosixFilePermission> permissions, OpenOption... options)
protected OpenOption[]
DefaultScpFileOpener. resolveOpenOptions(Session session, Path file, long size, Set<PosixFilePermission> permissions, OpenOption... options)
InputStream
LocalFileScpSourceStreamResolver. resolveSourceStream(Session session, long length, Set<PosixFilePermission> permissions, OpenOption... options)
OutputStream
LocalFileScpTargetStreamResolver. resolveTargetStream(Session session, String name, long length, Set<PosixFilePermission> perms, OpenOption... options)
-
Uses of Session in org.apache.sshd.common.session
Classes in org.apache.sshd.common.session with type parameters of type Session Modifier and Type Interface Description interface
SessionHolder<S extends Session>
Methods in org.apache.sshd.common.session that return Session Modifier and Type Method Description Session
SessionWorkBuffer. getSession()
Methods in org.apache.sshd.common.session with parameters of type Session Modifier and Type Method Description default boolean
SessionDisconnectHandler. handleAuthCountDisconnectReason(Session session, Service service, String serviceName, String method, String user, int currentAuthCount, int maxAuthCount)
Invoked if the number of authentication attempts exceeded the maximum alloweddefault boolean
SessionDisconnectHandler. handleAuthParamsDisconnectReason(Session session, Service service, String authUser, String username, String authService, String serviceName)
Invoked if the authentication parameters changed in mid-authentication process.default void
ReservedSessionMessagesHandler. handleDebugMessage(Session session, Buffer buffer)
Invoked when anSSH_MSG_DEBUG
packet is receiveddefault void
ReservedSessionMessagesHandler. handleIgnoreMessage(Session session, Buffer buffer)
Invoked when anSSH_MSG_IGNORE
packet is receiveddefault boolean
SessionDisconnectHandler. handleKexDisconnectReason(Session session, Map<KexProposalOption,String> c2sOptions, Map<KexProposalOption,String> s2cOptions, Map<KexProposalOption,String> negotiatedGuess, KexProposalOption option)
Invoked if after KEX negotiation parameters resolved one of the options violates some internal constraint (e.g., cannot negotiate a value, or RFC 8308 - section 2.2).default boolean
SessionDisconnectHandler. handleSessionsCountDisconnectReason(Session session, Service service, String username, int currentSessionCount, int maxSessionCount)
Called to inform that the maximum allowed concurrent sessions threshold has been exceeded.default boolean
SessionDisconnectHandler. handleTimeoutDisconnectReason(Session session, TimeoutIndicator timeoutStatus)
Invoked when an internal timeout has expired (e.g., authentication, idle).default boolean
ReservedSessionMessagesHandler. handleUnimplementedMessage(Session session, int cmd, Buffer buffer)
Invoked when a packet with an un-implemented message is received - includingSSH_MSG_UNIMPLEMENTED
itselfdefault boolean
SessionDisconnectHandler. handleUnsupportedServiceDisconnectReason(Session session, int cmd, String serviceName, Buffer buffer)
Invoked when a request has been made related to an unknown SSH service as described in RFC 4253 - section 10.static <T> T
Session. resolveAttribute(Session session, AttributeRepository.AttributeKey<T> key)
Attempts to use the session's attribute, if not found then tries the factory managerdefault void
SessionListener. sessionClosed(Session session)
A session has been closeddefault void
SessionListener. sessionCreated(Session session)
A new session just been createddefault void
SessionListener. sessionDisconnect(Session session, int reason, String msg, String language, boolean initiator)
Invoked whenSSH_MSG_DISCONNECT
message was sent/receiveddefault void
SessionListener. sessionEstablished(Session session)
An initial session connection has been established - Caveat emptor: the main difference between this callback andSessionListener.sessionCreated(Session)
is that when this callback is called, the session is not yet fully initialized so not all API(s) will respond as expected.default void
SessionListener. sessionEvent(Session session, SessionListener.Event event)
An event has been triggereddefault void
SessionListener. sessionException(Session session, Throwable t)
An exception was caught and the session will be closed (if not already so).default void
SessionListener. sessionNegotiationEnd(Session session, Map<KexProposalOption,String> clientProposal, Map<KexProposalOption,String> serverProposal, Map<KexProposalOption,String> negotiatedOptions, Throwable reason)
Signals the end of the negotiation options handlingdefault void
SessionListener. sessionNegotiationStart(Session session, Map<KexProposalOption,String> clientProposal, Map<KexProposalOption,String> serverProposal)
Signals the start of the negotiation options handlingdefault void
SessionListener. sessionPeerIdentificationReceived(Session session, String version, List<String> extraLines)
The peer's identification version was receivedConstructors in org.apache.sshd.common.session with parameters of type Session Constructor Description SessionWorkBuffer(Session session)
-
Uses of Session in org.apache.sshd.common.session.helpers
Classes in org.apache.sshd.common.session.helpers that implement Session Modifier and Type Class Description class
AbstractSession
The AbstractSession handles all the basic SSH protocol such as key exchange, authentication, encoding and decoding.class
SessionHelper
Contains split code in order to makeAbstractSession
class smallerMethods in org.apache.sshd.common.session.helpers with parameters of type Session Modifier and Type Method Description protected AgentForwardSupport
AbstractConnectionService. createAgentForwardSupport(Session session)
protected ForwardingFilter
AbstractConnectionService. createForwardingFilter(Session session)
protected X11ForwardSupport
AbstractConnectionService. createX11ForwardSupport(Session session)
void
ReservedSessionMessagesHandlerAdapter. handleDebugMessage(Session session, boolean display, String msg, String lang, Buffer buffer)
void
ReservedSessionMessagesHandlerAdapter. handleDebugMessage(Session session, Buffer buffer)
void
ReservedSessionMessagesHandlerAdapter. handleIgnoreMessage(Session session, byte[] data, Buffer buffer)
void
ReservedSessionMessagesHandlerAdapter. handleIgnoreMessage(Session session, Buffer buffer)
boolean
ReservedSessionMessagesHandlerAdapter. handleUnimplementedMessage(Session session, int cmd, Buffer buffer)
void
SessionTimeoutListener. sessionClosed(Session s)
void
SessionTimeoutListener. sessionCreated(Session session)
void
SessionTimeoutListener. sessionException(Session session, Throwable t)
-
Uses of Session in org.apache.sshd.server.channel
Methods in org.apache.sshd.server.channel with parameters of type Session Modifier and Type Method Description Channel
ChannelSessionFactory. createChannel(Session session)
static boolean
PuttyRequestHandler. isPuttyClient(Session session)
-
Uses of Session in org.apache.sshd.server.forward
Methods in org.apache.sshd.server.forward with parameters of type Session Modifier and Type Method Description boolean
StaticDecisionForwardingFilter. canConnect(TcpForwardingFilter.Type type, SshdSocketAddress address, Session session)
boolean
TcpForwardingFilter. canConnect(TcpForwardingFilter.Type type, SshdSocketAddress address, Session session)
Determine if the session may create an outbound connection.boolean
AgentForwardingFilter. canForwardAgent(Session session, String requestType)
Determine if the session may arrange for agent forwarding.boolean
StaticDecisionForwardingFilter. canForwardAgent(Session session, String requestType)
boolean
StaticDecisionForwardingFilter. canForwardX11(Session session, String requestType)
boolean
X11ForwardingFilter. canForwardX11(Session session, String requestType)
Determine if the session may arrange for X11 forwarding.boolean
StaticDecisionForwardingFilter. canListen(SshdSocketAddress address, Session session)
boolean
TcpForwardingFilter. canListen(SshdSocketAddress address, Session session)
Determine if the session may listen for inbound connections.protected boolean
StaticDecisionForwardingFilter. checkAcceptance(String request, Session session, SshdSocketAddress target)
Channel
TcpipServerChannel.TcpipFactory. createChannel(Session session)
-
Uses of Session in org.apache.sshd.server.global
Methods in org.apache.sshd.server.global with parameters of type Session Modifier and Type Method Description protected RequestHandler.Result
OpenSshHostKeysHandler. handleHostKeys(Session session, Collection<? extends PublicKey> keys, boolean wantReply, Buffer buffer)
-
Uses of Session in org.apache.sshd.server.kex
Constructors in org.apache.sshd.server.kex with parameters of type Session Constructor Description AbstractDHServerKeyExchange(Session s)
DHGEXServer(DHFactory factory, Session session)
DHGServer(DHFactory factory, Session session)
-
Uses of Session in org.apache.sshd.server.session
Subinterfaces of Session in org.apache.sshd.server.session Modifier and Type Interface Description interface
ServerSession
Classes in org.apache.sshd.server.session that implement Session Modifier and Type Class Description class
AbstractServerSession
Provides default implementations forServerSession
related methodsclass
ServerSessionImpl
The default implementation for aServerSession
Methods in org.apache.sshd.server.session with parameters of type Session Modifier and Type Method Description Service
ServerConnectionServiceFactory. create(Session session)
Service
ServerUserAuthServiceFactory. create(Session session)
Constructors in org.apache.sshd.server.session with parameters of type Session Constructor Description ServerUserAuthService(Session s)
-