ServerWebSocketContainer (Undertow 2.1.0.Final API)

java.lang.Object
- io.undertow.websockets.jsr.ServerWebSocketContainer

All Implemented Interfaces:

Closeable, AutoCloseable, javax.websocket.server.ServerContainer, javax.websocket.WebSocketContainer
```
public class ServerWebSocketContainer
extends Object
implements javax.websocket.server.ServerContainer, Closeable
```
ServerContainer implementation which allows to deploy endpoints for a server.

Author:

Norman Maurer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ServerWebSocketContainer.PauseListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ServerWebSocketContainer.PauseListener`

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_WEB_SOCKET_TIMEOUT_SECONDS

static String TIMEOUT

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_WEB_SOCKET_TIMEOUT_SECONDS`
`static String`	`TIMEOUT`

Constructor Summary

Constructors
Constructor and Description
`ServerWebSocketContainer(ClassIntrospecter classIntrospecter, ClassLoader classLoader, Supplier<org.xnio.XnioWorker> xnioWorker, ByteBufferPool bufferPool, List<ThreadSetupHandler> threadSetupHandlers, boolean dispatchToWorker)`
`ServerWebSocketContainer(ClassIntrospecter classIntrospecter, ClassLoader classLoader, Supplier<org.xnio.XnioWorker> xnioWorker, ByteBufferPool bufferPool, List<ThreadSetupHandler> threadSetupHandlers, boolean dispatchToWorker, InetSocketAddress clientBindAddress, WebSocketReconnectHandler reconnectHandler)`
`ServerWebSocketContainer(ClassIntrospecter classIntrospecter, ClassLoader classLoader, Supplier<org.xnio.XnioWorker> xnioWorker, ByteBufferPool bufferPool, List<ThreadSetupHandler> threadSetupHandlers, boolean dispatchToWorker, InetSocketAddress clientBindAddress, WebSocketReconnectHandler reconnectHandler, List<javax.websocket.Extension> installedExtensions)`
`ServerWebSocketContainer(ClassIntrospecter classIntrospecter, Supplier<org.xnio.XnioWorker> xnioWorker, ByteBufferPool bufferPool, List<ThreadSetupHandler> threadSetupHandlers, boolean dispatchToWorker, boolean clientMode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEndpoint(Class<?> endpoint)`
`void`	`addEndpoint(javax.websocket.server.ServerEndpointConfig endpoint)`
`void`	`close()`
`void`	`close(int waitTime)`
`javax.websocket.Session`	`connectToServer(Class<?> aClass, URI uri)`
`javax.websocket.Session`	`connectToServer(Class<?> aClass, WebSocketClient.ConnectionBuilder connectionBuilder)`
`javax.websocket.Session`	`connectToServer(Class<? extends javax.websocket.Endpoint> endpointClass, javax.websocket.ClientEndpointConfig cec, URI path)`
`javax.websocket.Session`	`connectToServer(javax.websocket.Endpoint endpointInstance, javax.websocket.ClientEndpointConfig config, URI path)`
`javax.websocket.Session`	`connectToServer(javax.websocket.Endpoint endpointInstance, javax.websocket.ClientEndpointConfig config, WebSocketClient.ConnectionBuilder connectionBuilder)`
`javax.websocket.Session`	`connectToServer(Object annotatedEndpointInstance, URI path)`
`javax.websocket.Session`	`connectToServer(Object annotatedEndpointInstance, WebSocketClient.ConnectionBuilder connectionBuilder)`
`void`	`deploymentComplete()`
`void`	`doUpgrade(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.websocket.server.ServerEndpointConfig sec, Map<String,String> pathParams)`
`ByteBufferPool`	`getBufferPool()`
`List<ConfiguredServerEndpoint>`	`getConfiguredServerEndpoints()`
`ServletContextImpl`	`getContextToAddFilter()`
`long`	`getDefaultAsyncSendTimeout()`
`int`	`getDefaultMaxBinaryMessageBufferSize()`
`long`	`getDefaultMaxSessionIdleTimeout()`
`int`	`getDefaultMaxTextMessageBufferSize()`
`Set<javax.websocket.Extension>`	`getInstalledExtensions()`
`WebSocketReconnectHandler`	`getWebSocketReconnectHandler()`
`org.xnio.XnioWorker`	`getXnioWorker()`
`void`	`invokeEndpointMethod(Executor executor, Runnable invocation)` Runs a web socket invocation, setting up the threads and dispatching a thread pool
`void`	`invokeEndpointMethod(Runnable invocation)` Directly invokes an endpoint method, without dispatching to an executor
`boolean`	`isClosed()`
`boolean`	`isDispatchToWorker()`
`void`	`pause(ServerWebSocketContainer.PauseListener listener)` Pauses the container
`void`	`resume()` resumes a paused container
`void`	`setAsyncSendTimeout(long defaultAsyncSendTimeout)`
`void`	`setContextToAddFilter(ServletContextImpl contextToAddFilter)`
`void`	`setDefaultMaxBinaryMessageBufferSize(int defaultMaxBinaryMessageBufferSize)`
`void`	`setDefaultMaxSessionIdleTimeout(long timeout)`
`void`	`setDefaultMaxTextMessageBufferSize(int defaultMaxTextMessageBufferSize)`
`void`	`validateDeployment()`

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

