org.apache.jcp.xml.dsig.internal.dom
Class DOMXMLObject

java.lang.Object
  org.apache.jcp.xml.dsig.internal.dom.BaseStructure
      org.apache.jcp.xml.dsig.internal.dom.DOMXMLObject

All Implemented Interfaces:

XMLObject, XMLStructure

public final class DOMXMLObject
extends BaseStructure
implements XMLObject

DOM-based implementation of XMLObject.

Author:

Sean Mullan

Field Summary

Fields inherited from interface javax.xml.crypto.dsig.XMLObject

TYPE

Constructor Summary

DOMXMLObject(Element objElem, XMLCryptoContext context, Provider provider)
Creates an XMLObject from an element.

DOMXMLObject(List<? extends XMLStructure> content, String id, String mimeType, String encoding)
Creates an XMLObject from the specified parameters.

Method Summary

boolean	equals(Object o)
List<XMLStructure>	getContent() Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.
String	getEncoding() Returns the encoding URI of this XMLObject.
String	getId() Returns the Id of this XMLObject.
String	getMimeType() Returns the mime type of this XMLObject.
static List<XMLStructure>	getXmlObjectContent(XMLObject xo)
int	hashCode()
static void	marshal(XmlWriter xwriter, XMLObject xmlObj, String dsPrefix, XMLCryptoContext context)

Methods inherited from class org.apache.jcp.xml.dsig.internal.dom.BaseStructure

isFeatureSupported, textOfNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Constructor Detail

DOMXMLObject

public DOMXMLObject(List<? extends XMLStructure> content,
                    String id,
                    String mimeType,
                    String encoding)

Creates an XMLObject from the specified parameters.

Parameters:

content - a list of XMLStructures. The list is defensively copied to protect against subsequent modification. May be null or empty.

id - the Id (may be null)

mimeType - the mime type (may be null)

encoding - the encoding (may be null)

Throws:

ClassCastException - if content contains any entries that are not of type XMLStructure

DOMXMLObject

public DOMXMLObject(Element objElem,
                    XMLCryptoContext context,
                    Provider provider)
             throws MarshalException

Creates an XMLObject from an element.

Parameters:

objElem - an Object element

Throws:

MarshalException - if there is an error when unmarshalling

Method Detail

getContent

public List<XMLStructure> getContent()

Description copied from interface: XMLObject

Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.

If there is a public subclass representing the type of XMLStructure, it is returned as an instance of that class (ex: a SignatureProperties element would be returned as an instance of SignatureProperties).

Specified by:

getContent in interface XMLObject

Returns:

an unmodifiable list of XMLStructures (may be empty but never null)

getId

public String getId()

Description copied from interface: XMLObject

Returns the Id of this XMLObject.

Specified by:

getId in interface XMLObject

Returns:

the Id (or null if not specified)

getMimeType

public String getMimeType()

Description copied from interface: XMLObject

Returns the mime type of this XMLObject. The mime type is an optional attribute which describes the data within this XMLObject (independent of its encoding).

Specified by:

getMimeType in interface XMLObject

Returns:

the mime type (or null if not specified)

getEncoding

public String getEncoding()

Description copied from interface: XMLObject

Returns the encoding URI of this XMLObject. The encoding URI identifies the method by which the object is encoded.

Specified by:

getEncoding in interface XMLObject

Returns:

the encoding URI (or null if not specified)

marshal

public static void marshal(XmlWriter xwriter,
                           XMLObject xmlObj,
                           String dsPrefix,
                           XMLCryptoContext context)
                    throws MarshalException

Throws:

MarshalException

getXmlObjectContent

public static List<XMLStructure> getXmlObjectContent(XMLObject xo)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object