XKMSLocateRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSLocateRequest.hpp>

Inheritance diagram for XKMSLocateRequest:

[legend]Collaboration diagram for XKMSLocateRequest:

[legend]List of all members.

---

Detailed Description

Interface definition for the LocateRequest elements.

The <LocateRequest> is one of the fundamental message types of the XKISS service. It is used by the Locate service to find a key and return a set of key bindings for that key.

The schema definition for LocateRequest is as follows :

   <!-- LocateRequest -->
   <element name="LocateRequest" type="xkms:LocateRequestType"/>
   <complexType name="LocateRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <sequence>
               <element ref="xkms:QueryKeyBinding"/>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <!-- /LocateRequest -->

Constructors and Destructors
virtual	~XKMSLocateRequest ()
	XKMSLocateRequest ()
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 XKMSQueryKeyBinding *	getQueryKeyBinding (void)=0
	Obtain the QueryKeyBinding element.
Setter Interface Methods
virtual XKMSQueryKeyBinding *	addQueryKeyBinding (void)=0
	Add a QueryKeyBinding element.

---

Constructor & Destructor Documentation

XKMSLocateRequest::XKMSLocateRequest (   )  [inline, protected]

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

---

Member Function Documentation

virtual XKMSQueryKeyBinding* XKMSLocateRequest::addQueryKeyBinding (  void   )  [pure virtual]

Add a QueryKeyBinding element. Set a QueryKeyBinding element in the LocateRequest message. The returned object can be manipulated to add KeyInfo elements to the LocateRequest. Returns: A pointer to the newly created QueryKeyBinding object, or the pointer to extant object if one already existed.

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

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

virtual XKMSQueryKeyBinding* XKMSLocateRequest::getQueryKeyBinding (  void   )  [pure virtual]

Obtain the QueryKeyBinding element. The QueryKeyBinding element is the core of the LocateRequest message, and defines the public key information that will be sent to the server. Returns: A pointer to the XKMSQueryKeyBinding element

---

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

• XKMSLocateRequest.hpp

---