Modifier and Type	Class and Description
public static class	ServerEndpointConfig.Builder The ServerEndpointConfig.Builder is a class used for creating `ServerEndpointConfig.Builder` objects for the purposes of deploying a server endpoint.
public static class	ServerEndpointConfig.Configurator The 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.

Modifier and Type	Method and Description
public ServerEndpointConfig.Configurator	Returns: the configurator in use. getConfigurator() Return the `ServerEndpointConfig.Configurator` this configuration is using.
public Class<?>	Returns: the class of the endpoint, annotated or programmatic. getEndpointClass() Returns the Class of the endpoint this configuration is configuring.
public List<Extension>	Returns: the list of extensions, the empty list if none. getExtensions() Return the websocket extensions configured.
public String	Returns: the relative path for this configuration. getPath() Return the path for this endpoint configuration.
public List<String>	Returns: the list of subprotocols, the empty list if none getSubprotocols() Return the websocket subprotocols configured.

Method Detail

getConfigurator back to summary

getConfigurator	back to summary
public ServerEndpointConfig.Configurator 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.

public ServerEndpointConfig.Configurator 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.

getEndpointClass	back to summary
public 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:Class<?> the class of the endpoint, annotated or programmatic.

getEndpointClass

back to summary

public 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:Class<?>: the class of the endpoint, annotated or programmatic.

getExtensions	back to summary
public List<Extension> getExtensions() Return the websocket extensions configured. Returns:List<Extension> the list of extensions, the empty list if none.

getExtensions

back to summary

public List<Extension> getExtensions()

Return the websocket extensions configured.

Returns:List<Extension>: the list of extensions, the empty list if none.

getPath	back to summary
public 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:String the relative path for this configuration.

getPath

back to summary

public 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:String: the relative path for this configuration.

getSubprotocols	back to summary
public List<String> getSubprotocols() Return the websocket subprotocols configured. Returns:List<String> the list of subprotocols, the empty list if none

getSubprotocols

back to summary

public List<String> getSubprotocols()

Return the websocket subprotocols configured.

Returns:List<String>: the list of subprotocols, the empty list if none

jakarta.websocket.server back to summary

public final Class ServerEndpointConfig.Builder

Class Inheritance

extends Object

java.lang.Object
jakarta.websocket.server.ServerEndpointConfig.Builder

The ServerEndpointConfig.Builder is a class used for creating ServerEndpointConfig.Builder objects for the purposes of deploying a server endpoint.

Here are some examples:

Building a plain configuration for an endpoint with just a path.


ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/foo").build();

Building a configuration with no subprotocols and a custom configurator.


ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/bar")
        .subprotocols(subprotocols)
        .configurator(new MyServerConfigurator())
        .build();

Author: dannycoward

Field Summary

Modifier and Type	Field and Description
private List<Class<? extends Decoder>>	decoders
private List<Class<? extends Encoder>>	encoders
private Class<?>	endpointClass
private List<Extension>	extensions
private String	path
private ServerEndpointConfig.Configurator	serverEndpointConfigurator
private List<String>	subprotocols

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public ServerEndpointConfig	Returns: a new ServerEndpointConfig object. build() Builds the configuration object using the current attributes that have been set on this builder object.
public ServerEndpointConfig.Builder	Returns: this builder instance configurator(ServerEndpointConfig.Configurator the configurator serverEndpointConfigurator) Sets the custom configurator to use on the configuration object built by this builder.
public static ServerEndpointConfig.Builder	Returns: a new instance of ServerEndpointConfig.Builder create(Class<?> the class of the endpoint to configure endpointClass, String The URI or URI template where the endpoint will be deployed. A trailing "/" will be ignored and the path must begin with /. path) Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.
public ServerEndpointConfig.Builder	Returns: this builder instance. decoders(List<Class<? extends Decoder>> the decoders decoders) Sets the decoder implementation classes to use in the configuration.
public ServerEndpointConfig.Builder	Returns: this builder instance encoders(List<Class<? extends Encoder>> the encoders encoders) Sets the list of encoder implementation classes for this builder.
public ServerEndpointConfig.Builder	Returns: this builder instance. extensions(List<Extension> the extensions to use. extensions) Sets the extensions to use in the configuration.
public ServerEndpointConfig.Builder	Returns: this builder instance subprotocols(List<String> the subprotocols. subprotocols) Sets the subprotocols to use in the configuration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

