Top Fields Constructors Methods
org.eclipse.jetty.ee10.websocket.jakarta.common

public abstract Class EndpointConfigWrapper

extends Object
implements EndpointConfig, PathParamProvider
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.ee10.websocket.jakarta.common.PathParamProvider, jakarta.websocket.EndpointConfig
Known Direct Subclasses
org.eclipse.jetty.ee10.websocket.jakarta.common.ServerEndpointConfigWrapper, org.eclipse.jetty.ee10.websocket.jakarta.common.ClientEndpointConfigWrapper
Imports
java.util.Collections, .List, .Map, jakarta.websocket.Decoder, .Encoder, .EndpointConfig

Field Summary

Modifier and TypeField and Description
private EndpointConfig
_endpointConfig

private Map<String, String>
_pathParameters

Constructor Summary

AccessConstructor and Description
public
EndpointConfigWrapper()

public
EndpointConfigWrapper(EndpointConfig endpointConfig)

Method Summary

Modifier and TypeMethod and Description
public List<Class<? extends Decoder>>
getDecoders()

Implements jakarta.websocket.EndpointConfig.getDecoders.

Return the Decoder implementation classes configured.

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

Implements jakarta.websocket.EndpointConfig.getEncoders.

Return the Encoder implementation classes configured.

public Map<String, String>
getPathParams()

Implements org.eclipse.jetty.ee10.websocket.jakarta.common.PathParamProvider.getPathParams.

public Map<String, Object>
getUserProperties()

Implements 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.

public void
init(EndpointConfig endpointConfig)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_endpointConfigback to summary
private EndpointConfig _endpointConfig
_pathParametersback to summary
private Map<String, String> _pathParameters

Constructor Detail

EndpointConfigWrapperback to summary
public EndpointConfigWrapper()
EndpointConfigWrapperback to summary
public EndpointConfigWrapper(EndpointConfig endpointConfig)

Method Detail

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

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
getEncodersback to summary
public List<Class<? extends Encoder>> getEncoders()

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
getPathParamsback to summary
public Map<String, String> getPathParams()

Implements org.eclipse.jetty.ee10.websocket.jakarta.common.PathParamProvider.getPathParams.

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

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
initback to summary
public void init(EndpointConfig endpointConfig)