Package gov.usgs.earthquake.distribution

Class ProductClient

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.distribution.ProductClient

All Implemented Interfaces:

Bootstrappable, ProductClientMBean, Configurable

public class ProductClient
extends DefaultConfigurable
implements ProductClientMBean, Bootstrappable

The entry point to product distribution. The ProductClient implements the Configurable interface and can use the following configuration parameters:

receivers

(Required) A comma separated list of section names that should be loaded as NotificationReceiver objects. Each receiver is a source of notifications for listeners.

listeners

(Required) A comma separated list of section names that should be loaded as NotificationListener objects. Each listener receives notifications from receivers.

logdirectory

(Optional) Log directory. Default is "log", relative to the current working directory. Log files using a naming convention ProductClient_YYYYMMDD.log.

loglevel

(Optional) Default is INFO. One of SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST

redirectconsole

(Optional) Default is false. Whether or not to redirect console output to the log file.

All listeners listen to all receivers for notifications.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUILD_ARGUMENT	Run the builder.
static final String	CONSOLE_REDIRECT_PROPERTY_NAME	Whether or not to redirect stdout and stderr to log file.
static final String	DEFAULT_CONSOLE_REDIRECT	Default console redirect value (don't redirect).
static final String	DEFAULT_ENABLE_ADMIN_SOCKET	Default bool for admin socket property
static final String	DEFAULT_LOGDIRECTORY	Default directory for logging.
static final String	DEFAULT_LOGLEVEL	Default log level is INFO.
static final String	ENABLE_ADMIN_SOCKET	Property used to enable Admin Socket
static final String	LISTENERS_PROPERTY_NAME	Property containing list of senders.
static final String	LOGDIRECTORY_PROPERTY_NAME	Property with location for log directory.
static final String	LOGLEVEL_PROPERTY_NAME	Log level property name.
static final String	PDL_CLIENT_VERSION_PROPERTY	Property name used on products for current RELEASE_VERSION.
static final String	RECEIVE_ARGUMENT	Run the client.
static final String	RECEIVERS_PROPERTY_NAME	Property containing list of receivers.
static final String	RELEASE_VERSION	The "release" version number.
static final String	SEARCH_ARGUMENT	Run the search.
static final String	SEND_ARGUMENT	Run the builder.
static final String	SVN_LAST_CHANGED_DATE	SVN LastChangedDate property.
static final String	SVN_REVISION	SVN Revision property.
static final String	SVN_VERSION	SVN Id property.
static final String	USAGE_ARGUMENT	Show usage.

Fields inherited from interface gov.usgs.earthquake.distribution.Bootstrappable

RUN_EXCEPTION_EXIT_CODE

Constructor Summary

Constructors

Constructor	Description
ProductClient()

Method Summary

Modifier and Type	Method	Description
void	configure(Config config)	Process configuration settings.
long	getFreeMemory()
String	getListenerQueueStatus()
List<NotificationListener>	getListeners()
long	getMaxMemory()
List<NotificationReceiver>	getReceivers()
static String	getUsage()
String	getVersion()
void	loadListeners(Config config)	Load listeners from a Config object.
void	loadReceivers(Config config)	Load NotificationReceivers from a Config object.
void	run(String[] args)	Entry point into Product Distribution.
void	shutdown()	Shut down all receivers and listeners.
void	startup()	Start up all listeners and receivers.

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

Field Details

RELEASE_VERSION

public static final String RELEASE_VERSION

The "release" version number.

See Also:

• Constant Field Values

PDL_CLIENT_VERSION_PROPERTY

public static final String PDL_CLIENT_VERSION_PROPERTY

Property name used on products for current RELEASE_VERSION.

See Also:

• Constant Field Values

SVN_VERSION

public static final String SVN_VERSION

SVN Id property.

See Also:

• Constant Field Values

SVN_REVISION

public static final String SVN_REVISION

SVN Revision property.

See Also:

• Constant Field Values

SVN_LAST_CHANGED_DATE

public static final String SVN_LAST_CHANGED_DATE

SVN LastChangedDate property.

See Also:

• Constant Field Values

BUILD_ARGUMENT

public static final String BUILD_ARGUMENT

Run the builder.

See Also:

• Constant Field Values

SEND_ARGUMENT

public static final String SEND_ARGUMENT

Run the builder.

See Also:

• Constant Field Values

RECEIVE_ARGUMENT

public static final String RECEIVE_ARGUMENT

Run the client.

See Also:

• Constant Field Values

SEARCH_ARGUMENT

public static final String SEARCH_ARGUMENT

Run the search.

See Also:

• Constant Field Values

USAGE_ARGUMENT

public static final String USAGE_ARGUMENT

Show usage.

See Also:

• Constant Field Values

RECEIVERS_PROPERTY_NAME

public static final String RECEIVERS_PROPERTY_NAME

Property containing list of receivers.

See Also:

• Constant Field Values

LISTENERS_PROPERTY_NAME

public static final String LISTENERS_PROPERTY_NAME

Property containing list of senders.

See Also:

• Constant Field Values

LOGLEVEL_PROPERTY_NAME

public static final String LOGLEVEL_PROPERTY_NAME

Log level property name.

See Also:

• Constant Field Values

DEFAULT_LOGLEVEL

public static final String DEFAULT_LOGLEVEL

Default log level is INFO.

See Also:

• Constant Field Values

LOGDIRECTORY_PROPERTY_NAME

public static final String LOGDIRECTORY_PROPERTY_NAME

Property with location for log directory.

See Also:

• Constant Field Values

DEFAULT_LOGDIRECTORY

public static final String DEFAULT_LOGDIRECTORY

Default directory for logging.

See Also:

• Constant Field Values

CONSOLE_REDIRECT_PROPERTY_NAME

public static final String CONSOLE_REDIRECT_PROPERTY_NAME

Whether or not to redirect stdout and stderr to log file.

See Also:

• Constant Field Values

DEFAULT_CONSOLE_REDIRECT

public static final String DEFAULT_CONSOLE_REDIRECT

Default console redirect value (don't redirect).

See Also:

• Constant Field Values

ENABLE_ADMIN_SOCKET

public static final String ENABLE_ADMIN_SOCKET

Property used to enable Admin Socket

See Also:

• Constant Field Values

DEFAULT_ENABLE_ADMIN_SOCKET

public static final String DEFAULT_ENABLE_ADMIN_SOCKET

Default bool for admin socket property

See Also:

• Constant Field Values

Constructor Details

ProductClient

public ProductClient()

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 DefaultConfigurable

Parameters:

config - the Config object with settings.

Throws:

Exception - if configuration exceptions occur.

loadListeners

public void loadListeners(Config config)
                   throws Exception

Load listeners from a Config object.

Parameters:

config - the configuration.

Throws:

Exception - if error occurs

loadReceivers

public void loadReceivers(Config config)
                   throws Exception

Load NotificationReceivers from a Config object.

Parameters:

config - the configuration

Throws:

Exception - if error occurs

startup

public void startup()
             throws Exception

Start up all listeners and receivers.

Specified by:

startup in interface Configurable

Overrides:

startup in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

shutdown

public void shutdown()
              throws Exception

Shut down all receivers and listeners.

Specified by:

shutdown in interface Configurable

Overrides:

shutdown in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

run

public void run(String[] args)
         throws Exception

Entry point into Product Distribution.

Specified by:

run in interface Bootstrappable

Parameters:

args - argument

Throws:

Exception - Exception

getReceivers

public List<NotificationReceiver> getReceivers()

Returns:

The list of receivers

getListeners

public List<NotificationListener> getListeners()

Returns:

The list of listeners

getUsage

public static String getUsage()

Returns:

Product usage

getListenerQueueStatus

public String getListenerQueueStatus()

Specified by:

getListenerQueueStatus in interface ProductClientMBean

Returns:

A string describing the current listener queues.

getVersion

public String getVersion()

Specified by:

getVersion in interface ProductClientMBean

Returns:

client version

getMaxMemory

public long getMaxMemory()

Specified by:

getMaxMemory in interface ProductClientMBean

Returns:

maximum amount of memory

getFreeMemory

public long getFreeMemory()

Specified by:

getFreeMemory in interface ProductClientMBean

Returns:

amount of free memory