FileDocCategorySizeDatePackage
Transform.javaAPI DocJava SE 6 API4949Tue Jun 10 00:27:06 BST 2008javax.xml.crypto.dsig

Transform

public interface Transform implements AlgorithmMethod, XMLStructure
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 {@link XMLSignatureFactory#newTransform newTransform} method of the {@link XMLSignatureFactory} class.
author
Sean Mullan
author
JSR 105 Expert Group
since
1.6
see
XMLSignatureFactory#newTransform(String, TransformParameterSpec)

Fields Summary
static final String
BASE64
The Base64 transform algorithm URI.
static final String
ENVELOPED
The Enveloped Signature transform algorithm URI.
static final String
XPATH
The XPath transform algorithm URI.
static final String
XPATH2
The XPath Filter 2 transform algorithm URI.
static final String
XSLT
The XSLT transform algorithm URI.
Constructors Summary
Methods Summary
public java.security.spec.AlgorithmParameterSpecgetParameterSpec()
Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a {@link TransformParameterSpec} object.

return
the algorithm-specific input parameters (may be null if not specified)

public abstract javax.xml.crypto.Datatransform(javax.xml.crypto.Data data, javax.xml.crypto.XMLCryptoContext context)
Transforms the specified data using the underlying transform algorithm.

param
data the data to be transformed
param
context the XMLCryptoContext containing additional context (may be null if not applicable)
return
the transformed data
throws
NullPointerException if data is null
throws
TransformException if an error occurs while executing the transform

public abstract javax.xml.crypto.Datatransform(javax.xml.crypto.Data data, javax.xml.crypto.XMLCryptoContext context, java.io.OutputStream os)
Transforms the specified data using the underlying transform algorithm. If the output of this transform is an 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 {@link #transform(Data, XMLCryptoContext)} were invoked.

param
data the data to be transformed
param
context the XMLCryptoContext containing additional context (may be null if not applicable)
param
os the OutputStream that should be used to write the transformed data to
return
the transformed data (or null if the data was written to the OutputStream parameter)
throws
NullPointerException if data or os is null
throws
TransformException if an error occurs while executing the transform