DSIGTransformC14n Class Reference
[Main Signature API]

#include <DSIGTransformC14n.hpp>

Inheritance diagram for DSIGTransformC14n:

[legend]Collaboration diagram for DSIGTransformC14n:

[legend]List of all members.

---

Detailed Description

Transform holder for C14n based transforms.

The DSIGTransformC14n class is used to hold C14n <Transform> elements within a document. This includes Exclusive and Comment options

See also:

TXFMC14n

DSIGTransform

Public Member Functions
Constructors and Destructors
	DSIGTransformC14n (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *node)
	Contructor used for existing XML signatures.
	DSIGTransformC14n (const XSECEnv *env)
	Contructor used for new signatures.
virtual	~DSIGTransformC14n ()
	Destructor.
Interface Methods
virtual transformType	getTransformType ()
	Determine the transform type.
virtual void	appendTransformer (TXFMChain *input)
	Create the Canonicalising transformer element.
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	createBlankTransform (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *parentDoc)
	Construct blank Canonicalisation Transform element.
virtual void	load (void)
	Load a DOM structure.
C14n Specific Methods
void	setCanonicalizationMethod (canonicalizationMethod method)
	Change canonicalisation method.
canonicalizationMethod	getCanonicalizationMethod (void)
	Get canonicalisation type.
void	addInclusiveNamespace (const char *ns)
	Add a namespace prefix to the InclusiveNamespaces list.
void	setInclusiveNamespaces (XMLCh *ns)
	Set the namespace list.
const XMLCh *	getPrefixList (void)
	Get the string containing the inclusive namespaces.
void	clearInclusiveNamespaces (void)
	Delete all inclusive namespaces.

---

Constructor & Destructor Documentation

DSIGTransformC14n::DSIGTransformC14n (  const XSECEnv *  env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  node )

Contructor used for existing XML signatures. The Node structure already exists, so read the nodes in. Parameters: env  The operating environment node  The DOM node (within doc) that is to be used as the base of the Transform. See also: load

DSIGTransformC14n::DSIGTransformC14n (  const XSECEnv *  env  )

Contructor used for new signatures. The Node structure will have to be created. Note: DSIGTransform structures should only ever be created via calls to a DSIGTransformList object. Parameters: env  The operating environment See also: createBlankTransform

virtual DSIGTransformC14n::~DSIGTransformC14n (   )  [virtual]

Destructor. Destroy the DSIGSignature elements. Does not destroy any associated DOM Nodes

---

Member Function Documentation

void DSIGTransformC14n::addInclusiveNamespace (  const char *  ns  )

Add a namespace prefix to the InclusiveNamespaces list. Exclusive canonicalisation includes the ability to define a PrefixList of namespace prefixes that will not be treated exclusively, rather they will be handled as per normal C14n. This function allows a caller to add a prefix to this list Parameters: ns  The prefix to add.

virtual void DSIGTransformC14n::appendTransformer (  TXFMChain *  input  )  [virtual]

Create the Canonicalising transformer element. Implemented by each Transform class and used by the DSIGSignature when consructing a TXFM List that includes canonicalisation (nearly always) Implements DSIGTransform.

void DSIGTransformC14n::clearInclusiveNamespaces (  void   )

Delete all inclusive namespaces. Deletes the structures (including the DOM nodes) that hold the inclusive namespaces list.

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGTransformC14n::createBlankTransform (  XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  parentDoc  )  [virtual]

Construct blank Canonicalisation Transform element. Instruct the implementation to create the required transform and return the newly constructed DOMNode structure Note: By default creates a non-comment non-exclusive C14n transform. Implements DSIGTransform.

canonicalizationMethod DSIGTransformC14n::getCanonicalizationMethod (  void   )

Get canonicalisation type. Return the type of canonicalisation to the caller. Returns: Canonicalisation type. See also: canonicalizationMethod

const XMLCh* DSIGTransformC14n::getPrefixList (  void   )

Get the string containing the inclusive namespaces. Get the string containing a list of (space separated) prefixes that will be handled non-exclusively in an exclusive C14n transform. Returns: A pointer to the string held in the node (NULL if no namespaces defined). Note: The pointer returned is owned by the Transform structure - do not delete.

virtual transformType DSIGTransformC14n::getTransformType (   )  [virtual]

Determine the transform type. Used to determine what the type of the transform is. Implements DSIGTransform.

virtual void DSIGTransformC14n::load (  void   )  [virtual]

Load a DOM structure. (Re)read the DOM structure into the Signature structures Implements DSIGTransform.

void DSIGTransformC14n::setCanonicalizationMethod (  canonicalizationMethod  method  )

Change canonicalisation method. Set the canonicalisation method to the type indicated. If this changes the transform from Exclusive to Standard C14n, any associated InclusiveNamespaces children will be removed. If this is moving from one form of Exclusive to another, any InclusiveNamespace children will remain. Parameters: method  Type of canicaliser required. See also: canonicalizationMethod

void DSIGTransformC14n::setInclusiveNamespaces (  XMLCh *  ns  )

Set the namespace list. Deletes current PrefixList (if any) and sets the list to the space separated list of namespace prefixes provided in ns. Note: No checking is done on the string passed in. Parameters: ns  The (space separated) list of prefixes to set.

---

The documentation for this class was generated from the following file:

• DSIGTransformC14n.hpp

---