Package gov.usgs.earthquake.distribution

Distribution distributes Products.

EmbeddedPDLClient

Provides an example configuration for PDL to be embedded in another java application.

ProductClient

The primary command-line entry point, via the Bootstrap main-class.

The primary distribution components are:

ProductSender

Used to send products to NotificationReceivers.

Usually directly using SocketProductSender, or when running a central hub using EIDSNotificationSender.

NotificationReceiver

Used to receive products.

Usually by connecting to a hub using EIDSNotificationReceiver, or when running a central hub using SocketProductReceiver.

A receiver notifies all its listeners when new products are received.

NotificationListener

Used to process received products.

Listeners receive Notifications when new products are available, and can request a product be processed based on its source and/or type.

The DefaultNotificationListener processes in a different thread, the ExternalNotificationListener executes an external process, and RelayProductListener forwards products over a socket.

These components are also regularly used:

ProductStorage

Store product contents in the file system. FileProductStorage supports a number of different storage formats, including "directory", "xml", "binary", and "zip".

NotificationIndex

Used to keep track of which products are in storage, have been processed, and when those products should be automatically cleaned up (if ever).

Interface Summary

Interface	Description
Bootstrappable	An interface used by the Bootstrap class to invoke the main class.
ListenerNotifier
Notification	A Notification describes an updated product that is available.
NotificationIndex	Stores and retrieves Notifications.
NotificationIndexCleanup.Listener	Interface for cleanup listeners to take additional steps before a notification is removed.
NotificationListener	Process Notifications of Products.
NotificationReceiver	Receives and processes notifications.
ProductClientMBean	Used to define JMX monitoring interface.
ProductSender	Send a product to a recipient.
ProductStorage	Stores and retrieves Products.
StorageListener
WebSocketListener	Allows overridden onMessage for different behavior of WebSocketClient onMessage

Class Summary

Class	Description
AdminSocketServer	Telnet to this socket to get a "command prompt".
Bootstrap	Bootstrap is a class used to start an application.
CLIProductBuilder	Command Line Interface Product Builder.
Command
ContentListener	A listener that listens for a specific content path.
DefaultNotification	A DefaultNotification is a implementation of the Notification interface.
DefaultNotificationListener	A base implementation of a notification listener.
DefaultNotificationReceiver	The core of product distribution.
DefaultNotificationSender	The base class for all Notification senders.
DefaultStorageListener
DeflateComparison
EIDSNotificationReceiver	Receive XML notifications using EIDS.
EIDSNotificationSender
EmbeddedPDLClient	An example of an embedded PDL client.
ExecutorListenerNotifier
ExternalNotificationListener	An external process that is called when new products arrive.
Factory
FileProductStorage	Store products in the file system.
FutureListenerNotifier	FutureListenerNotifier is similar to ExecutorListenerNotifier, but uses Futures with an ExecutorService to implement timeouts instead of Timers.
HashFileProductStorage	Deprecated.
HeartbeatInfo	HeartbeatInfo stores a single heartbeat key/value message, together with a timestamp
HeartbeatListener	Heartbeat Listener stores heartbeat messages and writes them to a heartbeat file when a product is received
HeartbeatStatus	Heartbeat status information for a single component
JDBCNotificationIndex	Stores and retrieves Notifications.
NotificationEvent	An event sent to a NotificationListener.
NotificationIndexCleanup	NotificationIndexCleanup manages cleaning up expired notifications.
NotificationListenerCallable	A Callable object for deferred listener notification.
ProductBuilder	Essentials for building/sending products.
ProductClient	The entry point to product distribution.
ProductKey	This represents a public key used to verify product signatures.
ProductKeyChain	A group of keys that can be used to verify product signatures.
ProductResender	A utility class to (re)send an existing product to pdl hubs.
ProductTracker	Send updates and search sent updates about distribution status.
ProductTrackerParser	Parser for ProductTracker responses.
ProductTrackerUpdate	Represents a single update sent to a product tracker.
RelayProductListener	Listen for products and use a product sender (SocketProductSender by default) to send products as they are received.
ReplicationStorageListener
SignatureVerifier
SocketProductReceiver	Receive Products directly via a Socket.
SocketProductReceiverHandler
SocketProductSender	Send Products to SocketProductReceivers.
StorageEvent
URLNotification	A URLNotification represents a product that is available via a URL.
URLNotificationJSONConverter
URLNotificationParser
URLNotificationXMLConverter
URLProductStorage	Store products in a file system which is also available at a URL.
WebSocketClient	Manages a simple connection to a websocket.
WebSocketNotificationReceiver	Receives notifications from an arbitrary web socket.

Enum Summary

Enum	Description
StorageEvent.StorageEventType	Enumeration of StorageEventTypes
URLProductStorage.Format	Different types of formats

Exception Summary

Exception	Description
Command.CommandTimeout
ConfigurationException	A configuration exception, thrown while loading the config file if there are problems.
ContinuableListenerException	Wrapper exception class.
InvalidSignatureException	An exception thrown when storing a product already in storage.
NotificationListenerException	An exception thrown by a NotificationListener when it cannot process a product.
ProductAlreadyInStorageException	An exception thrown when storing a product already in storage.