-
- 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.
-
-
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.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.