Package gov.usgs.earthquake.product.io

Class XmlProductHandler

java.lang.Object

gov.usgs.earthquake.product.io.XmlProductHandler

All Implemented Interfaces:

ProductHandler

public class XmlProductHandler
extends Object
implements ProductHandler

Store a product to an OutputStream using XML.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_ATTRIBUTE_ENCODED	Content attribute for encoded
static final String	CONTENT_ATTRIBUTE_HREF	Used with URLContent.
static final String	CONTENT_ATTRIBUTE_LENGTH	Content attribute for length
static final String	CONTENT_ATTRIBUTE_MODIFIED	Content attribute for modified
static final String	CONTENT_ATTRIBUTE_PATH	Content attribute for path
static final String	CONTENT_ATTRIBUTE_TYPE	Content attribute for type
static final String	CONTENT_ELEMENT	Element for content
static final String	LINK_ATTRIBUTE_HREF	Link attribute for href
static final String	LINK_ATTRIBUTE_RELATION	Link attribute for relation
static final String	LINK_ELEMENT	Element for link
static final String	PRODUCT_ATTRIBUTE_ID	Product Attribute for id
static final String	PRODUCT_ATTRIBUTE_STATUS	Product Attribute for status
static final String	PRODUCT_ATTRIBUTE_UPDATED	Product Attribute for updateTime
static final String	PRODUCT_ELEMENT	Element for product
static final String	PRODUCT_XML_NAMESPACE	Namespace for XML product
static final String	PROPERTY_ATTRIBUTE_NAME	Property attribute for name
static final String	PROPERTY_ATTRIBUTE_VALUE	Property attribute for value
static final String	PROPERTY_ELEMENT	Element for property
static final String	SIGNATURE_ATTRIBUTE_VERSION	Signature attribute for version
static final String	SIGNATURE_ELEMENT	Element for signature
static final String	SIGNATURE_HISTORY_ELEMENT	Element for signature history
static final String	SIGNATURE_HISTORY_ENTRY_ELEMENT	Element for entries to the signature history
static final String	SIGNATURE_HISTORY_SIGNATURE_ATTRIBUTE_	Signature history attribute for signature
static final String	SIGNATURE_HISTORY_VERSION_ATTRIBUTE_	Signature history attribute for signature version
static final String	XML_DECLARATION	Declaration for XML and version

Constructor Summary

Constructors

Constructor	Description
XmlProductHandler(OutputStream out)	Create a new XmlProductHandler object.
XmlProductHandler(OutputStream out, boolean includeDeclaration)	Create a new XmlProductHandler object.

Method Summary

Modifier and Type	Method	Description
void	close()	Free any resources associated with this handler.
void	onBeginProduct(ProductId id, String status)	Output the product root element.
void	onContent(ProductId id, String path, Content content)	Output a content object as xml.
void	onEndProduct(ProductId id)	Output the closing product element.
void	onLink(ProductId id, String relation, URI href)	Output a link element as xml.
void	onProperty(ProductId id, String name, String value)	Output the property element as xml.
void	onSignature(ProductId id, String signature)	Output the signature element as xml.
void	onSignatureHistory(ProductId id, List<ProductSignature> signatureHistory)	Product signature history.
void	onSignatureVersion(ProductId id, CryptoUtils.Version version)	Product signature version.

Methods inherited from class java.lang.Object

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

Field Details

XML_DECLARATION

public static final String XML_DECLARATION

Declaration for XML and version

See Also:

• Constant Field Values

PRODUCT_XML_NAMESPACE

public static final String PRODUCT_XML_NAMESPACE

Namespace for XML product

See Also:

• Constant Field Values

PRODUCT_ELEMENT

public static final String PRODUCT_ELEMENT

Element for product

See Also:

• Constant Field Values

PRODUCT_ATTRIBUTE_ID

public static final String PRODUCT_ATTRIBUTE_ID

Product Attribute for id

See Also:

• Constant Field Values

PRODUCT_ATTRIBUTE_UPDATED

public static final String PRODUCT_ATTRIBUTE_UPDATED

Product Attribute for updateTime

See Also:

• Constant Field Values

PRODUCT_ATTRIBUTE_STATUS

public static final String PRODUCT_ATTRIBUTE_STATUS

Product Attribute for status

See Also:

• Constant Field Values

PROPERTY_ELEMENT

public static final String PROPERTY_ELEMENT

Element for property

See Also:

• Constant Field Values

PROPERTY_ATTRIBUTE_NAME

public static final String PROPERTY_ATTRIBUTE_NAME

Property attribute for name

See Also:

• Constant Field Values

PROPERTY_ATTRIBUTE_VALUE

public static final String PROPERTY_ATTRIBUTE_VALUE

Property attribute for value

See Also:

• Constant Field Values

LINK_ELEMENT

public static final String LINK_ELEMENT

Element for link

See Also:

• Constant Field Values

LINK_ATTRIBUTE_RELATION

public static final String LINK_ATTRIBUTE_RELATION

