Top Description Fields Constructors Methods
org.springframework.web.reactive.socket.server.upgrade

pack-priv Class DefaultServerEndpointConfig

extends Configurator
implements ServerEndpointConfig
Class Inheritance
All Implemented Interfaces
jakarta.websocket.server.ServerEndpointConfig, jakarta.websocket.EndpointConfig
Imports
java.util.ArrayList, .HashMap, .List, .Map, jakarta.websocket.Decoder, .Encoder, .Endpoint, .Extension, jakarta.websocket.server.ServerEndpointConfig, org.springframework.util.Assert
Default implementation of jakarta.websocket.server.ServerEndpointConfig for use in RequestUpgradeStrategy implementations.
Authors
Violeta Georgieva, Rossen Stoyanchev
Since
5.0

Field Summary

Modifier and TypeField and Description
private final Endpoint
endpoint

private final String
path

private List<String>
protocols

Constructor Summary

AccessConstructor and Description
public
DefaultServerEndpointConfig(String
the endpoint path
path, Endpoint
the endpoint instance
endpoint)

Constructor with a path and an jakarta.websocket.Endpoint.

Method Summary

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

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

public List<Class<? extends Decoder>>
getDecoders()

Implements jakarta.websocket.EndpointConfig.getDecoders.

public List<Class<? extends Encoder>>
getEncoders()

Implements jakarta.websocket.EndpointConfig.getEncoders.

public Class<?>
getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

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

Overrides jakarta.websocket.server.ServerEndpointConfig.Configurator.getEndpointInstance.

public List<Extension>
getExtensions()

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

public String
getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

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

public List<String>
getSubprotocols()

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

public Map<String, Object>
getUserProperties()

Implements jakarta.websocket.EndpointConfig.getUserProperties.

public void
setSubprotocols(List<String> protocols)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from jakarta.websocket.server.ServerEndpointConfig.Configurator:
checkOrigingetContainerDefaultConfiguratorgetNegotiatedExtensionsgetNegotiatedSubprotocolmodifyHandshake

Field Detail

endpointback to summary
private final Endpoint endpoint
pathback to summary
private final String path
protocolsback to summary
private List<String> protocols

Constructor Detail

DefaultServerEndpointConfigback to summary
public DefaultServerEndpointConfig(String path, Endpoint endpoint)

Constructor with a path and an jakarta.websocket.Endpoint.

Parameters
path:String

the endpoint path

endpoint:Endpoint

the endpoint instance

Method Detail

getConfiguratorback to summary
public ServerEndpointConfig.Configurator getConfigurator()

Implements jakarta.websocket.server.ServerEndpointConfig.getConfigurator.

Annotations
@Override
getDecodersback to summary
public List<Class<? extends Decoder>> getDecoders()

Implements jakarta.websocket.EndpointConfig.getDecoders.

Annotations
@Override
getEncodersback to summary
public List<Class<? extends Encoder>> getEncoders()

Implements jakarta.websocket.EndpointConfig.getEncoders.

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

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Annotations
@Override
getEndpointInstanceback to summary
public <T> T getEndpointInstance(Class<T> endpointClass) throws InstantiationException

Overrides jakarta.websocket.server.ServerEndpointConfig.Configurator.getEndpointInstance.

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

Implements jakarta.websocket.server.ServerEndpointConfig.getExtensions.

Annotations
@Override
getPathback to summary
public String getPath()

Implements jakarta.websocket.server.ServerEndpointConfig.getPath.

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

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

Implements jakarta.websocket.server.ServerEndpointConfig.getSubprotocols.

Annotations
@Override
getUserPropertiesback to summary
public Map<String, Object> getUserProperties()

Implements jakarta.websocket.EndpointConfig.getUserProperties.

Annotations
@Override
setSubprotocolsback to summary
public void setSubprotocols(List<String> protocols)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override