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

XKMSRecoverRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSRecoverRequest.hpp>

Inheritance diagram for XKMSRecoverRequest:

Inheritance graph
[legend]
Collaboration diagram for XKMSRecoverRequest:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the RecoverRequest elements.

The <RecoverRequest> is one of the message types of the X-KRMS service. It is used when a client wishes to recover a private key known to the service.

The schema definition for RecoverRequest is as follows :

    <!-- RecoverRequest -->
   <element name="RecoverRequest" type="xkms:RecoverRequestType"/>
   <complexType name="RecoverRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <sequence>
               <element ref="xkms:RecoverKeyBinding"/>
               <element ref="xkms:Authentication"/>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <element name="RecoverKeyBinding" type="xkms:KeyBindingType"/>
   <!-- /RecoverRequest -->


Constructors and Destructors

virtual ~XKMSRecoverRequest ()
 XKMSRecoverRequest ()

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 XKMSRecoverKeyBindinggetRecoverKeyBinding (void) const =0
 Obtain the RecoverKeyBinding element.
virtual XKMSAuthenticationgetAuthentication (void) const =0
 Get the Authentication element.
Setter Interface Methods
virtual XKMSRecoverKeyBindingaddRecoverKeyBinding (XKMSStatus::StatusValue status)=0
 Add a RecoverKeyBinding element.
virtual XKMSAuthenticationaddAuthentication (void)=0
 Add an Authentication element.


Constructor & Destructor Documentation

XKMSRecoverRequest::XKMSRecoverRequest  )  [inline, protected]
 

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


Member Function Documentation

virtual XKMSAuthentication* XKMSRecoverRequest::addAuthentication void   )  [pure virtual]
 

Add an Authentication element.

Set a Authentication element in the Request message. The returned object can be manipulated to add Authentication information to the request.

Returns:
A pointer to the newly created Authenticaton object, or the pointer to extant object if one already existed.

virtual XKMSRecoverKeyBinding* XKMSRecoverRequest::addRecoverKeyBinding XKMSStatus::StatusValue  status  )  [pure virtual]
 

Add a RecoverKeyBinding element.

Set a RecoverKeyBinding element in the Request message. The returned object can be manipulated to add KeyInfo elements to the Request.

Parameters:
status The status value to add into the RecoverKeyBinding structure
Returns:
A pointer to the newly created RecoverKeyBinding object, or the pointer to extant object if one already existed.

virtual XKMSAuthentication* XKMSRecoverRequest::getAuthentication void   )  const [pure virtual]
 

Get the Authentication element.

The Authentication element of the RecoverRequest is used by the client to authenticate the request to the server.

Returns:
A pointer to the Authentication structure

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

Return the element at the base of the message.

Implements XKMSRequestAbstractType.

virtual XKMSRecoverKeyBinding* XKMSRecoverRequest::getRecoverKeyBinding void   )  const [pure virtual]
 

Obtain the RecoverKeyBinding element.

The RecoverKeyBinding element is the core of the RecoverRequest message, and defines the key information that a recover is required for.

Returns:
A pointer to the XKMSPrototypeKeyBinding element


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