ClientContainer (Jetty :: Project 9.4.22.v20191022 API)

java.lang.Object
- org.eclipse.jetty.util.component.AbstractLifeCycle
- - org.eclipse.jetty.util.component.ContainerLifeCycle
  - - org.eclipse.jetty.websocket.jsr356.ClientContainer

All Implemented Interfaces:

javax.websocket.WebSocketContainer, WebSocketContainerScope

Direct Known Subclasses:

ServerContainer
```
@ManagedObject("JSR356 Client Container")
public class ClientContainer
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements javax.websocket.WebSocketContainer, WebSocketContainerScope
```
Container for Client use of the javax.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
- 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.LifeCycle
  org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary
- Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
  FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING
- Fields inherited from interface org.eclipse.jetty.util.component.Dumpable
  KEY

Constructor Summary

Constructors
Modifier	Constructor	Description
	`ClientContainer()`	This is the entry point for `ContainerProvider.getWebSocketContainer()`
	`ClientContainer(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.
	`ClientContainer(WebSocketClient client)`	Build a ClientContainer with a specific WebSocketClient in mind.
	`ClientContainer(WebSocketContainerScope scope)`	This is the entry point for ServerContainer, via ServletContext.getAttribute(ServerContainer.class.getName())
`protected`	`ClientContainer(WebSocketContainerScope scope, org.eclipse.jetty.client.HttpClient httpClient)`	This is the entry point for ServerContainer, via ServletContext.getAttribute(ServerContainer.class.getName())

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addSessionListener(WebSocketSessionListener listener)`
`javax.websocket.Session`	`connectToServer(java.lang.Class<?> annotatedEndpointClass, java.net.URI path)`
`javax.websocket.Session`	`connectToServer(java.lang.Class<? extends javax.websocket.Endpoint> endpointClass, javax.websocket.ClientEndpointConfig config, java.net.URI path)`
`javax.websocket.Session`	`connectToServer(java.lang.Object endpoint, java.net.URI path)`
`javax.websocket.Session`	`connectToServer(javax.websocket.Endpoint endpoint, javax.websocket.ClientEndpointConfig config, java.net.URI path)`
`protected void`	`doStart()`
`protected void`	`doStop()`
`org.eclipse.jetty.io.ByteBufferPool`	`getBufferPool()`	The configured Container Buffer Pool.
`WebSocketClient`	`getClient()`
`EndpointMetadata`	`getClientEndpointMetadata(java.lang.Class<?> endpoint, javax.websocket.EndpointConfig config)`
`DecoderFactory`	`getDecoderFactory()`
`long`	`getDefaultAsyncSendTimeout()`
`int`	`getDefaultMaxBinaryMessageBufferSize()`
`long`	`getDefaultMaxSessionIdleTimeout()`
`int`	`getDefaultMaxTextMessageBufferSize()`
`EncoderFactory`	`getEncoderFactory()`
`java.util.concurrent.Executor`	`getExecutor()`	Executor in use by the container.
`java.util.Set<javax.websocket.Extension>`	`getInstalledExtensions()`
`org.eclipse.jetty.util.DecoratedObjectFactory`	`getObjectFactory()`	Object Factory used to create objects.
`java.util.Set<javax.websocket.Session>`	`getOpenSessions()`	Used in `Session.getOpenSessions()`
`WebSocketPolicy`	`getPolicy()`	The policy the container is running on.
`java.util.Collection<WebSocketSessionListener>`	`getSessionListeners()`
`org.eclipse.jetty.util.ssl.SslContextFactory`	`getSslContextFactory()`	The SslContextFactory in use by the container.
`EndpointInstance`	`newClientEndpointInstance(java.lang.Object endpoint, javax.websocket.ClientEndpointConfig config)`
`void`	`removeSessionListener(WebSocketSessionListener listener)`
`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.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable
dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope
isRunning

- Constructor Detail
  - ClientContainer
```
public ClientContainer()
```
    This is the entry point for ContainerProvider.getWebSocketContainer()
  - ClientContainer
```
public ClientContainer(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
  - ClientContainer
```
public ClientContainer(WebSocketContainerScope scope)
```
    This is the entry point for ServerContainer, via ServletContext.getAttribute(ServerContainer.class.getName())
    
    Parameters:
    
    scope - the scope of the ServerContainer
  - ClientContainer
```
protected ClientContainer(WebSocketContainerScope scope,
                          org.eclipse.jetty.client.HttpClient httpClient)
```
    This is the entry point for ServerContainer, via ServletContext.getAttribute(ServerContainer.class.getName())
    
    Parameters:
    
    scope - the scope of the ServerContainer
    
    httpClient - the HttpClient instance to use
  - ClientContainer
```
public ClientContainer(WebSocketClient client)
```
    Build a ClientContainer with a specific WebSocketClient in mind.
    
    Parameters:
    
    client - the WebSocketClient to use.
- Method Detail
  - connectToServer
```
public javax.websocket.Session connectToServer(java.lang.Class<? extends javax.websocket.Endpoint> endpointClass,
                                               javax.websocket.ClientEndpointConfig config,
                                               java.net.URI path)
                                        throws javax.websocket.DeploymentException,
                                               java.io.IOException
```
    Specified by:
    
    connectToServer in interface javax.websocket.WebSocketContainer
    
    Throws:
    
    javax.websocket.DeploymentException
    
    java.io.IOException
  - connectToServer
```
public javax.websocket.Session connectToServer(java.lang.Class<?> annotatedEndpointClass,
                                               java.net.URI path)
                                        throws javax.websocket.DeploymentException,
                                               java.io.IOException
```
    Specified by:
    
    connectToServer in interface javax.websocket.WebSocketContainer
    
    Throws:
    
    javax.websocket.DeploymentException
    
    java.io.IOException
  - connectToServer
```
public javax.websocket.Session connectToServer(javax.websocket.Endpoint endpoint,
                                               javax.websocket.ClientEndpointConfig config,
                                               java.net.URI path)
                                        throws javax.websocket.DeploymentException,
                                               java.io.IOException
```
    Specified by:
    
    connectToServer in interface javax.websocket.WebSocketContainer
    
    Throws:
    
    javax.websocket.DeploymentException
    
    java.io.IOException
  - connectToServer
```
public javax.websocket.Session connectToServer(java.lang.Object endpoint,
                                               java.net.URI path)
                                        throws javax.websocket.DeploymentException,
                                               java.io.IOException
```
    Specified by:
    
    connectToServer in interface javax.websocket.WebSocketContainer
    
    Throws:
    
    javax.websocket.DeploymentException
    
    java.io.IOException
  - doStart
```
protected void doStart()
                throws java.lang.Exception
```
    Overrides:
    
    doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle
    
    Throws:
    
    java.lang.Exception
  - doStop
```
protected void doStop()
               throws java.lang.Exception
```
    Overrides:
    
    doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
    
    Throws:
    
    java.lang.Exception
  - getBufferPool
```
public org.eclipse.jetty.io.ByteBufferPool getBufferPool()
```
    Description copied from interface: WebSocketContainerScope
    
    The configured Container Buffer Pool.
    
    Specified by:
    
    getBufferPool in interface WebSocketContainerScope
    
    Returns:
    
    the buffer pool (never null)
  - getClient
```
public WebSocketClient getClient()
```
  - getClientEndpointMetadata
```
public EndpointMetadata getClientEndpointMetadata(java.lang.Class<?> endpoint,
                                                  javax.websocket.EndpointConfig config)
```
  - getDecoderFactory
```
public DecoderFactory getDecoderFactory()
```
  - getDefaultAsyncSendTimeout
```
public long getDefaultAsyncSendTimeout()
```
    Specified by:
    
    getDefaultAsyncSendTimeout in interface javax.websocket.WebSocketContainer
  - getDefaultMaxBinaryMessageBufferSize
```
public int getDefaultMaxBinaryMessageBufferSize()
```
    Specified by:
    
    getDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer
  - getDefaultMaxSessionIdleTimeout
```
public long getDefaultMaxSessionIdleTimeout()
```
    Specified by:
    
    getDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer
  - getDefaultMaxTextMessageBufferSize
```
public int getDefaultMaxTextMessageBufferSize()
```
    Specified by:
    
    getDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer
  - getEncoderFactory
```
public EncoderFactory getEncoderFactory()
```
  - getExecutor
```
public java.util.concurrent.Executor getExecutor()
```
    Description copied from interface: WebSocketContainerScope
    
    Executor in use by the container.
    
    Specified by:
    
    getExecutor in interface WebSocketContainerScope
    
    Returns:
    
    the Executor in use by the container.
  - getInstalledExtensions
```
public java.util.Set<javax.websocket.Extension> getInstalledExtensions()
```
    Specified by:
    
    getInstalledExtensions in interface javax.websocket.WebSocketContainer
  - getObjectFactory
```
public org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()
```
    Description copied from interface: WebSocketContainerScope
    
    Object Factory used to create objects.
    
    Specified by:
    
    getObjectFactory in interface WebSocketContainerScope
    
    Returns:
    
    Object Factory used to create instances of objects.
  - getOpenSessions
```
public java.util.Set<javax.websocket.Session> getOpenSessions()
```
    Used in Session.getOpenSessions()
    
    Returns:
    
    the set of open sessions
  - getPolicy
```
public WebSocketPolicy getPolicy()
```
    Description copied from interface: WebSocketContainerScope
    
    The policy the container is running on.
    
    Specified by:
    
    getPolicy in interface WebSocketContainerScope
    
    Returns:
    
    the websocket policy
  - getSslContextFactory
```
public org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()
```
    Description copied from interface: WebSocketContainerScope
    
    The SslContextFactory in use by the container.
    
    Specified by:
    
    getSslContextFactory in interface WebSocketContainerScope
    
    Returns:
    
    the SslContextFactory in use by the container (can be null if no SSL context is defined)
  - addSessionListener
```
public void addSessionListener(WebSocketSessionListener listener)
```
    Specified by:
    
    addSessionListener in interface WebSocketContainerScope
  - removeSessionListener
```
public void removeSessionListener(WebSocketSessionListener listener)
```
    Specified by:
    
    removeSessionListener in interface WebSocketContainerScope
  - getSessionListeners
```
public java.util.Collection<WebSocketSessionListener> getSessionListeners()
```
    Specified by:
    
    getSessionListeners in interface WebSocketContainerScope
  - newClientEndpointInstance
```
public EndpointInstance newClientEndpointInstance(java.lang.Object endpoint,
                                                  javax.websocket.ClientEndpointConfig config)
```
  - setAsyncSendTimeout
```
public void setAsyncSendTimeout(long ms)
```
    Specified by:
    
    setAsyncSendTimeout in interface javax.websocket.WebSocketContainer
  - setDefaultMaxBinaryMessageBufferSize
```
public void setDefaultMaxBinaryMessageBufferSize(int max)
```
    Specified by:
    
    setDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer
  - setDefaultMaxSessionIdleTimeout
```
public void setDefaultMaxSessionIdleTimeout(long ms)
```
    Specified by:
    
    setDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer
  - setDefaultMaxTextMessageBufferSize
```
public void setDefaultMaxTextMessageBufferSize(int max)
```
    Specified by:
    
    setDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

Class ClientContainer

Nested Class Summary

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

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

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

Constructor Detail

ClientContainer

ClientContainer

ClientContainer

ClientContainer

ClientContainer

Method Detail

connectToServer

connectToServer

connectToServer

connectToServer

doStart

doStop

getBufferPool

getClient

getClientEndpointMetadata

getDecoderFactory

getDefaultAsyncSendTimeout

getDefaultMaxBinaryMessageBufferSize

getDefaultMaxSessionIdleTimeout

getDefaultMaxTextMessageBufferSize

getEncoderFactory

getExecutor

getInstalledExtensions

getObjectFactory

getOpenSessions

getPolicy

getSslContextFactory

addSessionListener

removeSessionListener

getSessionListeners

newClientEndpointInstance

setAsyncSendTimeout

setDefaultMaxBinaryMessageBufferSize

setDefaultMaxSessionIdleTimeout

setDefaultMaxTextMessageBufferSize