Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

XKMSRequestAbstractType Class Reference
[XML Key Management System Implementation]

#include <XKMSRequestAbstractType.hpp>

Inheritance diagram for XKMSRequestAbstractType:

Inheritance graph
[legend]
Collaboration diagram for XKMSRequestAbstractType:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the RequestAbstractType.

The <RequestAbstractType> is an abstract type on which all XKMS Request messages are built.

The schema definition for RequestAbstractType is as follows :

   <!-- RequestAbstractType -->
   <complexType name="RequestAbstractType" abstract="true">
      <complexContent>
         <extension base="xkms:MessageAbstractType">
            <sequence>
               <element ref="xkms:ResponseMechanism" minOccurs="0" 
                     maxOccurs="unbounded"/>
               <element ref="xkms:RespondWith" minOccurs="0" 
                     maxOccurs="unbounded"/>
               <element ref="xkms:PendingNotification" minOccurs="0"/>
            </sequence>
            <attribute name="OriginalRequestId" type="NCName" 
                  use="optional"/>
            <attribute name="ResponseLimit" type="integer" use="optional"/>
         </extension>
      </complexContent>
   </complexType>
   <!-- /RequestAbstractType -->


Constructors and Destructors

virtual ~XKMSRequestAbstractType ()
 XKMSRequestAbstractType ()

Public Member Functions

Getter Interface Methods
virtual XERCES_CPP_NAMESPACE_QUALIFIER
DOMElement * 
getElement (void) const =0
virtual const XMLCh * getOriginalRequestId (void) const =0
 Get the Original Request Id for the Message.
virtual unsigned int getResponseLimit (void) const =0
 Get the ResponseLimit size.
Setter interface methods
virtual void setOriginalRequestId (const XMLCh *id)=0
 Set the Original Reqeust Id for the Message.
virtual void setResponseLimit (unsigned int limit)=0
 Set the ResponseLimit size.
\<RespondWith\> handling
virtual int getRespondWithSize (void)=0
 Number of RespondWith elements in this Request.
virtual XKMSRespondWithgetRespondWithItem (int item)=0
 Get the nth item in the RespondWith list.
virtual const XMLCh * getRespondWithItemStr (int item)=0
 Get the string of the nth item in the RespondWith list.
virtual void appendRespondWithItem (XKMSRespondWith *item)=0
 Append an item to the RespondWith list.
virtual void appendRespondWithItem (const XMLCh *item)=0
 Shortcut for appending an item to the RespondWith list.
\<ResponseMechanism\> handling
virtual int getResponseMechanismSize (void)=0
 Number of ResponseMechanism elements in this Request.
virtual XKMSResponseMechanismgetResponseMechanismItem (int item)=0
 Get the nth item in the ResponseMechanism list.
virtual const XMLCh * getResponseMechanismItemStr (int item)=0
 Get the string of the nth item in the ResponseMechanism list.
virtual void appendResponseMechanismItem (XKMSResponseMechanism *item)=0
 Append an item to the ResponseMechanism list.
virtual void appendResponseMechanismItem (const XMLCh *item)=0
 Shortcut for appending an item to the ResponseMechanism list.
virtual void removeResponseMechanismItem (int item)=0
 Remove a ResponseMechanism.


Constructor & Destructor Documentation

XKMSRequestAbstractType::XKMSRequestAbstractType  )  [inline, protected]
 

virtual XKMSRequestAbstractType::~XKMSRequestAbstractType  )  [inline, virtual]
 


Member Function Documentation

virtual void XKMSRequestAbstractType::appendRespondWithItem const XMLCh *  item  )  [pure virtual]
 

Shortcut for appending an item to the RespondWith list.

Parameters:
item String to create a RespondWith element around and append to the list.

virtual void XKMSRequestAbstractType::appendRespondWithItem XKMSRespondWith item  )  [pure virtual]
 

Append an item to the RespondWith list.

Parameters:
item XKMSRespondWith object to append to the list.
Note:
Once passed in, this item will be owned by the library.

