Package gov.usgs.earthquake.distribution

Class ProductKey

java.lang.Object

gov.usgs.util.DefaultConfigurable

gov.usgs.earthquake.distribution.ProductKey

All Implemented Interfaces:

Configurable

public class ProductKey
extends DefaultConfigurable

This represents a public key used to verify product signatures. A key should have at least one source and/or one type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_PROPERTY_NAME	Property name for key.
static final Logger	LOGGER	Logger for use in file
static final String	SOURCES_PROPERTY_NAME	Property name for sources.
static final String	TYPES_PROPERTY_NAME	Property name for types.

Constructor Summary

Constructors

Constructor	Description
ProductKey()	Empty constructor for the Configurable interface.
ProductKey(PublicKey key, List<String> sources, List<String> types)	Construct a new ProductPublicKey.

Method Summary

Modifier and Type	Method	Description
void	configure(Config config)	Process configuration settings.
PublicKey	getKey()
List<String>	getSources()
List<String>	getTypes()
boolean	isForProduct(ProductId id)	Check whether this key is a candidate for verifying a signature.
void	setKey(PublicKey key)
void	shutdown()	Stop any processing/background threads.
void	startup()	Start any processing/background threads.

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

LOGGER

public static final Logger LOGGER

Logger for use in file

SOURCES_PROPERTY_NAME

public static final String SOURCES_PROPERTY_NAME

Property name for sources.

See Also:

• Constant Field Values

TYPES_PROPERTY_NAME

public static final String TYPES_PROPERTY_NAME

Property name for types.

See Also:

• Constant Field Values

KEY_PROPERTY_NAME

public static final String KEY_PROPERTY_NAME

Property name for key.

See Also:

• Constant Field Values

Constructor Details

ProductKey

public ProductKey()

Empty constructor for the Configurable interface.

ProductKey

public ProductKey(PublicKey key,
 List<String> sources,
 List<String> types)

Construct a new ProductPublicKey. Sources

Parameters:

key - the public key.

sources - the sources to use with this key.

types - the types to use with this key.

Method Details

isForProduct

public boolean isForProduct(ProductId id)

Check whether this key is a candidate for verifying a signature. If any sources, product source must be in list. If any types, product type must be in list.

Parameters:

id - which product to check.

Returns:

true if this key might verify the signature for given product.

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.

shutdown

public void shutdown()
              throws Exception

Description copied from class: DefaultConfigurable

Stop any processing/background threads.

Specified by:

shutdown in interface Configurable

Overrides:

shutdown in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

startup

public void startup()
             throws Exception

Description copied from class: DefaultConfigurable

Start any processing/background threads.

Specified by:

startup in interface Configurable

Overrides:

startup in class DefaultConfigurable

Throws:

Exception - if exceptions occur while starting.

getKey

public PublicKey getKey()

Returns:

the key

setKey

public void setKey(PublicKey key)

Parameters:

key - the key to set

getSources

public List<String> getSources()

Returns:

the sources

getTypes

public List<String> getTypes()

Returns:

the types