org.glassfish.tyrus.server

Class TyrusServerContainer

java.lang.Object

org.glassfish.tyrus.websockets.ExecutorServiceProvider

org.glassfish.tyrus.core.BaseContainer

org.glassfish.tyrus.server.TyrusServerContainer

All Implemented Interfaces:

javax.websocket.WebSocketContainer

public class TyrusServerContainer
extends BaseContainer
implements javax.websocket.WebSocketContainer

Server Container Implementation.

Author:

Martin Matula (martin.matula at oracle.com), Pavel Bucek (pavel.bucek at oracle.com), Stepan Kopriva (stepan.kopriva at oracle.com)

Constructor Summary

Constructors

Constructor and Description
TyrusServerContainer(org.glassfish.tyrus.spi.TyrusServer server, String contextPath, Set<Class<?>> classes, Set<Class<?>> dynamicallyAddedClasses, Set<javax.websocket.server.ServerEndpointConfig> dynamicallyAddedEndpointConfigs) Create new TyrusServerContainer.

Method Summary

Methods

Modifier and Type	Method and Description
javax.websocket.Session	connectToServer(Class<? extends javax.websocket.Endpoint> endpointClass, javax.websocket.ClientEndpointConfig cec, URI path)
javax.websocket.Session	connectToServer(Class annotatedEndpointClass, URI path)
javax.websocket.Session	connectToServer(javax.websocket.Endpoint endpointInstance, javax.websocket.ClientEndpointConfig cec, URI path)
javax.websocket.Session	connectToServer(Object annotatedEndpointInstance, URI path)
long	getDefaultAsyncSendTimeout()
int	getDefaultMaxBinaryMessageBufferSize()
long	getDefaultMaxSessionIdleTimeout()
int	getDefaultMaxTextMessageBufferSize()
Set<javax.websocket.Extension>	getInstalledExtensions()
void	setAsyncSendTimeout(long timeoutmillis)
void	setDefaultMaxBinaryMessageBufferSize(int max)
void	setDefaultMaxSessionIdleTimeout(long defaultMaxSessionIdleTimeout)
void	setDefaultMaxTextMessageBufferSize(int max)
void	start() Start container.
void	stop() Undeploy all endpoints and stop underlying TyrusServer.

Methods inherited from class org.glassfish.tyrus.core.BaseContainer

getExecutorService, getScheduledExecutorService

Methods inherited from class java.lang.Object

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

Constructor Detail

TyrusServerContainer

public TyrusServerContainer(org.glassfish.tyrus.spi.TyrusServer server,
                    String contextPath,
                    Set<Class<?>> classes,
                    Set<Class<?>> dynamicallyAddedClasses,
                    Set<javax.websocket.server.ServerEndpointConfig> dynamicallyAddedEndpointConfigs)

Create new TyrusServerContainer.

Parameters:

server - underlying server.

contextPath - context path of current application.

classes - classes to be included in this application instance. Can contain any combination of annotated endpoints (see ServerEndpoint) or Endpoint descendants.

dynamicallyAddedClasses - dynamically deployed classes. See ServerContainer.addEndpoint(Class).

dynamicallyAddedEndpointConfigs - dynamically deployed ServerEndpointConfigs. See ServerContainer.addEndpoint(ServerEndpointConfig).

Method Detail

start

public void start()
           throws IOException,
                  javax.websocket.DeploymentException

Start container.

Throws:

IOException - when any IO related issues emerge during TyrusServer.start().

javax.websocket.DeploymentException - when any deployment related error is found; should contain list of all found issues.

stop

public void stop()

Undeploy all endpoints and stop underlying TyrusServer.

connectToServer

public javax.websocket.Session connectToServer(Class annotatedEndpointClass,
                                      URI path)
                                        throws javax.websocket.DeploymentException

Specified by:

connectToServer in interface javax.websocket.WebSocketContainer

Throws:

javax.websocket.DeploymentException

connectToServer

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

Specified by:

connectToServer in interface javax.websocket.WebSocketContainer

Throws:

javax.websocket.DeploymentException

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(javax.websocket.Endpoint endpointInstance,
                                      javax.websocket.ClientEndpointConfig cec,
                                      URI path)
                                        throws javax.websocket.DeploymentException,
                                               IOException

Specified by:

connectToServer in interface javax.websocket.WebSocketContainer

Throws:

javax.websocket.DeploymentException

IOException

getDefaultMaxBinaryMessageBufferSize

public int getDefaultMaxBinaryMessageBufferSize()

Specified by:

getDefaultMaxBinaryMessageBufferSize in interface javax.websocket.WebSocketContainer

setDefaultMaxBinaryMessageBufferSize

public void setDefaultMaxBinaryMessageBufferSize(int max)

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 max)

Specified by:

setDefaultMaxTextMessageBufferSize in interface javax.websocket.WebSocketContainer

getInstalledExtensions

public Set<javax.websocket.Extension> getInstalledExtensions()

Specified by:

getInstalledExtensions in interface javax.websocket.WebSocketContainer

getDefaultAsyncSendTimeout

public long getDefaultAsyncSendTimeout()

Specified by:

getDefaultAsyncSendTimeout in interface javax.websocket.WebSocketContainer

setAsyncSendTimeout

public void setAsyncSendTimeout(long timeoutmillis)

Specified by:

setAsyncSendTimeout in interface javax.websocket.WebSocketContainer

getDefaultMaxSessionIdleTimeout

public long getDefaultMaxSessionIdleTimeout()

Specified by:

getDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer

setDefaultMaxSessionIdleTimeout

public void setDefaultMaxSessionIdleTimeout(long defaultMaxSessionIdleTimeout)

Specified by:

setDefaultMaxSessionIdleTimeout in interface javax.websocket.WebSocketContainer