Package co.arago.hiro.client.websocket

Class ActionWebSocket

java.lang.Object

co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

co.arago.hiro.client.websocket.ActionWebSocket

All Implemented Interfaces:

java.lang.AutoCloseable

public class ActionWebSocket
extends AuthenticatedWebSocketHandler

The handler for Action WebSocket.

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionWebSocket.Builder
static class	ActionWebSocket.Conf<T extends ActionWebSocket.Conf<T>>
protected class	ActionWebSocket.InternalActionListener	Listener class for Action WebSockets.
static class	ActionWebSocket.ResultParams	This creates a useful payload for the ActionHandlerResult.

Nested classes/interfaces inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

AuthenticatedWebSocketHandler.InternalListener, AuthenticatedWebSocketHandler.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected int	resultRetries

Fields inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

apiName, endpoint, fragment, headers, internalListener, maxRetries, name, protocol, query, reconnectOnFailedSend, status, tokenAPIHandler, webSocketRequestTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionWebSocket(ActionWebSocket.Conf<?> builder)	Constructor

Method Summary

Modifier and Type	Method	Description
void	close()	Clears the stores.
static ActionWebSocket.Conf<?>	newBuilder(TokenAPIHandler tokenAPIHandler, ActionWebSocketListener actionWebSocketListener)	Get a ActionWebSocket.Builder for ActionWebSocket.
static ActionWebSocket.ResultParams	newResultParams()	Static creator
void	sendActionResult(java.lang.String id, ActionWebSocket.ResultParams resultParams)	Send an ActionHandlerResult using the provided id and a ResultParams structure.
void	sendActionResult(java.lang.String id, java.lang.String result)	Send an ActionHandlerResult using the provided id and result string.

Methods inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

backoff, closeWebSocket, createWebSocket, restartWebSocket, send, start

Methods inherited from class java.lang.Object

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

Field Detail

resultRetries

protected int resultRetries

Constructor Detail

ActionWebSocket

protected ActionWebSocket(ActionWebSocket.Conf<?> builder)

Constructor

Parameters:

builder - The builder for this class.

Method Detail

newResultParams

public static ActionWebSocket.ResultParams newResultParams()

Static creator

Returns:

A new ActionWebSocket.ResultParams structure.

newBuilder

public static ActionWebSocket.Conf<?> newBuilder(TokenAPIHandler tokenAPIHandler,
                                                 ActionWebSocketListener actionWebSocketListener)

Get a ActionWebSocket.Builder for ActionWebSocket.

Parameters:

tokenAPIHandler - The API handler for this websocket.

actionWebSocketListener - The listener for this websocket.

Returns:

The ActionWebSocket.Builder for ActionWebSocket.

sendActionResult

public void sendActionResult(java.lang.String id,
                             ActionWebSocket.ResultParams resultParams)
                      throws HiroException,
                             java.io.IOException,
                             java.lang.InterruptedException

Send an ActionHandlerResult using the provided id and a ResultParams structure.

Parameters:

id - The id of the action message conversation.

resultParams - Standard result structure for the result.

Throws:

HiroException - On protocol errors

java.io.IOException - On IO or JSON parsing errors.

java.lang.InterruptedException - When a sleep gets interrupted.

sendActionResult

public void sendActionResult(java.lang.String id,
                             java.lang.String result)
                      throws HiroException,
                             java.io.IOException,
                             java.lang.InterruptedException

Send an ActionHandlerResult using the provided id and result string.

Parameters:

id - The id of the action message conversation.

result - The result string for the ActionHandlerResult.

Throws:

HiroException - On protocol errors

java.io.IOException - On IO or JSON parsing errors.

java.lang.InterruptedException - When a sleep gets interrupted.

close

public void close()

Clears the stores. This object cannot be used again thereafter.

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class AuthenticatedWebSocketHandler