public Class ServerEndpointConfigWrapper

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

Doc from jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

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.

Returns:ServerEndpointConfig.Configurator

the configurator in use.

Annotations

@Override

Implements jakarta.websocket.EndpointConfig.getDecoders.

Doc from jakarta.websocket.EndpointConfig.getDecoders.

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.

Returns:List<Class<? extends Decoder>>

the decoder implementation classes, the empty list if none.

Annotations

@Override

Implements jakarta.websocket.EndpointConfig.getEncoders.

Doc from jakarta.websocket.EndpointConfig.getEncoders.

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.

Returns:List<Class<? extends Encoder>>

the encoder implementation classes, an empty list if none.

Annotations

@Override

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Doc from jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

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.

Returns:Class<?>

the class of the endpoint, annotated or programmatic.

Annotations

@Override

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

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

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

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 "/".

Returns:String

the relative path for this configuration.

Annotations

@Override

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

Implements jakarta.websocket.EndpointConfig.getUserProperties.

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

Returns:Map<String, Object>

a modifiable Map of application data.

Annotations

@Override

Get the wrapped ServerEndpointConfig.

Returns:ServerEndpointConfig

the wrapped ServerEndpointConfig.