de.innovationgate.wga.server.api.tml

Interface WebSocket

All Known Implementing Classes:

IndependentWebSocket, TMLPageWebSocket

public interface WebSocket

A server-side Websocket endpoint, used to communicate with Websocket client

Method Summary

Methods

Modifier and Type	Method and Description
void	firePortletEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> params) Fire a portlet event to Websocket client.
void	sendMessage(java.util.Map<java.lang.String,java.lang.Object> data) Send a custom message to to the Websocket client.

Method Detail

firePortletEvent

void firePortletEvent(java.lang.String eventName,
                    java.util.Map<java.lang.String,java.lang.Object> params)
                      throws de.innovationgate.webgate.api.WGException

Fire a portlet event to Websocket client. Will only work if the client is an HTML page (or listens to portlet event messages)

Parameters:

eventName - The portlet event name

params - Event parameters

Throws:

de.innovationgate.webgate.api.WGException

sendMessage

void sendMessage(java.util.Map<java.lang.String,java.lang.Object> data)
                 throws de.innovationgate.webgate.api.WGException

Send a custom message to to the Websocket client.

Parameters:

data -

Throws:

de.innovationgate.webgate.api.WGException