-
- 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 Summary
Fields 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 Summary
All 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.AlgorithmMethod
getAlgorithm
-
Methods declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Field Detail
-
BASE64
static final String BASE64
The Base64 transform algorithm URI.- See Also:
- Constant Field Values
-
ENVELOPED
static final String ENVELOPED
The Enveloped Signature transform algorithm URI.- See Also:
- Constant Field Values
-
XPATH
static final String XPATH
The XPath transform algorithm URI.- See Also:
- Constant Field Values
-
XPATH2
static final String XPATH2
The XPath Filter 2 transform algorithm URI.- See Also:
- Constant Field Values
-
XSLT
static final String XSLT
The XSLT transform algorithm URI.- See Also:
- Constant Field Values
-
-
Method Detail
-
getParameterSpec
AlgorithmParameterSpec getParameterSpec()
Returns the algorithm-specific input parameters associated with thisTransform.The returned parameters can be typecast to a
TransformParameterSpecobject.- Specified by:
getParameterSpecin interfaceAlgorithmMethod- Returns:
- the algorithm-specific input parameters (may be
nullif not specified)
-
transform
Data transform(Data data, XMLCryptoContext context) throws TransformException
Transforms the specified data using the underlying transform algorithm.- Parameters:
data- the data to be transformedcontext- theXMLCryptoContextcontaining additional context (may benullif not applicable)- Returns:
- the transformed data
- Throws:
NullPointerException- ifdataisnullTransformException- if an error occurs while executing the transform
-
transform
Data 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 transformedcontext- theXMLCryptoContextcontaining additional context (may benullif not applicable)os- theOutputStreamthat should be used to write the transformed data to- Returns:
- the transformed data (or
nullif the data was written to theOutputStreamparameter) - Throws:
NullPointerException- ifdataorosisnullTransformException- if an error occurs while executing the transform
-
-