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

java.lang.Object
  extended by org.apache.jcp.xml.dsig.internal.dom.BaseStructure
      extended by org.apache.jcp.xml.dsig.internal.dom.DOMTransform
All Implemented Interfaces:
AlgorithmMethod, Transform, XMLStructure
Direct Known Subclasses:
DOMCanonicalizationMethod

public class DOMTransform
extends BaseStructure
implements Transform

DOM-based abstract implementation of Transform.

Author:
Sean Mullan

Field Summary
protected  TransformService spi
           
 
Fields inherited from interface javax.xml.crypto.dsig.Transform
BASE64, ENVELOPED, XPATH, XPATH2, XSLT
 
Constructor Summary
DOMTransform(Element transElem, XMLCryptoContext context, Provider provider)
          Creates a DOMTransform from an element.
DOMTransform(TransformService spi)
          Creates a DOMTransform.
 
Method Summary
 boolean equals(Object o)
           
 String getAlgorithm()
           
 AlgorithmParameterSpec getParameterSpec()
           
 int hashCode()
           
 void marshal(XmlWriter xwriter, String dsPrefix, XMLCryptoContext context)
          This method marshals 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.BaseStructure
isFeatureSupported, textOfNode
 
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. It unmarshals any algorithm-specific input parameters.

Parameters:
transElem - a Transform element
Throws:
MarshalException
Method Detail

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()
Specified by:
getParameterSpec in interface AlgorithmMethod
Specified by:
getParameterSpec in interface Transform

getAlgorithm

public final String getAlgorithm()
Specified by:
getAlgorithm in interface AlgorithmMethod

marshal

public void marshal(XmlWriter xwriter,
                    String dsPrefix,
                    XMLCryptoContext context)
             throws MarshalException
This method marshals any algorithm-specific parameters.

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

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

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.