- All Superinterfaces:
- AlgorithmMethod,- XMLStructure
- All Known Subinterfaces:
- CanonicalizationMethod
- All Known Implementing Classes:
- TransformService
A representation of the XML 
Transform element as
 defined in the 
 W3C Recommendation for XML-Signature Syntax and Processing.
 The XML Schema Definition is defined as:
 
 <element name="Transform" type="ds:TransformType"/>
   <complexType name="TransformType" mixed="true">
     <choice minOccurs="0" maxOccurs="unbounded">
       <any namespace="##other" processContents="lax"/>
       <!-- (1,1) elements from (0,unbounded) namespaces -->
       <element name="XPath" type="string"/>
     </choice>
     <attribute name="Algorithm" type="anyURI" use="required"/>
   </complexType>
 
 A Transform instance may be created by invoking the
 newTransform method
 of the XMLSignatureFactory class.- Since:
- 1.6
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringThe Base64 transform algorithm URI.static final StringThe Enveloped Signature transform algorithm URI.static final StringThe XPath transform algorithm URI.static final StringThe XPath Filter 2 transform algorithm URI.static final StringThe XSLT transform algorithm URI.
- 
Method SummaryModifier and TypeMethodDescriptionReturns the algorithm-specific input parameters associated with thisTransform.transform(Data data, XMLCryptoContext context) Transforms the specified data using the underlying transform algorithm.transform(Data data, XMLCryptoContext context, OutputStream os) Transforms the specified data using the underlying transform algorithm.Methods declared in interface javax.xml.crypto.AlgorithmMethodgetAlgorithmMethods declared in interface javax.xml.crypto.XMLStructureisFeatureSupported
- 
Field Details- 
BASE64The Base64 transform algorithm URI.- See Also:
 
- 
ENVELOPEDThe Enveloped Signature transform algorithm URI.- See Also:
 
- 
XPATHThe XPath transform algorithm URI.- See Also:
 
- 
XPATH2The XPath Filter 2 transform algorithm URI.- See Also:
 
- 
XSLTThe XSLT transform algorithm URI.- See Also:
 
 
- 
- 
Method Details- 
getParameterSpecAlgorithmParameterSpec getParameterSpec()Returns the algorithm-specific input parameters associated with thisTransform.The returned parameters can be typecast to a TransformParameterSpecobject.- Specified by:
- getParameterSpecin interface- AlgorithmMethod
- Returns:
- the algorithm-specific input parameters (may be nullif not specified)
 
- 
transformTransforms the specified data using the underlying transform algorithm.- Parameters:
- data- the data to be transformed
- context- the- XMLCryptoContextcontaining additional context (may be- nullif not applicable)
- Returns:
- the transformed data
- Throws:
- NullPointerException- if- datais- null
- TransformException- if an error occurs while executing the transform
 
- 
transformTransforms the specified data using the underlying transform algorithm. If the output of this transform is anOctetStreamData, then this method returnsnulland the bytes are written to the specifiedOutputStream. Otherwise, theOutputStreamis ignored and the method behaves as iftransform(Data, XMLCryptoContext)were invoked.- Parameters:
- data- the data to be transformed
- context- the- XMLCryptoContextcontaining additional context (may be- nullif not applicable)
- os- the- OutputStreamthat should be used to write the transformed data to
- Returns:
- the transformed data (or nullif the data was written to theOutputStreamparameter)
- Throws:
- NullPointerException- if- dataor- osis- null
- TransformException- if an error occurs while executing the transform
 
 
-