Package org.exoplatform.documents.service

Class DocumentWebSocketService

java.lang.Object

org.exoplatform.documents.service.DocumentWebSocketService

public class DocumentWebSocketService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMETD_CHANNEL

Constructor Summary

Constructors

Constructor	Description
DocumentWebSocketService(org.exoplatform.ws.frameworks.cometd.ContinuationService continuationService, org.mortbay.cometd.continuation.EXoContinuationBayeux continuationBayeux)

Method Summary

Modifier and Type	Method	Description
void	broadcastMessage(String wsEventName, Object... params)	Propagate an event from Backend to frontend for all users
String	getCometdContextName()
String	getUserToken(String username)	Generate a cometd Token for each user
void	sendBroadcastMessage(String wsEventName, org.exoplatform.documents.model.ActionData actionData)
void	sendMessage(String wsEventName, Collection<String> recipientUsers, Object... params)	Propagate an event from Backend to frontend to add dynamism in pages
void	sendMessage(String wsEventName, org.exoplatform.documents.model.ActionData actionData, org.exoplatform.services.security.Identity identity)
void	sendMessage(org.exoplatform.social.websocket.entity.WebSocketMessage messageObject, Collection<String> recipientUsers)	Propagate an event from Backend to frontend to add dynamism in pages

Methods inherited from class java.lang.Object

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

Field Details

COMETD_CHANNEL

public static final String COMETD_CHANNEL

See Also:

• Constant Field Values

Constructor Details

DocumentWebSocketService

public DocumentWebSocketService(org.exoplatform.ws.frameworks.cometd.ContinuationService continuationService,
 org.mortbay.cometd.continuation.EXoContinuationBayeux continuationBayeux)

Method Details

sendMessage

public void sendMessage(String wsEventName,
 org.exoplatform.documents.model.ActionData actionData,
 org.exoplatform.services.security.Identity identity)

sendMessage

public void sendMessage(String wsEventName,
 Collection<String> recipientUsers,
 Object... params)

Propagate an event from Backend to frontend to add dynamism in pages

Parameters:

wsEventName - event name that will allow Browser to distinguish which behavior to adopt in order to update UI

recipientUsers - Collection of usernames of receivers

params - an Array of parameters to include in message sent via WebSocket

sendMessage

public void sendMessage(org.exoplatform.social.websocket.entity.WebSocketMessage messageObject,
 Collection<String> recipientUsers)

Propagate an event from Backend to frontend to add dynamism in pages

Parameters:

messageObject - WebSocketMessage to transmit via WebSocket

recipientUsers - Collection of usernames of receivers

sendBroadcastMessage

public void sendBroadcastMessage(String wsEventName,
 org.exoplatform.documents.model.ActionData actionData)

broadcastMessage

public void broadcastMessage(String wsEventName,
 Object... params)

Propagate an event from Backend to frontend for all users

Parameters:

wsEventName - event name that will allow Browser to distinguish which behavior to adopt in order to update UI

params - an Array of parameters to include in message sent via WebSocket

getCometdContextName

public String getCometdContextName()

Returns:

'cometd' webapp context name

getUserToken

public String getUserToken(String username)

Generate a cometd Token for each user

Parameters:

username - user name for whom the token will be generated

Returns:

generated cometd token