Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

DSIGTransform Class Reference
[Main Signature API]

The base class for transforms. More...

#include <DSIGTransform.hpp>

Inheritance diagram for DSIGTransform:

Inheritance graph
[legend]
Collaboration diagram for DSIGTransform:

Collaboration graph
[legend]
List of all members.

Public Methods

Constructors and Destructors
 DSIGTransform (DSIGSignature *sig, DOMNode *node)
 Contructor used for existing XML signatures. More...

 DSIGTransform (DSIGSignature *sig)
 Contructor used for new signatures. More...

virtual ~DSIGTransform ()
 Destructor. More...

Interface Methods
virtual transformType getTransformType ()=0
 Determine the transform type. More...

virtual TXFMBasecreateTransformer (TXFMBase *input)=0
 Create the transformer element. More...

virtual DOMElement * createBlankTransform (DOMDocument *parentDoc)=0
 Construct a new transform. More...

virtual void load (void)=0
 Load a DOM structure. More...


Protected Methods

DOMElement * createTransformNode ()
 Create the basic node structure of a transform. More...


Protected Attributes

DOMNode * mp_txfmNode
DSIGSignaturemp_parentSignature

Detailed Description

The base class for transforms.

The DSIGTransform class is the base class used to hold <Transform> elements within a document.

It does not in actually perform any transformations - only hold the information about a transform in a <Signature> structure.

See also:
TXFMBase


Constructor & Destructor Documentation

DSIGTransform::DSIGTransform DSIGSignature   sig,
DOMNode *    node
[inline]
 

Contructor used for existing XML signatures.

The Node structure already exists, so this type of Transform constructor will generally read the nodes in.

Note:
DSIGTransform structures should only ever be created via calls to a DSIGTransformList object.
Parameters:
sig  The Signature structure in which this transform exists.
node  The DOM node (within doc) that is to be used as the base of the Transform.
See also:
load

DSIGTransform::DSIGTransform DSIGSignature   sig [inline]
 

Contructor used for new signatures.

The Node structure will have to be created by the implementation class

Note:
DSIGTransform structures should only ever be created via calls to a DSIGTransformList object.
Parameters:
sig  The Signature structure in which this transform exists.

virtual DSIGTransform::~DSIGTransform   [inline, virtual]
 

Destructor.

Destroy the DSIGSignature elements.

Does not destroy any associated DOM Nodes


Member Function Documentation

virtual DOMElement* DSIGTransform::createBlankTransform DOMDocument *    parentDoc [pure virtual]
 

Construct a new transform.

Instruct the implementation to create the required transform and return the newly constructed DOMNode structure

Implemented in DSIGTransformBase64, DSIGTransformC14n, DSIGTransformEnvelope, DSIGTransformXPath, and DSIGTransformXSL.

virtual TXFMBase* DSIGTransform::createTransformer TXFMBase   input [pure virtual]
 

Create the transformer element.

Implemented by each Transform class and used by the DSIGSignature to construct a complete Transform list.

Implemented in DSIGTransformBase64, DSIGTransformC14n, DSIGTransformEnvelope, DSIGTransformXPath, and DSIGTransformXSL.

DOMElement* DSIGTransform::createTransformNode   [protected]
 

Create the basic node structure of a transform.

virtual transformType DSIGTransform::getTransformType   [pure virtual]
 

Determine the transform type.

Used to determine what the type of the transform is.

Implemented in DSIGTransformBase64, DSIGTransformC14n, DSIGTransformEnvelope, DSIGTransformXPath, and DSIGTransformXSL.

virtual void DSIGTransform::load void    [pure virtual]
 

Load a DOM structure.

Take the original node and load any sub nodes in the transform (if necessary)

Implemented in DSIGTransformBase64, DSIGTransformC14n, DSIGTransformEnvelope, DSIGTransformXPath, and DSIGTransformXSL.


Member Data Documentation

DSIGSignature* DSIGTransform::mp_parentSignature [protected]
 

DOMNode* DSIGTransform::mp_txfmNode [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jan 11 20:35:10 2003 for XML-Security-C by doxygen1.2.15