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

Class DOMTransform

  • All Implemented Interfaces:
    javax.xml.crypto.AlgorithmMethod, javax.xml.crypto.dsig.Transform, javax.xml.crypto.XMLStructure
    Direct Known Subclasses:
    DOMCanonicalizationMethod
    public class DOMTransform
extends BaseStructure
implements javax.xml.crypto.dsig.Transform
    DOM-based abstract implementation of Transform.
    Author:
    Sean Mullan

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.xml.crypto.dsig.TransformService spi  

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

        BASE64, ENVELOPED, XPATH, XPATH2, XSLT

    • Constructor Summary

      Constructors 
      Constructor Description
      DOMTransform​(javax.xml.crypto.dsig.TransformService spi)
      Creates a DOMTransform.
      DOMTransform​(org.w3c.dom.Element transElem, javax.xml.crypto.XMLCryptoContext context, java.security.Provider provider)
      Creates a DOMTransform from an element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.lang.String getAlgorithm()  
      java.security.spec.AlgorithmParameterSpec getParameterSpec()  
      int hashCode()  
      void marshal​(XmlWriter xwriter, java.lang.String dsPrefix, javax.xml.crypto.XMLCryptoContext context)
      This method marshals any algorithm-specific parameters.
      javax.xml.crypto.Data transform​(javax.xml.crypto.Data data, javax.xml.crypto.XMLCryptoContext xc)
      Transforms the specified data using the underlying transform algorithm.
      javax.xml.crypto.Data transform​(javax.xml.crypto.Data data, javax.xml.crypto.XMLCryptoContext xc, java.io.OutputStream os)
      Transforms the specified data using the underlying transform algorithm.

      • 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 javax.xml.crypto.dsig.TransformService spi

    • Constructor Detail

      • DOMTransform

        public DOMTransform​(javax.xml.crypto.dsig.TransformService spi)
        Creates a DOMTransform.
        Parameters:
        spi - the TransformService

      • DOMTransform

        public DOMTransform​(org.w3c.dom.Element transElem,
                    javax.xml.crypto.XMLCryptoContext context,
                    java.security.Provider provider)
             throws javax.xml.crypto.MarshalException
        Creates a DOMTransform from an element. It unmarshals any algorithm-specific input parameters.
        Parameters:
        transElem - a Transform element
        Throws:
        javax.xml.crypto.MarshalException

    • Method Detail

      • getParameterSpec

        public final java.security.spec.AlgorithmParameterSpec getParameterSpec()
        Specified by:
        getParameterSpec in interface javax.xml.crypto.AlgorithmMethod
        Specified by:
        getParameterSpec in interface javax.xml.crypto.dsig.Transform

      • getAlgorithm

        public final java.lang.String getAlgorithm()
        Specified by:
        getAlgorithm in interface javax.xml.crypto.AlgorithmMethod

      • marshal

        public void marshal​(XmlWriter xwriter,
                    java.lang.String dsPrefix,
                    javax.xml.crypto.XMLCryptoContext context)
             throws javax.xml.crypto.MarshalException
        This method marshals any algorithm-specific parameters.
        Throws:
        javax.xml.crypto.MarshalException

      • transform

        public javax.xml.crypto.Data transform​(javax.xml.crypto.Data data,
                                       javax.xml.crypto.XMLCryptoContext xc)
                                throws javax.xml.crypto.dsig.TransformException
        Transforms the specified data using the underlying transform algorithm.
        Specified by:
        transform in interface javax.xml.crypto.dsig.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:
        java.lang.NullPointerException - if data is null
        XMLSignatureException - if an unexpected error occurs while executing the transform
        javax.xml.crypto.dsig.TransformException

      • transform

        public javax.xml.crypto.Data transform​(javax.xml.crypto.Data data,
                                       javax.xml.crypto.XMLCryptoContext xc,
                                       java.io.OutputStream os)
                                throws javax.xml.crypto.dsig.TransformException
        Transforms the specified data using the underlying transform algorithm.
        Specified by:
        transform in interface javax.xml.crypto.dsig.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:
        java.lang.NullPointerException - if data is null
        XMLSignatureException - if an unexpected error occurs while executing the transform
        javax.xml.crypto.dsig.TransformException

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object