Tyrus 2.2.0 · org.glassfish.tyrus.server.TyrusServerConfiguration

Modifier and Type	Field and Description
private final Set<Class<?>>	annotatedClasses
private static final Logger	LOGGER
private final Set<ServerEndpointConfig>	serverEndpointConfigs

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	TyrusServerConfiguration(Set<Class<?>> classes to be included in this application instance. Can contain any combination of annotated endpoints (see `ServerEndpoint`). Cannot be `null`. classes, Set<ServerEndpointConfig> List of instances of `ServerEndpointConfig` to be deployed. serverEndpointConfigs) Create new `TyrusServerConfiguration`.
public	TyrusServerConfiguration(Set<Class<?>> classes to be included in this application instance. Can contain any combination of annotated endpoints (see `ServerEndpoint`). classes, Set<Class<?>> dynamically deployed classes. See `.ServerContainer#addEndpoint(Class)`. dynamicallyAddedClasses, Set<ServerEndpointConfig> List of instances of `ServerEndpointConfig` to be deployed. serverEndpointConfigs, ErrorCollector model errors are reported to this instance. Cannot be `null`. errorCollector) Create new `TyrusServerConfiguration`.

public

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

classes, Set<ServerEndpointConfig>

List of instances of ServerEndpointConfig to be deployed.

serverEndpointConfigs)

Create new TyrusServerConfiguration.

public

TyrusServerConfiguration(Set<Class<?>>

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

classes, Set<Class<?>>

dynamically deployed classes. See .ServerContainer#addEndpoint(Class).

dynamicallyAddedClasses, Set<ServerEndpointConfig>

List of instances of ServerEndpointConfig to be deployed.

serverEndpointConfigs, ErrorCollector

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

errorCollector)

Create new TyrusServerConfiguration.

Method Summary

Modifier and Type	Method and Description
public Set<Class<?>>	Returns: all the classes annotated with `ServerEndpoint` annotation which should be deployed. getAnnotatedEndpointClasses(Set<Class<?>> is unused. scanned) Implements jakarta.websocket.server.ServerApplicationConfig.getAnnotatedEndpointClasses. Gets all the classes annotated with `ServerEndpoint` annotation which should be deployed.
public Set<ServerEndpointConfig>	Returns: all the `ServerEndpointConfig` classes which should be deployed. getEndpointConfigs(Set<Class<? extends Endpoint>> is unused. scanned) Implements jakarta.websocket.server.ServerApplicationConfig.getEndpointConfigs. Gets all the `ServerEndpointConfig` classes which should be deployed.
private boolean	isAbstract(Class<?> clazz, ErrorCollector errorCollector)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotatedClasses	back to summary
private final Set<Class<?>> annotatedClasses

LOGGER	back to summary
private static final Logger LOGGER

serverEndpointConfigs	back to summary
private final Set<ServerEndpointConfig> serverEndpointConfigs

Constructor Detail

TyrusServerConfiguration back to summary

TyrusServerConfiguration	back to summary
public TyrusServerConfiguration(Set<Class<?>> classes, Set<ServerEndpointConfig> serverEndpointConfigs) Create new `TyrusServerConfiguration`. Parameters classes:Set<Class<?>> classes to be included in this application instance. Can contain any combination of annotated endpoints (see `ServerEndpoint`). Cannot be `null`. serverEndpointConfigs:Set<ServerEndpointConfig> List of instances of `ServerEndpointConfig` to be deployed. Exceptions IllegalArgumentException: when any of the arguments is `null`.

public TyrusServerConfiguration(Set<Class<?>> classes, Set<ServerEndpointConfig> serverEndpointConfigs)

Create new TyrusServerConfiguration.

Parameters

classes:Set<Class<?>>: classes to be included in this application instance. Can contain any combination of annotated endpoints (see ServerEndpoint). Cannot be null.
serverEndpointConfigs:Set<ServerEndpointConfig>: List of instances of ServerEndpointConfig to be deployed.

Exceptions

IllegalArgumentException:: when any of the arguments is null.

TyrusServerConfiguration back to summary

TyrusServerConfiguration	back to summary
public TyrusServerConfiguration(Set<Class<?>> classes, Set<Class<?>> dynamicallyAddedClasses, Set<ServerEndpointConfig> serverEndpointConfigs, ErrorCollector errorCollector) Create new `TyrusServerConfiguration`. Parameters classes:Set<Class<?>> classes to be included in this application instance. Can contain any combination of annotated endpoints (see `ServerEndpoint`). dynamicallyAddedClasses:Set<Class<?>> dynamically deployed classes. See `.ServerContainer#addEndpoint(Class)`. serverEndpointConfigs:Set<ServerEndpointConfig> List of instances of `ServerEndpointConfig` to be deployed. errorCollector:ErrorCollector model errors are reported to this instance. Cannot be `null`. Exceptions IllegalArgumentException: when any of the arguments is `null`.

public TyrusServerConfiguration(Set<Class<?>> classes, Set<Class<?>> dynamicallyAddedClasses, Set<ServerEndpointConfig> serverEndpointConfigs, ErrorCollector errorCollector)

Create new TyrusServerConfiguration.

Parameters

classes:Set<Class<?>>: classes to be included in this application instance. Can contain any combination of annotated endpoints (see ServerEndpoint).
dynamicallyAddedClasses:Set<Class<?>>: dynamically deployed classes. See .ServerContainer#addEndpoint(Class).
serverEndpointConfigs:Set<ServerEndpointConfig>: List of instances of ServerEndpointConfig to be deployed.
errorCollector:ErrorCollector: model errors are reported to this instance. Cannot be null.

Exceptions

IllegalArgumentException:: when any of the arguments is null.

Method Detail

getAnnotatedEndpointClasses back to summary

getAnnotatedEndpointClasses	back to summary
public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) Implements jakarta.websocket.server.ServerApplicationConfig.getAnnotatedEndpointClasses. Gets all the classes annotated with `ServerEndpoint` annotation which should be deployed. Parameters scanned:Set<Class<?>> is unused. Returns:Set<Class<?>> all the classes annotated with `ServerEndpoint` annotation which should be deployed. Annotations @Override

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

Implements jakarta.websocket.server.ServerApplicationConfig.getAnnotatedEndpointClasses.

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

Parameters

scanned:Set<Class<?>>: is unused.

Returns:Set<Class<?>>

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

Annotations

@Override

getEndpointConfigs back to summary

getEndpointConfigs	back to summary
public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> scanned) Implements jakarta.websocket.server.ServerApplicationConfig.getEndpointConfigs. Gets all the `ServerEndpointConfig` classes which should be deployed. Parameters scanned:Set<Class<? extends Endpoint>> is unused. Returns:Set<ServerEndpointConfig> all the `ServerEndpointConfig` classes which should be deployed. Annotations @Override

public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> scanned)

Implements jakarta.websocket.server.ServerApplicationConfig.getEndpointConfigs.

Gets all the ServerEndpointConfig classes which should be deployed.

Parameters

scanned:Set<Class<? extends Endpoint>>: is unused.

Returns:Set<ServerEndpointConfig>

all the ServerEndpointConfig classes which should be deployed.

Annotations

@Override

isAbstract	back to summary
private boolean isAbstract(Class<?> clazz, ErrorCollector errorCollector)

public Class TyrusServerConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail