Module org.eclipse.jetty.websocket.jakarta.common
Package org.eclipse.jetty.websocket.jakarta.common

Class JakartaWebSocketContainer

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer
All Implemented Interfaces:
jakarta.websocket.WebSocketContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle
public abstract class JakartaWebSocketContainer extends org.eclipse.jetty.util.component.ContainerLifeCycle implements jakarta.websocket.WebSocketContainer, org.eclipse.jetty.util.component.Dumpable

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

    org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

    org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

    org.eclipse.jetty.util.component.LifeCycle.Listener

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.eclipse.jetty.websocket.core.WebSocketComponents
    components
     
    protected final org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer
    defaultCustomizer
     
    protected final SessionTracker
    sessionTracker
     

    Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    FAILED, STARTED, STARTING, STOPPED, STOPPING

    Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

    KEY

  • Constructor Summary

    Constructors
    Constructor
    Description
    JakartaWebSocketContainer(org.eclipse.jetty.websocket.core.WebSocketComponents components)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSessionListener(JakartaWebSocketSessionListener listener)
    Register a WebSocketSessionListener with the container
    void
    dump(Appendable out, String indent)
     
    org.eclipse.jetty.io.ByteBufferPool
    getBufferPool()
     
    long
    getDefaultAsyncSendTimeout()
     
    int
    getDefaultMaxBinaryMessageBufferSize()
     
    long
    getDefaultMaxSessionIdleTimeout()
     
    int
    getDefaultMaxTextMessageBufferSize()
     
    abstract Executor
    getExecutor()
     
    org.eclipse.jetty.websocket.core.WebSocketExtensionRegistry
    getExtensionRegistry()
     
    protected abstract JakartaWebSocketFrameHandlerFactory
    getFrameHandlerFactory()
     
    Set<jakarta.websocket.Extension>
    getInstalledExtensions()
    org.eclipse.jetty.util.DecoratedObjectFactory
    getObjectFactory()
     
    Set<jakarta.websocket.Session>
    getOpenSessions()
    Used in Session.getOpenSessions()
    org.eclipse.jetty.websocket.core.WebSocketComponents
    getWebSocketComponents()
     
    JakartaWebSocketFrameHandler
    newFrameHandler(Object websocketPojo, UpgradeRequest upgradeRequest)
     
    void
    notifySessionListeners(Consumer<JakartaWebSocketSessionListener> consumer)
    Notify Session Listeners of events
    boolean
    removeSessionListener(JakartaWebSocketSessionListener listener)
    Remove a WebSocketSessionListener from the container
    void
    setAsyncSendTimeout(long ms)
     
    void
    setDefaultMaxBinaryMessageBufferSize(int max)
     
    void
    setDefaultMaxSessionIdleTimeout(long ms)
     
    void
    setDefaultMaxTextMessageBufferSize(int max)
     

    Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

    addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

    Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

    getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.jetty.util.component.Container

    getCachedBeans, getEventListeners

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

    dump, dumpSelf

    Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

    isDumpable

    Methods inherited from interface jakarta.websocket.WebSocketContainer

    connectToServer, connectToServer, connectToServer, connectToServer

  • Field Details

    • sessionTracker

      protected final SessionTracker sessionTracker

    • defaultCustomizer

      protected final org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer defaultCustomizer

    • components

      protected final org.eclipse.jetty.websocket.core.WebSocketComponents components

  • Constructor Details

    • JakartaWebSocketContainer

      public JakartaWebSocketContainer(org.eclipse.jetty.websocket.core.WebSocketComponents components)

  • Method Details

    • getExecutor

      public abstract Executor getExecutor()

    • getFrameHandlerFactory

      protected abstract JakartaWebSocketFrameHandlerFactory getFrameHandlerFactory()

    • getBufferPool

      public org.eclipse.jetty.io.ByteBufferPool getBufferPool()

    • getExtensionRegistry

      public org.eclipse.jetty.websocket.core.WebSocketExtensionRegistry getExtensionRegistry()

    • getObjectFactory

      public org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()

    • getWebSocketComponents

      public org.eclipse.jetty.websocket.core.WebSocketComponents getWebSocketComponents()

    • getDefaultAsyncSendTimeout

      public long getDefaultAsyncSendTimeout()
      Specified by:
      getDefaultAsyncSendTimeout in interface jakarta.websocket.WebSocketContainer

    • getDefaultMaxBinaryMessageBufferSize

      public int getDefaultMaxBinaryMessageBufferSize()
      Specified by:
      getDefaultMaxBinaryMessageBufferSize in interface jakarta.websocket.WebSocketContainer

    • getDefaultMaxSessionIdleTimeout

      public long getDefaultMaxSessionIdleTimeout()
      Specified by:
      getDefaultMaxSessionIdleTimeout in interface jakarta.websocket.WebSocketContainer

    • getDefaultMaxTextMessageBufferSize

      public int getDefaultMaxTextMessageBufferSize()
      Specified by:
      getDefaultMaxTextMessageBufferSize in interface jakarta.websocket.WebSocketContainer

    • setAsyncSendTimeout

      public void setAsyncSendTimeout(long ms)
      Specified by:
      setAsyncSendTimeout in interface jakarta.websocket.WebSocketContainer

    • setDefaultMaxBinaryMessageBufferSize

      public void setDefaultMaxBinaryMessageBufferSize(int max)
      Specified by:
      setDefaultMaxBinaryMessageBufferSize in interface jakarta.websocket.WebSocketContainer

    • setDefaultMaxSessionIdleTimeout

      public void setDefaultMaxSessionIdleTimeout(long ms)
      Specified by:
      setDefaultMaxSessionIdleTimeout in interface jakarta.websocket.WebSocketContainer

    • setDefaultMaxTextMessageBufferSize

      public void setDefaultMaxTextMessageBufferSize(int max)
      Specified by:
      setDefaultMaxTextMessageBufferSize in interface jakarta.websocket.WebSocketContainer

    • getInstalledExtensions

      public Set<jakarta.websocket.Extension> getInstalledExtensions()
      Specified by:
      getInstalledExtensions in interface jakarta.websocket.WebSocketContainer
      Since:
      JSR356 v1.0
      See Also:
      • WebSocketContainer.getInstalledExtensions()

    • getOpenSessions

      public Set<jakarta.websocket.Session> getOpenSessions()
      Used in Session.getOpenSessions()
      Returns:
      the set of open sessions

    • newFrameHandler

      public JakartaWebSocketFrameHandler newFrameHandler(Object websocketPojo, UpgradeRequest upgradeRequest)

    • addSessionListener

      public void addSessionListener(JakartaWebSocketSessionListener listener)
      Register a WebSocketSessionListener with the container
      Parameters:
      listener - the listener

    • removeSessionListener

      public boolean removeSessionListener(JakartaWebSocketSessionListener listener)
      Remove a WebSocketSessionListener from the container
      Parameters:
      listener - the listener
      Returns:
      true if listener was present and removed

    • notifySessionListeners

      public void notifySessionListeners(Consumer<JakartaWebSocketSessionListener> consumer)
      Notify Session Listeners of events
      Parameters:
      consumer - the consumer to pass to each listener

    • dump

      public void dump(Appendable out, String indent) throws IOException
      Specified by:
      dump in interface org.eclipse.jetty.util.component.Dumpable
      Overrides:
      dump in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      IOException