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

XKMSResultType Class Reference
[XML Key Management System Implementation]

#include <XKMSResultType.hpp>

Inheritance diagram for XKMSResultType:

Inheritance graph
[legend]
Collaboration diagram for XKMSResultType:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the ResultType.

The <ResultType> is the base type on which Result messages are built. (The <Result> element is a direct implementation)

The schema definition for ResultType is as follows :

   <!-- ResultType -->
   <element name="Result" type="xkms:ResultType"/>
   <complexType name="ResultType">
      <complexContent>
         <extension base="xkms:MessageAbstractType">
            <sequence>
               <element ref="xkms:RequestSignatureValue" minOccurs="0"/>
            </sequence>
            <attribute name="ResultMajor" type="QName" use="required"/>
            <attribute name="ResultMinor" type="QName" use="optional"/>
            <attribute name="RequestId" type="NCName" use="optional"/>
         </extension>
      </complexContent>
   </complexType>
   <!-- /ResultType -->


Constructors and Destructors

virtual ~XKMSResultType ()
 XKMSResultType ()

Public Types

enum  ResultMajor {
  NoneMajor = 0,
  Success,
  VersionMismatch,
  Sender,
  Receiver,
  Represent,
  Pending
}
 Definition of Major Result codes. More...
enum  ResultMinor {
  NoneMinor = 0,
  NoMatch,
  TooManyResponses,
  Incomplete,
  Failure,
  Refused,
  NoAuthentication,
  MessageNotSupported,
  UnknownResponseId,
  RepresentRequired,
  NotSynchronous
}

Public Member Functions

Getter Interface Methods
virtual ResultMajor getResultMajor (void) const =0
 Get the ResultMajor code for the message.
virtual ResultMinor getResultMinor (void) const =0
 Get the ResultMinor code for the message.
virtual const XMLCh * getRequestId (void) const =0
 Obtain the RequestId attribute.
virtual const XMLCh * getRequestSignatureValue (void) const =0
 Obtain the value of the RequestSignatureValue element.
Setter interface methods
virtual void setResultMajor (ResultMajor rmaj)=0
 Set a new value for the ResultMajor of this response.
virtual void setResultMinor (ResultMinor rmin)=0
 Set a new value for the ResultMinor of this response.
virtual void setRequestId (const XMLCh *id)=0
 Set the Request Id for the Message.
virtual void setRequestSignatureValue (const XMLCh *value)=0
 Set the value of the RequestSignatureValue element.


Member Enumeration Documentation

enum XKMSResultType::ResultMajor
 

Definition of Major Result codes.

Enumeration values:
NoneMajor 
Success  No code - error!
VersionMismatch  Final - The operation succeeded.
Sender  Final - The service does not support the protocol version specified in the request.
Receiver  Final - An error occurred that was due to the message sent by the sender.
Represent  Final - An error occurred at the receiver.
Pending  The request has been accepted for processing and the service will return the result asynchronously

enum XKMSResultType::ResultMinor
 

Enumeration values:
NoneMinor 
NoMatch  No code - no code was returned
TooManyResponses  No match was found for the search prototype provided. Success The result code Success.NoMatch indicates that the service is authoritative for the search prototype specified and that the service positively asserts that no matches exist. Receiver The result code Receiver.NoMatch indicates that the service is not authoritative for the search prototype provided.
Incomplete  The request resulted in the number of responses that exceeded either the ResponseLimit value specified in the request or some other limit determined by the service. The service MAY either return a subset of the possible responses or none at all. Success The service has returned one or more responses that represent a subset of the possible responses. Receiver The service has returned no responses.
Failure  Success Only part of the information requested could be provided.
Refused  The service attempted to perform the request but the operation failed for unspecified reasons. Sender The reason for failure is attributed to the sender (e.g. the request failed schema validation). Receiver The reason for failure is attributed to the receiver (e.g. a database lookup failed).
NoAuthentication  The operation was refused. The service did not attempt to perform the request. Sender The sender failed to provide sufficient information to authenticate or authorize the request (e.g. payment not supplied) Receiver The receiver is currently refusing certain requests for unspecified reasons.
MessageNotSupported  Sender The operation was refused because the necessary authentication information was incorrect or missing.
UnknownResponseId  Sender The receiver does not implement the specified operation.
RepresentRequired  Sender The ResponseId for which pending status was requested is unknown to the service.
NotSynchronous  Receiver The receiver does not support synchronous processing of this type of request


Constructor & Destructor Documentation

XKMSResultType::XKMSResultType  )  [inline, protected]
 

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


Member Function Documentation

virtual const XMLCh* XKMSResultType::getRequestId void   )  const [pure virtual]
 

Obtain the RequestId attribute.

The RequestId attribute matches the Id of the request message to which this response is related.

Returns:
the RequestId string

virtual const XMLCh* XKMSResultType::getRequestSignatureValue void   )  const [pure virtual]
 

Obtain the value of the RequestSignatureValue element.

A request can have a ResponseMechanism of RequestSignatureValue. When this is set, the service can place the text within the SignatureValue element into the Result. This call allows a consumer of the result to find the value

Returns:
The original signature that was on the request message

virtual ResultMajor XKMSResultType::getResultMajor void   )  const [pure virtual]
 

Get the ResultMajor code for the message.

All result messages contain a Major Result code defining the overall status of the request performed by the client

Returns:
The ResultMajor code

virtual ResultMinor XKMSResultType::getResultMinor void   )  const [pure virtual]
 

Get the ResultMinor code for the message.

Messages may contain a minor result code that better defines the result returned in the ResultMajor code

Returns:
The ResultMinor code

virtual void XKMSResultType::setRequestId const XMLCh *  id  )  [pure virtual]
 

Set the Request Id for the Message.

Allows a calling application to set a new request Id for the message

Parameters:
id The Id to set as the RequestId

virtual void XKMSResultType::setRequestSignatureValue const XMLCh *  value  )  [pure virtual]
 

Set the value of the RequestSignatureValue element.

A request can have a ResponseMechanism of RequestSignatureValue. When this is set, the service can place the text within the SignatureValue element into the Result. This call allows a service to set this value in a response

Parameters:
value The base64 encoded signature value of the original request

virtual void XKMSResultType::setResultMajor ResultMajor  rmaj  )  [pure virtual]
 

Set a new value for the ResultMajor of this response.

Parameters:
rmaj New value for ResultMajor for this messag

virtual void XKMSResultType::setResultMinor ResultMinor  rmin  )  [pure virtual]
 

Set a new value for the ResultMinor of this response.

Parameters:
rmin New value for ResultMajor for this message


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:44:48 2005 for XML-Security-C by  doxygen 1.4.2