CPKIFResponseStatus Class Reference

#include <ResponseStatus.h>

Collaboration diagram for CPKIFResponseStatus:

[legend]

List of all members.

---

Detailed Description

The CPKIFResponseStatus class provides an interface to SCVP ResponseStatus object.

TSP-enforcing: No

Definition at line 30 of file ResponseStatus.h.

Public Member Functions
	CPKIFResponseStatus ()
	CPKIFResponseStatus (std::string errorMessage, int statusCode)
	CPKIFResponseStatus (const CPKIFBufferPtr &)
virtual	~CPKIFResponseStatus (void)
void	SetErrorMessage (std::string errorMessage)
const std::string	GetErrorMessage () const
void	SetStatusCode (int statusCode)
const int	GetStatusCode () const

---

Constructor & Destructor Documentation

CPKIFResponseStatus::CPKIFResponseStatus

(

)

Interface: External

This function is used to create and initialize CPKIFResponseStatus object.

Returns:

None

Definition at line 39 of file ResponseStatus.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFResponseStatus::CPKIFResponseStatus	(	std::string	errorMessage,
		int	statusCode
	)

Interface: External

This function is used to create and initialize CPKIFResponseStatus object.

Returns:

None

Parameters:

errorMessage	[in] String value representing error message
statusCode	[in] Integer value representing status code

Definition at line 54 of file ResponseStatus.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFResponseStatus::CPKIFResponseStatus

(

const CPKIFBufferPtr &

respStatus

)

Interface: External

This constructor is internally invoked; it will throw a std::bad_alloc exception if allocation of memory fails or ASN.1 decoding errors if the extension cannot be parsed.

Returns:

None

Exceptions:

std::bad_alloc

Parameters:

respStatus

[in] A reference to a smart pointer to CPKIFBuffer object containing der encoded ResponseStatus

Definition at line 75 of file ResponseStatus.cpp.

References CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, and TOOLKIT_SCVP_ASN.

CPKIFResponseStatus::~CPKIFResponseStatus

(

void

)

[virtual]

Interface: External

This function destroys instances of CPKIFResponseStatus.

Returns:

None

Definition at line 109 of file ResponseStatus.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

---

Member Function Documentation

void CPKIFResponseStatus::SetErrorMessage

(

std::string

errorMessage

)

Interface: External

This function is used to set error message

Returns:

None

Parameters:

errorMessage

[in] String value representing error message

Definition at line 124 of file ResponseStatus.cpp.

const string CPKIFResponseStatus::GetErrorMessage

(

)

const

Interface: External

This function is used to get error message

Returns:

String value representing error message

Definition at line 137 of file ResponseStatus.cpp.

void CPKIFResponseStatus::SetStatusCode

(

int

statusCode

)

Interface: External

This function is used to set status code

Status code value are:

okay = 0,
skipUnrecognizedItems = 1,
tooBusy = 10,
invalidRequest = 11,
internalError_1 = 12,
badStructure = 20,
unsupportedVersion = 21,
abortUnrecognizedItems = 22,
unrecognizedSigKey = 23,
badSignatureOrMAC = 24,
unableToDecode = 25,
notAuthorized = 26,
unsupportedChecks = 27,
unsupportedWantBacks = 28,
unsupportedSignatureOrMAC = 29,
invalidSignatureOrMAC = 30,
protectedResponseUnsupported = 31,
unrecognizedResponderName = 32,
relayingLoop = 40,
unrecognizedValPol = 50,
unrecognizedValAlg = 51,
fullRequestInResponseUnsupported = 52,
fullPolResponseUnsupported = 53,
inhibitPolicyMappingUnsuported = 54,
requireExplicitPolicyUnsupported = 55,
inhibitAnyPolicyUnsupported = 56,
validityTimeUnsupported = 57,
unrecognizedCritQueryExt = 63,
unrecognizedCritRequestExt = 64

Returns:

None

Parameters:

statusCode

[in] Integer value representing status code

Definition at line 182 of file ResponseStatus.cpp.

const int CPKIFResponseStatus::GetStatusCode

(

)

const

Interface: External

This function is used to get status code

Status code values are:

okay = 0,
skipUnrecognizedItems = 1,
tooBusy = 10,
invalidRequest = 11,
internalError_1 = 12,
badStructure = 20,
unsupportedVersion = 21,
abortUnrecognizedItems = 22,
unrecognizedSigKey = 23,
badSignatureOrMAC = 24,
unableToDecode = 25,
notAuthorized = 26,
unsupportedChecks = 27,
unsupportedWantBacks = 28,
unsupportedSignatureOrMAC = 29,
invalidSignatureOrMAC = 30,
protectedResponseUnsupported = 31,
unrecognizedResponderName = 32,
relayingLoop = 40,
unrecognizedValPol = 50,
unrecognizedValAlg = 51,
fullRequestInResponseUnsupported = 52,
fullPolResponseUnsupported = 53,
inhibitPolicyMappingUnsuported = 54,
requireExplicitPolicyUnsupported = 55,
inhibitAnyPolicyUnsupported = 56,
validityTimeUnsupported = 57,
unrecognizedCritQueryExt = 63,
unrecognizedCritRequestExt = 64

Returns:

Integer value representing status code

Definition at line 228 of file ResponseStatus.cpp.

---

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

• ResponseStatus.h
• ResponseStatus.cpp