-
- All Superinterfaces:
- EndpointConfig
public interface ServerEndpointConfig extends EndpointConfig
The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints. For developers deploying programmatic endpoints, ServerEndpointConfig objects can be created using aServerEndpointConfig.Builder. Certain configuration operations can be customized by providing aServerEndpointConfig.Configurator- Author:
- dannycoward
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static classServerEndpointConfig.BuilderThe ServerEndpointConfig.Builder is a class used for creatingServerEndpointConfig.Builderobjects for the purposes of deploying a server endpoint.static classServerEndpointConfig.ConfiguratorThe ServerEndpointConfig.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 ServerEndpointConfig.ConfiguratorgetConfigurator()Return theServerEndpointConfig.Configuratorthis configuration is using.Class<?>getEndpointClass()Returns the Class of the endpoint this configuration is configuring.List<Extension>getExtensions()Return the websocket extensions configured.StringgetPath()Return the path for this endpoint configuration.List<String>getSubprotocols()Return the websocket subprotocols configured.-
Methods inherited from interface javax.websocket.EndpointConfig
getDecoders, getEncoders, getUserProperties
-
-
-
-
Method Detail
-
getEndpointClass
Class<?> getEndpointClass()
Returns the Class of the endpoint this configuration is configuring. If the endpoint is an annotated endpoint, the value is the class of the Java class annotated with @ServerEndpoint. if the endpoint is a programmatic, the value is the class of the subclass of Endpoint.- Returns:
- the class of the endpoint, annotated or programmatic.
-
getPath
String getPath()
Return the path for this endpoint configuration. The path is the URI or URI-template (level 1) relative to the websocket root of the server to which the endpoint using this configuration will be mapped. The path is always non-null and always begins with a leading "/".- Returns:
- the relative path for this configuration.
-
getSubprotocols
List<String> getSubprotocols()
Return the websocket subprotocols configured.- Returns:
- the list of subprotocols, the empty list if none
-
getExtensions
List<Extension> getExtensions()
Return the websocket extensions configured.- Returns:
- the list of extensions, the empty list if none.
-
getConfigurator
ServerEndpointConfig.Configurator getConfigurator()
Return theServerEndpointConfig.Configuratorthis configuration is using. If none was set by callingServerEndpointConfig.Builder.configurator(javax.websocket.server.ServerEndpointConfig.Configurator)this methods returns the platform default configurator.- Returns:
- the configurator in use.
-
-
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:29 Cette version de la page est en cache (à la date du 21/08/2025 19:05:29) 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/server/ServerEndpointConfig.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.