Class DefaultServerEndpointConfig

java.lang.Object

javax.websocket.server.DefaultServerEndpointConfig

All Implemented Interfaces:

EndpointConfig, ServerEndpointConfig

final class DefaultServerEndpointConfig
extends Object
implements ServerEndpointConfig

The DefaultServerEndpointConfig is a concrete class that embodies all the configuration parameters for an endpoint that is to be published as a server endpoint. Developers may subclass this class in order to override the configuration behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface ServerEndpointConfig

ServerEndpointConfig.Builder, ServerEndpointConfig.Configurator

Field Summary

Fields

Modifier and Type	Field	Description
private List<Class<? extends Decoder>>	decoders
private List<Class<? extends Encoder>>	encoders
private Class<?>	endpointClass
private List<Extension>	extensions
private String	path
private ServerEndpointConfig.Configurator	serverEndpointConfigurator
private List<String>	subprotocols
private Map<String,Object>	userProperties

Constructor Summary

Constructors

Constructor	Description
DefaultServerEndpointConfig(Class<?> endpointClass, String path, List<String> subprotocols, List<Extension> extensions, List<Class<? extends Encoder>> encoders, List<Class<? extends Decoder>> decoders, ServerEndpointConfig.Configurator serverEndpointConfigurator)
DefaultServerEndpointConfig(Class<? extends Endpoint> endpointClass, String path)	Creates a server configuration with the given path

Method Summary

Modifier and Type	Method	Description
ServerEndpointConfig.Configurator	getConfigurator()	Return the ServerEndpointConfigurator
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 that this configuration configures.
final List<Extension>	getExtensions()	Return the websocket extensions configured.
String	getPath()	Return the path of this server configuration.
final List<String>	getSubprotocols()	Return the websocket subprotocols configured.
final Map<String,Object>	getUserProperties()	Editable map of user properties.

Methods inherited from class Object

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

Field Details

path

private String path

endpointClass

private Class<?> endpointClass

subprotocols

private List<String> subprotocols

extensions

private List<Extension> extensions

encoders

private List<Class<? extends Encoder>> encoders

decoders

private List<Class<? extends Decoder>> decoders

userProperties

private Map<String,Object> userProperties

serverEndpointConfigurator

private ServerEndpointConfig.Configurator serverEndpointConfigurator

Constructor Details

DefaultServerEndpointConfig

DefaultServerEndpointConfig(Class<?> endpointClass,
 String path,
 List<String> subprotocols,
 List<Extension> extensions,
 List<Class<? extends Encoder>> encoders,
 List<Class<? extends Decoder>> decoders,
 ServerEndpointConfig.Configurator serverEndpointConfigurator)

DefaultServerEndpointConfig

DefaultServerEndpointConfig(Class<? extends Endpoint> endpointClass,
 String path)

Creates a server configuration with the given path

Parameters:

path - the URI or URI template.

Method Details

getEndpointClass

public Class<?> getEndpointClass()

Returns the class of the Endpoint that this configuration configures.

Specified by:

getEndpointClass in interface ServerEndpointConfig

Returns:

the class of the Endpoint.

getEncoders

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

Return the Encoder implementation classes configured. These will be used by the container to encode outgoing messages.

Specified by:

getEncoders in interface EndpointConfig

Returns:

the encoder implementation classes, in an unmodifiable list, empty if there are none.

getDecoders

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

Return the Decoder implementation classes configured. These will be used by the container to decode incoming messages into the expected custom objects on MessageHandler callbacks.

Specified by:

getDecoders in interface EndpointConfig

Returns:

the decoder implementation classes, in an unmodifiable list.

getPath

public String getPath()

Return the path of this server configuration. The path is a relative URI or URI-template.

Specified by:

getPath in interface ServerEndpointConfig

Returns:

the path

getConfigurator

public ServerEndpointConfig.Configurator getConfigurator()

Return the ServerEndpointConfigurator

Specified by:

getConfigurator in interface ServerEndpointConfig

Returns:

the ServerEndpointConfigurator

getUserProperties

public final Map<String,Object> getUserProperties()

Editable map of user properties.

Specified by:

getUserProperties in interface EndpointConfig

Returns:

a modifiable Map of application data.

getSubprotocols

public final 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 final 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.