public interface Transform extends XMLStructure, AlgorithmMethod
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.XMLSignatureFactory.newTransform(String, TransformParameterSpec)
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BASE64
The Base64
transform algorithm URI.
|
static java.lang.String |
ENVELOPED
The
Enveloped Signature transform algorithm URI.
|
static java.lang.String |
XPATH
The XPath
transform algorithm URI.
|
static java.lang.String |
XPATH2
The
XPath Filter 2 transform algorithm URI.
|
static java.lang.String |
XSLT
The XSLT
transform algorithm URI.
|
Modifier and Type | Method and Description |
---|---|
java.security.spec.AlgorithmParameterSpec |
getParameterSpec()
Returns the algorithm-specific input parameters associated with this
Transform . |
Data |
transform(Data data,
XMLCryptoContext context)
Transforms the specified data using the underlying transform algorithm.
|
Data |
transform(Data data,
XMLCryptoContext context,
java.io.OutputStream os)
Transforms the specified data using the underlying transform algorithm.
|
isFeatureSupported
getAlgorithm
static final java.lang.String BASE64
static final java.lang.String ENVELOPED
static final java.lang.String XPATH
static final java.lang.String XPATH2
static final java.lang.String XSLT
java.security.spec.AlgorithmParameterSpec getParameterSpec()
Transform
.
The returned parameters can be typecast to a
TransformParameterSpec
object.
getParameterSpec
in interface AlgorithmMethod
null
if not specified)Data transform(Data data, XMLCryptoContext context) throws TransformException
data
- the data to be transformedcontext
- the XMLCryptoContext
containing
additional context (may be null
if not applicable)java.lang.NullPointerException
- if data
is null
TransformException
- if an error occurs while executing the
transformData transform(Data data, XMLCryptoContext context, java.io.OutputStream os) throws TransformException
OctetStreamData
, then
this method returns null
and the bytes are written to the
specified OutputStream
. Otherwise, the
OutputStream
is ignored and the method behaves as if
transform(Data, XMLCryptoContext)
were invoked.data
- the data to be transformedcontext
- the XMLCryptoContext
containing
additional context (may be null
if not applicable)os
- the OutputStream
that should be used to write
the transformed data tonull
if the data was
written to the OutputStream
parameter)java.lang.NullPointerException
- if data
or os
is null
TransformException
- if an error occurs while executing the
transform