iaik.xml.crypto.dsig

Class TransformsType

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.TransformsType

All Implemented Interfaces:

XMLStructure

Direct Known Subclasses:

TransformsImpl, TransformsImpl

public abstract class TransformsType
extends DOMStructure

A base class for elements that contain a number of Transforms which are applied to some input data according to the reference processing model of XMLDSig.

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	appliedTransforms_ The list of Transforms, that have already been applied to the input data.
protected List	transforms_ The list of Transforms.

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransformsType(List transforms) Creates a new instance of this TransformsType with the specified list of TransformImpls.
protected	TransformsType(List appliedTransforms, List transforms) Creates a new instance of this TransformsType with the specified list of TransformImpls and a list of already applied TransformImpls.
protected	TransformsType(Node node) Creates a new instance of this TransformsType with the specified node

Method Summary

Modifier and Type	Method and Description
Data	applyTransforms(XMLCryptoContext context, Data input) Applies all the Transforms contained to the input data according to the the reference processing model of XMLDSig.
protected List	checkCanonicalizationMethod(List transforms) Replaces each CanonicalizationMethod that maybe included in the given list by the corresponding Transform.
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
String	getLocalName() Returns the local name of the represented XML element.
List	getTransforms()
Node	marshal(DOMCryptoContext context, Node parent, Node nextSibling) Marshal the DOM node representation of this DOMStructure and all its child DOMStructures.
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

transforms_

protected List transforms_

The list of Transforms. May not be null.

appliedTransforms_

protected List appliedTransforms_

The list of Transforms, that have already been applied to the input data. These transforms are marshaled. However, the are not applied to the input data when applyTransforms(XMLCryptoContext, Data) is called.

Constructor Detail

TransformsType

protected TransformsType(Node node)

Creates a new instance of this TransformsType with the specified node

Parameters:

node - the node

TransformsType

protected TransformsType(List transforms)

Creates a new instance of this TransformsType with the specified list of TransformImpls.

Parameters:

transforms - a list of TransformImpls

Throws:

NullPointerException - if transforms is null

IllegalArgumentException - if transforms is empty

ClassCastException - if transforms contains any elements not of type TransformImpl

TransformsType

protected TransformsType(List appliedTransforms,
                         List transforms)

Creates a new instance of this TransformsType with the specified list of TransformImpls and a list of already applied TransformImpls.

Parameters:

appliedTransforms - a list of TransformImpls

transforms - a list of TransformImpls

Throws:

NullPointerException - if transforms or appliedTransforms is null

IllegalArgumentException - if transforms or appliedTransforms is empty

ClassCastException - if transforms or appliedTransforms contains any elements not of type TransformImpl

Method Detail

getTransforms

public List getTransforms()

Returns:

Returns the transforms.

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()

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()

marshal

public Node marshal(DOMCryptoContext context,
                    Node parent,
                    Node nextSibling)
             throws MarshalException

Description copied from class: DOMStructure

Marshal the DOM node representation of this DOMStructure and all its child DOMStructures.
This method calls

• DOMStructure.marshalElement(DOMCryptoContext, Node, Node)
• DOMStructure.marshalAttributes(DOMCryptoContext, Element)
• DOMStructure.marshalIDAttribute(DOMCryptoContext, Element)
• and DOMStructure.marshal(DOMCryptoContext, Node, Node) for every DOMStructure returned by DOMStructure.getChildStructures().

Overrides:

marshal in class DOMStructure

Parameters:

context - the DOMMarshalContext holding context information about the marshaling of this DOMStructure

parent - where to place the marshalled node

nextSibling - before wich to place the marshalled node

Returns:

the DOM node representation of this DOMStrucuture and all its child DOMStructurues

Throws:

MarshalException - if the marshaling fails for any reason

See Also:

DOMStructure.marshal(javax.xml.crypto.dom.DOMCryptoContext, org.w3c.dom.Node, org.w3c.dom.Node)

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, javax.xml.crypto.dom.DOMCryptoContext)

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)

applyTransforms

public Data applyTransforms(XMLCryptoContext context,
                            Data input)
                     throws TransformException

Applies all the Transforms contained to the input data according to the the reference processing model of XMLDSig.

Parameters:

context - the crypto context

input - the input data

Returns:

the result of applying all transforms to the input data

Throws:

TransformException - if an exception occurs during the transformation

checkCanonicalizationMethod

protected List checkCanonicalizationMethod(List transforms)

Replaces each CanonicalizationMethod that maybe included in the given list by the corresponding Transform.

Parameters:

transforms - A list of Transforms.

Returns:

A copy of the given list of Transforms where each CanonicalizationMethod that maybe included in the given list is replaced by the corresponding Transform.