APIdia Launch Partner
Top Description Fields Constructors Methods
org.jcp.xml.dsig.internal.dom

public abstract Class ApacheTransform

extends TransformService
Class Inheritance
Known Direct Subclasses
org.jcp.xml.dsig.internal.dom.DOMBase64Transform, org.jcp.xml.dsig.internal.dom.DOMEnvelopedTransform, org.jcp.xml.dsig.internal.dom.DOMXPathFilter2Transform, org.jcp.xml.dsig.internal.dom.DOMXPathTransform, org.jcp.xml.dsig.internal.dom.DOMXSLTTransform
Imports
java.io.OutputStream, java.security.InvalidAlgorithmParameterException, java.security.spec.AlgorithmParameterSpec, java.util.Set, javax.xml.crypto.Data, .MarshalException, .NodeSetData, .OctetStreamData, .XMLCryptoContext, .XMLStructure, javax.xml.crypto.dom.DOMCryptoContext, javax.xml.crypto.dsig.TransformException, .TransformService, javax.xml.crypto.dsig.spec.TransformParameterSpec, com.sun.org.apache.xml.internal.security.signature.XMLSignatureInput, com.sun.org.apache.xml.internal.security.transforms.Transform, .Transforms, org.w3c.dom.Document, .Element, .Node
This is a wrapper/glue class which invokes the Apache XML-Security Transform.

Field Summary

Modifier and TypeField and Description
private static final Logger
LOG

protected Document
ownerDoc

protected TransformParameterSpec
params

private Transform
transform

protected Element
transformElem

Constructor Summary

AccessConstructor and Description
public
ApacheTransform()

Method Summary

Modifier and TypeMethod and Description
public final AlgorithmParameterSpec
getParameterSpec()

Implements javax.xml.crypto.dsig.Transform.getParameterSpec.

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

public void
init(XMLStructure parent, XMLCryptoContext context)

Implements abstract javax.xml.crypto.dsig.TransformService.init.

Initializes this TransformService with the specified parameters and document context.

public final boolean
isFeatureSupported(String feature)

Implements javax.xml.crypto.XMLStructure.isFeatureSupported.

Indicates whether a specified feature is supported.

public void
marshalParams(XMLStructure parent, XMLCryptoContext context)

Implements abstract javax.xml.crypto.dsig.TransformService.marshalParams.

Marshals the algorithm-specific parameters.

public Data
transform(Data data, XMLCryptoContext xc)

Implements javax.xml.crypto.dsig.Transform.transform.

Transforms the specified data using the underlying transform algorithm.

public Data
transform(Data data, XMLCryptoContext xc, OutputStream os)

Implements javax.xml.crypto.dsig.Transform.transform.

Transforms the specified data using the underlying transform algorithm.

private Data
transformIt(Data data, XMLCryptoContext xc, OutputStream os)

Inherited from javax.xml.crypto.dsig.TransformService:
getAlgorithmgetInstancegetInstancegetInstancegetMechanismTypegetProviderinit

Field Detail

LOGback to summary
private static final Logger LOG
ownerDocback to summary
protected Document ownerDoc
paramsback to summary
protected TransformParameterSpec params
transformback to summary
private Transform transform
transformElemback to summary
protected Element transformElem

Constructor Detail

ApacheTransformback to summary
public ApacheTransform()

Method Detail

getParameterSpecback to summary
public final AlgorithmParameterSpec getParameterSpec()

Implements javax.xml.crypto.dsig.Transform.getParameterSpec.

Doc from javax.xml.crypto.dsig.Transform.getParameterSpec.

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

The returned parameters can be typecast to a TransformParameterSpec object.

Annotations
@Override
initback to summary
public void init(XMLStructure parent, XMLCryptoContext context) throws InvalidAlgorithmParameterException

Implements abstract javax.xml.crypto.dsig.TransformService.init.

Doc from javax.xml.crypto.dsig.TransformService.init.

Initializes this TransformService with the specified parameters and document context.

Annotations
@Override
Exceptions
InvalidAlgorithmParameterException:
if the specified parameters are invalid for this algorithm
isFeatureSupportedback to summary
public final boolean isFeatureSupported(String feature)

Implements javax.xml.crypto.XMLStructure.isFeatureSupported.

Doc from javax.xml.crypto.XMLStructure.isFeatureSupported.

Indicates whether a specified feature is supported.

Annotations
@Override
marshalParamsback to summary
public void marshalParams(XMLStructure parent, XMLCryptoContext context) throws MarshalException

Implements abstract javax.xml.crypto.dsig.TransformService.marshalParams.

Doc from javax.xml.crypto.dsig.TransformService.marshalParams.

Marshals the algorithm-specific parameters. If there are no parameters to be marshalled, this method returns without throwing an exception.

Annotations
@Override
Exceptions
MarshalException:
if the parameters cannot be marshalled
transformback to summary
public Data transform(Data data, XMLCryptoContext xc) throws TransformException

Implements javax.xml.crypto.dsig.Transform.transform.

Doc from javax.xml.crypto.dsig.Transform.transform.

Transforms the specified data using the underlying transform algorithm.

Annotations
@Override
Exceptions
TransformException:
if an error occurs while executing the transform
transformback to summary
public Data transform(Data data, XMLCryptoContext xc, OutputStream os) throws TransformException

Implements javax.xml.crypto.dsig.Transform.transform.

Doc from javax.xml.crypto.dsig.Transform.transform.

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(Data, XMLCryptoContext) were invoked.

Annotations
@Override
Exceptions
TransformException:
if an error occurs while executing the transform
transformItback to summary
private Data transformIt(Data data, XMLCryptoContext xc, OutputStream os) throws TransformException