Package javax.websocket

Class DefaultClientEndpointConfig

java.lang.Object

javax.websocket.DefaultClientEndpointConfig

All Implemented Interfaces:

ClientEndpointConfig, EndpointConfig

final class DefaultClientEndpointConfig
extends java.lang.Object
implements ClientEndpointConfig

The DefaultClientEndpointConfig is a concrete implementation of a client configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.websocket.ClientEndpointConfig

ClientEndpointConfig.Builder, ClientEndpointConfig.Configurator

Field Summary

Fields

Modifier and Type	Field	Description
private ClientEndpointConfig.Configurator	clientEndpointConfigurator
private java.util.List<java.lang.Class<? extends Decoder>>	decoders
private java.util.List<java.lang.Class<? extends Encoder>>	encoders
private java.util.List<Extension>	extensions
private java.util.List<java.lang.String>	preferredSubprotocols
private java.util.Map<java.lang.String,java.lang.Object>	userProperties

Constructor Summary

Constructors

Constructor	Description
DefaultClientEndpointConfig(java.util.List<java.lang.String> preferredSubprotocols, java.util.List<Extension> extensions, java.util.List<java.lang.Class<? extends Encoder>> encoders, java.util.List<java.lang.Class<? extends Decoder>> decoders, ClientEndpointConfig.Configurator clientEndpointConfigurator)

Method Summary

Modifier and Type	Method	Description
ClientEndpointConfig.Configurator	getConfigurator()	Return the custom configurator for this configuration.
java.util.List<java.lang.Class<? extends Decoder>>	getDecoders()	Return the (unmodifiable) list of decoders this client will use.
java.util.List<java.lang.Class<? extends Encoder>>	getEncoders()	Return the (unmodifiable) list of encoders this client will use.
java.util.List<Extension>	getExtensions()	Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.
java.util.List<java.lang.String>	getPreferredSubprotocols()	Return the protocols, in order of preference, favorite first, that this client would like to use for its sessions.
java.util.Map<java.lang.String,java.lang.Object>	getUserProperties()	Editable map of user properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

preferredSubprotocols

private java.util.List<java.lang.String> preferredSubprotocols

extensions

private java.util.List<Extension> extensions

encoders

private java.util.List<java.lang.Class<? extends Encoder>> encoders

decoders

private java.util.List<java.lang.Class<? extends Decoder>> decoders

userProperties

private java.util.Map<java.lang.String,java.lang.Object> userProperties

clientEndpointConfigurator

private ClientEndpointConfig.Configurator clientEndpointConfigurator

Constructor Detail

DefaultClientEndpointConfig

DefaultClientEndpointConfig(java.util.List<java.lang.String> preferredSubprotocols,
                            java.util.List<Extension> extensions,
                            java.util.List<java.lang.Class<? extends Encoder>> encoders,
                            java.util.List<java.lang.Class<? extends Decoder>> decoders,
                            ClientEndpointConfig.Configurator clientEndpointConfigurator)

Method Detail

getPreferredSubprotocols

public java.util.List<java.lang.String> getPreferredSubprotocols()

Return the protocols, in order of preference, favorite first, that this client would like to use for its sessions.

Specified by:

getPreferredSubprotocols in interface ClientEndpointConfig

Returns:

the preferred subprotocols.

getExtensions

public java.util.List<Extension> getExtensions()

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.

Specified by:

getExtensions in interface ClientEndpointConfig

Returns:

the (unmodifiable) extension list.

getEncoders

public java.util.List<java.lang.Class<? extends Encoder>> getEncoders()

Return the (unmodifiable) list of encoders this client will use.

Specified by:

getEncoders in interface EndpointConfig

Returns:

the encoder list.

getDecoders

public java.util.List<java.lang.Class<? extends Decoder>> getDecoders()

Return the (unmodifiable) list of decoders this client will use.

Specified by:

getDecoders in interface EndpointConfig

Returns:

the decoders to use.

getUserProperties

public final java.util.Map<java.lang.String,java.lang.Object> getUserProperties()

Editable map of user properties.

Specified by:

getUserProperties in interface EndpointConfig

Returns:

a modifiable Map of application data.

getConfigurator

public ClientEndpointConfig.Configurator getConfigurator()

Description copied from interface: ClientEndpointConfig

Return the custom configurator for this configuration. If the developer did not provide one, the platform default configurator is returned.

Specified by:

getConfigurator in interface ClientEndpointConfig

Returns:

the configurator in use with this configuration.