Field Detail
- TIMEOUT
```
public static final String TIMEOUT
```
  See Also:
  
  Constant Field Values
- DEFAULT_WEB_SOCKET_TIMEOUT_SECONDS
```
public static final int DEFAULT_WEB_SOCKET_TIMEOUT_SECONDS
```
  See Also:
  
  Constant Field Values

Constructor Detail

ServerWebSocketContainer

public ServerWebSocketContainer(ClassIntrospecter classIntrospecter,
                                Supplier<org.xnio.XnioWorker> xnioWorker,
                                ByteBufferPool bufferPool,
                                List<ThreadSetupHandler> threadSetupHandlers,
                                boolean dispatchToWorker,
                                boolean clientMode)

ServerWebSocketContainer

public ServerWebSocketContainer(ClassIntrospecter classIntrospecter,
                                ClassLoader classLoader,
                                Supplier<org.xnio.XnioWorker> xnioWorker,
                                ByteBufferPool bufferPool,
                                List<ThreadSetupHandler> threadSetupHandlers,
                                boolean dispatchToWorker)

ServerWebSocketContainer

public ServerWebSocketContainer(ClassIntrospecter classIntrospecter,
                                ClassLoader classLoader,
                                Supplier<org.xnio.XnioWorker> xnioWorker,
                                ByteBufferPool bufferPool,
                                List<ThreadSetupHandler> threadSetupHandlers,
                                boolean dispatchToWorker,
                                InetSocketAddress clientBindAddress,
                                WebSocketReconnectHandler reconnectHandler)

ServerWebSocketContainer

public ServerWebSocketContainer(ClassIntrospecter classIntrospecter,
                                ClassLoader classLoader,
                                Supplier<org.xnio.XnioWorker> xnioWorker,
                                ByteBufferPool bufferPool,
                                List<ThreadSetupHandler> threadSetupHandlers,
                                boolean dispatchToWorker,
                                InetSocketAddress clientBindAddress,
                                WebSocketReconnectHandler reconnectHandler,
                                List<javax.websocket.Extension> installedExtensions)

Method Detail

getDefaultAsyncSendTimeout
```
public long getDefaultAsyncSendTimeout()
```
Specified by:

getDefaultAsyncSendTimeout in interface javax.websocket.WebSocketContainer

setAsyncSendTimeout
```
public void setAsyncSendTimeout(long defaultAsyncSendTimeout)
```
Specified by:

setAsyncSendTimeout in interface javax.websocket.WebSocketContainer

connectToServer

public javax.websocket.Session connectToServer(Object annotatedEndpointInstance,
                                               WebSocketClient.ConnectionBuilder connectionBuilder)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(Object annotatedEndpointInstance,
                                               URI path)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Specified by:: connectToServer in interface javax.websocket.WebSocketContainer
Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(Class<?> aClass,
                                               WebSocketClient.ConnectionBuilder connectionBuilder)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(Class<?> aClass,
                                               URI uri)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Specified by:: connectToServer in interface javax.websocket.WebSocketContainer
Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(javax.websocket.Endpoint endpointInstance,
                                               javax.websocket.ClientEndpointConfig config,
                                               URI path)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Specified by:: connectToServer in interface javax.websocket.WebSocketContainer
Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(javax.websocket.Endpoint endpointInstance,
                                               javax.websocket.ClientEndpointConfig config,
                                               WebSocketClient.ConnectionBuilder connectionBuilder)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Throws:: javax.websocket.DeploymentException; IOException

connectToServer

public javax.websocket.Session connectToServer(Class<? extends javax.websocket.Endpoint> endpointClass,
                                               javax.websocket.ClientEndpointConfig cec,
                                               URI path)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Specified by:: connectToServer in interface javax.websocket.WebSocketContainer
