XML Security, 1.6

com.ibm.xml.enc.dom
Class DOMTransform

java.lang.Object
  extended by com.ibm.xml.enc.dom.DOMStructure
      extended by com.ibm.xml.enc.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.


Field Summary
protected  TransformService spi
           
 
Fields inherited from interface javax.xml.crypto.dsig.Transform
BASE64, ENVELOPED, XPATH, XPATH2, XSLT
 
Constructor Summary
DOMTransform(org.w3c.dom.Element transElem, XMLCryptoContext context)
          Creates a DOMTransform from an element.
DOMTransform(TransformService spi)
          Creates a DOMTransform.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 java.lang.String getAlgorithm()
          Returns the algorithm URI of this AlgorithmMethod.
 java.security.spec.AlgorithmParameterSpec getParameterSpec()
          Returns the algorithm-specific input parameters associated with this Transform.
 void marshal(org.w3c.dom.Node parent, java.lang.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.
(package private)  Data transform(Data data, XMLCryptoContext xc, DOMSignContext context)
          Transforms the specified data using the underlying transform algorithm.
 Data transform(Data data, XMLCryptoContext xc, java.io.OutputStream os)
          Transforms the specified data using the underlying transform algorithm.
 
Methods inherited from class com.ibm.xml.enc.dom.DOMStructure
isFeatureSupported
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, 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(org.w3c.dom.Element transElem,
                    XMLCryptoContext context)
             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 java.security.spec.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 java.lang.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(org.w3c.dom.Node parent,
                    java.lang.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:
java.lang.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,
                      java.io.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:
java.lang.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(java.lang.Object o)
Overrides:
equals in class java.lang.Object

transform

Data transform(Data data,
               XMLCryptoContext xc,
               DOMSignContext context)
         throws MarshalException,
                TransformException
Transforms the specified data using the underlying transform algorithm. This method invokes the marshal method and passes it the specified DOMSignContext before transforming the data.

Parameters:
data - the data to be transformed
sc - the XMLCryptoContext containing additional context (may be null if not applicable)
context - the marshalling context
Returns:
the transformed data
Throws:
MarshalException - if an exception occurs while marshalling
java.lang.NullPointerException - if data or context is null
XMLSignatureException - if an unexpected error occurs while executing the transform
TransformException

XML Security, 1.6

Portions Copyright 2003, 2012 IBM Corporation.
Portions Copyright 2003, 2012 Oracle and/or its affiliates.