Package io.vertx.ext.stomp.lite

Interface StompServerHandler

  • public interface StompServerHandler
    Created by Navid Mitchell on 2019-01-25.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void abort​(Frame frame)  
      void ack​(Frame frame)  
      io.vertx.core.Promise<java.util.Map<java.lang.String,​java.lang.String>> authenticate​(java.util.Map<java.lang.String,​java.lang.String> connectHeaders)
      Requests authentication for the given credentials
      void begin​(Frame frame)  
      void closed()
      Called when the client connection is closed
      void commit​(Frame frame)  
      void disconnected()
      Called when a client explicitly sends a DISCONNECT frame.
      void exception​(java.lang.Throwable t)
      This is called when the processing of a client request resulted in an exception.
      void nack​(Frame frame)  
      void send​(Frame frame)  
      void subscribe​(Frame frame)  
      void unsubscribe​(Frame frame)  

    • Method Detail

      • authenticate

        io.vertx.core.Promise<java.util.Map<java.lang.String,​java.lang.String>> authenticate​(java.util.Map<java.lang.String,​java.lang.String> connectHeaders)
        Requests authentication for the given credentials
        Parameters:
        connectHeaders - all of the headers provided with the CONNECT frame. This will include the login and passcode headers.
        Returns:
        a Promise completed normally to authenticate or failed to represent a failed authentication The promise must contain a Map that will provide any additional headers to be returned to the client with the CONNECTED frame

      • send

        void send​(Frame frame)

      • subscribe

        void subscribe​(Frame frame)

      • unsubscribe

        void unsubscribe​(Frame frame)

      • begin

        void begin​(Frame frame)

      • abort

        void abort​(Frame frame)

      • commit

        void commit​(Frame frame)

      • ack

        void ack​(Frame frame)

      • nack

        void nack​(Frame frame)

      • exception

        void exception​(java.lang.Throwable t)
        This is called when the processing of a client request resulted in an exception. Ex: parsing or handling of a STOMP frame resulted in an exception. After this is called the client connection will automatically be closed.
        Parameters:
        t - the exception that occurred

      • disconnected

        void disconnected()
        Called when a client explicitly sends a DISCONNECT frame. This will be called before closed().

      • closed

        void closed()
        Called when the client connection is closed