Transform JDK 1.6)

Description

public interface Transform

A representation of the XML Transform element as defined in the W3C Recommendation for XML-Signature Syntax and Processing.

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.

See also: XMLSignatureFactory.newTransform(String, TransformParameterSpec)

Methods

Hide/Show inherited methods

public AlgorithmParameterSpec getParameterSpec () [Specified in AlgorithmMethod]

Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a TransformParameterSpec object.
Returns: the algorithm-specific input parameters (may be null if not specified)

public Data transform (Data data, XMLCryptoContext context) throws TransformException

Transforms the specified data using the underlying transform algorithm.

Transforms the specified data using the underlying transform algorithm.
Returns: the transformed data
Parameters:
- data - the data to be transformed
- context - the XMLCryptoContext containing additional context (may be null if not applicable)
Throws:
- NullPointerException - if data is null
- TransformException - if an error occurs while executing the transform

public Data transform (Data data, XMLCryptoContext context, OutputStream os) throws TransformException

Transforms the specified data using the underlying transform algorithm.

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
Transform.transform(Data, XMLCryptoContext) were invoked.
Returns: the transformed data (or null if the data was written to the OutputStream parameter)
Parameters:
- data - the data to be transformed
- context - the XMLCryptoContext containing additional context (may be null if not applicable)
- os - the OutputStream that should be used to write the transformed data to
Throws:
- NullPointerException - if data or os is null
- TransformException - if an error occurs while executing the transform