Class AbstractWebsocketDefinition<T extends BaseWebsocket>

java.lang.Object

ch.tocco.nice2.web.core.api.websocket.SecureWebsocket<T>

ch.tocco.nice2.web.core.api.websocket.AnonymousWebsocket<T>

ch.tocco.nice2.devcon.impl.socket.AbstractWebsocketDefinition<T>

All Implemented Interfaces:

WebSocket<T>

Direct Known Subclasses:

ModelValidationWebsocketDefinition, SqlLoggingWebsocketDefinition

public abstract class AbstractWebsocketDefinition<T extends BaseWebsocket>
extends AnonymousWebsocket<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEBSOCKET_BASE_PATH

Fields inherited from class SecureWebsocket

BUSINESS_UNIT_KEY, CONTEXT_KEY, ORIGIN_ID_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractWebsocketDefinition(WebsocketFactory websocketFactory, SecurityManager securityManager)

Method Summary

Modifier and Type	Method	Description
protected T	doCreateWebSocketInstance()
protected abstract T	doCreateWebSocketInstance(int idleTimeoutSeconds)
protected abstract String	getName()
String	getPath()	The relative path where this endpoint should be published.

Methods inherited from class AnonymousWebsocket

allowAnonymous, getSecurityContext

Methods inherited from class SecureWebsocket

createWebSocketInstance, onHandshake, onLogout, sendMessage, sendMessageToOrigin, sendMessageToUser

Methods inherited from class Object

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

Methods inherited from interface WebSocket

webSocketClass

Field Details

WEBSOCKET_BASE_PATH

public static final String WEBSOCKET_BASE_PATH

See Also:

• Constant Field Values

Constructor Details

AbstractWebsocketDefinition

public AbstractWebsocketDefinition(WebsocketFactory websocketFactory,
 SecurityManager securityManager)

Method Details

doCreateWebSocketInstance

protected T doCreateWebSocketInstance()

Specified by:

doCreateWebSocketInstance in class SecureWebsocket<T extends BaseWebsocket>

doCreateWebSocketInstance

protected abstract T doCreateWebSocketInstance(int idleTimeoutSeconds)

getName

protected abstract String getName()

getPath

public String getPath()

Description copied from interface: WebSocket

The relative path where this endpoint should be published. Should start with '/nice2/websocket/' for consistency reasons.