Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

DSIGTransform Class Reference
[Main Signature API]

#include <DSIGTransform.hpp>

Inheritance diagram for DSIGTransform:

Inheritance graph
[legend]
Collaboration diagram for DSIGTransform:

Collaboration graph
[legend]
List of all members.

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


Utility Functions

XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
createTransformNode ()
 Create the basic node structure of a transform.
XERCES_CPP_NAMESPACE_QUALIFIER
DOMNode * 
mp_txfmNode
const XSECEnvmp_env

Public Member Functions

Constructors and Destructors
 DSIGTransform (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)
 Contructor used for existing XML signatures.
 DSIGTransform (const XSECEnv *env)
 Contructor used for new signatures.
virtual ~DSIGTransform ()
 Destructor.
Interface Methods
virtual transformType getTransformType ()=0
 Determine the transform type.
virtual void appendTransformer (TXFMChain *input)=0
 Create the transformer element and append to an existing Chain.
virtual XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
createBlankTransform (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *parentDoc)=0
 Construct a new transform.
virtual void load (void)=0
 Load a DOM structure.


Constructor & Destructor Documentation

DSIGTransform::DSIGTransform const XSECEnv env,
XERCES_CPP_NAMESPACE_QUALIFIER 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:
env The environment in which this transform operates
node The DOM node (within doc) that is to be used as the base of the Transform.
See also:
load

DSIGTransform::DSIGTransform const XSECEnv env  )  [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:
env The environment descriptor for the object

virtual DSIGTransform::~DSIGTransform  )  [inline, virtual]
 

Destructor.

Destroy the DSIGSignature elements.

Does not destroy any associated DOM Nodes


Member Function Documentation

virtual void DSIGTransform::appendTransformer TXFMChain input  )  [pure virtual]
 

Create the transformer element and append to an existing Chain.

Implemented by each Transform class and used by the DSIGSignature to construct a complete Transform chain (TXFMChain).

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

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGTransform::createBlankTransform XERCES_CPP_NAMESPACE_QUALIFIER 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, DSIGTransformXPathFilter, and DSIGTransformXSL.

XERCES_CPP_NAMESPACE_QUALIFIER 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, DSIGTransformXPathFilter, 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, DSIGTransformXPathFilter, and DSIGTransformXSL.


Member Data Documentation

const XSECEnv* DSIGTransform::mp_env [protected]
 

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* DSIGTransform::mp_txfmNode [protected]
 


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:41:25 2005 for XML-Security-C by  doxygen 1.4.2