DSIGObject Class Reference
[Main Signature API]

#include <DSIGObject.hpp>

Collaboration diagram for DSIGObject:

[legend]List of all members.

---

Detailed Description

Base class for <Object> nodes in a <Signature> element.

The DSIG spec allows for enveloping signatures, in which the signature holds the information it is signing. For these types of signatures, the data being signed can be held in an <Object> container.

This class allows callers to and manipulate Object containers.

Public Member Functions
Constructors and Destructors
	DSIGObject (const XSECEnv *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *dom)
	Construct from an owning signature.
	DSIGObject (const XSECEnv *env)
	Construct a new object.
	~DSIGObject ()
	Destructor.
Library functions
void	load (void)
	Load the object from DOM.
XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	createBlankObject (void)
	Create a new Object.
Get functions
const XMLCh *	getId (void)
	Get the Id for this object.
const XMLCh *	getMimeType (void)
	Returns the MimeType string of this object.
const XMLCh *	getEncoding (void)
	Returns the Encoding string of this object.
const XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	getElement (void)
	Returns the Element node for this object.
Setter functions
void	setId (const XMLCh *id)
	Set the Id attribute for this Object.
void	setMimeType (const XMLCh *type)
	Set the Id attribute for this Object.
void	setEncoding (const XMLCh *encoding)
	Set the Encoding attribute for this Object.
void	appendChild (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *child)
	Add a child node to the Object.

---

Constructor & Destructor Documentation

DSIGObject::DSIGObject (  const XSECEnv *  env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  dom )

Construct from an owning signature. Called by the library when an Object needs to be created from an Object in a DOM tree. Parameters: env  The environment that the Object is operating within dom  The DOM node that will be loaded

DSIGObject::DSIGObject (  const XSECEnv *  env  )

Construct a new object. Called by the library to create an Object from scratch Parameters: env  The environment the Object is operating within

DSIGObject::~DSIGObject (   )

Destructor.

---

Member Function Documentation

void DSIGObject::appendChild (  XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  child  )

Add a child node to the Object. This is a "ease of use" function to allow users to add a DOM structure that has been built previously into the Object element

XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGObject::createBlankObject (  void   )

Create a new Object. Create a new Object from scratch (will generate the DOM)

const XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGObject::getElement (  void   )

Returns the Element node for this object. Returns: the Element node at the head of this object

const XMLCh* DSIGObject::getEncoding (  void   )

Returns the Encoding string of this object. Returns: a pointer to the buffer containing the Encoding string

const XMLCh* DSIGObject::getId (  void   )

Get the Id for this object. Returns: the URI attribute string for this object

const XMLCh* DSIGObject::getMimeType (  void   )

Returns the MimeType string of this object. Returns: a pointer to the buffer containing the Mime Type string

void DSIGObject::load (  void   )

Load the object from DOM. Called by the library to load a constructed object

void DSIGObject::setEncoding (  const XMLCh *  encoding  )

Set the Encoding attribute for this Object. Parameters: encoding  String to use for the Encoding attribute

void DSIGObject::setId (  const XMLCh *  id  )

Set the Id attribute for this Object. Parameters: id  String to use for the Id attribute

void DSIGObject::setMimeType (  const XMLCh *  type  )

Set the Id attribute for this Object. Parameters: type  String to use for the MimeType attribute

---

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

• DSIGObject.hpp

---