Package gov.usgs.earthquake.distribution

Class CLIProductBuilder

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.distribution.CLIProductBuilder

All Implemented Interfaces:

Configurable

public class CLIProductBuilder
extends DefaultConfigurable

Command Line Interface Product Builder. This class is used to build and send products. It is typically called by using the --build argument with the standard ProductClient. The CLIProductBuilder implements the Configurable interface and uses the following configuration parameters:

senders

(Required). A comma separated list of section names that should be loaded as ProductSender objects. Each sender in this list will be used to send any built products. See each type of ProductSender for more configuration details.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINARY_FORMAT_ARGUMENT	binaryFormat argument
static final String	CODE_ARGUMENT	product id code argument
static final String	CONNECT_TIMEOUT_ARGUMENT	connectionTimeout argument
static final String	CONTENT_ARGUMENT	product content argument
static final String	CONTENT_TYPE_ARGUMENT	product content type argument
static final Integer	DEFAULT_CONNECT_TIMEOUT	Default connectionTimeout argument.
static final String	DELETE_ARGUMENT	product delete argument
static final String	DEPTH_ARGUMENT	depth argument
static final String	DIRECTORY_ARGUMENT	product directory argument
static final String	DISABLE_DEFLATE	disableDeflate argument
static final String	DISABLE_PARALLEL_SEND	disableParallelSend argument
static final String	EVENTCODE_ARGUMENT	eventCode argument
static final String	EVENTID_ARGUMENT	eventID argument
static final String	EVENTSOURCE_ARGUMENT	eventsource argument
static final String	EVENTSOURCECODE_ARGUMENT	eventsourcecode argument
static final String	EVENTTIME_ARGUMENT	eventtime argument
static final int	EXIT_INVALID_ARGUMENTS	Exit code used when an invalid combination of arguments is used.
static final int	EXIT_PARTIALLY_SENT	Exit code when errors occur while sending, but not to all senders.
static final int	EXIT_UNABLE_TO_BUILD	Exit code used when unable to build a product.
static final int	EXIT_UNABLE_TO_SEND	Exit code used when errors occur while sending.
static final String	FILE_ARGUMENT	product file argument
static final String	LATITUDE_ARGUMENT	latitude argument
static final String	LINK_ARGUMENT	product link argument
static final String	LONGITUDE_ARGUMENT	longitude argument
static final String	MAGNITUDE_ARGUMENT	magnitude argument
static final String	PARALLEL_SEND_TIMEOUT_ARGUMENT	parallelSendTimeout argument
static final String	PRIVATE_KEY_ARGUMENT	private key argument
static final String	PROPERTY_ARGUMENT	property argument
static final String	SENDERS_CONFIG_PROPERTY	Property name used for configuring the list of senders.
static final String	SERVERS_ARGUMENT	Arguments for configuring servers and connectTimeouts.
static final String	SIGNATURE_VERSION_ARGUMENT	signature version argument
static final String	SOURCE_ARGUMENT	product id source argument
static final String	STATUS_ARGUMENT	product status argument
static final String	TYPE_ARGUMENT	product id type argument
static final String	UPDATE_TIME_ARGUMENT	product id updateTime argument
static final String	VERSION_ARGUMENT	version argument

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CLIProductBuilder(String[] args)	This class is not intended to be instantiated directly.

Method Summary

Modifier and Type	Method	Description
Product	buildProduct()	Build a product using command line arguments.
void	configure(Config config)	Load ProductSenders that will send any built Products.
List<ProductSender>	getSenders()
static String	getUsage()	Function on how to use command
static void	main(String[] args)	Entry point into CLIProductBuilder.
static List<ProductSender>	parseServers(String servers, Integer connectTimeout, boolean binaryFormat, boolean enableDeflate)	Parse servers for list of product senders
Map<ProductSender,Exception>	sendProduct(Product product)	Send a product to all configured ProductSenders.
void	shutdown()	Called when the client is shutting down.
void	startup()	Called when the client is done configuring.

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

EXIT_INVALID_ARGUMENTS

public static final int EXIT_INVALID_ARGUMENTS

Exit code used when an invalid combination of arguments is used.

See Also:

• Constant Field Values

EXIT_UNABLE_TO_BUILD

public static final int EXIT_UNABLE_TO_BUILD

Exit code used when unable to build a product.

See Also:

• Constant Field Values

EXIT_UNABLE_TO_SEND

public static final int EXIT_UNABLE_TO_SEND

Exit code used when errors occur while sending.

See Also:

• Constant Field Values

EXIT_PARTIALLY_SENT

public static final int EXIT_PARTIALLY_SENT

Exit code when errors occur while sending, but not to all senders.

See Also:

• Constant Field Values

TYPE_ARGUMENT

public static final String TYPE_ARGUMENT

product id type argument

See Also:

• Constant Field Values

CODE_ARGUMENT

public static final String CODE_ARGUMENT

product id code argument

See Also:

• Constant Field Values

SOURCE_ARGUMENT

public static final String SOURCE_ARGUMENT

product id source argument

See Also:

• Constant Field Values

UPDATE_TIME_ARGUMENT

public static final String UPDATE_TIME_ARGUMENT

product id updateTime argument

See Also:

• Constant Field Values

STATUS_ARGUMENT

public static final String STATUS_ARGUMENT

product status argument

See Also:

• Constant Field Values

DELETE_ARGUMENT

public static final String DELETE_ARGUMENT

product delete argument

See Also:

• Constant Field Values

PROPERTY_ARGUMENT

public static final String PROPERTY_ARGUMENT

property argument

See Also:

• Constant Field Values

