javax.websocket
Class ClientEndpointConfigurationBuilder

java.lang.Object
  javax.websocket.ClientEndpointConfigurationBuilder

public class ClientEndpointConfigurationBuilder
extends Object

The ClientEndpointConfigurationBuilder is a class used for creating ClientEndpointConfiguration objects for the purposes of deploying a client endpoint.

Here are some examples:

Building a plain configuration with no encoders, decoders, subprotocols or extensions.

ClientEndpointConfiguration cec = ClientEndpointConfigurationBuilder.create().build();


Building a configuration with no subprotocols and a custom configurator.

ClientEndpointConfiguration customCec = ClientEndpointConfigurationBuilder.create()
.preferredSubprotocols(mySubprotocols)
.clientHandshakeConfigurator(new MyClientConfigurator())
.build();


Author:

dannycoward

Constructor Summary

ClientEndpointConfigurationBuilder()

Method Summary

ClientEndpointConfiguration	build() Builds a configuration object using the attributes set on this builder.
ClientEndpointConfigurationBuilder	clientHandshakeConfigurator(ClientEndpointConfigurator clientEndpointConfigurator) Sets the configurator object for the configuration this builder will build.
static ClientEndpointConfigurationBuilder	create() Creates a new builder object with no subprotocols, extensions, encoders, decoders and a null configurator.
ClientEndpointConfigurationBuilder	decoders(List<Decoder> decoders) Assign the list of decoders the client will use.
ClientEndpointConfigurationBuilder	encoders(List<Encoder> encoders) Assign the list of encoders the client will use.
ClientEndpointConfigurationBuilder	extensions(List<Extension> extensions) Set the extensions for the configuration this builder will build.
ClientEndpointConfigurationBuilder	preferredSubprotocols(List<String> preferredSubprotocols) Set the preferred sub protocols for the configuration this builder will build.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientEndpointConfigurationBuilder

public ClientEndpointConfigurationBuilder()

Method Detail

create

public static ClientEndpointConfigurationBuilder create()

Creates a new builder object with no subprotocols, extensions, encoders, decoders and a null configurator.

Returns:

a new builder object.

build

public ClientEndpointConfiguration build()

Builds a configuration object using the attributes set on this builder.

Returns:

a new configuration object.

clientHandshakeConfigurator

public ClientEndpointConfigurationBuilder clientHandshakeConfigurator(ClientEndpointConfigurator clientEndpointConfigurator)

Sets the configurator object for the configuration this builder will build.

Parameters:

clientEndpointConfigurator - the configurator

Returns:

the builder instance

preferredSubprotocols

public ClientEndpointConfigurationBuilder preferredSubprotocols(List<String> preferredSubprotocols)

Set the preferred sub protocols for the configuration this builder will build. The list is treated in order of preference, favorite first, that this client would like to use for its sessions.

Parameters:

preferredSubprotocols - the preferred subprotocol names.

Returns:

the builder instance

extensions

public ClientEndpointConfigurationBuilder extensions(List<Extension> extensions)

Set the extensions for the configuration this builder will build. The list is treated in order of preference, favorite first, that the client would like to use for its sessions.

Parameters:

extensions - the extensions

Returns:

the builder instance

encoders

public ClientEndpointConfigurationBuilder encoders(List<Encoder> encoders)

Assign the list of encoders the client will use.

Parameters:

encoders - the encoders

Returns:

the builder instance

decoders

public ClientEndpointConfigurationBuilder decoders(List<Decoder> decoders)

Assign the list of decoders the client will use.

Parameters:

decoders - the decoders

Returns:

this builder instance