org.springframework.web.socket.server.standard

Class ServerEndpointRegistration

java.lang.Object

ServerEndpointConfig.Configurator

org.springframework.web.socket.server.standard.ServerEndpointRegistration

All Implemented Interfaces:

Aware, BeanFactoryAware

public class ServerEndpointRegistration
extends ServerEndpointConfig.Configurator
implements BeanFactoryAware

An implementation of javax.websocket.server.ServerEndpointConfig for use in Spring applications. A ServerEndpointRegistration bean is detected by ServerEndpointExporter and registered with a Java WebSocket runtime at startup.

Class constructors accept a singleton javax.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 javax.websocket.server.ServerEndpointConfig.Configurator to make it easier to override methods for customizing the handshake process.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

ServerEndpointExporter

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.Class<? extends Decoder>>	decoders
private java.util.List<java.lang.Class<? extends Encoder>>	encoders
private Endpoint	endpoint
private BeanCreatingHandlerProvider<Endpoint>	endpointProvider
private java.util.List<Extension>	extensions
private java.lang.String	path
private java.util.List<java.lang.String>	protocols
private java.util.Map<java.lang.String,java.lang.Object>	userProperties

Constructor Summary

Constructors

Constructor and Description
ServerEndpointRegistration(java.lang.String path, java.lang.Class<? extends Endpoint> endpointClass) Create a new ServerEndpointRegistration instance from an javax.websocket.Endpoint class.
ServerEndpointRegistration(java.lang.String path, Endpoint endpoint) Create a new ServerEndpointRegistration instance from an javax.websocket.Endpoint instance.

Method Summary

Modifier and Type	Method and Description
boolean	checkOrigin(java.lang.String originHeaderValue)
Configurator	getConfigurator()
java.util.List<java.lang.Class<? extends Decoder>>	getDecoders()
java.util.List<java.lang.Class<? extends Encoder>>	getEncoders()
Endpoint	getEndpoint()
java.lang.Class<? extends Endpoint>	getEndpointClass()
<T> T	getEndpointInstance(java.lang.Class<T> clazz)
java.util.List<Extension>	getExtensions()
java.util.List<Extension>	getNegotiatedExtensions(java.util.List<Extension> installed, java.util.List<Extension> requested)
java.lang.String	getNegotiatedSubprotocol(java.util.List<java.lang.String> supported, java.util.List<java.lang.String> requested)
java.lang.String	getPath()
java.util.List<java.lang.String>	getSubprotocols()
java.util.Map<java.lang.String,java.lang.Object>	getUserProperties()
void	modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
void	setDecoders(java.util.List<java.lang.Class<? extends Decoder>> decoders)
void	setEncoders(java.util.List<java.lang.Class<? extends Encoder>> encoders)
void	setExtensions(java.util.List<Extension> extensions)
void	setSubprotocols(java.util.List<java.lang.String> protocols)
void	setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

path

private final java.lang.String path

endpointProvider

private final BeanCreatingHandlerProvider<Endpoint> endpointProvider

endpoint

private final Endpoint endpoint

encoders

private java.util.List<java.lang.Class<? extends Encoder>> encoders

decoders

private java.util.List<java.lang.Class<? extends Decoder>> decoders

protocols

private java.util.List<java.lang.String> protocols

extensions

private java.util.List<Extension> extensions

userProperties

private final java.util.Map<java.lang.String,java.lang.Object> userProperties

Constructor Detail

ServerEndpointRegistration

public ServerEndpointRegistration(java.lang.String path,
                                  java.lang.Class<? extends Endpoint> endpointClass)

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

Parameters:

path - the endpoint path

endpointClass - the endpoint class

ServerEndpointRegistration

public ServerEndpointRegistration(java.lang.String path,
                                  Endpoint endpoint)

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

Parameters:

path - the endpoint path

endpoint - the endpoint instance

Method Detail

getPath

public java.lang.String getPath()

getEndpointClass

public java.lang.Class<? extends Endpoint> getEndpointClass()

getEndpoint

public Endpoint getEndpoint()

setSubprotocols

public void setSubprotocols(java.util.List<java.lang.String> protocols)

getSubprotocols

public java.util.List<java.lang.String> getSubprotocols()

setExtensions

public void setExtensions(java.util.List<Extension> extensions)

getExtensions

public java.util.List<Extension> getExtensions()

setUserProperties

public void setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)

getUserProperties

public java.util.Map<java.lang.String,java.lang.Object> getUserProperties()

setEncoders

public void setEncoders(java.util.List<java.lang.Class<? extends Encoder>> encoders)

getEncoders

public java.util.List<java.lang.Class<? extends Encoder>> getEncoders()

setDecoders

public void setDecoders(java.util.List<java.lang.Class<? extends Decoder>> decoders)

getDecoders

public java.util.List<java.lang.Class<? extends Decoder>> getDecoders()

getConfigurator

public Configurator getConfigurator()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Description copied from interface: BeanFactoryAware

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.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

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

See Also:

BeanInitializationException

getEndpointInstance

public final <T> T getEndpointInstance(java.lang.Class<T> clazz)
                                throws java.lang.InstantiationException

Throws:

java.lang.InstantiationException

modifyHandshake

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

checkOrigin

public boolean checkOrigin(java.lang.String originHeaderValue)

getNegotiatedSubprotocol

public java.lang.String getNegotiatedSubprotocol(java.util.List<java.lang.String> supported,
                                                 java.util.List<java.lang.String> requested)

getNegotiatedExtensions

public java.util.List<Extension> getNegotiatedExtensions(java.util.List<Extension> installed,
                                                         java.util.List<Extension> requested)

toString

public java.lang.String toString()