-
- 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.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 18/08/2025
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-javaee-rf-javax/websocket/server/serverendpointconfig.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor dieser Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.