- java.lang.Object
-
- javax.websocket.ClientEndpointConfig.Builder
-
- Enclosing interface:
- ClientEndpointConfig
public static final class ClientEndpointConfig.Builder extends Object
The ClientEndpointConfig.Builder is a class used for creatingClientEndpointConfig
objects for the purposes of deploying a client endpoint. Here are some examples: Building a plain configuration with no encoders, decoders, subprotocols or extensions.ClientEndpointConfig cec = ClientEndpointConfig.Builder.create().build();
Building a configuration with no subprotocols and a custom configurator.ClientEndpointConfig customCec = ClientEndpointConfig.Builder.create() .preferredSubprotocols(mySubprotocols) .configurator(new MyClientConfigurator()) .build();
- Author:
- dannycoward
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description ClientEndpointConfig
build()
Builds a configuration object using the attributes set on this builder.ClientEndpointConfig.Builder
configurator(ClientEndpointConfig.Configurator clientEndpointConfigurator)
Sets the configurator object for the configuration this builder will build.static ClientEndpointConfig.Builder
create()
Creates a new builder object with no subprotocols, extensions, encoders, decoders and anull
configurator.ClientEndpointConfig.Builder
decoders(List<Class<? extends Decoder>> decoders)
Assign the list of decoder implementation classes the client will use.ClientEndpointConfig.Builder
encoders(List<Class<? extends Encoder>> encoders)
Assign the list of encoder implementation classes the client will use.ClientEndpointConfig.Builder
extensions(List<Extension> extensions)
Set the extensions for the configuration this builder will build.ClientEndpointConfig.Builder
preferredSubprotocols(List<String> preferredSubprotocols)
Set the preferred sub protocols for the configuration this builder will build.
-
-
-
Method Detail
-
create
public static ClientEndpointConfig.Builder create()
Creates a new builder object with no subprotocols, extensions, encoders, decoders and anull
configurator.- Returns:
- a new builder object.
-
build
public ClientEndpointConfig build()
Builds a configuration object using the attributes set on this builder.- Returns:
- a new configuration object.
-
configurator
public ClientEndpointConfig.Builder configurator(ClientEndpointConfig.Configurator clientEndpointConfigurator)
Sets the configurator object for the configuration this builder will build.- Parameters:
clientEndpointConfigurator
- the configurator- Returns:
- the builder instance
-
preferredSubprotocols
public ClientEndpointConfig.Builder 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 ClientEndpointConfig.Builder 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 ClientEndpointConfig.Builder encoders(List<Class<? extends Encoder>> encoders)
Assign the list of encoder implementation classes the client will use.- Parameters:
encoders
- the encoder implementation classes- Returns:
- the builder instance
-
decoders
public ClientEndpointConfig.Builder decoders(List<Class<? extends Decoder>> decoders)
Assign the list of decoder implementation classes the client will use.- Parameters:
decoders
- the decoder implementation classes- Returns:
- this builder instance
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 19:05:54 Cette version de la page est en cache (à la date du 21/08/2025 19:05:54) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/websocket/clientendpointconfig.builder.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.