CPKIFResponseData Class Reference
#include <ResponseData.h>
Detailed Description
The CPKIFResponseData class provides an interface to ResponseData objects.TSP-enforcing: No
Definition at line 28 of file ResponseData.h.
Public Member Functions | |
| CPKIFResponseData (void) | |
| CPKIFResponseData (const CPKIFBufferPtr &responseData) | |
| virtual | ~CPKIFResponseData (void) |
| int | GetVersion () const |
| CPKIFResponderIDPtr | GetResponderID () const |
| void | SetResponderID (CPKIFResponderIDPtr &rid) |
| CPKIFTimePtr | GetProducedAt () const |
| void | SetProducedAt (CPKIFTimePtr &pa) |
| void | GetResponses (CPKIFSingleResponseList &srs) |
| void | AddResponse (CPKIFSingleResponsePtr &sr) |
| CPKIFBufferPtr | toBeSigned () |
| void | GetExtensionByOID (const CPKIFOID &oid, CPKIFX509ExtensionPtr &ref) |
| void | GetEncodedExtensions (CPKIFBufferPtr &buf) |
| bool | AreThereAnyUnprocessedCriticalExtensions (std::vector< CPKIFX509ExtensionPtr > &processedExts) |
Constructor & Destructor Documentation
| CPKIFResponseData::CPKIFResponseData | ( | void | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 75 of file ResponseData.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
| CPKIFResponseData::CPKIFResponseData | ( | const CPKIFBufferPtr & | responseData | ) |
Interface: External
This function isused to create and initialize CPKIFResponseData objects. This constructor takes a ASN1OpenType parameter is used internally by PKIF when parsing OCSP objects. It is not used by applications.
- Returns:
- None
- Parameters:
-
responseData [in] A reference to a smart pointer to CPKIFBuffer object that contains ResponseData
Definition at line 92 of file ResponseData.cpp.
References CACASNWRAPPER_CREATE, CPKIFTime, LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
| CPKIFResponseData::~CPKIFResponseData | ( | void | ) | [virtual] |
Interface: External
This function destroys CPKIFResponseData objects
- Returns:
- None
Definition at line 147 of file ResponseData.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
Member Function Documentation
| int CPKIFResponseData::GetVersion | ( | ) | const |
this function is for use when retrieving an extension for which no proper class exists Interface: External
This function is used to get the version of a ResponseData object.
- Returns:
- Returns an integer representing the version of the associated ResponseData object
Definition at line 245 of file ResponseData.cpp.
| CPKIFResponderIDPtr CPKIFResponseData::GetResponderID | ( | ) | const |
Interface: External
This function is used to get the responder ID of a ResponseData object.
- Returns:
- The GetResponse function returns a smart pointer to a CPKIFResponderID object containing information identifying the associated OCSP responder, if present, and NULL otherwise.
Definition at line 259 of file ResponseData.cpp.
| void CPKIFResponseData::SetResponderID | ( | CPKIFResponderIDPtr & | rid | ) |
Interface: External
This function is used to set the responder ID of a ResponseData object.
- Returns:
- None
- Parameters:
-
rid [in] Reference to a smart pointer to a CPKIFResponderID object
Definition at line 270 of file ResponseData.cpp.
| CPKIFTimePtr CPKIFResponseData::GetProducedAt | ( | ) | const |
Interface: External
This function is used to get the produced at time of a ResponseData object.
- Returns:
- The GetResponse function returns a smart pointer to a CPKIFTime object containing the time from the ProducedAt field, if present, and NULL otherwise
Definition at line 285 of file ResponseData.cpp.
| void CPKIFResponseData::SetProducedAt | ( | CPKIFTimePtr & | pa | ) |
Interface: External
This function is used to set the produced at time of a ResponseData object.
- Returns:
- None
- Parameters:
-
pa [in] Reference to a smart pointer to a CPKIFTime object containing the time to use for the ProducedAt field in the ResponseData object
Definition at line 296 of file ResponseData.cpp.
| void CPKIFResponseData::GetResponses | ( | CPKIFSingleResponseList & | srs | ) |
Interface: External
This function is used to get the responses contained by a ResponseData object.
- Returns:
- None
- Parameters:
-
srs [in] Reference to a CPKIFSingleResponseList object to receive the list of SingleReponse objects associated with a ResponseData object
Definition at line 311 of file ResponseData.cpp.
| void CPKIFResponseData::AddResponse | ( | CPKIFSingleResponsePtr & | sr | ) |
Interface: External
This function is used to add the responses contained by a ResponseData object.
- Returns:
- None
- Parameters:
-
sr [in] Reference to a smart pointer to a CPKIFSingleReponse object containing a SingleResponse object to add to the list of SingleResponse objects contained by a ResponseData object
Definition at line 325 of file ResponseData.cpp.
| CPKIFBufferPtr CPKIFResponseData::toBeSigned | ( | ) |
Interface: External
This function returns a buffer contaning the data that was signed.
- Returns:
- A buffer contaning the data that was signed.
Definition at line 339 of file ResponseData.cpp.
| void CPKIFResponseData::GetExtensionByOID | ( | const CPKIFOID & | oid, | |
| CPKIFX509ExtensionPtr & | ref | |||
| ) | [virtual] |
Interface: External
This function is used to retrieve an extension from a responsedata object.
- Returns:
- None
- Exceptions:
-
CPKIFException(COMMON_INVALID_INPUT) CPKIFException(COMMON_ALREADY_INITIALIZED)
- Parameters:
-
oid [in] Identifies the extension sought ref [out] The extension (if present).
Implements IPKIFHasExtensions.
Definition at line 387 of file ResponseData.cpp.
| void CPKIFResponseData::GetEncodedExtensions | ( | CPKIFBufferPtr & | buf | ) | [virtual] |
Interface: External
This function returns a smart pointer to CPKIFBuffer object which will contain the encoded extension
- Returns:
- A smart pointer to CPKIFBuffer object which will contain the encoded extension
- Parameters:
-
buf [out] A reference to a smart pointer to CPKIFBuffer object which will contain the encoded extension
Implements IPKIFHasExtensions.
Definition at line 351 of file ResponseData.cpp.
References CACASNWRAPPER_CREATE, and data.
| bool CPKIFResponseData::AreThereAnyUnprocessedCriticalExtensions | ( | std::vector< CPKIFX509ExtensionPtr > & | processedExts | ) |
Interface: External
This function determines if a ResponseData object holds any unprocessed critical extensions.
- Returns:
- Returns true if there are any critical extensions present in the ResponseData object that are not in the processedExts parameter.
- Parameters:
-
processedExts [in] Reference to a vector containing smart pointers to CPKIFX509Extension objects that have been processed in some application context
Definition at line 186 of file ResponseData.cpp.
References LOG_STRING_DEBUG, ExtensionsMatch::SetRHS(), and TOOLKIT_OCSP_ASN.
The documentation for this class was generated from the following files:
