Package gov.usgs.earthquake.distribution

Class WebSocketNotificationReceiver

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.distribution.DefaultNotificationReceiver

gov.usgs.earthquake.distribution.WebSocketNotificationReceiver

All Implemented Interfaces:

NotificationIndexCleanup.Listener, NotificationReceiver, WebSocketListener, Configurable

public class WebSocketNotificationReceiver
extends DefaultNotificationReceiver
implements WebSocketListener

Receives notifications from an arbitrary web socket.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_MESSAGE_INTERVAL	Variable for anyMessageIntervalMillis string
static final String	ATTRIBUTE_DATA	attribute for data
static final String	CONNECT_ATTEMPTS_PROPERTY	Property for connectAttempts
static final String	CONNECT_TIMEOUT_PROPERTY	Property for connectTimeout
static final String	DEFAULT_ANY_MESSAGE_INTERVAL_MILLIS	Default for interval for any message
static final String	DEFAULT_CONNECT_ATTEMPTS	Default number of connect attempts
static final String	DEFAULT_CONNECT_TIMEOUT	Default timeout in ms
static final String	DEFAULT_PING_INTERVAL_MILLIS	Default for time in between pings to server
static final String	DEFAULT_PING_WAIT_MILLIS	Default for how long to wait for pong response to ping before closing or restarting connection
static final String	DEFAULT_RETRY_ON_CLOSE	Default condiction for retry on close
static final String	DEFAULT_SERVER_HOST	Default server host
static final String	DEFAULT_SERVER_PATH	Default server path
static final String	DEFAULT_SERVER_PORT	Default server port
static final String	DEFAULT_TRACKING_FILE_NAME	Default tracking file
static final Logger	LOGGER	Logger for use in the file
static final String	PING_INTERVAL	Variable for pingIntervalMillis string
static final String	PING_WAIT	Variable for pingWait string
static final String	RETRY_ON_CLOSE_PROPERTY	Property for retryOnClose
static final String	SEQUENCE_PROPERTY	Property for sequence
static final String	SERVER_HOST_PROPERTY	Property for serverHost
static final String	SERVER_PATH_PROPERTY	Property for serverPath
static final String	SERVER_PORT_PROPERTY	Property for serverPort
static final String	TIMESTAMP_PROPERTY	Property for timestamp
static final String	TRACKING_FILE_NAME_PROPERTY	Property for trackingFileName

Fields inherited from class gov.usgs.earthquake.distribution.DefaultNotificationReceiver

DEFAULT_PRODUCT_STORAGE_MAX_AGE, DEFAULT_READ_TIMEOUT, DEFAULT_RECEIVER_CLEANUP, EXECUTOR_LISTENER_NOTIFIER, FUTURE_LISTENER_NOTIFIER, INDEX_FILE_PROPERTY, LISTENER_NOTIFIER_PROPERTY, NOTIFICATION_INDEX_PROPERTY, PRODUCT_STORAGE_MAX_AGE_PROPERTY, PRODUCT_STORAGE_PROPERTY, READ_TIMEOUT_PROPERTY, RECEIVER_CLEANUP_PROPERTY, ROUNDROBIN_LISTENER_NOTIFIER, STORAGE_DIRECTORY_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebSocketNotificationReceiver()

Method Summary

Modifier and Type	Method	Description
void	configure(Config config)	Process configuration settings.
int	getAttempts()
String	getSequence()
String	getServerHost()
String	getServerPath()
String	getServerPort()
long	getTimeout()
String	getTrackingFileName()
void	onClose(javax.websocket.Session session, javax.websocket.CloseReason closeReason)	Interface method to be overriden by WebSocket files and AwsProductReceiver
void	onConnectFail()	Interface method to be overriden by WebSocket files and AwsProductReceiver
void	onMessage(String message)	Message handler function passed to WebSocketClient Parses the message as JSON, receives the contained URL notification, and writes the tracking file.
void	onOpen(javax.websocket.Session session)	Interface method to be overriden by WebSocket files and AwsProductReceiver
void	onReconnectFail()	Interface method to be overriden by WebSocket files and AwsProductReceiver
javax.json.JsonObject	readTrackingFile()	Reads tracking file from disc
void	setAttempts(int attempts)
void	setSequence(String sequence)
void	setServerHost(String serverHost)
void	setServerPath(String serverPath)
void	setServerPort(String serverPort)
void	setTimeout(long timeout)
void	setTrackingFileName(String trackingFileName)
void	shutdown()	Closes web socket
void	startup()	Reads a sequence from a tracking file if it exists.
void	writeTrackingFile()	Writes tracking file to disc, storing latest sequence