decoders	back to summary
private List<Class<? extends Decoder>> decoders

encoders	back to summary
private List<Class<? extends Encoder>> encoders

endpointClass	back to summary
private Class<?> endpointClass

extensions	back to summary
private List<Extension> extensions

path	back to summary
private String path

serverEndpointConfigurator	back to summary
private ServerEndpointConfig.Configurator serverEndpointConfigurator

subprotocols	back to summary
private List<String> subprotocols

Constructor Detail

Builder	back to summary
private Builder()

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

Method Detail

build	back to summary
public ServerEndpointConfig build() Builds the configuration object using the current attributes that have been set on this builder object. Returns:ServerEndpointConfig a new ServerEndpointConfig object.

build

back to summary

public ServerEndpointConfig build()

Builds the configuration object using the current attributes that have been set on this builder object.

Returns:ServerEndpointConfig: a new ServerEndpointConfig object.

configurator	back to summary
public ServerEndpointConfig.Builder configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator) Sets the custom configurator to use on the configuration object built by this builder. Parameters serverEndpointConfigurator:ServerEndpointConfig.Configurator the configurator Returns:ServerEndpointConfig.Builder this builder instance

configurator

back to summary

public ServerEndpointConfig.Builder configurator(ServerEndpointConfig.Configurator serverEndpointConfigurator)

Sets the custom configurator to use on the configuration object built by this builder.

Parameters

serverEndpointConfigurator:ServerEndpointConfig.Configurator: the configurator

Returns:ServerEndpointConfig.Builder

this builder instance

create	back to summary
public static ServerEndpointConfig.Builder create(Class<?> endpointClass, String path) Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator. Parameters endpointClass:Class<?> the class of the endpoint to configure path:String The URI or URI template where the endpoint will be deployed. A trailing "/" will be ignored and the path must begin with /. Returns:ServerEndpointConfig.Builder a new instance of ServerEndpointConfig.Builder

create

back to summary

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

Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom configurator.

Parameters

endpointClass:Class<?>: the class of the endpoint to configure
path:String: The URI or URI template where the endpoint will be deployed. A trailing "/" will be ignored and the path must begin with /.

Returns:ServerEndpointConfig.Builder

a new instance of ServerEndpointConfig.Builder

decoders	back to summary
public ServerEndpointConfig.Builder decoders(List<Class<? extends Decoder>> decoders) Sets the decoder implementation classes to use in the configuration. Parameters decoders:List<Class<? extends Decoder>> the decoders Returns:ServerEndpointConfig.Builder this builder instance.

decoders

back to summary

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

Sets the decoder implementation classes to use in the configuration.

Parameters

decoders:List<Class<? extends Decoder>>: the decoders

Returns:ServerEndpointConfig.Builder

this builder instance.

encoders	back to summary
public ServerEndpointConfig.Builder encoders(List<Class<? extends Encoder>> encoders) Sets the list of encoder implementation classes for this builder. Parameters encoders:List<Class<? extends Encoder>> the encoders Returns:ServerEndpointConfig.Builder this builder instance

encoders

back to summary

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

Sets the list of encoder implementation classes for this builder.

Parameters

encoders:List<Class<? extends Encoder>>: the encoders

Returns:ServerEndpointConfig.Builder

this builder instance

extensions	back to summary
public ServerEndpointConfig.Builder extensions(List<Extension> extensions) Sets the extensions to use in the configuration. Parameters extensions:List<Extension> the extensions to use. Returns:ServerEndpointConfig.Builder this builder instance.

extensions

back to summary

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

Sets the extensions to use in the configuration.

Parameters

extensions:List<Extension>: the extensions to use.

Returns:ServerEndpointConfig.Builder

this builder instance.

subprotocols	back to summary
public ServerEndpointConfig.Builder subprotocols(List<String> subprotocols) Sets the subprotocols to use in the configuration. Parameters subprotocols:List<String> the subprotocols. Returns:ServerEndpointConfig.Builder this builder instance

subprotocols

back to summary

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

Sets the subprotocols to use in the configuration.

Parameters

subprotocols:List<String>: the subprotocols.

Returns:ServerEndpointConfig.Builder

this builder instance

jakarta.websocket.server back to summary

public Class ServerEndpointConfig.Configurator

Class Inheritance

extends Object

java.lang.Object
jakarta.websocket.server.ServerEndpointConfig.Configurator

