EE4J 10.0.0 · jakarta.websocket.EndpointConfig

The endpoint configuration contains all the information needed during the handshake process for this end point. All endpoints specify, for example, a URI. In the case of a server endpoint, the URI signifies the URI to which the endpoint will be mapped. In the case of a client application the URI signifies the URI of the server to which the client endpoint will attempt to connect.

Method Summary

Modifier and Type	Method and Description
public List<Class<? extends Decoder>>	Returns: the decoder implementation classes, the empty list if none. getDecoders() Return the Decoder implementation classes configured.
public List<Class<? extends Encoder>>	Returns: the encoder implementation classes, an empty list if none. getEncoders() Return the Encoder implementation classes configured.
public Map<String, Object>	Returns: a modifiable Map of application data. 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.

Method Detail

getDecoders back to summary

getDecoders	back to summary
public List<Class<? extends Decoder>> 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.

public List<Class<? extends Decoder>> 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.

getEncoders	back to summary
public List<Class<? extends Encoder>> 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.

getEncoders

back to summary

public List<Class<? extends Encoder>> 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.

getUserProperties	back to summary
public Map<String, Object> 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.

getUserProperties

back to summary

public Map<String, Object> 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.

public Interface EndpointConfig

Method Summary

Method Detail