Top Description Fields Constructors Methods
jakarta.websocket.server

pack-priv final Class DefaultServerEndpointConfig

extends Object
implements ServerEndpointConfig
Class Inheritance
All Implemented Interfaces
jakarta.websocket.server.ServerEndpointConfig, jakarta.websocket.EndpointConfig
Imports
java.util.Collections, .HashMap, .List, .Map, jakarta.websocket.Decoder, .Encoder, .Endpoint, .Extension
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.
Author
dannycoward

Field Summary

Modifier and TypeField and 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

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

pack-priv
DefaultServerEndpointConfig(Class<? extends Endpoint> endpointClass, String
the URI or URI template.
path)

Creates a server configuration with the given path

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig.Configurator

Returns:

the ServerEndpointConfigurator
getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

Return the ServerEndpointConfigurator

public List<Class<? extends Decoder>>

Returns:

the decoder implementation classes, in an unmodifiable list.
getDecoders()

Implements jakarta.websocket.EndpointConfig.getDecoders.

Return the Decoder implementation classes configured.

public List<Class<? extends Encoder>>

Returns:

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

Implements jakarta.websocket.EndpointConfig.getEncoders.

Return the Encoder implementation classes configured.

public Class<?>

Returns:

the class of the Endpoint.
getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Returns the class of the Endpoint that this configuration configures.

public final List<Extension>
getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Return the websocket extensions configured.

public String

Returns:

the path
getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

Return the path of this server configuration.

public final List<String>
getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Return the websocket subprotocols configured.

public final Map<String, Object>
getUserProperties()

Implements jakarta.websocket.EndpointConfig.getUserProperties.

Editable map of user properties.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

decodersback to summary
private List<Class<? extends Decoder>> decoders
encodersback to summary
private List<Class<? extends Encoder>> encoders
endpointClassback to summary
private Class<?> endpointClass
extensionsback to summary
private List<Extension> extensions
pathback to summary
private String path
serverEndpointConfiguratorback to summary
private ServerEndpointConfig.Configurator serverEndpointConfigurator
subprotocolsback to summary
private List<String> subprotocols
userPropertiesback to summary
private Map<String, Object> userProperties

Constructor Detail

DefaultServerEndpointConfigback to summary
pack-priv DefaultServerEndpointConfig(Class<?> endpointClass, String path, List<String> subprotocols, List<Extension> extensions, List<Class<? extends Encoder>> encoders, List<Class<? extends Decoder>> decoders, ServerEndpointConfig.Configurator serverEndpointConfigurator)
DefaultServerEndpointConfigback to summary
pack-priv DefaultServerEndpointConfig(Class<? extends Endpoint> endpointClass, String path)

Creates a server configuration with the given path

Parameters
path:String

the URI or URI template.

Method Detail

getConfiguratorback to summary
public ServerEndpointConfig.Configurator getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

Return the ServerEndpointConfigurator

Returns:ServerEndpointConfig.Configurator

the ServerEndpointConfigurator

Annotations
@Override
getDecodersback to summary
public List<Class<? extends Decoder>> getDecoders()

Implements jakarta.websocket.EndpointConfig.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.

Returns:List<Class<? extends Decoder>>

the decoder implementation classes, in an unmodifiable list.

Annotations
@Override
getEncodersback to summary
public List<Class<? extends Encoder>> getEncoders()

Implements jakarta.websocket.EndpointConfig.getEncoders.

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

Returns:List<Class<? extends Encoder>>

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

Annotations
@Override
getEndpointClassback to summary
public Class<?> getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Returns the class of the Endpoint that this configuration configures.

Returns:Class<?>

the class of the Endpoint.

Annotations
@Override
getExtensionsback to summary
public final List<Extension> getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Doc from jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Return the websocket extensions configured.

Returns:List<Extension>

the list of extensions, the empty list if none.

Annotations
@Override
getPathback to summary
public String getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

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

Returns:String

the path

Annotations
@Override
getSubprotocolsback to summary
public final List<String> getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Doc from jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Return the websocket subprotocols configured.

Returns:List<String>

the list of subprotocols, the empty list if none

Annotations
@Override
getUserPropertiesback to summary
public final Map<String, Object> getUserProperties()

Implements jakarta.websocket.EndpointConfig.getUserProperties.

Editable map of user properties.

Returns:Map<String, Object>

Doc from jakarta.websocket.EndpointConfig.getUserProperties.

a modifiable Map of application data.

Annotations
@Override