DSIGKeyInfoPGPData Class Reference
[Main Signature API]

#include <DSIGKeyInfoPGPData.hpp>

Inheritance diagram for DSIGKeyInfoPGPData:

[legend]Collaboration diagram for DSIGKeyInfoPGPData:

[legend]List of all members.

---

Detailed Description

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

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

Public Member Functions
Constructors and Destructors
	DSIGKeyInfoPGPData (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pgpDataNode)
	Constructor used when XML exists.
	DSIGKeyInfoPGPData (const XSECEnv *env)
	Constructor used when XML needs to be created.
virtual	~DSIGKeyInfoPGPData ()
	Destructor.
Load and Get functions
virtual void	load (void)
	Load an existing XML structure into this object.
virtual const XMLCh *	getKeyID (void)
	Get the PGP Key ID held in the structure.
virtual const XMLCh *	getKeyPacket (void)
	Get the PGP Key Packet.
virtual const XMLCh *	getKeyName (void)
	Get key name - unimplemented for PGP packets.
Create and set functions
XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	createBlankPGPData (const XMLCh *id, const XMLCh *packet)
	Create a new PGPData element in the current document.
void	setKeyID (const XMLCh *id)
	Set the value of the KeyID to a new string.
void	setKeyPacket (const XMLCh *packet)
	Set the value of the KeyPacket to a new string.
Information Functions
virtual keyInfoType	getKeyInfoType (void)
	Return type of this KeyInfo element.

---

Constructor & Destructor Documentation

DSIGKeyInfoPGPData::DSIGKeyInfoPGPData (  const XSECEnv *  env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  pgpDataNode )

Constructor used when XML exists. This constructor is used by interface objects to load an existing DOM structure into the PGPData element. Parameters: env  Environment the KeyInfo is operating within pgpDataNode  DOMNode to load information from

DSIGKeyInfoPGPData::DSIGKeyInfoPGPData (  const XSECEnv *  env  )

Constructor used when XML needs to be created. This constructor is used by interface objects to create a DSIGKeyInfoPGPData object that can then be used to create the required XML. Parameters: env  Operating environment

virtual DSIGKeyInfoPGPData::~DSIGKeyInfoPGPData (   )  [virtual]

Destructor.

---

Member Function Documentation

XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGKeyInfoPGPData::createBlankPGPData (  const XMLCh *  id, const XMLCh *  packet )

Create a new PGPData element in the current document. Creates a new PGPData element and sets the KeyPacket and KeyID with the strings passed in. Parameters: id  Value to set the KeyID as (NULL if not to be set) packet  Value to set the key packet to (NULL if not to be set) Returns: The newly created DOMElement with the structure underneath.

virtual const XMLCh* DSIGKeyInfoPGPData::getKeyID (  void   )  [inline, virtual]

Get the PGP Key ID held in the structure. Returns a pointer to the buffer containing the ID of the PGP key. Returns: A pointer to the char buffer containing the (base 64 encoded) PGP Key ID

virtual keyInfoType DSIGKeyInfoPGPData::getKeyInfoType (  void   )  [inline, virtual]

Return type of this KeyInfo element. Implements DSIGKeyInfo.

virtual const XMLCh* DSIGKeyInfoPGPData::getKeyName (  void   )  [inline, virtual]

Get key name - unimplemented for PGP packets. Implements DSIGKeyInfo.

virtual const XMLCh* DSIGKeyInfoPGPData::getKeyPacket (  void   )  [inline, virtual]

Get the PGP Key Packet. Returns a pointer to the buffer containing the PGP Key packet. Returns: A pointer to the XMLCh buffer containing the Key Packet in base64 encoded format

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

Load an existing XML structure into this object. Implements DSIGKeyInfo.

void DSIGKeyInfoPGPData::setKeyID (  const XMLCh *  id  )

Set the value of the KeyID to a new string. Uses the passed in string to set a new value in the DOM structure. Parameters: id  The value to set the KeyID to

void DSIGKeyInfoPGPData::setKeyPacket (  const XMLCh *  packet  )

Set the value of the KeyPacket to a new string. Uses the passed in string to set a new value in the DOM structure. Parameters: packet  The value to set the KeyPacket to

---

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

• DSIGKeyInfoPGPData.hpp

---