javax.websocket.server

Class ServerEndpointConfig.Builder

Contents
  • Enclosing interface:
    ServerEndpointConfig

    public static final class ServerEndpointConfig.Builder
extends Object
    The ServerEndpointConfig.Builder is a class used for creating ServerEndpointConfig.Builder objects for the purposes of deploying a server endpoint.

    Here are some examples:

    Building a plain configuration for an endpoint with just a path. 

    
 ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/foo").build();

    Building a configuration with no subprotocols and a custom configurator. 

    
 ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/bar")
         .subprotocols(subprotocols)
         .configurator(new MyServerConfigurator())
         .build();
    Author:
    dannycoward

    • Method Detail

      • create

        public static ServerEndpointConfig.Builder create(Class<?> endpointClass,
                                                  String path)
        Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.
        Parameters:
        endpointClass - the class of the endpoint to configure
        path - The URI or URI template where the endpoint will be deployed. A trailing "/" will be ignored and the path must begin with /.
        Returns:
        a new instance of ServerEndpointConfig.Builder

      • build

        public ServerEndpointConfig build()
        Builds the configuration object using the current attributes that have been set on this builder object.
        Returns:
        a new ServerEndpointConfig object.

      • encoders

        public ServerEndpointConfig.Builder encoders(List<Class<? extends Encoder>> encoders)
        Sets the list of encoder implementation classes for this builder.
        Parameters:
        encoders - the encoders
        Returns:
        this builder instance

      • decoders

        public ServerEndpointConfig.Builder decoders(List<Class<? extends Decoder>> decoders)
        Sets the decoder implementation classes to use in the configuration.
        Parameters:
        decoders - the decoders
        Returns:
        this builder instance.

      • subprotocols

        public ServerEndpointConfig.Builder subprotocols(List<String> subprotocols)
        Sets the subprotocols to use in the configuration.
        Parameters:
        subprotocols - the subprotocols.
        Returns:
        this builder instance

      • extensions

        public ServerEndpointConfig.Builder extensions(List<Extension> extensions)
        Sets the extensions to use in the configuration.
        Parameters:
        extensions - the extensions to use.
        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/server/ServerEndpointConfig.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 ServerEndpointConfig.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.