Class Transforms
java.lang.Object
org.apache.xml.security.utils.ElementProxy
org.apache.xml.security.utils.SignatureElementProxy
org.apache.xml.security.transforms.Transforms
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Transform - Required base64 decodingstatic final String
Canonicalization - Required Exclusive Canonicalization (omits comments)static final String
Canonicalization - Recommended Exclusive Canonicalization with Commentsstatic final String
Canonicalization - Required Canonical XML (omits comments)static final String
Canonicalization - Recommended Canonical XML with Commentsstatic final String
Transform - Required Enveloped Signaturestatic final String
Transform - Recommended XPathstatic final String
Transform - XPath Filterstatic final String
Transform - XPath Filter v2.0static final String
Transform - XPath Filter CHGP privatestatic final String
Transform - XPointerstatic final String
Transform - Optional XSLTFields 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
ConstructorsConstructorDescriptionTransforms
(Document doc) ConsturctsTransforms
Transforms
(Element element, String BaseURI) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTransform
(String transformURI) Adds theTransform
with the specifiedTransform algorithm URI
void
addTransform
(String transformURI, Element contextElement) Adds theTransform
with the specifiedTransform algorithm URI
void
addTransform
(String transformURI, NodeList contextNodes) Adds theTransform
with the specifiedTransform algorithm URI
Returns the localname of the Elements of the sub-class.int
Return the nonnegative number of transformations.item
(int i) Return thei th
.Transform
performTransforms
(XMLSignatureInput xmlSignatureInput) Applies all includedTransform
s to xmlSignatureInput and returns the result of these transformations.performTransforms
(XMLSignatureInput xmlSignatureInput, OutputStream os) Applies all includedTransform
s to xmlSignatureInput and returns the result of these transformations.Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy
getBaseNamespace
Methods inherited from class org.apache.xml.security.utils.ElementProxy
addBase64Element, addBase64Text, addBigIntegerElement, addText, addTextElement, createElementForFamily, getBaseURI, getBigIntegerFromChildElement, getBytesFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getTextFromChildElement, getTextFromTextChild, guaranteeThatElementInCorrectSpace, length, setDefaultPrefix, setElement, setXPathNamespaceContext
-
Field Details
-
TRANSFORM_C14N_OMIT_COMMENTS
Canonicalization - Required Canonical XML (omits comments)- See Also:
-
TRANSFORM_C14N_WITH_COMMENTS
Canonicalization - Recommended Canonical XML with Comments- See Also:
-
TRANSFORM_C14N_EXCL_OMIT_COMMENTS
Canonicalization - Required Exclusive Canonicalization (omits comments)- See Also:
-
TRANSFORM_C14N_EXCL_WITH_COMMENTS
Canonicalization - Recommended Exclusive Canonicalization with Comments- See Also:
-
TRANSFORM_XSLT
Transform - Optional XSLT- See Also:
-
TRANSFORM_BASE64_DECODE
Transform - Required base64 decoding- See Also:
-
TRANSFORM_XPATH
Transform - Recommended XPath- See Also:
-
TRANSFORM_ENVELOPED_SIGNATURE
Transform - Required Enveloped Signature- See Also:
-
TRANSFORM_XPOINTER
Transform - XPointer- See Also:
-
TRANSFORM_XPATH2FILTER04
Transform - XPath Filter v2.0- See Also:
-
TRANSFORM_XPATH2FILTER
Transform - XPath Filter- See Also:
-
TRANSFORM_XPATHFILTERCHGP
Transform - XPath Filter CHGP private- See Also:
-
-
Constructor Details
-
Transforms
ConsturctsTransforms
- Parameters:
doc
- theDocument
in whichXMLsignature
will be placed
-
Transforms
public Transforms(Element element, String BaseURI) throws DOMException, XMLSignatureException, InvalidTransformException, TransformationException, XMLSecurityException - Parameters:
element
- isTransforms
elementBaseURI
- the URI where the XML instance was stored- Throws:
DOMException
InvalidTransformException
TransformationException
XMLSecurityException
XMLSignatureException
-
-
Method Details
-
addTransform
Adds theTransform
with the specifiedTransform 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 theTransform
with the specifiedTransform algorithm URI
- Parameters:
transformURI
- the URI form of transform that indicates which transformation is applied to datacontextElement
-- Throws:
TransformationException
- See Also:
-
addTransform
Adds theTransform
with the specifiedTransform algorithm URI
- Parameters:
transformURI
- the URI form of transform that indicates which transformation is applied to datacontextNodes
-- Throws:
TransformationException
- See Also:
-
performTransforms
public XMLSignatureInput performTransforms(XMLSignatureInput xmlSignatureInput) throws TransformationException Applies all includedTransform
s to xmlSignatureInput and returns the result of these transformations.- Parameters:
xmlSignatureInput
- the input for theTransform
s- Returns:
- the result of the
Transforms
- Throws:
TransformationException
-
performTransforms
public XMLSignatureInput performTransforms(XMLSignatureInput xmlSignatureInput, OutputStream os) throws TransformationException Applies all includedTransform
s to xmlSignatureInput and returns the result of these transformations.- Parameters:
xmlSignatureInput
- the input for theTransform
sos
- 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
- Parameters:
i
- index ofTransform
to return- Returns:
- the
i th transforms - Throws:
TransformationException
-
getBaseLocalName
Description copied from class:ElementProxy
Returns the localname of the Elements of the sub-class.- Specified by:
getBaseLocalName
in classElementProxy
- Returns:
- the localname of the Elements of the sub-class.
-