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

XKMSRevokeRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSRevokeRequest.hpp>

Inheritance diagram for XKMSRevokeRequest:

Inheritance graph
[legend]
Collaboration diagram for XKMSRevokeRequest:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the RevokeRequest elements.

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

The schema definition for RevokeRequest is as follows :

   <!-- RevokeRequest -->
   <element name="RevokeRequest" type="xkms:RevokeRequestType"/>
   <complexType name="RevokeRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <sequence>
               <element ref="xkms:RevokeKeyBinding"/>
               <choice>
                  <element ref="xkms:Authentication"/>
                  <element ref="xkms:RevocationCode"/>
               </choice>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <element name="RevokeKeyBinding" type="xkms:KeyBindingType"/>
   <!-- /RevokeRequest -->


Constructors and Destructors

virtual ~XKMSRevokeRequest ()
 XKMSRevokeRequest ()

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 XKMSRevokeKeyBindinggetRevokeKeyBinding (void) const =0
 Obtain the PrototypKeyBinding element.
virtual XKMSAuthenticationgetAuthentication (void) const =0
 Get the Authentication element.
virtual const XMLCh * getRevocationCode (void) const =0
 Get the revocation code for the request.
Setter Interface Methods
virtual XKMSRevokeKeyBindingaddRevokeKeyBinding (XKMSStatus::StatusValue status)=0
 Add a RevokeKeyBinding element.
virtual XKMSAuthenticationaddAuthentication (void)=0
 Add an Authentication element.
virtual void addRevocationCode (const XMLCh *code)=0
 Add a RevocationCode to the message.


Constructor & Destructor Documentation

XKMSRevokeRequest::XKMSRevokeRequest  )  [inline, protected]
 

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


Member Function Documentation

virtual XKMSAuthentication* XKMSRevokeRequest::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 void XKMSRevokeRequest::addRevocationCode const XMLCh *  code  )  [pure virtual]
 

Add a RevocationCode to the message.

Allows the client to add a new Revocation Code string RevokeRequest element

Parameters:
code the base64 representation of the revocation code

virtual XKMSRevokeKeyBinding* XKMSRevokeRequest::addRevokeKeyBinding XKMSStatus::StatusValue  status  )  [pure virtual]
 

Add a RevokeKeyBinding element.

Set a RevokeKeyBinding 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 RevokeKeyBinding structure
Returns:
A pointer to the newly created RevokeKeyBinding object, or the pointer to extant object if one already existed.

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

Get the Authentication element.

The Authentication element of the RegisterRequest 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* XKMSRevokeRequest::getElement void   )  const [pure virtual]
 

Return the element at the base of the message.

Implements XKMSRequestAbstractType.

virtual const XMLCh* XKMSRevokeRequest::getRevocationCode void   )  const [pure virtual]
 

Get the revocation code for the request.

This element is used by the client to provide a MAC of a pass phrase that proves to the service tha the client has the authority to revoke this key.

Returns:
A pointer to string representing the base64 encoded revocation code, or NULL if none was defined

virtual XKMSRevokeKeyBinding* XKMSRevokeRequest::getRevokeKeyBinding void   )  const [pure virtual]
 

Obtain the PrototypKeyBinding element.

The PrototypeKeyBinding element is the core of the RegisterRequest message, and defines the key information that will be sent to the server for registration.

Returns:
A pointer to the XKMSPrototypeKeyBinding element


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