Interface ReservedSessionMessagesHandler

  • All Superinterfaces:
    java.util.EventListener, SshdEventListener
    All Known Implementing Classes:
    ReservedSessionMessagesHandlerAdapter

    public interface ReservedSessionMessagesHandler
    extends SshdEventListener
    Provides a way to listen and handle the SSH_MSG_IGNORE and SSH_MSG_DEBUG messages that are received by a session, as well as proprietary and/or extension messages.
    • Method Detail

      • handleIgnoreMessage

        default void handleIgnoreMessage​(Session session,
                                         Buffer buffer)
                                  throws java.lang.Exception
        Invoked when an SSH_MSG_IGNORE packet is received
        Parameters:
        session - The Session through which the message was received
        buffer - The Buffer containing the data
        Throws:
        java.lang.Exception - If failed to handle the message
        See Also:
        RFC 4253 - section 11.2
      • handleDebugMessage

        default void handleDebugMessage​(Session session,
                                        Buffer buffer)
                                 throws java.lang.Exception
        Invoked when an SSH_MSG_DEBUG packet is received
        Parameters:
        session - The Session through which the message was received
        buffer - The Buffer containing the data
        Throws:
        java.lang.Exception - If failed to handle the message
        See Also:
        RFC 4253 - section 11.3
      • handleUnimplementedMessage

        default boolean handleUnimplementedMessage​(Session session,
                                                   int cmd,
                                                   Buffer buffer)
                                            throws java.lang.Exception
        Invoked when a packet with an un-implemented message is received - including SSH_MSG_UNIMPLEMENTED itself
        Parameters:
        session - The Session through which the message was received
        cmd - The received (un-implemented) command
        buffer - The Buffer containing the data - positioned just beyond the command
        Returns:
        true if message handled internally, false if should return a SSH_MSG_UNIMPLEMENTED reply (default behavior)
        Throws:
        java.lang.Exception - If failed to handle the message
        See Also:
        RFC 4253 - section 11.4
      • sendReservedHeartbeat

        default boolean sendReservedHeartbeat​(ConnectionService service)
                                       throws java.lang.Exception
        Invoked if the user configured usage of a proprietary heartbeat mechanism. Note: by default throws UnsupportedOperationException so users who configure a proprietary heartbeat mechanism option must provide an implementation for this method.
        Parameters:
        service - The ConnectionService through which the heartbeat is being executed.
        Returns:
        true whether heartbeat actually sent - Note: used mainly for debugging purposes.
        Throws:
        java.lang.Exception - If failed to send the heartbeat - Note: causes associated session termination.