Package co.arago.hiro.client.websocket

Class AuthenticatedWebSocketHandler

java.lang.Object

co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ActionWebSocket, EventWebSocket

public abstract class AuthenticatedWebSocketHandler
extends java.lang.Object
implements java.lang.AutoCloseable

Handles websockets. Tries to renew any aborted connection until the websocket gets closed from this side.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticatedWebSocketHandler.Conf<T extends AuthenticatedWebSocketHandler.Conf<T>>	Configuration interface for all the parameters of an AuthenticatedAPIHandler.
protected class	AuthenticatedWebSocketHandler.InternalListener	HiroWebSocketListener (thread) for incoming websocket messages.
static class	AuthenticatedWebSocketHandler.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	apiName
protected java.lang.String	endpoint
protected java.lang.String	fragment
protected HttpHeaderMap	headers
protected AuthenticatedWebSocketHandler.InternalListener	internalListener
protected int	maxRetries
protected java.lang.String	name
protected java.lang.String	protocol
protected URIEncodedData	query
protected boolean	reconnectOnFailedSend
protected java.util.concurrent.atomic.AtomicReference<AuthenticatedWebSocketHandler.Status>	status
protected TokenAPIHandler	tokenAPIHandler
protected long	webSocketRequestTimeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected int	backoff(int reconnectDelay)	Backoff operations that fail.
void	close()
protected void	closeWebSocket(int status, java.lang.String reason)	Close the websocket and set webSocket to null.
protected void	createWebSocket()	Create new WebSocket.
protected void	restartWebSocket(boolean refreshToken)	Restarts the websocket by closing the old and creating a new one.
void	send(java.lang.String message)	Send a message across the websocket.
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

status

protected final java.util.concurrent.atomic.AtomicReference<AuthenticatedWebSocketHandler.Status> status

name

protected final java.lang.String name

apiName

protected final java.lang.String apiName

endpoint

protected final java.lang.String endpoint

protocol

protected final java.lang.String protocol

maxRetries

protected final int maxRetries

tokenAPIHandler

protected final TokenAPIHandler tokenAPIHandler

query

protected final URIEncodedData query

headers

protected final HttpHeaderMap headers

fragment

protected final java.lang.String fragment

reconnectOnFailedSend

protected final boolean reconnectOnFailedSend

webSocketRequestTimeout

protected final long webSocketRequestTimeout

internalListener

protected AuthenticatedWebSocketHandler.InternalListener internalListener

Constructor Detail

AuthenticatedWebSocketHandler

protected AuthenticatedWebSocketHandler(AuthenticatedWebSocketHandler.Conf<?> builder)

Protected Constructor

Parameters:

builder - The builder for this Handler.

Method Detail

createWebSocket

protected void createWebSocket()
                        throws HiroException,
                               java.io.IOException,
                               java.lang.InterruptedException

Create new WebSocket. Closes any old websocket.

Throws:

HiroException - When creation of the webSocket fails.

java.io.IOException - On IO problems.

java.lang.InterruptedException - When the call gets interrupted.

closeWebSocket

protected void closeWebSocket(int status,
                              java.lang.String reason)

Close the websocket and set webSocket to null.

Parameters:

status - The status for the close message

reason - The reason string for the close message.

restartWebSocket

protected void restartWebSocket(boolean refreshToken)
                         throws HiroException,
                                java.io.IOException,
                                java.lang.InterruptedException

Restarts the websocket by closing the old and creating a new one. Uses the same internalListener. Delays the restart according to backoff(int reconnectDelay).

Parameters:

refreshToken - Refresh the current token.

Throws:

HiroException - When creation of the webSocket fails.

java.io.IOException - On IO problems.

java.lang.InterruptedException - When the call gets interrupted.

backoff

protected int backoff(int reconnectDelay)
               throws java.lang.InterruptedException

Backoff operations that fail. The delay increases with every try up to 10 minutes.

Parameters:

reconnectDelay - The old delay value (seconds).

Returns:

The new delay value (seconds).

Throws:

java.lang.InterruptedException - When Thread.sleep(long) gets interrupted.

See Also:

send(String), restartWebSocket(boolean)

send

public void send(java.lang.String message)
          throws HiroException,
                 java.lang.InterruptedException,
                 java.io.IOException

Send a message across the websocket. Tries maxRetries times to send a message before resetting the websocket.

Parameters:

message - The message to send.

Throws:

HiroException - When sending finally fails.

java.io.IOException - On IO problems.

java.lang.InterruptedException - When the call gets interrupted.

start

public void start()
           throws HiroException,
                  java.io.IOException,
                  java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable