Package ch.tocco.nice2.notificationcenter.impl

Class NotificationWebsocketDefinition

java.lang.Object

ch.tocco.nice2.web.core.api.websocket.SecureWebsocket<NotificationWebsocketDefinition.NotificationWebsocket>

ch.tocco.nice2.notificationcenter.impl.NotificationWebsocketDefinition

All Implemented Interfaces:

WebSocket<NotificationWebsocketDefinition.NotificationWebsocket>

@Component
public class NotificationWebsocketDefinition
extends SecureWebsocket<NotificationWebsocketDefinition.NotificationWebsocket>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationWebsocketDefinition.NotificationWebsocket

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEBSOCKET_PATH

Fields inherited from class ch.tocco.nice2.web.core.api.websocket.SecureWebsocket

BUSINESS_UNIT_KEY, CONTEXT_KEY, ORIGIN_ID_KEY

Constructor Summary

Constructors

Constructor	Description
NotificationWebsocketDefinition(org.slf4j.Logger logger, WebsocketFactory websocketFactory)

Method Summary

Modifier and Type	Method	Description
protected boolean	allowAnonymous()
protected NotificationWebsocketDefinition.NotificationWebsocket	doCreateWebSocketInstance()
String	getPath()	The relative path where this endpoint should be published.
Class<NotificationWebsocketDefinition.NotificationWebsocket>	webSocketClass()	Class of the WebSocket implementation (must extend javax.websocket.Endpoint)

Methods inherited from class ch.tocco.nice2.web.core.api.websocket.SecureWebsocket

createWebSocketInstance, getSecurityContext, onHandshake, onLogout, sendMessage, sendMessageToOrigin, sendMessageToUser

Methods inherited from class java.lang.Object

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

Field Details

WEBSOCKET_PATH

public static final String WEBSOCKET_PATH

See Also:

• Constant Field Values

Constructor Details

NotificationWebsocketDefinition

public NotificationWebsocketDefinition(org.slf4j.Logger logger,
 WebsocketFactory websocketFactory)

Method Details

webSocketClass

public Class<NotificationWebsocketDefinition.NotificationWebsocket> webSocketClass()

Description copied from interface: WebSocket

Class of the WebSocket implementation (must extend javax.websocket.Endpoint)

doCreateWebSocketInstance

protected NotificationWebsocketDefinition.NotificationWebsocket doCreateWebSocketInstance()

Specified by:

doCreateWebSocketInstance in class SecureWebsocket<NotificationWebsocketDefinition.NotificationWebsocket>

allowAnonymous

protected boolean allowAnonymous()

Specified by:

allowAnonymous in class SecureWebsocket<NotificationWebsocketDefinition.NotificationWebsocket>

Returns:

true if unauthenticated users are supported by this web socket

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.