Interface ServerEndpointConfig

All Superinterfaces:
EndpointConfig
All Known Subinterfaces:
TyrusServerEndpointConfig
All Known Implementing Classes:
ServerEndpointConfigWrapper

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 a ServerEndpointConfig.Builder. Certain configuration operations can be customized by providing a ServerEndpointConfig.Configurator
Author:
dannycoward
  • Method Details

    • 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

      Return the ServerEndpointConfig.Configurator this configuration is using. If none was set by calling ServerEndpointConfig.Builder.configurator(jakarta.websocket.server.ServerEndpointConfig.Configurator) this methods returns the platform default configurator.
      Returns:
      the configurator in use.