The 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. The implementation must provide a platform default configurator loading using the service loader.

Field Summary

Modifier and Type	Field and Description
private ServerEndpointConfig.Configurator	containerDefaultConfigurator

Constructor Summary

Access	Constructor and Description
public	Configurator()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether the check passed or not checkOrigin(String the value of the origin header passed by the client. originHeaderValue) Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.
pack-priv static ServerEndpointConfig.Configurator	fetchContainerDefaultConfigurator()
public ServerEndpointConfig.Configurator	Returns: the platform default configurator getContainerDefaultConfigurator() Return the platform default configurator.
public < the type of the endpoint T> T	Returns: an instance of the endpoint that will handle all interactions from a new client. getEndpointInstance(Class<T> the class of the endpoint endpointClass) This method is called by the container each time a new client connects to the logical endpoint this configurator configures.
public List<Extension>	Returns: the list of extensions negotiated, the empty list if none. getNegotiatedExtensions(List<Extension> the installed extensions on the implementation. installed, List<Extension> the requested extensions, in the order they were requested by the client requested) Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none.
public String	Returns: the negotiated subprotocol or the empty string if there isn't one. getNegotiatedSubprotocol(List<String> the subprotocols supported by the server endpoint supported, List<String> the requested subprotocols from the client endpoint requested) Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked.
public void	modifyHandshake(ServerEndpointConfig the configuration object involved in the handshake sec, HandshakeRequest the opening handshake request. request, HandshakeResponse the proposed opening handshake response response) Called by the container after it has formulated a handshake response resulting from a well-formed handshake request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

containerDefaultConfigurator	back to summary
private ServerEndpointConfig.Configurator containerDefaultConfigurator

Constructor Detail

Configurator	back to summary
public Configurator()

Method Detail

checkOrigin	back to summary
public boolean checkOrigin(String originHeaderValue) Check the value of the Origin header (See Origin Header) the client passed during the opening handshake. The platform default implementation of this method makes a check of the validity of the Origin header sent along with the opening handshake following the recommendation at: Sending the Server's Opening Handshake. Parameters originHeaderValue:String the value of the origin header passed by the client. Returns:boolean whether the check passed or not

checkOrigin

back to summary

public boolean checkOrigin(String originHeaderValue)

Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.

The platform default implementation of this method makes a check of the validity of the Origin header sent along with the opening handshake following the recommendation at: Sending the Server's Opening Handshake.

Parameters

originHeaderValue:String: the value of the origin header passed by the client.

Returns:boolean

whether the check passed or not

fetchContainerDefaultConfigurator	back to summary
pack-priv static ServerEndpointConfig.Configurator fetchContainerDefaultConfigurator()

getContainerDefaultConfigurator	back to summary
public ServerEndpointConfig.Configurator getContainerDefaultConfigurator() Return the platform default configurator. Returns:ServerEndpointConfig.Configurator the platform default configurator Since WebSocket 2.1

getContainerDefaultConfigurator

back to summary

public ServerEndpointConfig.Configurator getContainerDefaultConfigurator()

Return the platform default configurator.

Returns:ServerEndpointConfig.Configurator: the platform default configurator
Since: WebSocket 2.1

getEndpointInstance	back to summary
public <T> T getEndpointInstance(Class<T> endpointClass) throws InstantiationException This method is called by the container each time a new client connects to the logical endpoint this configurator configures. Developers may override this method to control instantiation of endpoint instances in order to customize the initialization of the endpoint instance, or manage them in some other way. If the developer overrides this method, services like dependency injection that are otherwise supported, for example, when the implementation is part of the Java EE platform may not be available. The platform default implementation of this method returns a new endpoint instance per call, thereby ensuring that there is one endpoint instance per client, the default deployment cardinality. Parameters <T> the type of the endpoint endpointClass:Class<T> the class of the endpoint Returns:T an instance of the endpoint that will handle all interactions from a new client. Exceptions InstantiationException: if there was an error producing the endpoint instance.

getEndpointInstance

back to summary

public <T> T getEndpointInstance(Class<T> endpointClass) throws InstantiationException

This method is called by the container each time a new client connects to the logical endpoint this configurator configures. Developers may override this method to control instantiation of endpoint instances in order to customize the initialization of the endpoint instance, or manage them in some other way. If the developer overrides this method, services like dependency injection that are otherwise supported, for example, when the implementation is part of the Java EE platform may not be available. The platform default implementation of this method returns a new endpoint instance per call, thereby ensuring that there is one endpoint instance per client, the default deployment cardinality.

