org.apache.xml.security.encryption
Class Transforms

java.lang.Object
  |
  +--org.apache.xml.security.utils.ElementProxy
        |
        +--org.apache.xml.security.utils.EncryptionElementProxy
              |
              +--org.apache.xml.security.encryption.Transforms

public class Transforms
extends EncryptionElementProxy

This class maps to the xenc:ReferenceList element. NOTE: this is physically the same as a Transforms, but has different semantics. Using ds:Transforms, signer and verifier perform the same operations on the data. Using xenc:Transforms, encryptor and decryptor perform opposite operations.

Author:
$Author: geuerp $

Field Summary
 
Fields inherited from class org.apache.xml.security.utils.ElementProxy
_baseURI, _constructionElement, _doc, _state, MODE_CREATE, MODE_DECRYPT, MODE_ENCRYPT, MODE_PROCESS, MODE_SIGN, MODE_UNKNOWN, MODE_VERIFY
 
Constructor Summary
Transforms(org.w3c.dom.Document doc)
          Constructor Transforms
Transforms(org.w3c.dom.Element element, java.lang.String BaseURI)
          Consturcts Transforms from Element which is Transforms Element
 
Method Summary
 void addTransform(java.lang.String transformURI)
          Adds the Transform with the specified Transform algorithm URI
 void addTransform(java.lang.String transformURI, org.w3c.dom.Element contextElement)
          Adds the Transform with the specified Transform algorithm URI
 void addTransform(java.lang.String transformURI, org.w3c.dom.NodeList contextNodes)
          Adds the Transform with the specified Transform algorithm URI
 java.lang.String getBaseLocalName()
          Returns the localname of the Elements of the sub-class.
 int getLength()
          Return the nonnegative number of transformations.
 XMLSignatureInput performDecryptionTransforms(XMLSignatureInput xmlSignatureInput)
          Applies all included Transforms to xmlSignatureInput and returns the result of these transformations.
 
Methods inherited from class org.apache.xml.security.utils.EncryptionElementProxy
getBaseNamespace
 
Methods inherited from class org.apache.xml.security.utils.ElementProxy
addBase64Element, addBase64Text, addBigIntegerElement, addText, addTextElement, createElementForFamily, getBaseURI, getBigIntegerFromChildElement, getBytesFromChildElement, getBytesFromTextChild, getChildElementLocalName, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getTextFromChildElement, getTextFromTextChild, guaranteeThatElementInCorrectSpace, length, setDefaultPrefix, setElement, setXPathNamespaceContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Transforms

public Transforms(org.w3c.dom.Document doc)
Constructor Transforms

Parameters:
doc -

Transforms

public Transforms(org.w3c.dom.Element element,
                  java.lang.String BaseURI)
           throws XMLSecurityException
Consturcts Transforms from Element which is Transforms Element

Parameters:
element - is Transforms element
BaseURI - the URI where the XML instance was stored
Throws:
XMLSecurityException
Method Detail

addTransform

public void addTransform(java.lang.String transformURI)
                  throws TransformationException
Adds the Transform with the specified Transform algorithm URI

Parameters:
transformURI - the URI form of transform that indicates which transformation is applied to data
Throws:
TransformationException

addTransform

public void addTransform(java.lang.String transformURI,
                         org.w3c.dom.Element contextElement)
                  throws TransformationException
Adds the Transform with the specified Transform algorithm URI

Parameters:
transformURI - the URI form of transform that indicates which transformation is applied to data
contextElement -
Throws:
TransformationException
See Also:
Transform.getInstance(Document doc, String algorithmURI, Element childElement)

addTransform

public void addTransform(java.lang.String transformURI,
                         org.w3c.dom.NodeList contextNodes)
                  throws TransformationException
Adds the Transform with the specified Transform algorithm URI

Parameters:
transformURI - the URI form of transform that indicates which transformation is applied to data
contextNodes -
Throws:
TransformationException
See Also:
Transform.getInstance(Document doc, String algorithmURI, NodeList contextNodes)

performDecryptionTransforms

public XMLSignatureInput performDecryptionTransforms(XMLSignatureInput xmlSignatureInput)
                                              throws TransformationException
Applies all included Transforms to xmlSignatureInput and returns the result of these transformations.

Parameters:
xmlSignatureInput - the input for the Transforms
Returns:
the result of the Transforms
Throws:
TransformationException

getLength

public int getLength()
Return the nonnegative number of transformations.

Returns:
the number of transformations

getBaseLocalName

public java.lang.String getBaseLocalName()
Description copied from class: ElementProxy
Returns the localname of the Elements of the sub-class.

Specified by:
getBaseLocalName in class ElementProxy
Returns:
the localname of the Elements of the sub-class.