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.List, .Map, java.util.concurrent.ConcurrentHashMap, jakarta.websocket.Decoder, .Encoder, .Extension
Provides the default configuration for WebSocket server endpoints.

Field Summary

Modifier and TypeField and Description
private final List<Class<? extends Decoder>>
decoders

private final List<Class<? extends Encoder>>
encoders

private final Class<?>
endpointClass

private final List<Extension>
extensions

private final String
path

private final ServerEndpointConfig.Configurator
serverEndpointConfigurator

private final List<String>
subprotocols

private final 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)

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig.Configurator
getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

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

Implements jakarta.websocket.EndpointConfig.getDecoders.

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

Implements jakarta.websocket.EndpointConfig.getEncoders.

public Class<?>
getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

public List<Extension>
getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

public String
getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

Returns the path at which this WebSocket server endpoint has been registered.

public List<String>
getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

public Map<String, Object>
getUserProperties()

Implements jakarta.websocket.EndpointConfig.getUserProperties.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

decodersback to summary
private final List<Class<? extends Decoder>> decoders
encodersback to summary
private final List<Class<? extends Encoder>> encoders
endpointClassback to summary
private final Class<?> endpointClass
extensionsback to summary
private final List<Extension> extensions
pathback to summary
private final String path
serverEndpointConfiguratorback to summary
private final ServerEndpointConfig.Configurator serverEndpointConfigurator
subprotocolsback to summary
private final List<String> subprotocols
userPropertiesback to summary
private final 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)

Method Detail

getConfiguratorback to summary
public ServerEndpointConfig.Configurator getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

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

Implements jakarta.websocket.EndpointConfig.getDecoders.

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

Implements jakarta.websocket.EndpointConfig.getEncoders.

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

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

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

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Annotations
@Override
getPathback to summary
public String getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

Doc from jakarta.websocket.server.ServerEndpointConfig.getPath.

Returns the path at which this WebSocket server endpoint has been registered. It may be a path or a level 0 URI template.

Returns:String

The registered path

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

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

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

Implements jakarta.websocket.EndpointConfig.getUserProperties.

Annotations
@Override