XKMSCompoundRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSCompoundRequest.hpp>

Inheritance diagram for XKMSCompoundRequest:

[legend]Collaboration diagram for XKMSCompoundRequest:

[legend]List of all members.

---

Detailed Description

Interface definition for the CompoundRequest elements.

The <CompoundRequest> is used to merge a number of separate requests into a single message. It is a very simple type - simply a holding Request that has all the sub-requests held within it.

The schema definition for CompoundRequest is as follows :

   <!-- CompoundRequest -->
   <element name="CompoundRequest" type="xkms:CompoundRequestType"/>
   <complexType name="CompoundRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <choice maxOccurs="unbounded">
               <element ref="xkms:LocateRequest"/>
               <element ref="xkms:ValidateRequest"/>
               <element ref="xkms:RegisterRequest"/>
               <element ref="xkms:ReissueRequest"/>
               <element ref="xkms:RecoverRequest"/>
               <element ref="xkms:RevokeRequest"/>
            </choice>
         </extension>
      </complexContent>
   </complexType>
   <!-- /CompoundRequest -->

Constructors and Destructors
virtual	~XKMSCompoundRequest ()
	XKMSCompoundRequest ()
Public Member Functions
Getter Interface Methods
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	getElement (void) const =0
	Return the element at the base of the message.
virtual int	getRequestListSize (void)=0
	Obtain the number of requests within the compound request.
virtual XKMSRequestAbstractType *	getRequestListItem (int item)=0
	Obtain a request item.
Setter Interface Methods
virtual XKMSLocateRequest *	createLocateRequest (const XMLCh *service, const XMLCh *id=NULL)=0
	Add a LocateRequest item.
virtual XKMSValidateRequest *	createValidateRequest (const XMLCh *service, const XMLCh *id=NULL)=0
	Add a ValidateRequest item.
virtual XKMSRegisterRequest *	createRegisterRequest (const XMLCh *service, const XMLCh *id=NULL)=0
	Add a RegisterRequest item.

---

Constructor & Destructor Documentation

XKMSCompoundRequest::XKMSCompoundRequest (   )  [inline, protected]

virtual XKMSCompoundRequest::~XKMSCompoundRequest (   )  [inline, virtual]

---

Member Function Documentation

virtual XKMSLocateRequest* XKMSCompoundRequest::createLocateRequest (  const XMLCh *  service, const XMLCh *  id = NULL )  [pure virtual]

Add a LocateRequest item. Appends a LocateRequest to the CompoundRequest object and returns the newly created object Parameters: service  URI id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSLocateRequest structure

virtual XKMSRegisterRequest* XKMSCompoundRequest::createRegisterRequest (  const XMLCh *  service, const XMLCh *  id = NULL )  [pure virtual]

Add a RegisterRequest item. Appends a RegisterRequest to the CompoundRequest object and returns the newly created object Parameters: service  URI id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSValidateRequest structure

virtual XKMSValidateRequest* XKMSCompoundRequest::createValidateRequest (  const XMLCh *  service, const XMLCh *  id = NULL )  [pure virtual]

Add a ValidateRequest item. Appends a ValidateRequest to the CompoundRequest object and returns the newly created object Parameters: service  URI id  Value to set in the Id field. If NULL, the library will generate a new Unique Id value. Returns: the new XKMSValidateRequest structure

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XKMSCompoundRequest::getElement (  void   )  const [pure virtual]

Return the element at the base of the message. Implements XKMSRequestAbstractType.

virtual XKMSRequestAbstractType* XKMSCompoundRequest::getRequestListItem (  int  item  )  [pure virtual]

Obtain a request item. Obtain a particular request from the list of requests held in this compound object Returns: The nominated item

virtual int XKMSCompoundRequest::getRequestListSize (  void   )  [pure virtual]

Obtain the number of requests within the compound request. This class holds a list of requests that can be accessed using the getRequestListItem method. This method allows an application to determine how many request items there are. Returns: The size of the request list

---

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

• XKMSCompoundRequest.hpp

---