virtual void XKMSRequestAbstractType::appendResponseMechanismItem const XMLCh *  item  )  [pure virtual]
 

Shortcut for appending an item to the ResponseMechanism list.

Parameters:
item String to create a ResponseMechanism element around and append to the list.

virtual void XKMSRequestAbstractType::appendResponseMechanismItem XKMSResponseMechanism item  )  [pure virtual]
 

Append an item to the ResponseMechanism list.

Parameters:
item XKMSResponseMechanism object to append to the list.
Note:
Once passed in, this item will be owned by the library.

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

Implements XKMSMessageAbstractType.

Implemented in XKMSCompoundRequest, XKMSLocateRequest, XKMSPendingRequest, XKMSRecoverRequest, XKMSRegisterRequest, XKMSReissueRequest, XKMSRevokeRequest, XKMSStatusRequest, and XKMSValidateRequest.

virtual const XMLCh* XKMSRequestAbstractType::getOriginalRequestId void   )  const [pure virtual]
 

Get the Original Request Id for the Message.

For transactions that use multipt request/response sessions (e.g. two stage commit or asyncronous processing), this attribute can be used to identify the id of the original message that was processed.

Returns:
a pointer to the Original Request Id string (owned by the library)

virtual XKMSRespondWith* XKMSRequestAbstractType::getRespondWithItem int  item  )  [pure virtual]
 

Get the nth item in the RespondWith list.

Parameters:
item The item to return
Returns:
the nth item in the RespondWith list.

virtual const XMLCh* XKMSRequestAbstractType::getRespondWithItemStr int  item  )  [pure virtual]
 

Get the string of the nth item in the RespondWith list.

Parameters:
item The item whose string is to be returned
Returns:
the string of the nth item in the RespondWith list.

virtual int XKMSRequestAbstractType::getRespondWithSize void   )  [pure virtual]
 

Number of RespondWith elements in this Request.

Returns the number of RespondWith elements held within this request

Returns:
Number of RespondWith elements

virtual unsigned int XKMSRequestAbstractType::getResponseLimit void   )  const [pure virtual]
 

Get the ResponseLimit size.

A client can limit the number of keys to be returned by the service by setting this value to the required limit.

Returns:
Value of the ResponseLimit within the message. 0 if none was set

virtual XKMSResponseMechanism* XKMSRequestAbstractType::getResponseMechanismItem int  item  )  [pure virtual]
 

Get the nth item in the ResponseMechanism list.

Parameters:
item The item to return
Returns:
the nth item in the ResponseMechanism list.

virtual const XMLCh* XKMSRequestAbstractType::getResponseMechanismItemStr int  item  )  [pure virtual]
 

Get the string of the nth item in the ResponseMechanism list.

Parameters:
item The item whose string is to be returned
Returns:
the string of the nth item in the RespondWith list.

virtual int XKMSRequestAbstractType::getResponseMechanismSize void   )  [pure virtual]
 

Number of ResponseMechanism elements in this Request.

Returns the number of ResponseMechanism elements held within this request

Returns:
Number of ResponseMechanism elements

virtual void XKMSRequestAbstractType::removeResponseMechanismItem int  item  )  [pure virtual]
 

Remove a ResponseMechanism.

Removes the identified ResponseMechanism from the item

Parameters:
item Item to remove

virtual void XKMSRequestAbstractType::setOriginalRequestId const XMLCh *  id  )  [pure virtual]
 

Set the Original Reqeust Id for the Message.

Allows a calling application to set a new original request Id for the message

Parameters:
id The Id to set as the OriginalRequestId

virtual void XKMSRequestAbstractType::setResponseLimit unsigned int  limit  )  [pure virtual]
 

Set the ResponseLimit size.

A client can limit the number of keys to be returned by the service by setting this value to the required limit.

Parameters:
limit Value to set the ResponseLimit within the message


The documentation for this class was generated from the following file:
Generated on Sun Jan 28 19:50:57 2007 for XML-Security-C by  doxygen 1.4.2