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

DSIGKeyInfoName Class Reference
[Main Signature API]

#include <DSIGKeyInfoName.hpp>

Inheritance diagram for DSIGKeyInfoName:

Inheritance graph
[legend]
Collaboration diagram for DSIGKeyInfoName:

Collaboration graph
[legend]
List of all members.

Detailed Description

The class for <KeyName> nodes in a KeyInfo list.

Class for holding information on a KeyName node as well as setting such a node in a signature.


Public Methods

Constructors and Destructors
 DSIGKeyInfoName (DSIGSignature *sig, DOMNode *nameNode)
 Constructor used when XML exists.

 DSIGKeyInfoName (DSIGSignature *sig)
 Constructor used when XML needs to be created.

virtual ~DSIGKeyInfoName ()
 Destructor.

Load and Get functions
virtual void load (void)
 Load an existing XML structure into this object.

virtual const XMLCh * getKeyName (void)
 Get the name held in the structure.

Create and set functions
DOMElement * createBlankKeyName (const XMLCh *name)
 Create a new KeyName element in the current document.

void setKeyName (const XMLCh *name)
 Set the value of the KeyName to a new string.

Information Functions
virtual keyInfoType getKeyInfoType (void)
 Return type of this KeyInfo element.


Constructor & Destructor Documentation

DSIGKeyInfoName::DSIGKeyInfoName DSIGSignature   sig,
DOMNode *    nameNode
 

Constructor used when XML exists.

This constructor is used by DSIGSignature objects to load an existing DOM structure into the Name element.

Parameters:
sig  Calling signature object.
nameNode  DOMNode to load information from

DSIGKeyInfoName::DSIGKeyInfoName DSIGSignature   sig
 

Constructor used when XML needs to be created.

This constructor is used by DSIGSignature objects to create a DSIGKeyInfoName object that can then be used to create the required XML.

Parameters:
sig  Calling signature object.

virtual DSIGKeyInfoName::~DSIGKeyInfoName   [virtual]
 

Destructor.


Member Function Documentation

DOMElement* DSIGKeyInfoName::createBlankKeyName const XMLCh *    name
 

Create a new KeyName element in the current document.

Creates a new KeyName element and sets the name with the string passed in.

Parameters:
name  Value to set the KeyName as
Returns:
The newly created DOMElement with the structure underneath.

virtual keyInfoType DSIGKeyInfoName::getKeyInfoType void    [inline, virtual]
 

Return type of this KeyInfo element.

Implements DSIGKeyInfo.

virtual const XMLCh* DSIGKeyInfoName::getKeyName void    [inline, virtual]
 

Get the name held in the structure.

Returns a pointer to the buffer containing the name of the key.

Returns:
A pointer to the char buffer containing the key name

Implements DSIGKeyInfo.

virtual void DSIGKeyInfoName::load void    [virtual]
 

Load an existing XML structure into this object.

Implements DSIGKeyInfo.

void DSIGKeyInfoName::setKeyName const XMLCh *    name
 

Set the value of the KeyName to a new string.

Uses the passed in string to set a new value in the DOM structure.

Parameters:
name  Value to set in KeyName


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 20:59:09 2003 for XML-Security-C by doxygen1.2.18