org.hawkular.cmdgw.command.ws.server

Class AbstractGatewayWebSocket

java.lang.Object

org.hawkular.cmdgw.command.ws.server.AbstractGatewayWebSocket

Direct Known Subclasses:

FeedWebSocket, UIClientWebSocket

public abstract class AbstractGatewayWebSocket
extends Object

A common parent for FeedWebSocket and UIClientWebSocket.

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
protected org.hawkular.accounts.websocket.Authenticator	authenticator
protected BusEndpointProcessors	busEndpointProcessors These perform some additional processing when UI clients or feeds connect and disconnect.
protected WsCommandContextFactory	commandContextFactory
protected String	endpoint This is the actual URL context of the websocket endpoint.
protected WsCommands	wsCommands
protected WsEndpoints	wsEndpoints A container that holds all known and currently active websocket clients (UI and feed clients).

Constructor Summary

Constructors

Constructor and Description
AbstractGatewayWebSocket(String endpoint)

Method Summary

Modifier and Type	Method and Description
protected void	authenticate(org.hawkular.bus.common.BasicMessage basicMessage, javax.websocket.Session session) This makes sure the message is properly authenticated.
protected void	handleRequest(javax.websocket.Session session, org.hawkular.bus.common.BasicMessageWithExtraData<org.hawkular.bus.common.BasicMessage> requestWithBinary)
void	onBinaryMessage(InputStream binaryDataStream, javax.websocket.Session session) When a binary message is received from a WebSocket client, this method will lookup the WsCommand for the given request class and execute it.
void	onMessage(String nameAndJsonStr, javax.websocket.Session session) When a message is received from a WebSocket client, this method will lookup the WsCommand for the given request class and execute it.
protected void	sendErrorResponse(javax.websocket.Session session, String errorMessage, Throwable t)

Methods inherited from class java.lang.Object

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

Field Detail

authenticator

@Inject
protected org.hawkular.accounts.websocket.Authenticator authenticator

commandContextFactory

@Inject
protected WsCommandContextFactory commandContextFactory

endpoint

protected final String endpoint

This is the actual URL context of the websocket endpoint. For example, something like "ui/ws" for a UI client websocket endpoint or "feed/{feedId}" for a feed websocket endpoint.

wsCommands

@Inject
protected WsCommands wsCommands

wsEndpoints

@Inject
protected WsEndpoints wsEndpoints

A container that holds all known and currently active websocket clients (UI and feed clients).

busEndpointProcessors

@Inject
protected BusEndpointProcessors busEndpointProcessors

These perform some additional processing when UI clients or feeds connect and disconnect. This performs such tasks as adding and removing bus listeners that will help process message flow for UI clients and feeds.

Constructor Detail

AbstractGatewayWebSocket

public AbstractGatewayWebSocket(String endpoint)

Method Detail

authenticate

protected void authenticate(org.hawkular.bus.common.BasicMessage basicMessage,
                            javax.websocket.Session session)
                     throws org.hawkular.accounts.websocket.WebsocketAuthenticationException

This makes sure the message is properly authenticated. If the message is not authenticated with the appropriate credentials, an exception is thrown. Otherwise, this returns silently, allowing the caller to continue.

Parameters:

basicMessage - the message (including its authentication credentials) to be authenticated

session - the session that sent the message

Throws:

org.hawkular.accounts.websocket.WebsocketAuthenticationException - if the authentication check fails

handleRequest

protected void handleRequest(javax.websocket.Session session,
                             org.hawkular.bus.common.BasicMessageWithExtraData<org.hawkular.bus.common.BasicMessage> requestWithBinary)
                      throws org.hawkular.accounts.websocket.WebsocketAuthenticationException,
                             NoCommandForMessageException,
                             Exception

Throws:

org.hawkular.accounts.websocket.WebsocketAuthenticationException

NoCommandForMessageException

Exception

onBinaryMessage

public void onBinaryMessage(InputStream binaryDataStream,
                            javax.websocket.Session session)

When a binary message is received from a WebSocket client, this method will lookup the WsCommand for the given request class and execute it.

Parameters:

binaryDataStream - contains the JSON request and additional binary data

session - the client session making the request

onMessage

public void onMessage(String nameAndJsonStr,
                      javax.websocket.Session session)

When a message is received from a WebSocket client, this method will lookup the WsCommand for the given request class and execute it.

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

sendErrorResponse

protected void sendErrorResponse(javax.websocket.Session session,
                                 String errorMessage,
                                 Throwable t)