Parameters

<T>: the type of the endpoint
endpointClass:Class<T>: the class of the endpoint

Returns:T

an instance of the endpoint that will handle all interactions from a new client.

Exceptions

InstantiationException:: if there was an error producing the endpoint instance.

getNegotiatedExtensions	back to summary
public List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none. See Negotiating Extensions The default platform implementation of this method returns a list containing all of the requested extensions passed to this method that it supports, using the order in the requested extensions, the empty list if none. Parameters installed:List<Extension> the installed extensions on the implementation. requested:List<Extension> the requested extensions, in the order they were requested by the client Returns:List<Extension> the list of extensions negotiated, the empty list if none.

getNegotiatedExtensions

back to summary

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

Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none. See Negotiating Extensions

The default platform implementation of this method returns a list containing all of the requested extensions passed to this method that it supports, using the order in the requested extensions, the empty list if none.

Parameters

installed:List<Extension>: the installed extensions on the implementation.
requested:List<Extension>: the requested extensions, in the order they were requested by the client

Returns:List<Extension>

the list of extensions negotiated, the empty list if none.

getNegotiatedSubprotocol	back to summary
public String getNegotiatedSubprotocol(List<String> supported, List<String> requested) Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked. See Sending the Server's Opening Handshake. Subclasses may provide custom algorithms based on other factors. The default platform implementation of this method returns the first subprotocol in the list sent by the client that the server supports, or the empty string if there isn't one. Parameters supported:List<String> the subprotocols supported by the server endpoint requested:List<String> the requested subprotocols from the client endpoint Returns:String the negotiated subprotocol or the empty string if there isn't one.

getNegotiatedSubprotocol

back to summary

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

Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked. See Sending the Server's Opening Handshake. Subclasses may provide custom algorithms based on other factors.

The default platform implementation of this method returns the first subprotocol in the list sent by the client that the server supports, or the empty string if there isn't one.

Parameters

supported:List<String>: the subprotocols supported by the server endpoint
requested:List<String>: the requested subprotocols from the client endpoint

Returns:String

the negotiated subprotocol or the empty string if there isn't one.

modifyHandshake back to summary

modifyHandshake	back to summary
public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) Called by the container after it has formulated a handshake response resulting from a well-formed handshake request. The container has already checked that this configuration has a matching URI, determined the validity of the origin using the checkOrigin method, and filled out the negotiated subprotocols and extensions based on this configuration. Custom configurations may override this method in order to inspect the request parameters and modify the handshake response that the server has formulated. and the URI checking also. If the developer does not override this method, no further modification of the request and response are made by the implementation. The user properties made available via `ServerEndpointConfig#getUserProperties()` must be a per WebSocket connection (i.e. per `jakarta.websocket.Session`) copy of the user properties. This copy, including any modifications made to the user properties during the execution of this method must be used to populate the initial contents of `jakarta.websocket.Session#getUserProperties()`. Parameters sec:ServerEndpointConfig the configuration object involved in the handshake request:HandshakeRequest the opening handshake request. response:HandshakeResponse the proposed opening handshake response

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

Called by the container after it has formulated a handshake response resulting from a well-formed handshake request. The container has already checked that this configuration has a matching URI, determined the validity of the origin using the checkOrigin method, and filled out the negotiated subprotocols and extensions based on this configuration. Custom configurations may override this method in order to inspect the request parameters and modify the handshake response that the server has formulated. and the URI checking also.

If the developer does not override this method, no further modification of the request and response are made by the implementation.

The user properties made available via ServerEndpointConfig#getUserProperties() must be a per WebSocket connection (i.e. per jakarta.websocket.Session) copy of the user properties. This copy, including any modifications made to the user properties during the execution of this method must be used to populate the initial contents of jakarta.websocket.Session#getUserProperties().

Parameters

sec:ServerEndpointConfig: the configuration object involved in the handshake
request:HandshakeRequest: the opening handshake request.
response:HandshakeResponse: the proposed opening handshake response

public Interface ServerEndpointConfig

Nested and Inner Type Summary

Method Summary

Method Detail

public final Class ServerEndpointConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ServerEndpointConfig.Configurator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail