Package org.apache.tomcat.websocket.pojo

Class PojoEndpointBase

  • Direct Known Subclasses:
    PojoEndpointClient, PojoEndpointServer
    public abstract class PojoEndpointBase
extends Endpoint
    Base implementation (client and server have different concrete implementations) of the wrapper that converts a POJO instance into a WebSocket endpoint instance.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected PojoEndpointBase​(java.util.Map<java.lang.String,​java.lang.String> pathParameters)
      Constructs a new PojoEndpointBase.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void doOnOpen​(Session session, EndpointConfig config)
      Handles the WebSocket session open event by adding message handlers and invoking the onOpen method.
      protected PojoMethodMapping getMethodMapping()
      Returns the method mapping for this endpoint.
      protected java.lang.Object getPojo()
      Returns the POJO instance wrapped by this endpoint.
      void onClose​(Session session, CloseReason closeReason)
      Event that is triggered when a session has closed.
      void onError​(Session session, java.lang.Throwable throwable)
      Event that is triggered when a protocol error occurs.
      protected void setMethodMapping​(PojoMethodMapping methodMapping)
      Sets the method mapping for this endpoint.
      protected void setPojo​(java.lang.Object pojo)
      Sets the POJO instance wrapped by this endpoint.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PojoEndpointBase

        protected PojoEndpointBase​(java.util.Map<java.lang.String,​java.lang.String> pathParameters)
        Constructs a new PojoEndpointBase.
        Parameters:
        pathParameters - the path parameters for the endpoint

    • Method Detail

      • doOnOpen

        protected final void doOnOpen​(Session session,
                              EndpointConfig config)
        Handles the WebSocket session open event by adding message handlers and invoking the onOpen method.
        Parameters:
        session - the WebSocket session
        config - the endpoint configuration

      • onClose

        public final void onClose​(Session session,
                          CloseReason closeReason)
        Description copied from class: jakarta.websocket.Endpoint
        Event that is triggered when a session has closed.
        Overrides:
        onClose in class Endpoint
        Parameters:
        session - The session
        closeReason - Why the session was closed

      • onError

        public final void onError​(Session session,
                          java.lang.Throwable throwable)
        Description copied from class: jakarta.websocket.Endpoint
        Event that is triggered when a protocol error occurs.
        Overrides:
        onError in class Endpoint
        Parameters:
        session - The session.
        throwable - The exception.

      • getPojo

        protected java.lang.Object getPojo()
        Returns the POJO instance wrapped by this endpoint.
        Returns:
        the POJO instance

      • setPojo

        protected void setPojo​(java.lang.Object pojo)
        Sets the POJO instance wrapped by this endpoint.
        Parameters:
        pojo - the POJO instance

      • getMethodMapping

        protected PojoMethodMapping getMethodMapping()
        Returns the method mapping for this endpoint.
        Returns:
        the method mapping

      • setMethodMapping

        protected void setMethodMapping​(PojoMethodMapping methodMapping)
        Sets the method mapping for this endpoint.
        Parameters:
        methodMapping - the method mapping