Top Description Inners Methods
jakarta.websocket.server

public Interface ServerEndpointConfig

extends EndpointConfig
Known Direct Implementers
org.apache.tomcat.websocket.server.WsPerSessionServerEndpointConfig, jakarta.websocket.server.DefaultServerEndpointConfig
Imports
java.security.AccessController, .PrivilegedAction, java.util.Collections, .Iterator, .List, .ServiceLoader, jakarta.websocket.Decoder, .Encoder, .EndpointConfig, .Extension, .HandshakeResponse
Provides configuration information for WebSocket endpoints published to a server. Applications may provide their own implementation or use Builder.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ServerEndpointConfig.Builder

public static class
ServerEndpointConfig.Configurator

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig.Configurator
getConfigurator()

public Class<?>
getEndpointClass()

public List<Extension>
getExtensions()

public String

Returns:

The registered path
getPath()

Returns the path at which this WebSocket server endpoint has been registered.

public List<String>
getSubprotocols()

Inherited from jakarta.websocket.EndpointConfig:
getDecodersgetEncodersgetUserProperties

Method Detail

getConfiguratorback to summary
public ServerEndpointConfig.Configurator getConfigurator()
getEndpointClassback to summary
public Class<?> getEndpointClass()
getExtensionsback to summary
public List<Extension> getExtensions()
getPathback to summary
public String getPath()

Returns the path at which this WebSocket server endpoint has been registered. It may be a path or a level 0 URI template.

Returns:String

The registered path

getSubprotocolsback to summary
public List<String> getSubprotocols()
jakarta.websocket.server back to summary

public final Class ServerEndpointConfig.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private ServerEndpointConfig.Configurator
configurator

private List<Class<? extends Decoder>>
decoders

private List<Class<? extends Encoder>>
encoders

private final Class<?>
endpointClass

private List<Extension>
extensions

private final String
path

private List<String>
subprotocols

Constructor Summary

AccessConstructor and Description
private
Builder(Class<?> endpointClass, String path)

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig
build()

public ServerEndpointConfig.Builder
configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator)

public static ServerEndpointConfig.Builder
create(Class<?> endpointClass, String path)

public ServerEndpointConfig.Builder
decoders(List<Class<? extends Decoder>> decoders)

public ServerEndpointConfig.Builder
encoders(List<Class<? extends Encoder>> encoders)

public ServerEndpointConfig.Builder
extensions(List<Extension> extensions)

public ServerEndpointConfig.Builder
subprotocols(List<String> subprotocols)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configuratorback to summary
private ServerEndpointConfig.Configurator configurator
decodersback to summary
private List<Class<? extends Decoder>> decoders
encodersback to summary
private List<Class<? extends Encoder>> encoders
endpointClassback to summary
private final Class<?> endpointClass
extensionsback to summary
private List<Extension> extensions
pathback to summary
private final String path
subprotocolsback to summary
private List<String> subprotocols

Constructor Detail

Builderback to summary
private Builder(Class<?> endpointClass, String path)

Method Detail

buildback to summary
public ServerEndpointConfig build()
configuratorback to summary
public ServerEndpointConfig.Builder configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator)
createback to summary
public static ServerEndpointConfig.Builder create(Class<?> endpointClass, String path)
decodersback to summary
public ServerEndpointConfig.Builder decoders(List<Class<? extends Decoder>> decoders)
encodersback to summary
public ServerEndpointConfig.Builder encoders(List<Class<? extends Encoder>> encoders)
extensionsback to summary
public ServerEndpointConfig.Builder extensions(List<Extension> extensions)
subprotocolsback to summary
public ServerEndpointConfig.Builder subprotocols(List<String> subprotocols)
jakarta.websocket.server back to summary

public Class ServerEndpointConfig.Configurator

extends Object
Class Inheritance
Known Direct Subclasses
org.apache.tomcat.websocket.server.DefaultServerEndpointConfigurator

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ServerEndpointConfig.Configurator.PrivilegedLoadDefault

Field Summary

Modifier and TypeField and Description
private static final String
DEFAULT_IMPL_CLASSNAME

private static volatile ServerEndpointConfig.Configurator
defaultImpl

private static final Object
defaultImplLock

Constructor Summary

AccessConstructor and Description
public
Configurator()

Method Summary

Modifier and TypeMethod and Description
public boolean
checkOrigin(String originHeaderValue)

pack-priv static ServerEndpointConfig.Configurator
fetchContainerDefaultConfigurator()

public ServerEndpointConfig.Configurator

Returns:

the platform default configurator
getContainerDefaultConfigurator()

Return the platform default configurator.

public <T> T
getEndpointInstance(Class<T> clazz)

public List<Extension>
getNegotiatedExtensions(List<Extension> installed, List<Extension> requested)

public String
getNegotiatedSubprotocol(List<String> supported, List<String> requested)

private static ServerEndpointConfig.Configurator
loadDefault()

public void
modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_IMPL_CLASSNAMEback to summary
private static final String DEFAULT_IMPL_CLASSNAME
defaultImplback to summary
private static volatile ServerEndpointConfig.Configurator defaultImpl
defaultImplLockback to summary
private static final Object defaultImplLock

Constructor Detail

Configuratorback to summary
public Configurator()

Method Detail

checkOriginback to summary
public boolean checkOrigin(String originHeaderValue)
fetchContainerDefaultConfiguratorback to summary
pack-priv static ServerEndpointConfig.Configurator fetchContainerDefaultConfigurator()
getContainerDefaultConfiguratorback to summary
public ServerEndpointConfig.Configurator getContainerDefaultConfigurator()

Return the platform default configurator.

Returns:ServerEndpointConfig.Configurator

the platform default configurator

Since
WebSocket 2.1
getEndpointInstanceback to summary
public <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException
getNegotiatedExtensionsback to summary
public List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested)
getNegotiatedSubprotocolback to summary
public String getNegotiatedSubprotocol(List<String> supported, List<String> requested)
loadDefaultback to summary
private static ServerEndpointConfig.Configurator loadDefault()
modifyHandshakeback to summary
public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)
jakarta.websocket.server back to summary

private Class ServerEndpointConfig.Configurator.PrivilegedLoadDefault

extends Object
implements PrivilegedAction<ServerEndpointConfig.Configurator>
Class Inheritance
  • java.lang.Object
  • jakarta.websocket.server.ServerEndpointConfig.Configurator.PrivilegedLoadDefault
All Implemented Interfaces
java.security.PrivilegedAction

Constructor Summary

AccessConstructor and Description
private
PrivilegedLoadDefault()

Method Summary

Modifier and TypeMethod and Description
public ServerEndpointConfig.Configurator
run()

Implements java.security.PrivilegedAction.run.

Performs the computation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

PrivilegedLoadDefaultback to summary
private PrivilegedLoadDefault()

Method Detail

runback to summary
public ServerEndpointConfig.Configurator run()

Implements java.security.PrivilegedAction.run.

Doc from java.security.PrivilegedAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:ServerEndpointConfig.Configurator

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedAction should document what (if anything) this value represents.

Annotations
@Override