Top Fields Constructors Methods
org.eclipse.jetty.ee10.websocket.jakarta.common

public Class ServerEndpointConfigWrapper

extends EndpointConfigWrapper
implements ServerEndpointConfig
Class Inheritance
All Implemented Interfaces
jakarta.websocket.server.ServerEndpointConfig, jakarta.websocket.EndpointConfig
Imports
java.util.List, jakarta.websocket.Extension, jakarta.websocket.server.ServerEndpointConfig

Field Summary

Modifier and TypeField and Description
private ServerEndpointConfig

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig.Configurator
public Class<?>
getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Returns the Class of the endpoint this configuration is configuring.

public List<Extension>
getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Return the websocket extensions configured.

public String
getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

Return the path for this endpoint configuration.

public List<String>
getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Return the websocket subprotocols configured.

public void
init(ServerEndpointConfig endpointConfig)

Inherited from org.eclipse.jetty.ee10.websocket.jakarta.common.EndpointConfigWrapper:
getDecodersgetEncodersgetPathParamsgetUserPropertiesinit

Field Detail

_endpointConfigback to summary
private ServerEndpointConfig _endpointConfig

Hides org.eclipse.jetty.ee10.websocket.jakarta.common.EndpointConfigWrapper._endpointConfig.

Constructor Detail

ServerEndpointConfigWrapperback to summary
public ServerEndpointConfigWrapper()
ServerEndpointConfigWrapperback to summary
public ServerEndpointConfigWrapper(ServerEndpointConfig endpointConfig)

Method Detail

getConfiguratorback to summary
public ServerEndpointConfig.Configurator getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

Doc from jakarta.websocket.server.ServerEndpointConfig.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:ServerEndpointConfig.Configurator

the configurator in use.

Annotations
@Override
getEndpointClassback to summary
public Class<?> getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Doc from jakarta.websocket.server.ServerEndpointConfig.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:Class<?>

the class of the endpoint, annotated or programmatic.

Annotations
@Override
getExtensionsback to summary
public List<Extension> getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Doc from jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Return the websocket extensions configured.

Returns:List<Extension>

the list of extensions, the empty list if none.

Annotations
@Override
getPathback to summary
public String getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

Doc from jakarta.websocket.server.ServerEndpointConfig.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:String

the relative path for this configuration.

Annotations
@Override
getSubprotocolsback to summary
public List<String> getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Doc from jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Return the websocket subprotocols configured.

Returns:List<String>

the list of subprotocols, the empty list if none

Annotations
@Override
initback to summary
public void init(ServerEndpointConfig endpointConfig)