Package org.glassfish.tyrus.core

Class ServerEndpointConfigWrapper

  • All Implemented Interfaces:
    EndpointConfig, jakarta.websocket.server.ServerEndpointConfig
    public class ServerEndpointConfigWrapper
extends java.lang.Object
implements jakarta.websocket.server.ServerEndpointConfig
    A public class that holds a wrapped ServerEndpointConfig.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface jakarta.websocket.server.ServerEndpointConfig

        jakarta.websocket.server.ServerEndpointConfig.Builder, jakarta.websocket.server.ServerEndpointConfig.Configurator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected jakarta.websocket.server.ServerEndpointConfig wrapped  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      jakarta.websocket.server.ServerEndpointConfig.Configurator getConfigurator()  
      java.util.List<java.lang.Class<? extends Decoder>> getDecoders()
      Return the Decoder implementation classes configured.
      java.util.List<java.lang.Class<? extends Encoder>> getEncoders()
      Return the Encoder implementation classes configured.
      java.lang.Class<?> getEndpointClass()  
      java.util.List<Extension> getExtensions()  
      java.lang.String getPath()  
      java.util.List<java.lang.String> getSubprotocols()  
      java.util.Map<java.lang.String,​java.lang.Object> getUserProperties()
      This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance.
      jakarta.websocket.server.ServerEndpointConfig getWrapped()
      Get the wrapped ServerEndpointConfig.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • wrapped

        protected final jakarta.websocket.server.ServerEndpointConfig wrapped

    • Method Detail

      • getEndpointClass

        public java.lang.Class<?> getEndpointClass()
        Specified by:
        getEndpointClass in interface jakarta.websocket.server.ServerEndpointConfig

      • getPath

        public java.lang.String getPath()
        Specified by:
        getPath in interface jakarta.websocket.server.ServerEndpointConfig

      • getSubprotocols

        public java.util.List<java.lang.String> getSubprotocols()
        Specified by:
        getSubprotocols in interface jakarta.websocket.server.ServerEndpointConfig

      • getExtensions

        public java.util.List<Extension> getExtensions()
        Specified by:
        getExtensions in interface jakarta.websocket.server.ServerEndpointConfig

      • getConfigurator

        public jakarta.websocket.server.ServerEndpointConfig.Configurator getConfigurator()
        Specified by:
        getConfigurator in interface jakarta.websocket.server.ServerEndpointConfig

      • getEncoders

        public java.util.List<java.lang.Class<? extends Encoder>> getEncoders()
        Description copied from interface: EndpointConfig
        Return the Encoder implementation classes configured. These will be instantiated by the container to encode custom objects passed into the send() methods on remote endpoints.
        Specified by:
        getEncoders in interface EndpointConfig
        Returns:
        the encoder implementation classes, an empty list if none.

      • getDecoders

        public java.util.List<java.lang.Class<? extends Decoder>> getDecoders()
        Description copied from interface: EndpointConfig
        Return the Decoder implementation classes configured. These will be instantiated by the container to decode incoming messages into the expected custom objects on MessageHandler.Whole.onMessage(Object) callbacks.
        Specified by:
        getDecoders in interface EndpointConfig
        Returns:
        the decoder implementation classes, the empty list if none.

      • getUserProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getUserProperties()
        Description copied from interface: EndpointConfig
        This method returns a modifiable Map that the developer may use to store application specific information relating to the endpoint that uses this configuration instance. Web socket applications running on distributed implementations of the web container should make any application specific objects stored here java.io.Serializable, or the object may not be recreated after a failover.
        Specified by:
        getUserProperties in interface EndpointConfig
        Returns:
        a modifiable Map of application data.

      • getWrapped

        public jakarta.websocket.server.ServerEndpointConfig getWrapped()
        Get the wrapped ServerEndpointConfig.
        Returns:
        the wrapped ServerEndpointConfig.