-
- 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.
-
-
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 20:49:54 Cette version de la page est en cache (à la date du 21/08/2025 20:49: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.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.