Top Description Fields Constructors Methods
org.apache.tomcat.websocket.server

pack-priv Class WsPerSessionServerEndpointConfig

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, jakarta.websocket.server.ServerEndpointConfig
Wraps the provided ServerEndpointConfig and provides a per session view - the difference being that the map returned by getUserProperties() is unique to this instance rather than shared with the wrapped ServerEndpointConfig.

Field Summary

Modifier and TypeField and Description
private final ServerEndpointConfig
perEndpointConfig

private final Map<String, Object>
perSessionUserProperties

Constructor Summary

AccessConstructor and Description
pack-priv
WsPerSessionServerEndpointConfig(ServerEndpointConfig perEndpointConfig)

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

perEndpointConfigback to summary
private final ServerEndpointConfig perEndpointConfig
perSessionUserPropertiesback to summary
private final Map<String, Object> perSessionUserProperties

Constructor Detail

WsPerSessionServerEndpointConfigback to summary
pack-priv WsPerSessionServerEndpointConfig(ServerEndpointConfig perEndpointConfig)

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