de.innovationgate.wgpublisher.websockets

Class IndependentWebSocket

java.lang.Object

de.innovationgate.wgpublisher.websockets.AbstractWebSocket

de.innovationgate.wgpublisher.websockets.IndependentWebSocket

All Implemented Interfaces:

WebSocket

public class IndependentWebSocket
extends AbstractWebSocket
implements WebSocket

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndependentWebSocket.Configurator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH
static java.lang.String	PROP_AUTH
static java.lang.String	PROP_DBKEY
static java.lang.String	PROP_SOCKET

Fields inherited from class de.innovationgate.wgpublisher.websockets.AbstractWebSocket

LOG, SESSIONPROP_SOCKET

Constructor Summary

Constructors

Constructor and Description
IndependentWebSocket()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	firePortletEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> params) Fire a portlet event to Websocket client.
void	onClose(javax.websocket.CloseReason reason)
void	open(javax.websocket.Session session, javax.websocket.EndpointConfig cfg, java.lang.String dbKey)
java.lang.String	receiveMessage(java.lang.String dbKey, java.lang.String messageStr)
void	sendMessage(java.util.Map<java.lang.String,java.lang.Object> data) Send a custom message to to the Websocket client.

Methods inherited from class de.innovationgate.wgpublisher.websockets.AbstractWebSocket

doSend, error, getFromSession, getScopeObjectRegistry, getSession, initSession, isConnected

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

PROP_DBKEY

public static final java.lang.String PROP_DBKEY

See Also:

Constant Field Values

PROP_AUTH

public static final java.lang.String PROP_AUTH

See Also:

Constant Field Values

PROP_SOCKET

public static final java.lang.String PROP_SOCKET

See Also:

Constant Field Values

Constructor Detail

IndependentWebSocket

public IndependentWebSocket()

Method Detail

open

public void open(javax.websocket.Session session,
        javax.websocket.EndpointConfig cfg,
        java.lang.String dbKey)
          throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

onClose

public void onClose(javax.websocket.CloseReason reason)

close

public void close()

firePortletEvent

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

Description copied from interface: WebSocket

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

Specified by:

firePortletEvent in interface WebSocket

Parameters:

eventName - The portlet event name

params - Event parameters

Throws:

de.innovationgate.webgate.api.WGException

sendMessage

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

Description copied from interface: WebSocket

Send a custom message to to the Websocket client.

Specified by:

sendMessage in interface WebSocket

Throws:

de.innovationgate.webgate.api.WGException

receiveMessage

public java.lang.String receiveMessage(java.lang.String dbKey,
                              java.lang.String messageStr)