Package org.apache.sshd.common.session
Interface SessionListener
- All Superinterfaces:
EventListener,SshdEventListener
- All Known Implementing Classes:
SessionTimeoutListener
Represents an interface receiving session events.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptiondefault voidsessionClosed(Session session) A session has been closeddefault voidsessionCreated(Session session) A new session just been createddefault voidsessionDisconnect(Session session, int reason, String msg, String language, boolean initiator) Invoked whenSSH_MSG_DISCONNECTmessage was sent/receiveddefault voidsessionEstablished(Session session) An initial session connection has been established - Caveat emptor: the main difference between this callback andsessionCreated(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 voidsessionEvent(Session session, SessionListener.Event event) An event has been triggereddefault voidsessionException(Session session, Throwable t) An exception was caught and the session will be closed (if not already so).default voidsessionNegotiationEnd(Session session, Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal, Map<KexProposalOption, String> negotiatedOptions, Throwable reason) Signals the end of the negotiation options handlingdefault voidsessionNegotiationOptionsCreated(Session session, Map<KexProposalOption, String> proposal) default voidsessionNegotiationStart(Session session, Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal) Signals the start of the negotiation options handlingdefault voidsessionPeerIdentificationLine(Session session, String line, List<String> extraLines) Successfully read a line as part of the initial peer identificationdefault voidsessionPeerIdentificationReceived(Session session, String version, List<String> extraLines) The peer's identification version was receiveddefault voidsessionPeerIdentificationSend(Session session, String version, List<String> extraLines) About to send identification to peerstatic <L extends SessionListener>
LvalidateListener(L listener)
-
Method Details
-
sessionEstablished
An initial session connection has been established - Caveat emptor: the main difference between this callback andsessionCreated(Session)is that when this callback is called, the session is not yet fully initialized so not all API(s) will respond as expected. The main purpose of this callback is to allow the user to customize some session properties based on the peer's address and/or any provided connection context.- Parameters:
session- The establishedSession
-
sessionCreated
A new session just been created- Parameters:
session- The createdSession
-
sessionPeerIdentificationSend
default void sessionPeerIdentificationSend(Session session, String version, List<String> extraLines) About to send identification to peer- Parameters:
session- TheSessioninstanceversion- The resolved identification versionextraLines- Extra data preceding the identification to be sent. Note: the list is modifiable only if this is a server session. The user may modify it based on the peer.- See Also:
-
sessionPeerIdentificationLine
Successfully read a line as part of the initial peer identification- Parameters:
session- TheSessioninstanceline- The data that was read so far - Note: might not be a full line if more packets are required for full identification data. Furthermore, it may be repeated data due to packets segmentation and re-assembly mechanismextraLines- Previous lines that were before this one - Note: it may be repeated data due to packets segmentation and re-assembly mechanism- See Also:
-
sessionPeerIdentificationReceived
default void sessionPeerIdentificationReceived(Session session, String version, List<String> extraLines) The peer's identification version was received- Parameters:
session- TheSessioninstanceversion- The retrieved identification versionextraLines- Extra data preceding the identification- See Also:
-
sessionNegotiationOptionsCreated
default void sessionNegotiationOptionsCreated(Session session, Map<KexProposalOption, String> proposal) - Parameters:
session- The referencedSessionproposal- The proposals that will be sent to the peer - Caveat emptor: the proposal is modifiable i.e., the handler can modify it before being sent
-
sessionNegotiationStart
default void sessionNegotiationStart(Session session, Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal) Signals the start of the negotiation options handling- Parameters:
session- The referencedSessionclientProposal- The client proposal options (un-modifiable)serverProposal- The server proposal options (un-modifiable)
-
sessionNegotiationEnd
default void sessionNegotiationEnd(Session session, Map<KexProposalOption, String> clientProposal, Map<KexProposalOption, String> serverProposal, Map<KexProposalOption, String> negotiatedOptions, Throwable reason) Signals the end of the negotiation options handling- Parameters:
session- The referencedSessionclientProposal- The client proposal options (un-modifiable)serverProposal- The server proposal options (un-modifiable)negotiatedOptions- The successfully negotiated options so far - even if exception occurred (un-modifiable)reason- Negotiation end reason -nullif successful
-
sessionEvent
An event has been triggered- Parameters:
session- The referencedSessionevent- The generatedSessionListener.Event
-
sessionException
An exception was caught and the session will be closed (if not already so). Note: the code makes no guarantee that at this stagesessionClosed(Session)will be called or perhaps has already been called- Parameters:
session- The referencedSessiont- The caught exception
-
sessionDisconnect
default void sessionDisconnect(Session session, int reason, String msg, String language, boolean initiator) Invoked whenSSH_MSG_DISCONNECTmessage was sent/received- Parameters:
session- The referencedSessionreason- The signaled reason codemsg- The provided description message (may be empty)language- The language tag indicator (may be empty)initiator- Whether the session is the sender or recipient of the message- See Also:
-
sessionClosed
A session has been closed- Parameters:
session- The closedSession
-
validateListener
-