Link attribute for relation

See Also:

• Constant Field Values

LINK_ATTRIBUTE_HREF

public static final String LINK_ATTRIBUTE_HREF

Link attribute for href

See Also:

• Constant Field Values

CONTENT_ELEMENT

public static final String CONTENT_ELEMENT

Element for content

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_PATH

public static final String CONTENT_ATTRIBUTE_PATH

Content attribute for path

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_TYPE

public static final String CONTENT_ATTRIBUTE_TYPE

Content attribute for type

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_LENGTH

public static final String CONTENT_ATTRIBUTE_LENGTH

Content attribute for length

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_MODIFIED

public static final String CONTENT_ATTRIBUTE_MODIFIED

Content attribute for modified

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_HREF

public static final String CONTENT_ATTRIBUTE_HREF

Used with URLContent.

See Also:

• Constant Field Values

CONTENT_ATTRIBUTE_ENCODED

public static final String CONTENT_ATTRIBUTE_ENCODED

Content attribute for encoded

See Also:

• Constant Field Values

SIGNATURE_ELEMENT

public static final String SIGNATURE_ELEMENT

Element for signature

See Also:

• Constant Field Values

SIGNATURE_ATTRIBUTE_VERSION

public static final String SIGNATURE_ATTRIBUTE_VERSION

Signature attribute for version

See Also:

• Constant Field Values

SIGNATURE_HISTORY_ELEMENT

public static final String SIGNATURE_HISTORY_ELEMENT

Element for signature history

See Also:

• Constant Field Values

SIGNATURE_HISTORY_ENTRY_ELEMENT

public static final String SIGNATURE_HISTORY_ENTRY_ELEMENT

Element for entries to the signature history

See Also:

• Constant Field Values

SIGNATURE_HISTORY_SIGNATURE_ATTRIBUTE_

public static final String SIGNATURE_HISTORY_SIGNATURE_ATTRIBUTE_

Signature history attribute for signature

See Also:

• Constant Field Values

SIGNATURE_HISTORY_VERSION_ATTRIBUTE_

public static final String SIGNATURE_HISTORY_VERSION_ATTRIBUTE_

Signature history attribute for signature version

See Also:

• Constant Field Values

Constructor Details

XmlProductHandler

public XmlProductHandler(OutputStream out)

Create a new XmlProductHandler object.

Parameters:

out - the OutputStream where xml will be written.

XmlProductHandler

public XmlProductHandler(OutputStream out,
 boolean includeDeclaration)

Create a new XmlProductHandler object.

Parameters:

out - the OutputStream where xml will be written.

includeDeclaration - whether to include the XML declaration with output

Method Details

onBeginProduct

public void onBeginProduct(ProductId id,
 String status)
                    throws Exception

Output the product root element.

Specified by:

onBeginProduct in interface ProductHandler

Parameters:

id - which product.

status - the product's status.

Throws:

Exception - if error occurs

onContent

public void onContent(ProductId id,
 String path,
 Content content)
               throws Exception

Output a content object as xml.

Specified by:

onContent in interface ProductHandler

Parameters:

id - which product.

path - path to content within product.

content - the product content.

Throws:

Exception - if error occurs

onEndProduct

public void onEndProduct(ProductId id)
                  throws Exception

Output the closing product element.

Specified by:

onEndProduct in interface ProductHandler

Parameters:

id - which product.

Throws:

Exception - if error occurs

onLink

public void onLink(ProductId id,
 String relation,
 URI href)
            throws Exception

Output a link element as xml.

Specified by:

onLink in interface ProductHandler

Parameters:

id - which product.

relation - how the URI is related to this product.

href - the URI that is related to this product.

Throws:

Exception - if error occurs

onProperty

public void onProperty(ProductId id,
 String name,
 String value)
                throws Exception

Output the property element as xml.

Specified by:

onProperty in interface ProductHandler

Parameters:

id - which product.

name - the property name.

value - the property value.

Throws:

Exception - if error occurs

onSignatureVersion

public void onSignatureVersion(ProductId id,
 CryptoUtils.Version version)
                        throws Exception

Description copied from interface: ProductHandler

Product signature version.

Specified by:

onSignatureVersion in interface ProductHandler

Parameters:

id - which product.

version - product version

Throws:

Exception - if error occurs

onSignature

public void onSignature(ProductId id,
 String signature)
                 throws Exception

Output the signature element as xml.

Specified by:

onSignature in interface ProductHandler

Parameters:

id - which product.

signature - the product signature, which can be verified using the ProductSigner class.

Throws:

Exception - if error occurs

onSignatureHistory

public void onSignatureHistory(ProductId id,
 List<ProductSignature> signatureHistory)
                        throws Exception

Description copied from interface: ProductHandler

Product signature history.

Specified by:

onSignatureHistory in interface ProductHandler

Parameters:

id - which product.

signatureHistory - signature history of product.

Throws:

Exception - if error occurs

close

public void close()

Free any resources associated with this handler.

Specified by:

close in interface ProductHandler