Throws:: javax.websocket.DeploymentException; IOException

doUpgrade

public void doUpgrade(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.websocket.server.ServerEndpointConfig sec,
                      Map<String,String> pathParams)
               throws javax.servlet.ServletException,
                      IOException

Throws:: javax.servlet.ServletException; IOException

getDefaultMaxSessionIdleTimeout
```
public long getDefaultMaxSessionIdleTimeout()
```
Specified by:

getDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer

setDefaultMaxSessionIdleTimeout
```
public void setDefaultMaxSessionIdleTimeout(long timeout)
```
Specified by:

setDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer

getDefaultMaxBinaryMessageBufferSize
```
public int getDefaultMaxBinaryMessageBufferSize()
```
Specified by:

getDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer

setDefaultMaxBinaryMessageBufferSize
```
public void setDefaultMaxBinaryMessageBufferSize(int defaultMaxBinaryMessageBufferSize)
```
Specified by:

setDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer

getDefaultMaxTextMessageBufferSize
```
public int getDefaultMaxTextMessageBufferSize()
```
Specified by:

getDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

setDefaultMaxTextMessageBufferSize
```
public void setDefaultMaxTextMessageBufferSize(int defaultMaxTextMessageBufferSize)
```
Specified by:

setDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

getInstalledExtensions
```
public Set<javax.websocket.Extension> getInstalledExtensions()
```
Specified by:

getInstalledExtensions in interface javax.websocket.WebSocketContainer

invokeEndpointMethod
```
public void invokeEndpointMethod(Executor executor,
                                 Runnable invocation)
```
Runs a web socket invocation, setting up the threads and dispatching a thread pool
Unfortunately we need to dispatch to a thread pool, because there is a good chance that the endpoint will use blocking IO methods. We suspend recieves while this is in progress, to make sure that we do not have multiple methods invoked at once.

Parameters:

invocation - The task to run

invokeEndpointMethod
```
public void invokeEndpointMethod(Runnable invocation)
```
Directly invokes an endpoint method, without dispatching to an executor

Parameters:

invocation - The invocation

addEndpoint
```
public void addEndpoint(Class<?> endpoint)
                 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 endpoint)
                 throws javax.websocket.DeploymentException

Specified by:: addEndpoint in interface javax.websocket.server.ServerContainer
Throws:: javax.websocket.DeploymentException

validateDeployment
```
public void validateDeployment()
```

deploymentComplete
```
public void deploymentComplete()
```

getConfiguredServerEndpoints

public List<ConfiguredServerEndpoint> getConfiguredServerEndpoints()

getContextToAddFilter

public ServletContextImpl getContextToAddFilter()

setContextToAddFilter

public void setContextToAddFilter(ServletContextImpl contextToAddFilter)

close
```
public void close(int waitTime)
```

close
```
public void close()
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getBufferPool
```
public ByteBufferPool getBufferPool()
```

getXnioWorker

public org.xnio.XnioWorker getXnioWorker()

pause

public void pause(ServerWebSocketContainer.PauseListener listener)

Pauses the container

Parameters:: listener -

resume
```
public void resume()
```
resumes a paused container

getWebSocketReconnectHandler

public WebSocketReconnectHandler getWebSocketReconnectHandler()

isClosed
```
public boolean isClosed()
```

isDispatchToWorker
```
public boolean isDispatchToWorker()
```

Class ServerWebSocketContainer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIMEOUT

DEFAULT_WEB_SOCKET_TIMEOUT_SECONDS

Constructor Detail

ServerWebSocketContainer

ServerWebSocketContainer

ServerWebSocketContainer

ServerWebSocketContainer

Method Detail

getDefaultAsyncSendTimeout

setAsyncSendTimeout

connectToServer

connectToServer

connectToServer

connectToServer

connectToServer

connectToServer

connectToServer

doUpgrade

getDefaultMaxSessionIdleTimeout

setDefaultMaxSessionIdleTimeout

getDefaultMaxBinaryMessageBufferSize

setDefaultMaxBinaryMessageBufferSize

getDefaultMaxTextMessageBufferSize

setDefaultMaxTextMessageBufferSize

getInstalledExtensions

invokeEndpointMethod

invokeEndpointMethod

addEndpoint

addEndpoint

validateDeployment

deploymentComplete

getConfiguredServerEndpoints

getContextToAddFilter

setContextToAddFilter

close

close

getBufferPool

getXnioWorker

pause

resume

getWebSocketReconnectHandler

isClosed

isDispatchToWorker