- 
- All Superinterfaces:
- AlgorithmMethod,- XMLStructure
 - All Known Subinterfaces:
- CanonicalizationMethod
 - All Known Implementing Classes:
- TransformService
 
 public interface Transform extends XMLStructure, AlgorithmMethod A representation of the XMLTransformelement 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>ATransforminstance may be created by invoking thenewTransformmethod of theXMLSignatureFactoryclass.- Since:
- 1.6
- See Also:
- XMLSignatureFactory.newTransform(String, TransformParameterSpec)
 
- 
- 
Field SummaryFields Modifier and Type Field Description static StringBASE64The Base64 transform algorithm URI.static StringENVELOPEDThe Enveloped Signature transform algorithm URI.static StringXPATHThe XPath transform algorithm URI.static StringXPATH2The XPath Filter 2 transform algorithm URI.static StringXSLTThe XSLT transform algorithm URI.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description AlgorithmParameterSpecgetParameterSpec()Returns the algorithm-specific input parameters associated with thisTransform.Datatransform(Data data, XMLCryptoContext context)Transforms the specified data using the underlying transform algorithm.Datatransform(Data data, XMLCryptoContext context, OutputStream os)Transforms the specified data using the underlying transform algorithm.- 
Methods declared in interface javax.xml.crypto.AlgorithmMethodgetAlgorithm
 - 
Methods declared in interface javax.xml.crypto.XMLStructureisFeatureSupported
 
- 
 
- 
- 
- 
Field Detail- 
BASE64static final String BASE64 The Base64 transform algorithm URI.- See Also:
- Constant Field Values
 
 - 
ENVELOPEDstatic final String ENVELOPED The Enveloped Signature transform algorithm URI.- See Also:
- Constant Field Values
 
 - 
XPATHstatic final String XPATH The XPath transform algorithm URI.- See Also:
- Constant Field Values
 
 - 
XPATH2static final String XPATH2 The XPath Filter 2 transform algorithm URI.- See Also:
- Constant Field Values
 
 - 
XSLTstatic final String XSLT The XSLT transform algorithm URI.- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
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)
 
 - 
transformData transform(Data data, XMLCryptoContext context) throws TransformException Transforms 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
 
 - 
transformData transform(Data data, XMLCryptoContext context, OutputStream os) throws TransformException Transforms 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
 
 
- 
 
-