Package com.levigo.jadice.web.transport.server.networking.websocket

Class WebSocketContext

java.lang.Object
com.levigo.jadice.web.transport.server.networking.websocket.WebSocketContext
All Implemented Interfaces:
MessageContext
public class WebSocketContext extends Object implements MessageContext
This extends the MessageContext by carrying the WebSocket-Session and the HttpSession of the client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebSocketContext(String clientID, jakarta.websocket.Session session)
    Constructs a message context, that interfaces a Client, identified by its id, with the corresponding WebSocket-Session and its HttpSession.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getClientID()
    Returns the client id of the client which did send the message associated with this message context.
    jakarta.servlet.http.HttpSession
    getHTTPSession()
    Returns the HttpSession of the message associated with this message context.
    String
    getQueryString()
    Returns the query string contained in the message for this context.
    String
    getRequestURI()
    Returns the URI requested by the message for this context from the protocol up to the query string.
    jakarta.websocket.Session
    getSession()
    Gets the WebSocket-Session associated with the message.
    Principal
    getUserPrincipal()
    Returns the Principal identifying the user sending the message.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WebSocketContext

      public WebSocketContext(String clientID, jakarta.websocket.Session session)
      Constructs a message context, that interfaces a Client, identified by its id, with the corresponding WebSocket-Session and its HttpSession.
      Parameters:
      clientID - the id of the client
      session - the WebSocket-Session of the client

  • Method Details

    • getSession

      public jakarta.websocket.Session getSession()
      Gets the WebSocket-Session associated with the message.
      Returns:
      WebSocket-Session associated with the message

    • getQueryString

      public String getQueryString()
      Description copied from interface: MessageContext
      Returns the query string contained in the message for this context.

      Example:

      • https://somepage.com/somesite?key=value
      • QueryString: key=value
      Specified by:
      getQueryString in interface MessageContext
      Returns:
      the query string

    • getRequestURI

      public String getRequestURI()
      Description copied from interface: MessageContext
      Returns the URI requested by the message for this context from the protocol up to the query string.

      Example:

      • https://somepage.com/somesite?key=value
      • RequestURI: somepage.com/somesite
      Specified by:
      getRequestURI in interface MessageContext
      Returns:
      the requested URI

    • getUserPrincipal

      public Principal getUserPrincipal()
      Description copied from interface: MessageContext
      Returns the Principal identifying the user sending the message.
      Specified by:
      getUserPrincipal in interface MessageContext
      Returns:
      the user Principal

    • getClientID

      public String getClientID()
      Description copied from interface: MessageContext
      Returns the client id of the client which did send the message associated with this message context.
      Specified by:
      getClientID in interface MessageContext
      Returns:
      the client id

    • getHTTPSession

      public jakarta.servlet.http.HttpSession getHTTPSession()
      Description copied from interface: MessageContext
      Returns the HttpSession of the message associated with this message context.
      Specified by:
      getHTTPSession in interface MessageContext
      Returns:
      the HttpSession