public class ServerEndpointRegistration extends Object implements javax.websocket.server.ServerEndpointConfig, BeanFactoryAware
ServerEndpointConfig that also
contains the target Endpoint, provided either as a reference or
as a bean name.
ServerEndpointRegistration beans are detected by
ServerEndpointExporter and registered with a Java WebSocket runtime at startup.
ServerEndpointExporter| Constructor and Description |
|---|
ServerEndpointRegistration(String path,
Class<? extends javax.websocket.Endpoint> endpointClass)
Create a new
ServerEndpointRegistration instance from an
javax.webscoket.Endpoint class. |
ServerEndpointRegistration(String path,
javax.websocket.Endpoint endpoint)
Create a new
ServerEndpointRegistration instance from an
javax.webscoket.Endpoint instance. |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkOrigin(String originHeaderValue) |
javax.websocket.server.ServerEndpointConfig.Configurator |
getConfigurator() |
List<Class<? extends javax.websocket.Decoder>> |
getDecoders() |
List<Class<? extends javax.websocket.Encoder>> |
getEncoders() |
javax.websocket.Endpoint |
getEndpoint() |
Class<? extends javax.websocket.Endpoint> |
getEndpointClass() |
List<javax.websocket.Extension> |
getExtensions() |
protected List<javax.websocket.Extension> |
getNegotiatedExtensions(List<javax.websocket.Extension> installed,
List<javax.websocket.Extension> requested) |
protected String |
getNegotiatedSubprotocol(List<String> supported,
List<String> requested) |
String |
getPath() |
List<String> |
getSubprotocols() |
Map<String,Object> |
getUserProperties() |
protected void |
modifyHandshake(javax.websocket.server.HandshakeRequest request,
javax.websocket.HandshakeResponse response) |
void |
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.
|
void |
setDecoders(List<Class<? extends javax.websocket.Decoder>> decoders) |
void |
setEncoders(List<Class<? extends javax.websocket.Encoder>> encoders) |
void |
setExtensions(List<javax.websocket.Extension> extensions) |
void |
setSubprotocols(List<String> subprotocols) |
void |
setUserProperties(Map<String,Object> userProperties) |
public ServerEndpointRegistration(String path, Class<? extends javax.websocket.Endpoint> endpointClass)
ServerEndpointRegistration instance from an
javax.webscoket.Endpoint class.path - the endpoint pathendpointClass - the endpoint classpublic ServerEndpointRegistration(String path, javax.websocket.Endpoint endpoint)
ServerEndpointRegistration instance from an
javax.webscoket.Endpoint instance.path - the endpoint pathendpoint - the endpoint instancepublic String getPath()
getPath in interface javax.websocket.server.ServerEndpointConfigpublic Class<? extends javax.websocket.Endpoint> getEndpointClass()
getEndpointClass in interface javax.websocket.server.ServerEndpointConfigpublic javax.websocket.Endpoint getEndpoint()
public List<String> getSubprotocols()
getSubprotocols in interface javax.websocket.server.ServerEndpointConfigpublic void setExtensions(List<javax.websocket.Extension> extensions)
public List<javax.websocket.Extension> getExtensions()
getExtensions in interface javax.websocket.server.ServerEndpointConfigpublic Map<String,Object> getUserProperties()
getUserProperties in interface javax.websocket.EndpointConfigpublic List<Class<? extends javax.websocket.Encoder>> getEncoders()
getEncoders in interface javax.websocket.EndpointConfigpublic List<Class<? extends javax.websocket.Decoder>> getDecoders()
getDecoders in interface javax.websocket.EndpointConfigpublic javax.websocket.server.ServerEndpointConfig.Configurator getConfigurator()
getConfigurator in interface javax.websocket.server.ServerEndpointConfigpublic void setBeanFactory(BeanFactory beanFactory) throws BeansException
BeanFactoryAwareInvoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
setBeanFactory in interface BeanFactoryAwarebeanFactory - owning BeanFactory (never null).
The bean can immediately call methods on the factory.BeansException - in case of initialization errorsBeanInitializationExceptionprotected void modifyHandshake(javax.websocket.server.HandshakeRequest request,
javax.websocket.HandshakeResponse response)
protected boolean checkOrigin(String originHeaderValue)
protected String getNegotiatedSubprotocol(List<String> supported, List<String> requested)