javax.websocket

Class ClientEndpointConfig.Builder

Contents
  • Enclosing interface:
    ClientEndpointConfig

    public static final class ClientEndpointConfig.Builder
extends Object
    The ClientEndpointConfig.Builder is a class used for creating ClientEndpointConfig 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 Detail

      • create

        public static ClientEndpointConfig.Builder create()
        Creates a new builder object with no subprotocols, extensions, encoders, decoders and a null 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.

      • 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

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/clientendpointconfig.builder.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com/en/java/, Class ClientEndpointConfig.Builder

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.