Package org.eclipse.jetty.websocket.jsr356.server

Class ServerContainer

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.jsr356.ClientContainer

org.eclipse.jetty.websocket.jsr356.server.ServerContainer

All Implemented Interfaces:

javax.websocket.server.ServerContainer, javax.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, org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

@ManagedObject("JSR356 Server Container")
public class ServerContainer
extends ClientContainer
implements javax.websocket.server.ServerContainer

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

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

Constructor	Description
ServerContainer(NativeWebSocketConfiguration configuration, Executor executor)	Deprecated. use ServerContainer(NativeWebSocketConfiguration, HttpClient) instead
ServerContainer(NativeWebSocketConfiguration configuration, org.eclipse.jetty.client.HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
void	addEndpoint(Class<?> endpointClass)
void	addEndpoint(javax.websocket.server.ServerEndpointConfig config)
protected void	doStart()
long	getDefaultAsyncSendTimeout()
int	getDefaultMaxBinaryMessageBufferSize()
long	getDefaultMaxSessionIdleTimeout()
int	getDefaultMaxTextMessageBufferSize()
ServerEndpointMetadata	getServerEndpointMetadata(Class<?> endpoint, javax.websocket.server.ServerEndpointConfig config)
static javax.websocket.WebSocketContainer	getWebSocketContainer()	Get the WebSocketContainer out of the current ThreadLocal reference of the active ContextHandler.
WebSocketServerFactory	getWebSocketServerFactory()
EndpointInstance	newClientEndpointInstance(Object endpoint, javax.websocket.server.ServerEndpointConfig config, String path)
void	setAsyncSendTimeout(long ms)
void	setDefaultMaxBinaryMessageBufferSize(int max)
void	setDefaultMaxSessionIdleTimeout(long ms)
void	setDefaultMaxTextMessageBufferSize(int max)
void	upgradeHttpToWebSocket(Object httpServletRequest, Object httpServletResponse, javax.websocket.server.ServerEndpointConfig sec, Map<String,String> pathParameters)

Methods inherited from class org.eclipse.jetty.websocket.jsr356.ClientContainer

addSessionListener, connectToServer, connectToServer, connectToServer, connectToServer, doStop, getBufferPool, getClassLoader, getClient, getClientEndpointMetadata, getDecoderFactory, getEncoderFactory, getExecutor, getInstalledExtensions, getObjectFactory, getOpenSessions, getPolicy, getSessionListeners, getSslContextFactory, newClientEndpointInstance, removeSessionListener

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 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

dumpSelf

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

isDumpable

Methods inherited from interface javax.websocket.WebSocketContainer

connectToServer, connectToServer, connectToServer, connectToServer, getInstalledExtensions

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

isRunning

Field Details

PATH_PARAM_ATTRIBUTE

public static final String PATH_PARAM_ATTRIBUTE

See Also:

• Constant Field Values

Constructor Details

ServerContainer

@Deprecated
public ServerContainer(NativeWebSocketConfiguration configuration,
 Executor executor)

Deprecated.

use ServerContainer(NativeWebSocketConfiguration, HttpClient) instead

Parameters:

configuration - the NativeWebSocketConfiguration to use

executor - not used

ServerContainer

public ServerContainer(NativeWebSocketConfiguration configuration,
 org.eclipse.jetty.client.HttpClient httpClient)

Parameters:

configuration - the NativeWebSocketConfiguration to use

httpClient - the HttpClient instance to use

Method Details

getWebSocketContainer

public static javax.websocket.WebSocketContainer getWebSocketContainer()

Get the WebSocketContainer out of the current ThreadLocal reference of the active ContextHandler.

Returns:

the WebSocketContainer if found, null if not found.

newClientEndpointInstance

public EndpointInstance newClientEndpointInstance(Object endpoint,
 javax.websocket.server.ServerEndpointConfig config,
 String path)

addEndpoint

public void addEndpoint(Class<?> endpointClass)
                 throws javax.websocket.DeploymentException

Specified by:

addEndpoint in interface javax.websocket.server.ServerContainer

Throws:

javax.websocket.DeploymentException

addEndpoint

public void addEndpoint(javax.websocket.server.ServerEndpointConfig config)
                 throws javax.websocket.DeploymentException

Specified by:

addEndpoint in interface javax.websocket.server.ServerContainer

Throws:

javax.websocket.DeploymentException

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class ClientContainer

Throws:

Exception

getServerEndpointMetadata

public ServerEndpointMetadata getServerEndpointMetadata(Class<?> endpoint,
 javax.websocket.server.ServerEndpointConfig config)
                                                 throws javax.websocket.DeploymentException

Throws:

javax.websocket.DeploymentException

getDefaultAsyncSendTimeout

public long getDefaultAsyncSendTimeout()

Specified by:

getDefaultAsyncSendTimeout in interface javax.websocket.WebSocketContainer

Overrides:

getDefaultAsyncSendTimeout in class ClientContainer

getDefaultMaxBinaryMessageBufferSize

public int getDefaultMaxBinaryMessageBufferSize()

Specified by:

getDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer

Overrides:

getDefaultMaxBinaryMessageBufferSize in class ClientContainer

getDefaultMaxSessionIdleTimeout

public long getDefaultMaxSessionIdleTimeout()

Specified by:

getDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer

Overrides:

getDefaultMaxSessionIdleTimeout in class ClientContainer

getDefaultMaxTextMessageBufferSize

public int getDefaultMaxTextMessageBufferSize()

Specified by:

getDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

Overrides:

getDefaultMaxTextMessageBufferSize in class ClientContainer

getWebSocketServerFactory

public WebSocketServerFactory getWebSocketServerFactory()

upgradeHttpToWebSocket

public void upgradeHttpToWebSocket(Object httpServletRequest,
 Object httpServletResponse,
 javax.websocket.server.ServerEndpointConfig sec,
 Map<String,String> pathParameters)
                            throws IOException,
javax.websocket.DeploymentException

Throws:

IOException

javax.websocket.DeploymentException

setAsyncSendTimeout

public void setAsyncSendTimeout(long ms)

Specified by:

setAsyncSendTimeout in interface javax.websocket.WebSocketContainer

Overrides:

setAsyncSendTimeout in class ClientContainer

setDefaultMaxBinaryMessageBufferSize

public void setDefaultMaxBinaryMessageBufferSize(int max)

Specified by:

setDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer

Overrides:

setDefaultMaxBinaryMessageBufferSize in class ClientContainer

setDefaultMaxSessionIdleTimeout

public void setDefaultMaxSessionIdleTimeout(long ms)

Specified by:

setDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer

Overrides:

setDefaultMaxSessionIdleTimeout in class ClientContainer

setDefaultMaxTextMessageBufferSize

public void setDefaultMaxTextMessageBufferSize(int max)

Specified by:

setDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

Overrides:

setDefaultMaxTextMessageBufferSize in class ClientContainer