iaik.xml.crypto.dsig

Class XMLObjectImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XmldsigDOMStructure

iaik.xml.crypto.dsig.XMLObjectImpl

All Implemented Interfaces:

XMLObject, XMLStructure

public class XMLObjectImpl
extends XmldsigDOMStructure
implements XMLObject

An implementation of the Object that supports the DOM XML representation and processing mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dom.DOMStructure

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected List	content_ The list XMLStructures.
protected String	encoding_ The Encoding attribute value.
protected String	id_ The Id attribute value.
protected String	mimeType_ The MimeType attribute value.

Fields inherited from class iaik.xml.crypto.dom.DOMStructure

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

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

TYPE

Constructor Summary

Constructors

Constructor and Description
XMLObjectImpl(DOMCryptoContext context, Node node) Creates a new instance of this XMLObjectImpl with the specified context and node to unmarshal from.
XMLObjectImpl(List content, String id, String mimeType, String encoding) Creates a new instance of this XMLObjectImpl with the specified list of XMLStructures, id-attribute value, MimeType-attribute value and Encoding-attribute value.

Method Summary

Modifier and Type	Method and Description
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
List	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	getLocalName() Returns the local name of the represented XML element.
String	getMimeType() Returns the mime type of this XMLObject.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the MimeType and Encoding attributes.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the MimeType, URI and Id attributes.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.

Methods inherited from class iaik.xml.crypto.dom.XmldsigDOMStructure

getNamespace, init

Methods inherited from class iaik.xml.crypto.dom.DOMStructure

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, marshalElement, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, wrapNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

content_

protected List content_

The list XMLStructures. (may not be null)

id_

protected String id_

The Id attribute value.

mimeType_

protected String mimeType_

The MimeType attribute value.

encoding_

protected String encoding_

The Encoding attribute value.

Constructor Detail

XMLObjectImpl

public XMLObjectImpl(DOMCryptoContext context,
                     Node node)
              throws MarshalException

Creates a new instance of this XMLObjectImpl with the specified context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

XMLObjectImpl

public XMLObjectImpl(List content,
                     String id,
                     String mimeType,
                     String encoding)

Creates a new instance of this XMLObjectImpl with the specified list of XMLStructures, id-attribute value, MimeType-attribute value and Encoding-attribute value.

Parameters:

content - a list of XMLStructures (may be empty or null)

id - the Id-attribute value (may be null)

mimeType - the MimeType-attribute value (may be null)

encoding - the Encoding-attribute value (may be null)

Method Detail

getLocalName

public String getLocalName()

Description copied from class: DOMStructure

Returns the local name of the represented XML element.

Specified by:

getLocalName in class DOMStructure

Returns:

the local name of the represented XML element

See Also:

DOMStructure.getLocalName()

getContent

public List getContent()

Description copied from interface: javax.xml.crypto.dsig.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 XMLStructure s (may be empty but never null)

See Also:

XMLObject.getContent()

getId

public String getId()

Description copied from interface: javax.xml.crypto.dsig.XMLObject

Returns the Id of this XMLObject.

Specified by:

getId in interface XMLObject

Returns:

the Id (or null if not specified)

See Also:

XMLObject.getId()

getMimeType

public String getMimeType()

Description copied from interface: javax.xml.crypto.dsig.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)

See Also:

XMLObject.getMimeType()

getEncoding

public String getEncoding()

Description copied from interface: javax.xml.crypto.dsig.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)

See Also:

XMLObject.getEncoding()

marshalAttributes

protected void marshalAttributes(DOMCryptoContext context,
                                 Element parent)
                          throws MarshalException

Marshals the MimeType and Encoding attributes.

Overrides:

marshalAttributes in class DOMStructure

Parameters:

context - the marshal context

parent - the element is the parent of the attribute node created however, an the attribute node is not a child of it's parent element. see XPath.

Throws:

MarshalException - if an exception occurs during marshaling

marshalIDAttribute

protected Attr marshalIDAttribute(DOMCryptoContext context,
                                  Element parent)

Description copied from class: DOMStructure

Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method in order to marshal an Id-attribute.

Overrides:

marshalIDAttribute in class DOMStructure

Parameters:

context - the marshal context

parent - the element is the parent of the attribute node created however, an the attribute node is not a child of it's parent element. see XPath.

Returns:

the marshaled Id-attribute if any, otherwise null

See Also:

DOMStructure.marshalIDAttribute(DOMCryptoContext, Element)

unmarshalAttributes

protected void unmarshalAttributes(NamedNodeMap attributes,
                                   DOMCryptoContext context)
                            throws MarshalException

Unmarshals the MimeType, URI and Id attributes.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

unmarshalStructures

protected void unmarshalStructures(NodeList nodes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshals DOMStructures from the given nodes.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

This method calls DOMStructure.getInstance(Node, DOMCryptoContext) for every Element in the list of nodes. If DOMStructure.getInstance(Node, DOMCryptoContext) returns a DOMStructure DOMStructure.putChildStructure(DOMStructure) is called with the returned DOMStructure as parameter.

Overrides:

unmarshalStructures in class DOMStructure

Parameters:

nodes - the nodes to unmarshal from

context - the marshal context

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.unmarshalStructures(org.w3c.dom.NodeList, DOMCryptoContext)

putChildStructure

public void putChildStructure(DOMStructure childStructure)
                       throws MarshalException

Description copied from class: DOMStructure

Put an unmarshalled child structure.

This method is called by DOMStructure.unmarshalStructures(NodeList, DOMCryptoContext) for every unmarshalled child structure.

A subclass has to overwrite this method to store the given child structure in its the corresponding field.

Overrides:

putChildStructure in class DOMStructure

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

getChildStructures

protected List getChildStructures()

Description copied from class: DOMStructure

Returns the list of child structures of this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method to return a list of DOMStrucutres represented by this subclass.

Overrides:

getChildStructures in class DOMStructure

Returns:

a list of DOMStructures (may be empty, but never null)