de.innovationgate.wgpublisher.websockets

Class TMLPageWebSocket

java.lang.Object

de.innovationgate.wgpublisher.websockets.AbstractWebSocket

de.innovationgate.wgpublisher.websockets.TMLPageWebSocket

All Implemented Interfaces:

WebSocket

public class TMLPageWebSocket
extends AbstractWebSocket
implements WebSocket

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TMLPageWebSocket.Configurator

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOG
static java.lang.String	PATH
static java.lang.String	PROP_HTTPSESSION
static java.lang.String	PROP_INVALID
static java.lang.String	PROP_ORIGIN
static java.lang.String	PROP_PAGEID
static java.lang.String	PROP_WINDOWID

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

SESSIONPROP_SOCKET

Constructor Summary

Constructors

Constructor and Description
TMLPageWebSocket()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	firePortletEvent(java.lang.String eventName)
void	firePortletEvent(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> params) Fire a portlet event to Websocket client.
java.net.URI	getOrigin()
PageConnection	getPageConnection()
java.lang.String	getWindowId()
void	onClose(javax.websocket.CloseReason reason)
void	open(javax.websocket.Session session, javax.websocket.EndpointConfig cfg)
java.lang.String	receiveMessage(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

LOG

public static final org.apache.log4j.Logger LOG

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

PROP_INVALID

public static final java.lang.String PROP_INVALID

See Also:

Constant Field Values

PROP_HTTPSESSION

public static final java.lang.String PROP_HTTPSESSION

See Also:

Constant Field Values

PROP_WINDOWID

public static final java.lang.String PROP_WINDOWID

See Also:

Constant Field Values

PROP_PAGEID

public static final java.lang.String PROP_PAGEID

See Also:

Constant Field Values

PROP_ORIGIN

public static final java.lang.String PROP_ORIGIN

See Also:

Constant Field Values

Constructor Detail

TMLPageWebSocket

public TMLPageWebSocket()

Method Detail

open

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

Throws:

de.innovationgate.webgate.api.WGException

java.net.URISyntaxException

onClose

public void onClose(javax.websocket.CloseReason reason)

close

public void close()

firePortletEvent

public void firePortletEvent(java.lang.String eventName)
                      throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

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

getOrigin

public java.net.URI getOrigin()

receiveMessage

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

getPageConnection

public PageConnection getPageConnection()

getWindowId

public java.lang.String getWindowId()