iaik.xml.crypto.dsig

Class TransformImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.TransformImpl

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

Direct Known Subclasses:

CanonicalizationMethodImpl

public class TransformImpl
extends DOMStructure
implements Transform

An implementation of the Transform 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 URI	algorithm_ The algorithm URI.
protected DOMStructure	params_ The algorithm parameters if given in XML form.
protected TransformService	service_ The transform service.

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

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransformImpl() Creates a new instance of this TransformImpl.
	TransformImpl(DOMCryptoContext context, Node node) Creates a new instance of this TransformImpl with the specified context and the node to unmarshal from.
protected	TransformImpl(Node node) Creates a new instance of this TransformImpl with the specified node.
	TransformImpl(String algorithm, DOMStructure params) Creates a new instance of this TransformImpl with specified algorithm URI and parameters.
	TransformImpl(String algorithm, TransformParameterSpec params) Creates a new instance of this TransformImpl with the specified algorithm URI and parameters.

Method Summary

Modifier and Type	Method and Description
protected void	clearMarshalling() This Method is required to link the resetting of the marshaled DOMStructures with the AlgorithmParameterImpl instances that would otherwise be separated by the TransformService service_.
String	getAlgorithm() Returns the algorithm URI of this AlgorithmMethod.
String	getLocalName() Returns the local name of the represented XML element.
String	getNamespace() Returns the namespace URI of the represented XML element.
AlgorithmParameterSpec	getParameterSpec() Returns the algorithm-specific input parameters associated with this Transform.
TransformService	getTransformService() Returns the TransformService.
Node	marshal(DOMCryptoContext context, Node parent, Node nextSibling) Marshal the DOM node representation of this DOMStructure and all its child DOMStructures.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the Algorithm attribute.
protected void	setTransformService() Fetches the provider and sets the transform service.
String	toString()
Data	transform(Data data, XMLCryptoContext context) Transforms the specified data using the underlying transform algorithm.
Data	transform(Data data, XMLCryptoContext context, OutputStream os) Transforms the specified data using the underlying transform algorithm.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the Algorithm attribute.
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, getBytesFromElement, getBytesFromElementStream, getChildStructures, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshalElement, marshalIDAttribute, newIDforLookUp, putChildStructure, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, 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

algorithm_

protected URI algorithm_

The algorithm URI. (may not be null)

params_

protected DOMStructure params_

The algorithm parameters if given in XML form.

service_

protected TransformService service_

The transform service. (may not be null)

Constructor Detail

TransformImpl

protected TransformImpl()

Creates a new instance of this TransformImpl.

TransformImpl

protected TransformImpl(Node node)

Creates a new instance of this TransformImpl with the specified node.

Parameters:

node - the node

TransformImpl

public TransformImpl(String algorithm,
                     TransformParameterSpec params)
              throws NoSuchAlgorithmException,
                     InvalidAlgorithmParameterException

Creates a new instance of this TransformImpl with the specified algorithm URI and parameters.

Parameters:

algorithm - the URI identifying the transform algorithm

params - algorithm-specific transform parameters (may be null)

Throws:

NoSuchAlgorithmException - if an implementation of the specified algorithm cannot be found

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for the requested algorithm

NullPointerException - if algorithm is null

TransformImpl

public TransformImpl(String algorithm,
                     DOMStructure params)
              throws NoSuchAlgorithmException,
                     InvalidAlgorithmParameterException

Creates a new instance of this TransformImpl with specified algorithm URI and parameters. The parameters are specified as a mechanism-specific XMLStructure ( DOMStructure). This method is useful when the parameters are in XML form or there is no standard class for specifying the parameters.

Parameters:

algorithm - the URI identifying the transform algorithm

params - a mechanism-specific XML structure from which to unmarshal the parameters from (may be null if not required or optional)

Throws:

ClassCastException - if the type of params is inappropriate for this XMLSignatureFactory

NoSuchAlgorithmException - if an implementation of the specified algorithm cannot be found

InvalidAlgorithmParameterException - if the specified parameters are inappropriate for the requested algorithm

NullPointerException - if if algorithm is null

TransformImpl

public TransformImpl(DOMCryptoContext context,
                     Node node)
              throws MarshalException

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

Parameters:

context - the marshal context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

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

getNamespace

public String getNamespace()

Description copied from class: DOMStructure

Returns the namespace URI of the represented XML element.

Specified by:

getNamespace in class DOMStructure

Returns:

the namespace URI of the represented XML element

See Also:

DOMStructure.getNamespace()

getParameterSpec

public AlgorithmParameterSpec getParameterSpec()

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

Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a TransformParameterSpec object.

Specified by:

getParameterSpec in interface AlgorithmMethod

Specified by:

getParameterSpec in interface Transform

Returns:

the algorithm parameters of this AlgorithmMethod. Returns null if this AlgorithmMethod does not require parameters and they are not specified.

See Also:

AlgorithmMethod.getParameterSpec()

transform

public Data transform(Data data,
                      XMLCryptoContext context)
               throws TransformException

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

Transforms the specified data using the underlying transform algorithm.

Specified by:

transform in interface Transform

Parameters:

data - the data to be transformed

context - the XMLCryptoContext containing additional context (may be null if not applicable)

Returns:

the transformed data

Throws:

TransformException - if an error occurs while executing the transform

See Also:

Transform.transform(javax.xml.crypto.Data, javax.xml.crypto.XMLCryptoContext)

transform

public Data transform(Data data,
                      XMLCryptoContext context,
                      OutputStream os)
               throws TransformException

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

Transforms the specified data using the underlying transform algorithm. If the output of this transform is an OctetStreamData, then this method returns null and the bytes are written to the specified OutputStream. Otherwise, the OutputStream is ignored and the method behaves as if Transform.transform(Data, XMLCryptoContext)were invoked.

Specified by:

transform in interface Transform

Parameters:

data - the data to be transformed

context - the XMLCryptoContext containing additional context (may be null if not applicable)

os - the OutputStream that should be used to write the transformed data to

Returns:

the transformed data (or null if the data was written to the OutputStream parameter)

Throws:

TransformException - if an error occurs while executing the transform

See Also:

Transform.transform(javax.xml.crypto.Data, javax.xml.crypto.XMLCryptoContext, java.io.OutputStream)

getAlgorithm

public String getAlgorithm()

Description copied from interface: javax.xml.crypto.AlgorithmMethod

Returns the algorithm URI of this AlgorithmMethod.

Specified by:

getAlgorithm in interface AlgorithmMethod

Returns:

the algorithm URI of this AlgorithmMethod

See Also:

AlgorithmMethod.getAlgorithm()

getTransformService

public TransformService getTransformService()

Returns the TransformService.

Returns:

the TransformService

marshalAttributes

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

Marshals the Algorithm 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

unmarshalAttributes

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

Unmarshals the Algorithm attribute.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

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(DOMCryptoContext, Node, 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, DOMCryptoContext), TransformServiceImpl.init(XMLStructure, XMLCryptoContext)

clearMarshalling

protected void clearMarshalling()

This Method is required to link the resetting of the marshaled DOMStructures with the AlgorithmParameterImpl instances that would otherwise be separated by the TransformService service_.

Overrides:

clearMarshalling in class DOMStructure

See Also:

DOMStructure.clearMarshalling()

toString

public String toString()

Overrides:

toString in class DOMStructure

setTransformService

protected void setTransformService()
                            throws NoSuchAlgorithmException

Fetches the provider and sets the transform service.

Throws:

NoSuchAlgorithmException