Module org.omnifaces
Package org.omnifaces.cdi.push

Class SocketSessionManager

java.lang.Object
org.omnifaces.cdi.push.SocketSessionManager
@ApplicationScoped public class SocketSessionManager extends Object

This web socket session manager holds all web socket sessions by their channel identifier.

Since:
2.3
Author:
Bauke Scholtz
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    SocketSessionManager()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    add(Session session)
    On open, add given web socket session to the mapping associated with its channel identifier and returns true if it's accepted (i.e. the channel identifier is known) and the same session hasn't been added before, otherwise false.
    protected boolean
    addSession(String channelId, Session session)
    Add a session to the collection associated with the given channel identifier.
    protected void
    closeSession(Session session)
    Close the given session.
    protected void
    deregister(Iterable<String> channelIds)
    Deregister given channel identifiers and explicitly close all open sessions associated with them.
    protected boolean
    isOpen(Session session)
    Returns whether the given session is still open.
    protected boolean
    isRegistered(String channelId)
    Returns whether the given channel identifier is registered.
    protected void
    register(Iterable<String> channelIds)
    Register given channel identifiers.
    protected void
    register(String channelId)
    Register given channel identifier.
    protected void
    remove(Session session, CloseReason reason)
    On close, remove given web socket session from the mapping.
    protected boolean
    removeSession(String channelId, Session session)
    Remove a session from the collection associated with the given channel identifier.
    protected Set<Future<Void>>
    send(String channelId, String message)
    Send the given message to all open sessions associated with given channel identifier.
    protected Future<Void>
    sendToSession(Session session, String message)
    Send the given message to the given session.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SocketSessionManager

      public SocketSessionManager()

  • Method Details

    • add

      protected boolean add(Session session)
      On open, add given web socket session to the mapping associated with its channel identifier and returns true if it's accepted (i.e. the channel identifier is known) and the same session hasn't been added before, otherwise false.
      Parameters:
      session - The opened web socket session.
      Returns:
      true if given web socket session is accepted and is new, otherwise false.

    • remove

      protected void remove(Session session, CloseReason reason)
      On close, remove given web socket session from the mapping.
      Parameters:
      session - The closed web socket session.
      reason - The close reason.

    • sendToSession

      protected Future<Void> sendToSession(Session session, String message)
      Send the given message to the given session.
      Parameters:
      session - The transport session.
      message - The push message string.
      Returns:
      The result of the send operation, or null if the session is no longer usable.

    • isOpen

      protected boolean isOpen(Session session)
      Returns whether the given session is still open.
      Parameters:
      session - The transport session.
      Returns:
      true if the session is open.

    • closeSession

      protected void closeSession(Session session)
      Close the given session.
      Parameters:
      session - The transport session to close.

    • register

      protected void register(String channelId)
      Register given channel identifier.
      Parameters:
      channelId - The channel identifier to register.

    • register

      protected void register(Iterable<String> channelIds)
      Register given channel identifiers.
      Parameters:
      channelIds - The channel identifiers to register.

    • send

      protected Set<Future<Void>> send(String channelId, String message)
      Send the given message to all open sessions associated with given channel identifier.
      Parameters:
      channelId - The channel identifier.
      message - The push message string.
      Returns:
      The results of the send operation. If it returns an empty set, then there was no open session associated with given channel identifier. The returned futures will return null on Future.get() if the message was successfully delivered and otherwise throw ExecutionException.

    • deregister

      protected void deregister(Iterable<String> channelIds)
      Deregister given channel identifiers and explicitly close all open sessions associated with them.
      Parameters:
      channelIds - The channel identifiers to deregister.

    • isRegistered

      protected boolean isRegistered(String channelId)
      Returns whether the given channel identifier is registered.
      Parameters:
      channelId - The channel identifier.
      Returns:
      true if the channel identifier is registered, otherwise false.

    • addSession

      protected boolean addSession(String channelId, Session session)
      Add a session to the collection associated with the given channel identifier.
      Parameters:
      channelId - The channel identifier.
      session - The transport session to add.
      Returns:
      true if the channel identifier is known and the session was added, otherwise false.

    • removeSession

      protected boolean removeSession(String channelId, Session session)
      Remove a session from the collection associated with the given channel identifier.
      Parameters:
      channelId - The channel identifier.
      session - The transport session to remove.
      Returns:
      true if the session was present and removed, otherwise false.