javax.websocket
Interface EndpointConfiguration

All Known Subinterfaces:

ClientEndpointConfiguration

public interface EndpointConfiguration

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.

Since:

DRAFT 001

Author:

dannycoward

Method Summary

List<Decoder>	getDecoders() Return the Decoder implementations configured.
List<Encoder>	getEncoders() Return the Encoder implementations configured.
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.

Method Detail

getEncoders

List<Encoder> getEncoders()

Return the Encoder implementations configured. These will be used by the container to encode custom objects passed into the send() methods on remote endpoints.

Returns:

the encoders, an empty list if none.

getDecoders

List<Decoder> getDecoders()

Return the Decoder implementations configured. These will be used by the container to decode incoming messages into the expected custom objects on MessageHandler.Basic.onMessage(Object) callbacks.

Returns:

the decoders, the empty list if none.

getUserProperties

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:

a modifiable Map of application data.