XKMSPendingRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSPendingRequest.hpp>

Inheritance diagram for XKMSPendingRequest:

[legend]Collaboration diagram for XKMSPendingRequest:

[legend]List of all members.

---

Detailed Description

Interface definition for the PendingRequest elements.

The <PendingRequest> is used in Asynchronous processing. A client uses the PendingRequest element to request a response to a request that was placed in the past, and to which the service originally provided a "Pending" response - i.e. work yet to be done.

The schema definition for PendingRequest is as follows :

   <!-- PendingRequest -->
   <element name="PendingRequest" type="xkms:PendingRequestType"/>
   <complexType name="PendingRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <attribute name="ResponseId" type="NCName" use="required"/>
         </extension>
      </complexContent>
   </complexType>
   <!-- /PendingRequest -->

Constructors and Destructors
virtual	~XKMSPendingRequest ()
	XKMSPendingRequest ()
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 const XMLCh *	getResponseId (void) const =0
	Return the ResponseId.
Setter Interface Methods
virtual void	setResponseId (const XMLCh *responseId)=0
	Set the ResponseId.

---

Constructor & Destructor Documentation

XKMSPendingRequest::XKMSPendingRequest (   )  [inline, protected]

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

---

Member Function Documentation

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

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

virtual const XMLCh* XKMSPendingRequest::getResponseId (  void   )  const [pure virtual]

Return the ResponseId. The ResponseId equates to the Id of the first response the service returned, which must (by definition) have had a response code of "Pending". Together with the OriginalRequestId, this can be used by the service to uniquley identify the original request for which this PendingRequest refers. Returns: A pointer to the XMLCh string holding the ResponseId

virtual void XKMSPendingRequest::setResponseId (  const XMLCh *  responseId  )  [pure virtual]

Set the ResponseId. Allows a calling application to over-ride the configured responseId Parameters: responseId  The new responseId for this element

---

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

• XKMSPendingRequest.hpp

---