EVENTID_ARGUMENT

public static final String EVENTID_ARGUMENT

eventID argument

See Also:

• Constant Field Values

EVENTSOURCE_ARGUMENT

public static final String EVENTSOURCE_ARGUMENT

eventsource argument

See Also:

• Constant Field Values

EVENTSOURCECODE_ARGUMENT

public static final String EVENTSOURCECODE_ARGUMENT

eventsourcecode argument

See Also:

• Constant Field Values

EVENTCODE_ARGUMENT

public static final String EVENTCODE_ARGUMENT

eventCode argument

See Also:

• Constant Field Values

EVENTTIME_ARGUMENT

public static final String EVENTTIME_ARGUMENT

eventtime argument

See Also:

• Constant Field Values

LATITUDE_ARGUMENT

public static final String LATITUDE_ARGUMENT

latitude argument

See Also:

• Constant Field Values

LONGITUDE_ARGUMENT

public static final String LONGITUDE_ARGUMENT

longitude argument

See Also:

• Constant Field Values

DEPTH_ARGUMENT

public static final String DEPTH_ARGUMENT

depth argument

See Also:

• Constant Field Values

MAGNITUDE_ARGUMENT

public static final String MAGNITUDE_ARGUMENT

magnitude argument

See Also:

• Constant Field Values

VERSION_ARGUMENT

public static final String VERSION_ARGUMENT

version argument

See Also:

• Constant Field Values

LINK_ARGUMENT

public static final String LINK_ARGUMENT

product link argument

See Also:

• Constant Field Values

CONTENT_ARGUMENT

public static final String CONTENT_ARGUMENT

product content argument

See Also:

• Constant Field Values

CONTENT_TYPE_ARGUMENT

public static final String CONTENT_TYPE_ARGUMENT

product content type argument

See Also:

• Constant Field Values

DIRECTORY_ARGUMENT

public static final String DIRECTORY_ARGUMENT

product directory argument

See Also:

• Constant Field Values

FILE_ARGUMENT

public static final String FILE_ARGUMENT

product file argument

See Also:

• Constant Field Values

PRIVATE_KEY_ARGUMENT

public static final String PRIVATE_KEY_ARGUMENT

private key argument

See Also:

• Constant Field Values

SIGNATURE_VERSION_ARGUMENT

public static final String SIGNATURE_VERSION_ARGUMENT

signature version argument

See Also:

• Constant Field Values

SENDERS_CONFIG_PROPERTY

public static final String SENDERS_CONFIG_PROPERTY

Property name used for configuring the list of senders.

See Also:

• Constant Field Values

SERVERS_ARGUMENT

public static final String SERVERS_ARGUMENT

Arguments for configuring servers and connectTimeouts.

See Also:

• Constant Field Values

CONNECT_TIMEOUT_ARGUMENT

public static final String CONNECT_TIMEOUT_ARGUMENT

connectionTimeout argument

See Also:

• Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final Integer DEFAULT_CONNECT_TIMEOUT

Default connectionTimeout argument. 15s

BINARY_FORMAT_ARGUMENT

public static final String BINARY_FORMAT_ARGUMENT

binaryFormat argument

See Also:

• Constant Field Values

DISABLE_DEFLATE

public static final String DISABLE_DEFLATE

disableDeflate argument

See Also:

• Constant Field Values

DISABLE_PARALLEL_SEND

public static final String DISABLE_PARALLEL_SEND

disableParallelSend argument

See Also:

• Constant Field Values

PARALLEL_SEND_TIMEOUT_ARGUMENT

public static final String PARALLEL_SEND_TIMEOUT_ARGUMENT

parallelSendTimeout argument

See Also:

• Constant Field Values

Constructor Details

CLIProductBuilder

protected CLIProductBuilder(String[] args)

This class is not intended to be instantiated directly.

Parameters:

args - arguments

Method Details

getSenders

public List<ProductSender> getSenders()

Returns:

the senders

configure

public void configure(Config config)
               throws Exception

Load ProductSenders that will send any built Products. There should be a property "senders" containing a comma delimited list of sender names to be loaded.

Specified by:

configure in interface Configurable

Overrides:

configure in class DefaultConfigurable

Parameters:

config - the Config to load.

Throws:

Exception - if configuration exceptions occur.

shutdown

public void shutdown()
              throws Exception

Called when the client is shutting down.

Specified by:

shutdown in interface Configurable

Overrides:

shutdown in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

startup

public void startup()
             throws Exception

Called when the client is done configuring.

Specified by:

startup in interface Configurable

Overrides:

startup in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

sendProduct

public Map<ProductSender,Exception> sendProduct(Product product)

Send a product to all configured ProductSenders.

Parameters:

product - the product to send.

Returns:

exceptions that occured while sending. If map is empty, there were no exceptions.

buildProduct

public Product buildProduct()
                     throws Exception

Build a product using command line arguments.

Returns:

Product

Throws:

Exception - if error occurs

parseServers

public static List<ProductSender> parseServers(String servers,
 Integer connectTimeout,
 boolean binaryFormat,
 boolean enableDeflate)
                                        throws Exception

Parse servers for list of product senders

Parameters:

servers - CSV string of servers

connectTimeout - timeout

binaryFormat - if binaryFormat

enableDeflate - if enableDeflate

Returns:

List of product senders

Throws:

Exception - if error occurs

main

public static void main(String[] args)
                 throws Exception

Entry point into CLIProductBuilder. Called by Main if the --build argument is present.

Parameters:

args - arguments

Throws:

Exception - if error occurs

getUsage

public static String getUsage()

Function on how to use command

Returns:

string