org.jets3t.apps.uploader

Class XmlGenerator

java.lang.Object

org.jets3t.apps.uploader.XmlGenerator

public class XmlGenerator
extends java.lang.Object

Generates XML documents containing metadata about files uploaded to Amazon S3 by the Uploader. The XML document includes metadata for user inputs, inputs sourced from applet parameter tags, and additional information available from the uploader such as filenames and generated UUID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	XmlGenerator.ObjectAndSignatureRequestDetails

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map	applicationProperties
private java.util.Map	messageProperties
private java.util.List	objectRequestList
static java.lang.String	xmlVersionNumber

Constructor Summary

Constructors

Constructor and Description
XmlGenerator()

Method Summary

Modifier and Type	Method and Description
void	addApplicationProperties(java.util.Map properties) Add application-specific properties to the XML document.
void	addMessageProperties(java.util.Map properties) Add message-specific properties to the XML document.
void	addSignatureRequest(java.lang.String key, java.lang.String bucketName, java.util.Map metadata, SignatureRequest signatureRequest) Add a signature request item to the XML document to store the request, and details about the object the request was related to.
private org.w3c.dom.Element	createObjectElement(org.w3c.dom.Document document, java.lang.String key, java.lang.String bucketName, java.util.Map metadata, java.lang.String elementName) Creates and element to contain information about an object.
private org.w3c.dom.Element	createPropertyElement(org.w3c.dom.Document document, java.lang.String propertyName, java.lang.String propertyValue, java.lang.String source) Creates a Property XML element for a document.
private org.w3c.dom.Element	createSignatureRequestElement(org.w3c.dom.Document document, XmlGenerator.ObjectAndSignatureRequestDetails details) Creates a SignatureRequest document element.
java.lang.String	generateXml() Generates an XML document containing metadata information as Property elements.

Methods inherited from class java.lang.Object

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

Field Detail

xmlVersionNumber

public static final java.lang.String xmlVersionNumber

See Also:

Constant Field Values

objectRequestList

private java.util.List objectRequestList

applicationProperties

private java.util.Map applicationProperties

messageProperties

private java.util.Map messageProperties

Constructor Detail

XmlGenerator

public XmlGenerator()

Method Detail

addSignatureRequest

public void addSignatureRequest(java.lang.String key,
                                java.lang.String bucketName,
                                java.util.Map metadata,
                                SignatureRequest signatureRequest)

Add a signature request item to the XML document to store the request, and details about the object the request was related to.

Parameters:

key - the key name of the object the signature request applies to.

bucketName - the bucket containing the object.

metadata - the object's metadata

signatureRequest - the signature request for the object.

addApplicationProperties

public void addApplicationProperties(java.util.Map properties)

Add application-specific properties to the XML document.

Parameters:

properties -

addMessageProperties

public void addMessageProperties(java.util.Map properties)

Add message-specific properties to the XML document.

Parameters:

properties -

generateXml

public java.lang.String generateXml()
                             throws java.lang.Exception

Generates an XML document containing metadata information as Property elements. The root of the document is the element Uploader.

Returns:

an XML document string containing Property elements.

Throws:

java.lang.Exception

createPropertyElement

private org.w3c.dom.Element createPropertyElement(org.w3c.dom.Document document,
                                                  java.lang.String propertyName,
                                                  java.lang.String propertyValue,
                                                  java.lang.String source)

Creates a Property XML element for a document.

Parameters:

document - the document the property is being created for.

propertyName - the property's name, becomes a name attribute of the element.

propertyValue - the property's value, becomes the CDATA text value of the element. If this value is null, the Property element is empty.

source - text to describe the source of the information, such as userinput or parameter. Becomes a source attribute of the element.

Returns:

a Property element.

createSignatureRequestElement

private org.w3c.dom.Element createSignatureRequestElement(org.w3c.dom.Document document,
                                                          XmlGenerator.ObjectAndSignatureRequestDetails details)

Creates a SignatureRequest document element.

Parameters:

document -

details -

Returns:

createObjectElement

private org.w3c.dom.Element createObjectElement(org.w3c.dom.Document document,
                                                java.lang.String key,
                                                java.lang.String bucketName,
                                                java.util.Map metadata,
                                                java.lang.String elementName)

Creates and element to contain information about an object.

Parameters:

document -

key -

bucketName -

metadata -

elementName -

Returns: