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

XKMSReissueRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSReissueRequest.hpp>

Inheritance diagram for XKMSReissueRequest:

Inheritance graph
[legend]
Collaboration diagram for XKMSReissueRequest:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the ReissueRequest elements.

The <ReissueRequest> is one of the message types of the X-KRMS service. It is used when a client wishes to request the service reissue a key binding (e.g. a cert).

The schema definition for ReissueRequest is as follows :

   <!-- ReissueRequest -->
   <element name="ReissueRequest" type="xkms:ReissueRequestType"/>
   <complexType name="ReissueRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <sequence>
               <element ref="xkms:ReissueKeyBinding"/>
               <element ref="xkms:Authentication"/>
               <element ref="xkms:ProofOfPossession" minOccurs="0"/>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <element name="ReissueKeyBinding" type="xkms:KeyBindingType"/>
   <!-- /ReissueRequest -->


Constructors and Destructors

virtual ~XKMSReissueRequest ()
 XKMSReissueRequest ()

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 XKMSReissueKeyBindinggetReissueKeyBinding (void) const =0
 Obtain the ReissueKeyBinding element.
virtual XKMSAuthenticationgetAuthentication (void) const =0
 Get the Authentication element.
virtual DSIGSignaturegetProofOfPossessionSignature (void) const =0
 Get the signature used to prove possession of the private key.
Setter Interface Methods
virtual XKMSReissueKeyBindingaddReissueKeyBinding (XKMSStatus::StatusValue status)=0
 Add a ReissueKeyBinding element.
virtual XKMSAuthenticationaddAuthentication (void)=0
 Add an Authentication element.
virtual DSIGSignatureaddProofOfPossessionSignature (canonicalizationMethod cm=CANON_C14N_NOC, signatureMethod sm=SIGNATURE_DSA, hashMethod hm=HASH_SHA1)=0
 Add a ProofOfPossession signature to the message.


Constructor & Destructor Documentation

XKMSReissueRequest::XKMSReissueRequest  )  [inline, protected]
 

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


Member Function Documentation

virtual XKMSAuthentication* XKMSReissueRequest::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 DSIGSignature* XKMSReissueRequest::addProofOfPossessionSignature canonicalizationMethod  cm = CANON_C14N_NOC,
signatureMethod  sm = SIGNATURE_DSA,
hashMethod  hm = HASH_SHA1
[pure virtual]
 

Add a ProofOfPossession signature to the message.

Allows the application to add a new ProofOfPossession signature into a ReissueRequest element

Note:
the client application will need to set the key and sign the message - however the appropriate reference (to the ReissueKeyBinding element) will be set. This implies that the ReissueKeyBinding *must* be added prior to the call to this method.
Returns:
the new Signature structure

virtual XKMSReissueKeyBinding* XKMSReissueRequest::addReissueKeyBinding XKMSStatus::StatusValue  status  )  [pure virtual]
 

Add a ReissueKeyBinding element.

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

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

Get the Authentication element.

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

Return the element at the base of the message.

Implements XKMSRequestAbstractType.

virtual DSIGSignature* XKMSReissueRequest::getProofOfPossessionSignature void   )  const [pure virtual]
 

Get the signature used to prove possession of the private key.

When the client presents a request for a key generated by them, this element is used to show that the client is authorised to make this request using this key.

Returns:
A pointer to the proof of possession Signature object (or NULL if none was defined

virtual XKMSReissueKeyBinding* XKMSReissueRequest::getReissueKeyBinding void   )  const [pure virtual]
 

Obtain the ReissueKeyBinding element.

The ReissueKeyBinding element is the core of the ReissueRequest message, and defines the key information that a Reissue 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:46 2007 for XML-Security-C by  doxygen 1.4.2