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

Class DOMTransform

java.lang.Object

org.apache.jcp.xml.dsig.internal.dom.DOMStructure

org.apache.jcp.xml.dsig.internal.dom.DOMTransform

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

Direct Known Subclasses:

DOMCanonicalizationMethod

public class DOMTransform
extends DOMStructure
implements Transform

DOM-based abstract implementation of Transform.

Author:

Sean Mullan

Field Summary

Fields

Modifier and Type	Field and Description
protected TransformService	spi

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

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Constructor and Description
DOMTransform(Element transElem, XMLCryptoContext context, Provider provider) Creates a DOMTransform from an element.
DOMTransform(TransformService spi) Creates a DOMTransform.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAlgorithm() Returns the algorithm URI of this AlgorithmMethod.
AlgorithmParameterSpec	getParameterSpec() Returns the algorithm-specific input parameters associated with this Transform.
int	hashCode()
void	marshal(Node parent, String dsPrefix, DOMCryptoContext context) This method invokes the abstract marshalParams method to marshal any algorithm-specific parameters.
Data	transform(Data data, XMLCryptoContext xc) Transforms the specified data using the underlying transform algorithm.
Data	transform(Data data, XMLCryptoContext xc, OutputStream os) Transforms the specified data using the underlying transform algorithm.

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

isFeatureSupported

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

Field Detail

spi

protected TransformService spi

Constructor Detail

DOMTransform

public DOMTransform(TransformService spi)

Creates a DOMTransform.

Parameters:

spi - the TransformService

DOMTransform

public DOMTransform(Element transElem,
                    XMLCryptoContext context,
                    Provider provider)
             throws MarshalException

Creates a DOMTransform from an element. This constructor invokes the abstract unmarshalParams method to unmarshal any algorithm-specific input parameters.

Parameters:

transElem - a Transform element

Throws:

MarshalException

Method Detail

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()

Description copied from interface: 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-specific input parameters (may be null if not specified)

getAlgorithm

public final String getAlgorithm()

Description copied from interface: AlgorithmMethod

Returns the algorithm URI of this AlgorithmMethod.

Specified by:

getAlgorithm in interface AlgorithmMethod

Returns:

the algorithm URI of this AlgorithmMethod

marshal

public void marshal(Node parent,
                    String dsPrefix,
                    DOMCryptoContext context)
             throws MarshalException

This method invokes the abstract marshalParams method to marshal any algorithm-specific parameters.

Specified by:

marshal in class DOMStructure

Throws:

MarshalException

transform

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

Transforms the specified data using the underlying transform algorithm.

Specified by:

transform in interface Transform

Parameters:

data - the data to be transformed

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

Returns:

the transformed data

Throws:

NullPointerException - if data is null

XMLSignatureException - if an unexpected error occurs while executing the transform

TransformException - if an error occurs while executing the transform

transform

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

Transforms the specified data using the underlying transform algorithm.

Specified by:

transform in interface Transform

Parameters:

data - the data to be transformed

sc - 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

Throws:

NullPointerException - if data is null

XMLSignatureException - if an unexpected error occurs while executing the transform

TransformException - if an error occurs while executing the transform

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object