Class Transforms
- java.lang.Object
-
- org.apache.xml.security.utils.ElementProxy
-
- org.apache.xml.security.utils.SignatureElementProxy
-
- org.apache.xml.security.transforms.Transforms
-
- Direct Known Subclasses:
XMLCipher.Factory.TransformsImpl
public class Transforms extends SignatureElementProxy
Holder of theTransform
steps to be performed on the data. The input to the first Transform is the result of dereferencing theURI
attribute of theReference
element. The output from the last Transform is the input for theDigestMethod algorithm
-
-
Field Summary
Fields Modifier and Type Field Description private static org.slf4j.Logger
LOG
private boolean
secureValidation
static java.lang.String
TRANSFORM_BASE64_DECODE
Transform - Required base64 decodingstatic java.lang.String
TRANSFORM_C14N_EXCL_OMIT_COMMENTS
Canonicalization - Required Exclusive Canonicalization (omits comments)static java.lang.String
TRANSFORM_C14N_EXCL_WITH_COMMENTS
Canonicalization - Recommended Exclusive Canonicalization with Commentsstatic java.lang.String
TRANSFORM_C14N_OMIT_COMMENTS
Canonicalization - Required Canonical XML (omits comments)static java.lang.String
TRANSFORM_C14N_WITH_COMMENTS
Canonicalization - Recommended Canonical XML with Commentsstatic java.lang.String
TRANSFORM_C14N11_OMIT_COMMENTS
Canonicalization - Required Canonical XML 1.1 (omits comments)static java.lang.String
TRANSFORM_C14N11_WITH_COMMENTS
Canonicalization - Recommended Canonical XML 1.1 with Commentsstatic java.lang.String
TRANSFORM_ENVELOPED_SIGNATURE
Transform - Required Enveloped Signaturestatic java.lang.String
TRANSFORM_XPATH
Transform - Recommended XPathstatic java.lang.String
TRANSFORM_XPATH2FILTER
Transform - XPath Filterstatic java.lang.String
TRANSFORM_XPOINTER
Transform - XPointerstatic java.lang.String
TRANSFORM_XSLT
Transform - Optional XSLTprivate org.w3c.dom.Element[]
transforms
-
Fields inherited from class org.apache.xml.security.utils.ElementProxy
baseURI
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Transforms()
Transforms(org.w3c.dom.Document doc)
ConstructsTransforms
.Transforms(org.w3c.dom.Element element, java.lang.String baseURI)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addTransform(java.lang.String transformURI)
Adds theTransform
with the specifiedTransform algorithm URI
void
addTransform(java.lang.String transformURI, org.w3c.dom.Element contextElement)
Adds theTransform
with the specifiedTransform algorithm URI
void
addTransform(java.lang.String transformURI, org.w3c.dom.NodeList contextNodes)
Adds theTransform
with the specifiedTransform algorithm URI
.private void
addTransform(Transform transform)
Adds a user-provided Transform step.private void
checkSecureValidation(Transform transform)
java.lang.String
getBaseLocalName()
Returns the localname of the Elements of the sub-class.int
getLength()
Return the nonnegative number of transformations.private void
initTransforms()
Transform
item(int i)
Return the ith
.Transform
XMLSignatureInput
performTransforms(XMLSignatureInput xmlSignatureInput)
Applies all includedTransform
s to xmlSignatureInput and returns the result of these transformations.XMLSignatureInput
performTransforms(XMLSignatureInput xmlSignatureInput, java.io.OutputStream os)
Applies all includedTransform
s 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
-
-
-
-
Field Detail
-
TRANSFORM_C14N_OMIT_COMMENTS
public static final java.lang.String TRANSFORM_C14N_OMIT_COMMENTS
Canonicalization - Required Canonical XML (omits comments)- See Also:
- Constant Field Values
-
TRANSFORM_C14N_WITH_COMMENTS
public static final java.lang.String TRANSFORM_C14N_WITH_COMMENTS
Canonicalization - Recommended Canonical XML with Comments- See Also:
- Constant Field Values
-
TRANSFORM_C14N11_OMIT_COMMENTS
public static final java.lang.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 java.lang.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 java.lang.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 java.lang.String TRANSFORM_C14N_EXCL_WITH_COMMENTS
Canonicalization - Recommended Exclusive Canonicalization with Comments- See Also:
- Constant Field Values
-
TRANSFORM_XSLT
public static final java.lang.String TRANSFORM_XSLT
Transform - Optional XSLT- See Also:
- Constant Field Values
-
TRANSFORM_BASE64_DECODE
public static final java.lang.String TRANSFORM_BASE64_DECODE
Transform - Required base64 decoding- See Also:
- Constant Field Values
-
TRANSFORM_XPATH
public static final java.lang.String TRANSFORM_XPATH
Transform - Recommended XPath- See Also:
- Constant Field Values
-
TRANSFORM_ENVELOPED_SIGNATURE
public static final java.lang.String TRANSFORM_ENVELOPED_SIGNATURE
Transform - Required Enveloped Signature- See Also:
- Constant Field Values
-
TRANSFORM_XPOINTER
public static final java.lang.String TRANSFORM_XPOINTER
Transform - XPointer- See Also:
- Constant Field Values
-
TRANSFORM_XPATH2FILTER
public static final java.lang.String TRANSFORM_XPATH2FILTER
Transform - XPath Filter- See Also:
- Constant Field Values
-
LOG
private static final org.slf4j.Logger LOG
-
transforms
private org.w3c.dom.Element[] transforms
-
secureValidation
private boolean secureValidation
-
-
Constructor Detail
-
Transforms
protected Transforms()
-
Transforms
public Transforms(org.w3c.dom.Document doc)
ConstructsTransforms
.- Parameters:
doc
- theDocument
in whichXMLSignature
will be placed
-
Transforms
public Transforms(org.w3c.dom.Element element, java.lang.String baseURI) throws org.w3c.dom.DOMException, XMLSignatureException, InvalidTransformException, TransformationException, XMLSecurityException
- Parameters:
element
- isTransforms
elementbaseURI
- the URI where the XML instance was stored- Throws:
org.w3c.dom.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(java.lang.String transformURI) throws TransformationException
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(java.lang.String transformURI, org.w3c.dom.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
-
addTransform
public void addTransform(java.lang.String transformURI, org.w3c.dom.NodeList contextNodes) throws TransformationException
Adds theTransform
with the specifiedTransform algorithm URI
.- Parameters:
transformURI
- the URI form of transform that indicates which transformation is applied to datacontextNodes
-- Throws:
TransformationException
-
addTransform
private void addTransform(Transform transform)
Adds a user-provided Transform step.- Parameters:
transform
-Transform
object
-
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, java.io.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
-
checkSecureValidation
private void checkSecureValidation(Transform transform) throws TransformationException
- 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
- Parameters:
i
- index ofTransform
to return- Returns:
- the ith Transform
- Throws:
TransformationException
-
initTransforms
private void initTransforms()
-
getBaseLocalName
public java.lang.String getBaseLocalName()
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.
-
-