-
- All Superinterfaces:
- EndpointConfig
public interface ClientEndpointConfig extends EndpointConfig
The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to client endpoints. Developers deploying programmatic client endpoints can create instances of this configuration by using aClientEndpointConfig.Builder. Developers can override some of the configuration operations by providing an implementation ofClientEndpointConfig.Configurator.- Author:
- dannycoward
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static classClientEndpointConfig.BuilderThe ClientEndpointConfig.Builder is a class used for creatingClientEndpointConfigobjects for the purposes of deploying a client endpoint.static classClientEndpointConfig.ConfiguratorThe Configurator class may be extended by developers who want to provide custom configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each endpoint instance configured with this configurator.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ClientEndpointConfig.ConfiguratorgetConfigurator()Return the custom configurator for this configuration.List<Extension>getExtensions()Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.List<String>getPreferredSubprotocols()Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions.-
Methods inherited from interface javax.websocket.EndpointConfig
getDecoders, getEncoders, getUserProperties
-
-
-
-
Method Detail
-
getPreferredSubprotocols
List<String> getPreferredSubprotocols()
Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite first that this client would like to use for its sessions. This list is used to generate the Sec-WebSocket-Protocol header in the opening handshake for clients using this configuration. The first protocol name is the most preferred. See Client Opening Handshake.- Returns:
- the list of the preferred subprotocols, the empty list if there are none
-
getExtensions
List<Extension> getExtensions()
Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions. These are the extensions that will be used to populate the Sec-WebSocket-Extensions header in the opening handshake for clients using this configuration. The first extension in the list is the most preferred extension. See Negotiating Extensions.- Returns:
- the list of extensions, the empty list if there are none.
-
getConfigurator
ClientEndpointConfig.Configurator getConfigurator()
Return the custom configurator for this configuration. If the developer did not provide one, the platform default configurator is returned.- Returns:
- the configurator in use with this configuration.
-
-
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.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
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.