Top Description Fields Constructors Methods
org.springframework.web.socket.server.standard

public Class ServerEndpointRegistration

extends Configurator
implements ServerEndpointConfig, BeanFactoryAware
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.Aware, jakarta.websocket.server.ServerEndpointConfig, jakarta.websocket.EndpointConfig
Imports
java.util.ArrayList, .HashMap, .List, .Map, jakarta.websocket.Decoder, .Encoder, .Endpoint, .Extension, .HandshakeResponse, jakarta.websocket.server.HandshakeRequest, .ServerEndpointConfig, org.springframework.beans.factory.BeanFactory, .BeanFactoryAware, org.springframework.lang.Nullable, org.springframework.util.Assert, org.springframework.web.socket.handler.BeanCreatingHandlerProvider
An implementation of jakarta.websocket.server.ServerEndpointConfig for use in Spring-based applications. A ServerEndpointRegistration bean is detected by ServerEndpointExporter and registered with a Jakarta WebSocket runtime at startup.

Class constructors accept a singleton jakarta.websocket.Endpoint instance or an Endpoint specified by type Class. When specified by type, the endpoint will be instantiated and initialized through the Spring ApplicationContext before each client WebSocket connection.

This class also extends jakarta.websocket.server.ServerEndpointConfig.Configurator to make it easier to override methods for customizing the handshake process.

Authors
Rossen Stoyanchev, Juergen Hoeller
Since
4.0
See Also
ServerEndpointExporter

Field Summary

Modifier and TypeField and Description
private List<Class<? extends Decoder>>
decoders

private List<Class<? extends Encoder>>
encoders

private final Endpoint
endpoint

private final BeanCreatingHandlerProvider<Endpoint>
endpointProvider

private List<Extension>
extensions

private final String
path

private List<String>
subprotocols

private final Map<String, Object>
userProperties

Constructor Summary

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

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint instance.

public
ServerEndpointRegistration(String
the endpoint path
path, Class<? extends Endpoint>
the endpoint class
endpointClass)

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint class.

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 Endpoint
getEndpoint()

public Class<? extends Endpoint>
getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

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

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
modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)

Overrides jakarta.websocket.server.ServerEndpointConfig.Configurator.modifyHandshake.

public void
setBeanFactory(BeanFactory
owning BeanFactory (never null). The bean can immediately call methods on the factory.
beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

Callback that supplies the owning factory to a bean instance.

public void
setDecoders(List<Class<? extends Decoder>> decoders)

public void
setEncoders(List<Class<? extends Encoder>> encoders)

public void
setExtensions(List<Extension> extensions)

public void
setSubprotocols(List<String> subprotocols)

public void
setUserProperties(Map<String, Object> userProperties)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

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

Field Detail

decodersback to summary
private List<Class<? extends Decoder>> decoders
encodersback to summary
private List<Class<? extends Encoder>> encoders
endpointback to summary
private final Endpoint endpoint
Annotations
@Nullable
endpointProviderback to summary
private final BeanCreatingHandlerProvider<Endpoint> endpointProvider
Annotations
@Nullable
extensionsback to summary
private List<Extension> extensions
pathback to summary
private final String path
subprotocolsback to summary
private List<String> subprotocols
userPropertiesback to summary
private final Map<String, Object> userProperties

Constructor Detail

ServerEndpointRegistrationback to summary
public ServerEndpointRegistration(String path, Endpoint endpoint)

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint instance.

Parameters
path:String

the endpoint path

endpoint:Endpoint

the endpoint instance

ServerEndpointRegistrationback to summary
public ServerEndpointRegistration(String path, Class<? extends Endpoint> endpointClass)

Create a new ServerEndpointRegistration instance from an jakarta.websocket.Endpoint class.

Parameters
path:String

the endpoint path

endpointClass:Class<? extends Endpoint>

the endpoint class

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
getEndpointback to summary
public Endpoint getEndpoint()
getEndpointClassback to summary
public Class<? extends Endpoint> getEndpointClass()

Implements jakarta.websocket.server.ServerEndpointConfig.getEndpointClass.

Annotations
@Override
getEndpointInstanceback to summary
public final <T> T getEndpointInstance(Class<T> clazz) 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
modifyHandshakeback to summary
public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)

Overrides jakarta.websocket.server.ServerEndpointConfig.Configurator.modifyHandshake.

Annotations
@Override
setBeanFactoryback to summary
public void setBeanFactory(BeanFactory beanFactory)

Implements org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

Doc from org.springframework.beans.factory.BeanFactoryAware.setBeanFactory.

Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean#afterPropertiesSet() or a custom init-method.

Parameters
beanFactory:BeanFactory

owning BeanFactory (never null). The bean can immediately call methods on the factory.

Annotations
@Override
setDecodersback to summary
public void setDecoders(List<Class<? extends Decoder>> decoders)
setEncodersback to summary
public void setEncoders(List<Class<? extends Encoder>> encoders)
setExtensionsback to summary
public void setExtensions(List<Extension> extensions)
setSubprotocolsback to summary
public void setSubprotocols(List<String> subprotocols)
setUserPropertiesback to summary
public void setUserProperties(Map<String, Object> userProperties)
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