Class WebSocketServerComponents

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.core.WebSocketComponents

org.eclipse.jetty.websocket.core.server.WebSocketServerComponents

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class WebSocketServerComponents
extends WebSocketComponents

A collection of components which are the resources needed for websockets such as ByteBufferPool, WebSocketExtensionRegistry, and DecoratedObjectFactory.

These components should be accessed through getWebSocketComponents(ContextHandler) so that the instance can be shared by being stored as a bean on the ContextHandler.

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
static final String	WEBSOCKET_BUFFER_POOL_ATTRIBUTE
static final String	WEBSOCKET_COMPONENTS_ATTRIBUTE
static final String	WEBSOCKET_DEFLATER_POOL_ATTRIBUTE
static final String	WEBSOCKET_INFLATER_POOL_ATTRIBUTE

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Method Summary

Modifier and Type	Method	Description
static WebSocketComponents	ensureWebSocketComponents(Server server)	This ensures a WebSocketComponents is available on the Server attribute WEBSOCKET_COMPONENTS_ATTRIBUTE.
static WebSocketComponents	ensureWebSocketComponents(Server server, ContextHandler contextHandler)	This ensures a WebSocketComponents is available at the ContextHandler attribute WEBSOCKET_COMPONENTS_ATTRIBUTE.
static WebSocketComponents	getWebSocketComponents(ContextHandler contextHandler)
static WebSocketComponents	getWebSocketComponents(Server server)

Methods inherited from class WebSocketComponents

getByteBufferPool, getDeflaterPool, getExecutor, getExtensionRegistry, getInflaterPool, getObjectFactory

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, 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

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Field Details

WEBSOCKET_COMPONENTS_ATTRIBUTE

public static final String WEBSOCKET_COMPONENTS_ATTRIBUTE

WEBSOCKET_INFLATER_POOL_ATTRIBUTE

public static final String WEBSOCKET_INFLATER_POOL_ATTRIBUTE

See Also:

• Constant Field Values

WEBSOCKET_DEFLATER_POOL_ATTRIBUTE

public static final String WEBSOCKET_DEFLATER_POOL_ATTRIBUTE

See Also:

• Constant Field Values

WEBSOCKET_BUFFER_POOL_ATTRIBUTE

public static final String WEBSOCKET_BUFFER_POOL_ATTRIBUTE

See Also:

• Constant Field Values

Method Details

ensureWebSocketComponents

public static WebSocketComponents ensureWebSocketComponents(Server server,
 ContextHandler contextHandler)

This ensures a WebSocketComponents is available at the ContextHandler attribute WEBSOCKET_COMPONENTS_ATTRIBUTE.

This should be called when the server is starting.

Servlet context attributes can be set with WEBSOCKET_BUFFER_POOL_ATTRIBUTE, WEBSOCKET_INFLATER_POOL_ATTRIBUTE and WEBSOCKET_DEFLATER_POOL_ATTRIBUTE to override the ByteBufferPool, DeflaterPool or InflaterPool used by the components, otherwise this will try to use the pools shared on the Server.

Parameters:

server - the server.

contextHandler - the ContextHandler.

Returns:

the WebSocketComponents that was created or found on the ServletContext.

ensureWebSocketComponents

public static WebSocketComponents ensureWebSocketComponents(Server server)

This ensures a WebSocketComponents is available on the Server attribute WEBSOCKET_COMPONENTS_ATTRIBUTE.

This should be called when the server is starting.

Server attributes can be set with WEBSOCKET_BUFFER_POOL_ATTRIBUTE, WEBSOCKET_INFLATER_POOL_ATTRIBUTE and WEBSOCKET_DEFLATER_POOL_ATTRIBUTE to override the ByteBufferPool, DeflaterPool or InflaterPool used by the components, otherwise this will try to use the pools shared on the Server.

Parameters:

server - the server.

Returns:

the WebSocketComponents that was created or found.

getWebSocketComponents

public static WebSocketComponents getWebSocketComponents(ContextHandler contextHandler)

getWebSocketComponents

public static WebSocketComponents getWebSocketComponents(Server server)