Methods inherited from class gov.usgs.earthquake.distribution.DefaultNotificationReceiver

addNotificationListener, getConnectTimeout, getListenerQueueStatus, getNotificationIndex, getNotifier, getProductStorage, getProductStorageMaxAge, getQueueStatus, getReadTimeout, getReceiverCleanupInterval, notifyListeners, onExpiredNotification, receiveNotification, removeExpiredNotifications, removeNotificationListener, retrieveProduct, sendNotifications, setConnectTimeout, setNotificationIndex, setNotifier, setProductStorage, setProductStorageMaxAge, setReadTimeout, setReceiverCleanupInterval, storeProductSource, throttleQueues

Methods inherited from class gov.usgs.util.DefaultConfigurable

getName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.usgs.util.Configurable

getName, setName

Field Details

LOGGER

public static final Logger LOGGER

Logger for use in the file

SERVER_HOST_PROPERTY

public static final String SERVER_HOST_PROPERTY

Property for serverHost

See Also:

• Constant Field Values

SERVER_PORT_PROPERTY

public static final String SERVER_PORT_PROPERTY

Property for serverPort

See Also:

• Constant Field Values

SERVER_PATH_PROPERTY

public static final String SERVER_PATH_PROPERTY

Property for serverPath

See Also:

• Constant Field Values

SEQUENCE_PROPERTY

public static final String SEQUENCE_PROPERTY

Property for sequence

See Also:

• Constant Field Values

TIMESTAMP_PROPERTY

public static final String TIMESTAMP_PROPERTY

Property for timestamp

See Also:

• Constant Field Values

TRACKING_FILE_NAME_PROPERTY

public static final String TRACKING_FILE_NAME_PROPERTY

Property for trackingFileName

See Also:

• Constant Field Values

CONNECT_ATTEMPTS_PROPERTY

public static final String CONNECT_ATTEMPTS_PROPERTY

Property for connectAttempts

See Also:

• Constant Field Values

CONNECT_TIMEOUT_PROPERTY

public static final String CONNECT_TIMEOUT_PROPERTY

Property for connectTimeout

See Also:

• Constant Field Values

RETRY_ON_CLOSE_PROPERTY

public static final String RETRY_ON_CLOSE_PROPERTY

Property for retryOnClose

See Also:

• Constant Field Values

PING_INTERVAL

public static final String PING_INTERVAL

Variable for pingIntervalMillis string

See Also:

• Constant Field Values

PING_WAIT

public static final String PING_WAIT

Variable for pingWait string

See Also:

• Constant Field Values

ANY_MESSAGE_INTERVAL

public static final String ANY_MESSAGE_INTERVAL

Variable for anyMessageIntervalMillis string

See Also:

• Constant Field Values

DEFAULT_SERVER_HOST

public static final String DEFAULT_SERVER_HOST

Default server host

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT

public static final String DEFAULT_SERVER_PORT

Default server port

See Also:

• Constant Field Values

DEFAULT_SERVER_PATH

public static final String DEFAULT_SERVER_PATH

Default server path

See Also:

• Constant Field Values

DEFAULT_TRACKING_FILE_NAME

public static final String DEFAULT_TRACKING_FILE_NAME

Default tracking file

See Also:

• Constant Field Values

DEFAULT_CONNECT_ATTEMPTS

public static final String DEFAULT_CONNECT_ATTEMPTS

Default number of connect attempts

See Also:

• Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final String DEFAULT_CONNECT_TIMEOUT

Default timeout in ms

See Also:

• Constant Field Values

DEFAULT_RETRY_ON_CLOSE

public static final String DEFAULT_RETRY_ON_CLOSE

Default condiction for retry on close

See Also:

• Constant Field Values

ATTRIBUTE_DATA

public static final String ATTRIBUTE_DATA

attribute for data

See Also:

• Constant Field Values

DEFAULT_PING_INTERVAL_MILLIS

public static final String DEFAULT_PING_INTERVAL_MILLIS

Default for time in between pings to server

See Also:

• Constant Field Values

DEFAULT_PING_WAIT_MILLIS

public static final String DEFAULT_PING_WAIT_MILLIS

Default for how long to wait for pong response to ping before closing or restarting connection

See Also:

• Constant Field Values

DEFAULT_ANY_MESSAGE_INTERVAL_MILLIS

public static final String DEFAULT_ANY_MESSAGE_INTERVAL_MILLIS

Default for interval for any message

See Also:

• Constant Field Values

Constructor Details

WebSocketNotificationReceiver

public WebSocketNotificationReceiver()

Method Details

configure

public void configure(Config config)
               throws Exception

Description copied from class: DefaultConfigurable

Process configuration settings. Called before startup().

Specified by:

configure in interface Configurable

Overrides:

configure in class DefaultNotificationReceiver

Parameters:

config - the Config object with settings.

Throws:

Exception - if configuration exceptions occur.

startup

public void startup()
             throws Exception

Reads a sequence from a tracking file if it exists. Otherwise, starting sequence is 0. Connects to web socket

Specified by:

startup in interface Configurable

Overrides:

startup in class DefaultNotificationReceiver

Throws:

Exception - if error occurs

shutdown

public void shutdown()
              throws Exception

Closes web socket

Specified by:

shutdown in interface Configurable

Overrides:

shutdown in class DefaultNotificationReceiver

Throws:

Exception - if error occurs

writeTrackingFile

public void writeTrackingFile()
                       throws Exception

Writes tracking file to disc, storing latest sequence

Throws:

Exception - if error occurs

readTrackingFile

public javax.json.JsonObject readTrackingFile()
                                       throws Exception

Reads tracking file from disc

Returns:

JsonObject tracking file

Throws:

Exception - if error occurs

onOpen

public void onOpen(javax.websocket.Session session)

Description copied from interface: WebSocketListener

Interface method to be overriden by WebSocket files and AwsProductReceiver

Specified by:

onOpen in interface WebSocketListener

Parameters:

session - Session to open

onMessage

public void onMessage(String message)

Message handler function passed to WebSocketClient Parses the message as JSON, receives the contained URL notification, and writes the tracking file.

Specified by:

onMessage in interface WebSocketListener

Parameters:

message - String

onClose

public void onClose(javax.websocket.Session session,
 javax.websocket.CloseReason closeReason)

Description copied from interface: WebSocketListener

Interface method to be overriden by WebSocket files and AwsProductReceiver

Specified by:

onClose in interface WebSocketListener

Parameters:

session - Session to close

closeReason - Reason for closing session

onConnectFail

public void onConnectFail()

Description copied from interface: WebSocketListener

Interface method to be overriden by WebSocket files and AwsProductReceiver

Specified by:

onConnectFail in interface WebSocketListener

onReconnectFail

public void onReconnectFail()

Description copied from interface: WebSocketListener

Interface method to be overriden by WebSocket files and AwsProductReceiver

Specified by:

onReconnectFail in interface WebSocketListener

getServerHost

public String getServerHost()

Returns:

serverHost

setServerHost

public void setServerHost(String serverHost)

Parameters:

serverHost - to set

getServerPort

public String getServerPort()

Returns:

serverPort

setServerPort

public void setServerPort(String serverPort)

Parameters:

serverPort - to set

getServerPath

public String getServerPath()

Returns:

serverPath

setServerPath

public void setServerPath(String serverPath)

Parameters:

serverPath - to set

getTrackingFileName

public String getTrackingFileName()

Returns:

trackingFileName

setTrackingFileName

public void setTrackingFileName(String trackingFileName)

Parameters:

trackingFileName - to set

getSequence

public String getSequence()

Returns:

sequence

setSequence

public void setSequence(String sequence)

Parameters:

sequence - to set

getAttempts

public int getAttempts()

Returns:

attempts

setAttempts

public void setAttempts(int attempts)

Parameters:

attempts - to set

getTimeout

public long getTimeout()

Returns:

timeout

setTimeout

public void setTimeout(long timeout)

Parameters:

timeout - to set