Class JakartaWebSocketClientContainer

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

All Implemented Interfaces:

jakarta.websocket.WebSocketContainer, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

JakartaWebSocketServerContainer

@ManagedObject("JSR356 Client Container")
public class JakartaWebSocketClientContainer
extends 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 AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected WebSocketCoreClient	coreClient
protected Function<WebSocketComponents, WebSocketCoreClient>	coreClientFactory

Fields inherited from class JakartaWebSocketContainer

components, defaultCustomizer, sessionTracker

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
JakartaWebSocketClientContainer()
JakartaWebSocketClientContainer(HttpClient httpClient)	Create a WebSocketContainer using the supplied HttpClient for environments where you want to configure SSL/TLS or Proxy behaviors.
JakartaWebSocketClientContainer(WebSocketComponents components)
JakartaWebSocketClientContainer(WebSocketComponents components, Function<WebSocketComponents, 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()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
Object	getContextHandler()
Executor	getExecutor()
JakartaWebSocketFrameHandlerFactory	getFrameHandlerFactory()
protected HttpClient	getHttpClient()
protected WebSocketCoreClient	getWebSocketCoreClient()
static void	setShutdownContainer(ContainerLifeCycle container)

Methods inherited from class JakartaWebSocketContainer

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

Methods inherited from class 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 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 Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dump, dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface jakarta.websocket.WebSocketContainer

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

Field Details

coreClient

protected WebSocketCoreClient coreClient

coreClientFactory

protected Function<WebSocketComponents, WebSocketCoreClient> coreClientFactory

Constructor Details

JakartaWebSocketClientContainer

public JakartaWebSocketClientContainer()

JakartaWebSocketClientContainer

public JakartaWebSocketClientContainer(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(WebSocketComponents components)

JakartaWebSocketClientContainer

public JakartaWebSocketClientContainer(WebSocketComponents components,
 Function<WebSocketComponents, WebSocketCoreClient> coreClientFactory)

Method Details

setShutdownContainer

public static void setShutdownContainer(ContainerLifeCycle container)

getHttpClient

protected HttpClient getHttpClient()

getWebSocketCoreClient

protected 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 JakartaWebSocketFrameHandlerFactory getFrameHandlerFactory()

Specified by:

getFrameHandlerFactory in class JakartaWebSocketContainer

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in class JakartaWebSocketContainer

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

doClientStart

protected void doClientStart()

doClientStop

protected void doClientStop()

getContextHandler

public Object getContextHandler()