Class JakartaWebSocketServerContainer

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketContainer
org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer
org.eclipse.jetty.ee10.websocket.jakarta.server.JakartaWebSocketServerContainer
All Implemented Interfaces:
jakarta.websocket.server.ServerContainer, jakarta.websocket.WebSocketContainer, EventListener, 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, org.eclipse.jetty.util.component.LifeCycle.Listener
@ManagedObject("JSR356 Server Container") public class JakartaWebSocketServerContainer extends org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer implements jakarta.websocket.server.ServerContainer, org.eclipse.jetty.util.component.LifeCycle.Listener

  • 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, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

    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
    static final String
    JAKARTA_WEBSOCKET_CONTAINER_ATTRIBUTE
     
    static final String
    PATH_PARAM_ATTRIBUTE
     

    Fields inherited from class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer

    coreClient, coreClientFactory

    Fields inherited from class org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketContainer

    components, defaultCustomizer, 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

    LEGEND

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addEndpoint(jakarta.websocket.server.ServerEndpointConfig providedConfig)
     
    void
    addEndpoint(Class<?> endpointClass)
     
    protected void
    doClientStart()
     
    protected void
    doClientStop()
     
    protected void
    doStart()
     
    static JakartaWebSocketServerContainer
    ensureContainer(jakarta.servlet.ServletContext servletContext)
     
    static JakartaWebSocketServerContainer
    getContainer(jakarta.servlet.ServletContext servletContext)
     
    JakartaWebSocketServerFrameHandlerFactory
    getFrameHandlerFactory()
     
    void
    upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, jakarta.websocket.server.ServerEndpointConfig sec, Map<String,String> pathParameters)
     

    Methods inherited from class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer

    connectToServer, connectToServer, connectToServer, connectToServer, convertCause, doStop, getContextHandler, getExecutor, getHttpClient, getWebSocketCoreClient, setShutdownContainer

    Methods inherited from class org.eclipse.jetty.ee10.websocket.jakarta.common.JakartaWebSocketContainer

    addSessionListener, dump, getByteBufferPool, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getExtensionRegistry, getInstalledExtensions, getObjectFactory, getOpenSessions, getWebSocketComponents, newFrameHandler, notifySessionListeners, removeSessionListener, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize

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

    addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, 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 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 org.eclipse.jetty.util.component.LifeCycle.Listener

    lifeCycleFailure, lifeCycleStarted, lifeCycleStarting, lifeCycleStopped, lifeCycleStopping

    Methods inherited from interface jakarta.websocket.WebSocketContainer

    connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize

  • Field Details

    • PATH_PARAM_ATTRIBUTE

      public static final String PATH_PARAM_ATTRIBUTE
      See Also:

    • JAKARTA_WEBSOCKET_CONTAINER_ATTRIBUTE

      public static final String JAKARTA_WEBSOCKET_CONTAINER_ATTRIBUTE

  • Method Details

    • getContainer

      public static JakartaWebSocketServerContainer getContainer(jakarta.servlet.ServletContext servletContext)

    • ensureContainer

      public static JakartaWebSocketServerContainer ensureContainer(jakarta.servlet.ServletContext servletContext)

    • getFrameHandlerFactory

      public JakartaWebSocketServerFrameHandlerFactory getFrameHandlerFactory()
      Overrides:
      getFrameHandlerFactory in class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer

    • addEndpoint

      public void addEndpoint(Class<?> endpointClass) throws jakarta.websocket.DeploymentException
      Specified by:
      addEndpoint in interface jakarta.websocket.server.ServerContainer
      Throws:
      jakarta.websocket.DeploymentException

    • addEndpoint

      public void addEndpoint(jakarta.websocket.server.ServerEndpointConfig providedConfig) throws jakarta.websocket.DeploymentException
      Specified by:
      addEndpoint in interface jakarta.websocket.server.ServerContainer
      Throws:
      jakarta.websocket.DeploymentException

    • upgradeHttpToWebSocket

      public void upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, jakarta.websocket.server.ServerEndpointConfig sec, Map<String,String> pathParameters) throws IOException, jakarta.websocket.DeploymentException
      Specified by:
      upgradeHttpToWebSocket in interface jakarta.websocket.server.ServerContainer
      Throws:
      IOException
      jakarta.websocket.DeploymentException

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer
      Throws:
      Exception

    • doClientStart

      protected void doClientStart()
      Overrides:
      doClientStart in class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer

    • doClientStop

      protected void doClientStop()
      Overrides:
      doClientStop in class org.eclipse.jetty.ee10.websocket.jakarta.client.JakartaWebSocketClientContainer