org.apache.xml.security.transforms
Class Transforms

java.lang.Object
  extended by org.apache.xml.security.utils.ElementProxy
      extended by org.apache.xml.security.utils.SignatureElementProxy
          extended by org.apache.xml.security.transforms.Transforms

public class Transforms
extends SignatureElementProxy

Holder of the Transform steps to be performed on the data. The input to the first Transform is the result of dereferencing the URI attribute of the Reference element. The output from the last Transform is the input for the DigestMethod algorithm

Author:
Christian Geuer-Pollmann
See Also:
Transform, Reference

Field Summary
static String TRANSFORM_BASE64_DECODE
          Transform - Required base64 decoding
static String TRANSFORM_C14N_EXCL_OMIT_COMMENTS
          Canonicalization - Required Exclusive Canonicalization (omits comments)
static String TRANSFORM_C14N_EXCL_WITH_COMMENTS
          Canonicalization - Recommended Exclusive Canonicalization with Comments
static String TRANSFORM_C14N_OMIT_COMMENTS
          Canonicalization - Required Canonical XML (omits comments)
static String TRANSFORM_C14N_WITH_COMMENTS
          Canonicalization - Recommended Canonical XML with Comments
static String TRANSFORM_C14N11_OMIT_COMMENTS
          Canonicalization - Required Canonical XML 1.1 (omits comments)
static String TRANSFORM_C14N11_WITH_COMMENTS
          Canonicalization - Recommended Canonical XML 1.1 with Comments
static String TRANSFORM_ENVELOPED_SIGNATURE
          Transform - Required Enveloped Signature
static String TRANSFORM_XPATH
          Transform - Recommended XPath
static String TRANSFORM_XPATH2FILTER
          Transform - XPath Filter
static String TRANSFORM_XPOINTER
          Transform - XPointer
static String TRANSFORM_XSLT
          Transform - Optional XSLT
 
Fields inherited from class org.apache.xml.security.utils.ElementProxy
baseURI
 
Constructor Summary
protected Transforms()
           
  Transforms(Document doc)
          Constructs Transforms.
  Transforms(Element element, String BaseURI)
          Constructs Transforms from Element which is Transforms Element
 
Method Summary
 void addTransform(String transformURI)
          Adds the Transform with the specified Transform algorithm URI
 void addTransform(String transformURI, Element contextElement)
          Adds the Transform with the specified Transform algorithm URI
 void addTransform(String transformURI, NodeList contextNodes)
          Adds the Transform with the specified Transform algorithm URI.
 String getBaseLocalName()
          Returns the localname of the Elements of the sub-class.
 int getLength()
          Return the nonnegative number of transformations.
 Transform item(int i)
          Return the ith Transform.
 XMLSignatureInput performTransforms(XMLSignatureInput xmlSignatureInput)
          Applies all included Transforms to xmlSignatureInput and returns the result of these transformations.
 XMLSignatureInput performTransforms(XMLSignatureInput xmlSignatureInput, OutputStream os)
          Applies all included Transforms to xmlSignatureInput and returns the result of these transformations.
 void setSecureValidation(boolean secureValidation)
          Set whether secure validation is enabled or not.
 
Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy
getBaseNamespace
 
Methods inherited from class org.apache.xml.security.utils.ElementProxy
addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TRANSFORM_C14N_OMIT_COMMENTS

public static final String TRANSFORM_C14N_OMIT_COMMENTS
Canonicalization - Required Canonical XML (omits comments)

See Also:
Constant Field Values

TRANSFORM_C14N_WITH_COMMENTS

public static final String TRANSFORM_C14N_WITH_COMMENTS
Canonicalization - Recommended Canonical XML with Comments

See Also:
Constant Field Values

TRANSFORM_C14N11_OMIT_COMMENTS

public static final String TRANSFORM_C14N11_OMIT_COMMENTS
Canonicalization - Required Canonical XML 1.1 (omits comments)

See Also:
Constant Field Values

TRANSFORM_C14N11_WITH_COMMENTS

public static final String TRANSFORM_C14N11_WITH_COMMENTS
Canonicalization - Recommended Canonical XML 1.1 with Comments

See Also:
Constant Field Values

TRANSFORM_C14N_EXCL_OMIT_COMMENTS

public static final String TRANSFORM_C14N_EXCL_OMIT_COMMENTS
Canonicalization - Required Exclusive Canonicalization (omits comments)

See Also:
Constant Field Values

TRANSFORM_C14N_EXCL_WITH_COMMENTS

public static final String TRANSFORM_C14N_EXCL_WITH_COMMENTS
Canonicalization - Recommended Exclusive Canonicalization with Comments

See Also:
Constant Field Values

TRANSFORM_XSLT

public static final String TRANSFORM_XSLT
Transform - Optional XSLT

See Also:
Constant Field Values

TRANSFORM_BASE64_DECODE

public static final String TRANSFORM_BASE64_DECODE
Transform - Required base64 decoding

See Also:
Constant Field Values

TRANSFORM_XPATH

public static final String TRANSFORM_XPATH
Transform - Recommended XPath

See Also:
Constant Field Values

TRANSFORM_ENVELOPED_SIGNATURE

public static final String TRANSFORM_ENVELOPED_SIGNATURE
Transform - Required Enveloped Signature

See Also:
Constant Field Values

TRANSFORM_XPOINTER

public static final String TRANSFORM_XPOINTER
Transform - XPointer

See Also:
Constant Field Values

TRANSFORM_XPATH2FILTER

public static final String TRANSFORM_XPATH2FILTER
Transform - XPath Filter

See Also:
Constant Field Values
Constructor Detail

Transforms

protected Transforms()

Transforms

public Transforms(Document doc)
Constructs Transforms.

Parameters:
doc - the Document in which XMLSignature will be placed

Transforms

public Transforms(Element element,
                  String BaseURI)
           throws DOMException,
                  XMLSignatureException,
                  InvalidTransformException,
                  TransformationException,
                  XMLSecurityException
Constructs Transforms from Element which is Transforms Element

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

setSecureValidation

public void setSecureValidation(boolean secureValidation)
Set whether secure validation is enabled or not. The default is false.


addTransform

public void addTransform(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(String transformURI,
                         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

addTransform

public void addTransform(String transformURI,
                         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

performTransforms

public XMLSignatureInput performTransforms(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

performTransforms

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

Parameters:
xmlSignatureInput - the input for the Transforms
os - where to output the last transformation.
Returns:
the result of the Transforms
Throws:
TransformationException

getLength

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

Returns:
the number of transformations

item

public Transform item(int i)
               throws TransformationException
Return the ith Transform. Valid i values are 0 to getLength()-1.

Parameters:
i - index of Transform to return
Returns:
the ith Transform
Throws:
TransformationException

getBaseLocalName

public 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.


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