Module org.eclipse.jetty.websocket.jakarta.client
Package org.eclipse.jetty.websocket.jakarta.client.internal

Class JakartaWebSocketClientContainer

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer
org.eclipse.jetty.websocket.jakarta.client.internal.JakartaWebSocketClientContainer
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
@ManagedObject("JSR356 Client Container") public class JakartaWebSocketClientContainer extends org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer implements jakarta.websocket.WebSocketContainer
Container for Client use of the jakarta.websocket API.

This should be specific to a JVM if run in a standalone mode. or specific to a WebAppContext if running on the Jetty server.

  • 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 org.eclipse.jetty.websocket.core.client.WebSocketCoreClient
    coreClient
     
    protected Function<org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.client.WebSocketCoreClient>
    coreClientFactory
     

    Fields inherited from class org.eclipse.jetty.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

    KEY

  • Constructor Summary

    Constructors
    Constructor
    Description
    JakartaWebSocketClientContainer()
     
    JakartaWebSocketClientContainer(org.eclipse.jetty.client.HttpClient httpClient)
    Create a WebSocketContainer using the supplied HttpClient for environments where you want to configure SSL/TLS or Proxy behaviors.
    JakartaWebSocketClientContainer(org.eclipse.jetty.websocket.core.WebSocketComponents components)
     
    JakartaWebSocketClientContainer(org.eclipse.jetty.websocket.core.WebSocketComponents components, Function<org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.client.WebSocketCoreClient> coreClientFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.websocket.Session
    connectToServer(jakarta.websocket.Endpoint endpoint, jakarta.websocket.ClientEndpointConfig providedConfig, URI path)
     
    jakarta.websocket.Session
    connectToServer(Class<?> annotatedEndpointClass, URI path)
     
    jakarta.websocket.Session
    connectToServer(Class<? extends jakarta.websocket.Endpoint> endpointClass, jakarta.websocket.ClientEndpointConfig providedConfig, URI path)
     
    jakarta.websocket.Session
    connectToServer(Object endpoint, URI path)
     
    static Throwable
    convertCause(Throwable error)
     
    protected void
    doClientStart()
     
    protected void
    doClientStop()
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    Executor
    getExecutor()
     
    org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketFrameHandlerFactory
    getFrameHandlerFactory()
     
    protected org.eclipse.jetty.client.HttpClient
    getHttpClient()
     
    protected org.eclipse.jetty.websocket.core.client.WebSocketCoreClient
    getWebSocketCoreClient()
     
    static void
    setShutdownContainer(org.eclipse.jetty.util.component.ContainerLifeCycle container)
     

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

    addSessionListener, dump, getBufferPool, 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, 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

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

  • Field Details

    • coreClient

      protected org.eclipse.jetty.websocket.core.client.WebSocketCoreClient coreClient

    • coreClientFactory

      protected Function<org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.client.WebSocketCoreClient> coreClientFactory

  • Constructor Details

    • JakartaWebSocketClientContainer

      public JakartaWebSocketClientContainer()

    • JakartaWebSocketClientContainer

      public JakartaWebSocketClientContainer(org.eclipse.jetty.client.HttpClient httpClient)
      Create a WebSocketContainer using the supplied HttpClient for environments where you want to configure SSL/TLS or Proxy behaviors.
      Parameters:
      httpClient - the HttpClient instance to use

    • JakartaWebSocketClientContainer

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

    • JakartaWebSocketClientContainer

      public JakartaWebSocketClientContainer(org.eclipse.jetty.websocket.core.WebSocketComponents components, Function<org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.client.WebSocketCoreClient> coreClientFactory)

  • Method Details

    • setShutdownContainer

      public static void setShutdownContainer(org.eclipse.jetty.util.component.ContainerLifeCycle container)

    • getHttpClient

      protected org.eclipse.jetty.client.HttpClient getHttpClient()

    • getWebSocketCoreClient

      protected org.eclipse.jetty.websocket.core.client.WebSocketCoreClient getWebSocketCoreClient()

    • convertCause

      public static Throwable convertCause(Throwable error)

    • connectToServer

      public jakarta.websocket.Session connectToServer(Class<? extends jakarta.websocket.Endpoint> endpointClass, jakarta.websocket.ClientEndpointConfig providedConfig, URI path) throws jakarta.websocket.DeploymentException, IOException
      Specified by:
      connectToServer in interface jakarta.websocket.WebSocketContainer
      Throws:
      jakarta.websocket.DeploymentException
      IOException

    • connectToServer

      public jakarta.websocket.Session connectToServer(Class<?> annotatedEndpointClass, URI path) throws jakarta.websocket.DeploymentException, IOException
      Specified by:
      connectToServer in interface jakarta.websocket.WebSocketContainer
      Throws:
      jakarta.websocket.DeploymentException
      IOException

    • connectToServer

      public jakarta.websocket.Session connectToServer(jakarta.websocket.Endpoint endpoint, jakarta.websocket.ClientEndpointConfig providedConfig, URI path) throws jakarta.websocket.DeploymentException, IOException
      Specified by:
      connectToServer in interface jakarta.websocket.WebSocketContainer
      Throws:
      jakarta.websocket.DeploymentException
      IOException

    • connectToServer

      public jakarta.websocket.Session connectToServer(Object endpoint, URI path) throws jakarta.websocket.DeploymentException, IOException
      Specified by:
      connectToServer in interface jakarta.websocket.WebSocketContainer
      Throws:
      jakarta.websocket.DeploymentException
      IOException

    • getFrameHandlerFactory

      public org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketFrameHandlerFactory getFrameHandlerFactory()
      Specified by:
      getFrameHandlerFactory in class org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer

    • getExecutor

      public Executor getExecutor()
      Specified by:
      getExecutor in class org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
      Throws:
      Exception

    • doClientStart

      protected void doClientStart()

    • doClientStop

      protected void doClientStop()