iaik.xml.crypto.dsig

Class SignaturePropertyImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XmldsigDOMStructure

iaik.xml.crypto.dsig.SignaturePropertyImpl

All Implemented Interfaces:

SignatureProperty, XMLStructure

public class SignaturePropertyImpl
extends XmldsigDOMStructure
implements SignatureProperty

An implementation of the SignatureProperty element 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 content.
protected String	id_ The id-attribute value.
protected String	target_ The target-attribute value.

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Constructor and Description
SignaturePropertyImpl(DOMCryptoContext context, Node node) Creates a new instance of this SignaturePropertyImpl with the specified context and node to unmarshal from.
SignaturePropertyImpl(List content, String id, String target) Creates a new instance of this SignaturePropertyImpl with the specified list of XMLStructures, id-attribute value and target-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 one or more XMLStructures that are contained in this SignatureProperty.
String	getId() Returns the Id of this SignatureProperty.
String	getLocalName() Returns the local name of the represented XML element.
String	getTarget() Returns the target URI of this SignatureProperty.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the Target-attribute.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the Id-attribute and the Target -attribute.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals the contents of this SignatureProperty.

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 content. (may not be null)

id_

protected String id_

The id-attribute value.

target_

protected String target_

The target-attribute value. (may not be null)

Constructor Detail

SignaturePropertyImpl

public SignaturePropertyImpl(DOMCryptoContext context,
                             Node node)
                      throws MarshalException

Creates a new instance of this SignaturePropertyImpl 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

SignaturePropertyImpl

public SignaturePropertyImpl(List content,
                             String id,
                             String target)

Creates a new instance of this SignaturePropertyImpl with the specified list of XMLStructures, id-attribute value and target-attribute value.

Parameters:

content - a list of XMLStructures

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

target - the target-attribute value

Throws:

NullPointerException - content or target is null

IllegalArgumentException - if content is empty

ClassCastException - if any of the content elements is not of type XMLStructure

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.SignatureProperty

Returns an unmodifiable list of one or more XMLStructures that are contained in this SignatureProperty. These represent additional information items concerning the generation of the XMLSignature (i.e. date/time stamp or serial numbers of cryptographic hardware used in signature generation).

Specified by:

getContent in interface SignatureProperty

Returns:

an unmodifiable list of one or more XMLStructures

See Also:

SignatureProperty.getContent()

getTarget

public String getTarget()

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

Returns the target URI of this SignatureProperty.

Specified by:

getTarget in interface SignatureProperty

Returns:

the target URI of this SignatureProperty (never null)

See Also:

SignatureProperty.getTarget()

getId

public String getId()

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

Returns the Id of this SignatureProperty.

Specified by:

getId in interface SignatureProperty

Returns:

the Id of this SignatureProperty (or null if not specified)

See Also:

SignatureProperty.getId()

marshalAttributes

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

Marshals the Target-attribute.

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 Id-attribute and the Target -attribute.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

putChildStructure

protected 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

See Also:

DOMStructure.putChildStructure(iaik.xml.crypto.dom.DOMStructure)

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)

See Also:

DOMStructure.getChildStructures()

unmarshalStructures

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

Unmarshals the contents of this SignatureProperty.

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)