org.glassfish.tyrus.server

Class TyrusServerConfiguration

java.lang.Object

org.glassfish.tyrus.server.TyrusServerConfiguration

All Implemented Interfaces:

javax.websocket.server.ServerApplicationConfiguration

public class TyrusServerConfiguration
extends Object
implements javax.websocket.server.ServerApplicationConfiguration

Container for either deployed ServerApplicationConfigurations, if any, or deployed classes.

Author:

Stepan Kopriva (stepan.kopriva at oracle.com)

Constructor Summary

Constructors

Constructor and Description
TyrusServerConfiguration(Set<Class<?>> classes, Set<javax.websocket.server.ServerEndpointConfiguration> serverEndpointConfigurations) Create new TyrusServerConfiguration.
TyrusServerConfiguration(Set<Class<?>> classes, Set<javax.websocket.server.ServerEndpointConfiguration> serverEndpointConfigurations, ErrorCollector errorCollector) Create new TyrusServerConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
Set<Class<?>>	getAnnotatedEndpointClasses(Set<Class<?>> scanned) Gets all the classes annotated with ServerEndpoint annotation which should be deployed.
Set<javax.websocket.server.ServerEndpointConfiguration>	getEndpointConfigurations(Set<Class<? extends javax.websocket.Endpoint>> scanned) Gets all the ServerEndpointConfiguration classes which should be deployed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TyrusServerConfiguration

public TyrusServerConfiguration(Set<Class<?>> classes,
                        Set<javax.websocket.server.ServerEndpointConfiguration> serverEndpointConfigurations)

Create new TyrusServerConfiguration.

Parameters:

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

serverEndpointConfigurations - List of instances of ServerEndpointConfiguration to be deployed.

Throws:

IllegalArgumentException - when any of the arguments is null.

TyrusServerConfiguration

public TyrusServerConfiguration(Set<Class<?>> classes,
                        Set<javax.websocket.server.ServerEndpointConfiguration> serverEndpointConfigurations,
                        ErrorCollector errorCollector)

Create new TyrusServerConfiguration.

Parameters:

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

serverEndpointConfigurations - List of instances of ServerEndpointConfiguration to be deployed.

errorCollector - model errors are reported to this instance. Cannot be null.

Throws:

IllegalArgumentException - when any of the arguments is null.

Method Detail

getEndpointConfigurations

public Set<javax.websocket.server.ServerEndpointConfiguration> getEndpointConfigurations(Set<Class<? extends javax.websocket.Endpoint>> scanned)

Gets all the ServerEndpointConfiguration classes which should be deployed.

Specified by:

getEndpointConfigurations in interface javax.websocket.server.ServerApplicationConfiguration

Parameters:

scanned - is unused.

Returns:

all the ServerEndpointConfiguration classes which should be deployed.

getAnnotatedEndpointClasses

public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned)

Gets all the classes annotated with ServerEndpoint annotation which should be deployed.

Specified by:

getAnnotatedEndpointClasses in interface javax.websocket.server.ServerApplicationConfiguration

Parameters:

scanned - is unused.

Returns:

all the classes annotated with ServerEndpoint annotation which should be deployed.