Package org.glassfish.tyrus.core

Class ServerEndpointConfigWrapper

java.lang.Object

org.glassfish.tyrus.core.ServerEndpointConfigWrapper

All Implemented Interfaces:

EndpointConfig, ServerEndpointConfig

public class ServerEndpointConfigWrapper
extends Object
implements ServerEndpointConfig

A public class that holds a wrapped ServerEndpointConfig.

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.server.ServerEndpointConfig

ServerEndpointConfig.Builder, ServerEndpointConfig.Configurator

Field Summary

Fields

Modifier and Type	Field	Description
protected final ServerEndpointConfig	wrapped

Method Summary

Modifier and Type	Method	Description
ServerEndpointConfig.Configurator	getConfigurator()	Return the ServerEndpointConfig.Configurator this configuration is using.
List<Class<? extends Decoder>>	getDecoders()	Return the Decoder implementation classes configured.
List<Class<? extends Encoder>>	getEncoders()	Return the Encoder implementation classes configured.
Class<?>	getEndpointClass()	Returns the Class of the endpoint this configuration is configuring.
List<Extension>	getExtensions()	Return the websocket extensions configured.
String	getPath()	Return the path for this endpoint configuration.
List<String>	getSubprotocols()	Return the websocket subprotocols configured.
Map<String,Object>	getUserProperties()	This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance.
ServerEndpointConfig	getWrapped()	Get the wrapped ServerEndpointConfig.

Methods inherited from class java.lang.Object

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

Field Details

wrapped

protected final ServerEndpointConfig wrapped

Method Details

getEndpointClass

public Class<?> getEndpointClass()

Description copied from interface: ServerEndpointConfig

Returns the Class of the endpoint this configuration is configuring. If the endpoint is an annotated endpoint, the value is the class of the Java class annotated with @ServerEndpoint. if the endpoint is a programmatic, the value is the class of the subclass of Endpoint.

Specified by:

getEndpointClass in interface ServerEndpointConfig

Returns:

the class of the endpoint, annotated or programmatic.

getPath

public String getPath()

Description copied from interface: ServerEndpointConfig

Return the path for this endpoint configuration. The path is the URI or URI-template (level 1) relative to the websocket root of the server to which the endpoint using this configuration will be mapped. The path is always non-null and always begins with a leading "/".

Specified by:

getPath in interface ServerEndpointConfig

Returns:

the relative path for this configuration.

getSubprotocols

public List<String> getSubprotocols()

Description copied from interface: ServerEndpointConfig

Return the websocket subprotocols configured.

Specified by:

getSubprotocols in interface ServerEndpointConfig

Returns:

the list of subprotocols, the empty list if none

getExtensions

public List<Extension> getExtensions()

Description copied from interface: ServerEndpointConfig

Return the websocket extensions configured.

Specified by:

getExtensions in interface ServerEndpointConfig

Returns:

the list of extensions, the empty list if none.

getConfigurator

public ServerEndpointConfig.Configurator getConfigurator()

Description copied from interface: ServerEndpointConfig

Return the ServerEndpointConfig.Configurator this configuration is using. If none was set by calling ServerEndpointConfig.Builder.configurator(jakarta.websocket.server.ServerEndpointConfig.Configurator) this methods returns the platform default configurator.

Specified by:

getConfigurator in interface ServerEndpointConfig

Returns:

the configurator in use.

getEncoders

public List<Class<? extends Encoder>> getEncoders()

Description copied from interface: EndpointConfig

Return the Encoder implementation classes configured. These will be instantiated by the container to encode custom objects passed into the send() methods on remote endpoints.

Specified by:

getEncoders in interface EndpointConfig

Returns:

the encoder implementation classes, an empty list if none.

getDecoders

public List<Class<? extends Decoder>> getDecoders()

Description copied from interface: EndpointConfig

Return the Decoder implementation classes configured. These will be instantiated by the container to decode incoming messages into the expected custom objects on MessageHandler.Whole.onMessage(Object) callbacks.

Specified by:

getDecoders in interface EndpointConfig

Returns:

the decoder implementation classes, the empty list if none.

getUserProperties

public Map<String,Object> getUserProperties()

Description copied from interface: EndpointConfig

This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance. Web socket applications running on distributed implementations of the web container should make any application specific objects stored here java.io.Serializable, or the object may not be recreated after a failover.

Specified by:

getUserProperties in interface EndpointConfig

Returns:

a modifiable Map of application data.

getWrapped

public ServerEndpointConfig getWrapped()

Get the wrapped ServerEndpointConfig.

Returns:

the wrapped ServerEndpointConfig.