org.hawkular.feedcomm.ws.server

Class UIClientCommWebSocket

java.lang.Object

org.hawkular.feedcomm.ws.server.UIClientCommWebSocket

public class UIClientCommWebSocket
extends Object

This is similiar to the feed web socket endpoint, however, it has a different set of allowed commants that can be processed for a UI client.

Constructor Summary

Constructors

Constructor and Description
UIClientCommWebSocket()

Method Summary

Modifier and Type	Method and Description
String	uiClientBinaryData(InputStream binaryDataStream, javax.websocket.Session session) When a binary message is received from a UI client, this method will execute the command the client is asking for.
String	uiClientMessage(String nameAndJsonStr, javax.websocket.Session session) When a message is received from a UI client, this method will execute the command the client is asking for.
void	uiClientSessionClose(javax.websocket.Session session, javax.websocket.CloseReason reason)
void	uiClientSessionOpen(javax.websocket.Session session)

Methods inherited from class java.lang.Object

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

Constructor Detail

UIClientCommWebSocket

public UIClientCommWebSocket()

Method Detail

uiClientSessionOpen

public void uiClientSessionOpen(javax.websocket.Session session)

uiClientMessage

public String uiClientMessage(String nameAndJsonStr,
                              javax.websocket.Session session)

When a message is received from a UI client, this method will execute the command the client is asking for.

Parameters:

nameAndJsonStr - the name of the API request followed by "=" followed then by the request's JSON data

session - the client session making the request

Returns:

the results of the command invocation; this is sent back to the UI client

uiClientBinaryData

public String uiClientBinaryData(InputStream binaryDataStream,
                                 javax.websocket.Session session)

When a binary message is received from a UI client, this method will execute the command the client is asking for.

Parameters:

binaryDataStream - contains the JSON request and additional binary data

session - the client session making the request

Returns:

the results of the command invocation; this is sent back to the UI client

uiClientSessionClose

public void uiClientSessionClose(javax.websocket.Session session,
                                 javax.websocket.CloseReason reason)