-
- 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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/websocket/server/ServerEndpointConfig.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.