org.argeo.cms.websocket

Class CmsWebSocketConfigurator

java.lang.Object

javax.websocket.server.ServerEndpointConfig.Configurator

org.argeo.cms.websocket.CmsWebSocketConfigurator

public class CmsWebSocketConfigurator
extends javax.websocket.server.ServerEndpointConfig.Configurator

Customises the initialisation of a new web socket.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WEBSOCKET_SUBJECT

Constructor Summary

Constructors

Constructor and Description
CmsWebSocketConfigurator()

Method Summary

Modifier and Type	Method and Description
boolean	checkOrigin(java.lang.String originHeaderValue)
<T> T	getEndpointInstance(java.lang.Class<T> endpointClass)
java.util.List<javax.websocket.Extension>	getNegotiatedExtensions(java.util.List<javax.websocket.Extension> installed, java.util.List<javax.websocket.Extension> requested)
java.lang.String	getNegotiatedSubprotocol(java.util.List<java.lang.String> supported, java.util.List<java.lang.String> requested)
void	modifyHandshake(javax.websocket.server.ServerEndpointConfig sec, javax.websocket.server.HandshakeRequest request, javax.websocket.HandshakeResponse response)
protected void	rejectResponse(javax.websocket.HandshakeResponse response, java.lang.Exception e) Behaviour when the web socket could not be authenticated.

Methods inherited from class java.lang.Object

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

Field Detail

WEBSOCKET_SUBJECT

public static final java.lang.String WEBSOCKET_SUBJECT

See Also:

Constant Field Values

Constructor Detail

CmsWebSocketConfigurator

public CmsWebSocketConfigurator()

Method Detail

checkOrigin

public boolean checkOrigin(java.lang.String originHeaderValue)

Overrides:

checkOrigin in class javax.websocket.server.ServerEndpointConfig.Configurator

getEndpointInstance

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

Overrides:

getEndpointInstance in class javax.websocket.server.ServerEndpointConfig.Configurator

Throws:

java.lang.InstantiationException

getNegotiatedExtensions

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

Overrides:

getNegotiatedExtensions in class javax.websocket.server.ServerEndpointConfig.Configurator

getNegotiatedSubprotocol

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

Overrides:

getNegotiatedSubprotocol in class javax.websocket.server.ServerEndpointConfig.Configurator

modifyHandshake

public void modifyHandshake(javax.websocket.server.ServerEndpointConfig sec,
                            javax.websocket.server.HandshakeRequest request,
                            javax.websocket.HandshakeResponse response)

Overrides:

modifyHandshake in class javax.websocket.server.ServerEndpointConfig.Configurator

rejectResponse

protected void rejectResponse(javax.websocket.HandshakeResponse response,
                              java.lang.Exception e)

Behaviour when the web socket could not be authenticated. Throws an IllegalStateException by default.

Parameters:

e - can be null