XKMSStatus Class Reference
[XML Key Management System Implementation]

#include <XKMSStatus.hpp>

List of all members.

---

Detailed Description

Interface definition for the Status elements.

The <Status> Element is used in a KeyBinding message to a client to provide status information for keys that are returned in a ValidateResult message

The schema definition for KeyBinding is as follows :

   <!-- Status -->
   <element name="Status" type="xkms:StatusType"/>
   <complexType name="StatusType">
      <sequence>
         <element ref="xkms:ValidReason" minOccurs="0" 
               maxOccurs="unbounded"/>
         <element ref="xkms:IndeterminateReason" minOccurs="0" 
               maxOccurs="unbounded"/>
         <element ref="xkms:InvalidReason" minOccurs="0" 
               maxOccurs="unbounded"/>
      </sequence>
      <attribute name="StatusValue" type="xkms:KeyBindingStatus" 
            use="required"/>
   </complexType>
   <simpleType name="KeyBindingStatus">
      <restriction base="QName">
         <enumeration value="xkms:Valid"/>
         <enumeration value="xkms:Invalid"/>
         <enumeration value="xkms:Indeterminate"/>
      </restriction>
   </simpleType>
   <!-- /Status -->
 

Constructors and Destructors
virtual	~XKMSStatus ()
	XKMSStatus ()
Public Types
enum	StatusValue {   StatusUndefined = 0,   Valid = 1,   Invalid = 2,   Indeterminate = 3 }
enum	StatusReason {   ReasonUndefined = 0,   IssuerTrust = 1,   RevocationStatus = 2,   ValidityInterval = 3,   Signature = 4 }
Public Member Functions
Getter methods
virtual StatusValue	getStatusValue (void) const =0
	Get the KeyBinding status assertion.
virtual bool	getStatusReason (StatusValue status, StatusReason reason) const =0
	Find the Reason for a particular facet of status codes.
Setter Methods
virtual void	setStatusReason (StatusValue status, StatusReason reason, bool value)=0
	Activate or de-activate a particular reason in the status result.

---

Member Enumeration Documentation

enum XKMSStatus::StatusReason

Enumeration values: ReasonUndefined  IssuerTrust  The reason is undefined or unknown RevocationStatus  The issuer of the info is considered good ValidityInterval  Key is/is not revoked Signature  Key not expired

enum XKMSStatus::StatusValue

Enumeration values: StatusUndefined  Valid  Error - the status value is undefined Invalid  Good key! Indeterminate  Bad key!

---

Constructor & Destructor Documentation

XKMSStatus::XKMSStatus (   )  [inline, protected]

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

---

Member Function Documentation

virtual bool XKMSStatus::getStatusReason (  StatusValue  status, StatusReason  reason )  const [pure virtual]

Find the Reason for a particular facet of status codes. For each status reason, a Status can define a number of reasons to return to a client. There are some controls on this (e.g. you cannot have an InvalidReason if the actual KeyBindingStatus is Valid), but you can have things in ValidReason and IndeterminateReason for an Invalid result. This call allows you to find out about any facet of a reason Parameters: status  The particular status value you want to find a reason for reason  The particular reason that you want to determine is or is not set Returns: true if the particular reason is set for the given status, false otherwise

virtual StatusValue XKMSStatus::getStatusValue (  void   )  const [pure virtual]

Get the KeyBinding status assertion. The Status element has a StatusValue attribute that defines the validity of the key in question Returns: the status assertion

virtual void XKMSStatus::setStatusReason (  StatusValue  status, StatusReason  reason, bool  value )  [pure virtual]

Activate or de-activate a particular reason in the status result. For each status reason, a Status can define a number of reasons to return to a client. There are some controls on this (e.g. you cannot have an InvalidReason if the actual KeyBindingStatus is Valid), but you can have things in ValidReason and IndeterminateReason for an Invalid result. This call allows you to set any facet of a reason Parameters: status  The particular status value you want to set a reason for reason  The particular reason that you want to set value  true to turn on the reason, false to turn it off

---

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

• XKMSStatus.hpp

---