CPKIFOCSPResponse Class Reference

#include <OCSPResponse.h>

Collaboration diagram for CPKIFOCSPResponse:

[legend]

List of all members.

---

Detailed Description

The CPKIFOCSPResponse class provides an interface to OCSPResponse objects.

TSP-enforcing: No

Definition at line 23 of file OCSPResponse.h.

Public Member Functions
	CPKIFOCSPResponse (void)
	~CPKIFOCSPResponse (void)
int	GetResponseStatus () const
void	SetResponseStatus (int status)
CPKIFResponseBytesPtr	GetResponseBytes () const
void	SetResponseBytes (CPKIFResponseBytesPtr &respBytes)
void	Decode (CPKIFBufferPtr &bp)
CPKIFBufferPtr	Encoded () const
Friends
struct	CPKIFOCSPResponseImpl

---

Constructor & Destructor Documentation

CPKIFOCSPResponse::CPKIFOCSPResponse

(

void

)

Interface: External

This function creates and initializes CPKIFOCSPResponse objects.

Returns:

None

Definition at line 47 of file OCSPResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

CPKIFOCSPResponse::~CPKIFOCSPResponse

(

void

)

Interface: External

This function destroys CPKIFOCSPResponse objects.

Returns:

None

Definition at line 61 of file OCSPResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

---

Member Function Documentation

int CPKIFOCSPResponse::GetResponseStatus

(

)

const

Interface: External

This function is used to get the response status associated with an OCSPResponse object.

Response status values are:

successful = 0,
malformedRequest = 1,
internalError = 2,
tryLater = 3,
sigRequired = 5,
unauthorized = 6

Returns:

An integer indicating the response status

Definition at line 90 of file OCSPResponse.cpp.

void CPKIFOCSPResponse::SetResponseStatus

(

int

status

)

Interface: External

This function is used to set the response status associated with an OCSPResponse object.

NOTE* OCSPResponseStatus is a typedef of OCSPResponseStatus_Root structure.

Returns:

None

Parameters:

status

[in] An integer value indicating the outcome of processing associated with the corresponding OCSP request

Definition at line 104 of file OCSPResponse.cpp.

CPKIFResponseBytesPtr CPKIFOCSPResponse::GetResponseBytes

(

)

const

Interface: External

This function is used to get the response bytes associated with an OCSPResponse object.

Returns:

A smart pointer to CPKIFResponseBytes object

Definition at line 120 of file OCSPResponse.cpp.

References LOG_STRING_DEBUG, m_impl, and TOOLKIT_OCSP_ASN.

void CPKIFOCSPResponse::SetResponseBytes

(

CPKIFResponseBytesPtr &

respBytes

)

Interface: External

This function is used to set the response bytes associated with an OCSPResponse object.

Returns:

None

Parameters:

respBytes

[in] Reference to a smart pointer to a CPKIFResponseBytes object containing the encoded response information

Definition at line 145 of file OCSPResponse.cpp.

void CPKIFOCSPResponse::Decode

(

CPKIFBufferPtr &

msg

)

Interface: External

This function is used to decode an encoded OCSPResponse.

Returns:

None

Exceptions:

	CPKIFOCSPException(COMMON_INVALID_INPUT)
	CPKIFOCSPException(ASN1_DECODE_ERROR)

Parameters:

msg	[in] Reference to a smart pointer to a CPKIFBuffer object containing an encoded CPKIFOCSPResponse object

Definition at line 174 of file OCSPResponse.cpp.

References ASN1_DECODE_ERROR, COMMON_INVALID_INPUT, LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

CPKIFBufferPtr CPKIFOCSPResponse::Encoded

(

)

const

Interface: External

This function returns a smart pointer to a CPKIFBuffer object containing the encoded OCSPResponse object, a NULL buffer if no OCSPResponse object has been decoded.

Returns:

A smart pointer to a CPKIFBuffer object containing the encoded OCSPResponse object

Definition at line 160 of file OCSPResponse.cpp.

---

Friends And Related Function Documentation

friend struct CPKIFOCSPResponseImpl [friend]

Definition at line 25 of file OCSPResponse.h.

---

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

• OCSPResponse.h
• OCSPResponse.cpp