CPKIFSingleResponse Class Reference
#include <SingleResponse.h>
Detailed Description
The CPKIFSingleResponse class provides an interface to SingleResponse objects.TSP-enforcing: No
Definition at line 31 of file SingleResponse.h.
Public Member Functions | |
| CPKIFSingleResponse (void) | |
| CPKIFSingleResponse (const CPKIFBufferPtr &singleResponse) | |
| virtual | ~CPKIFSingleResponse (void) |
| CPKIFCertIDPtr | GetCertID () const |
| void | SetCertID (CPKIFCertIDPtr &ci) |
| CPKIFOCSPCertStatusPtr | GetCertStatus () const |
| void | SetCertStatus (CPKIFOCSPCertStatusPtr &cs) |
| CPKIFTimePtr | GetThisUpdate () const |
| void | SetThisUpdate (CPKIFTimePtr &str) |
| CPKIFTimePtr | GetNextUpdate () const |
| void | SetNextUpdate (CPKIFTimePtr &str) |
| void | GetExtensionByOID (const CPKIFOID &oid, CPKIFX509ExtensionPtr &ref) |
| void | GetEncodedExtensions (CPKIFBufferPtr &buf) |
| bool | AreThereAnyUnprocessedCriticalExtensions (std::vector< CPKIFX509ExtensionPtr > &processedExts) |
Constructor & Destructor Documentation
| CPKIFSingleResponse::CPKIFSingleResponse | ( | void | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 69 of file SingleResponse.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
| CPKIFSingleResponse::CPKIFSingleResponse | ( | const CPKIFBufferPtr & | singleResponse | ) |
Interface: External
This function is used to create and initialize CPKIFSingleResponse objects. It is used internally by PKIF when parsing OCSP objects. It is not used by applications.
- Returns:
- None
- Parameters:
-
singleResponse [in] Reference to a buffer containing SingleResponse
Definition at line 84 of file SingleResponse.cpp.
References CACASNWRAPPER_CREATE, CPKIFTime, LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
| CPKIFSingleResponse::~CPKIFSingleResponse | ( | void | ) | [virtual] |
Interface: External
This function destroys CPKIFSingleResponse objects.
- Returns:
- None
Definition at line 142 of file SingleResponse.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
Member Function Documentation
| CPKIFCertIDPtr CPKIFSingleResponse::GetCertID | ( | ) | const |
Interface: External
This function is used to get the CertID associated with a SingleResponse object.
- Returns:
- The GetCertID function returns a smart pointer to a CPKIFCertID object, if present, and NULL otherwise.
Definition at line 213 of file SingleResponse.cpp.
| void CPKIFSingleResponse::SetCertID | ( | CPKIFCertIDPtr & | ci | ) |
Interface: External
This function is used to set the CertID associated with a SingleResponse object.
- Returns:
- None
- Parameters:
-
ci [in] Reference to a smart pointer to a CPKIFCertID object
Definition at line 224 of file SingleResponse.cpp.
| CPKIFOCSPCertStatusPtr CPKIFSingleResponse::GetCertStatus | ( | ) | const |
Interface: External
This function is used to get the CertStatus associated with a SingleResponse object.
- Returns:
- The GetCertStatus function returns a smart pointer to a CPKIFOCSPCertStatus object, if present, and NULL otherwise.
Definition at line 239 of file SingleResponse.cpp.
| void CPKIFSingleResponse::SetCertStatus | ( | CPKIFOCSPCertStatusPtr & | cs | ) |
Interface: External
This function is used to set the CertStatus associated with a SingleResponse object.
- Returns:
- None
- Parameters:
-
cs [in] Reference to a smart pointer to a CPKIFOCSPCertStatus object
Definition at line 250 of file SingleResponse.cpp.
| CPKIFTimePtr CPKIFSingleResponse::GetThisUpdate | ( | ) | const |
Interface: External
This function is used to get the thisUpdate time associated with a SingleResponse object
- Returns:
- The GetThisUpdate function returns a smart pointer to a CPKIFTime object, if present, and NULL otherwise
Definition at line 265 of file SingleResponse.cpp.
| void CPKIFSingleResponse::SetThisUpdate | ( | CPKIFTimePtr & | str | ) |
Interface: External
This function is used to set the thisUpdate time associated with a SingleResponse object
- Returns:
- None
- Parameters:
-
str [in] Reference to a smart pointer to a CPKIFTime object containing the time for the thisUpdate field
Definition at line 276 of file SingleResponse.cpp.
| CPKIFTimePtr CPKIFSingleResponse::GetNextUpdate | ( | ) | const |
Interface: External
This function is used to get the nextUpdate time associated with a SingleResponse object.
- Returns:
- The GetNextUpdate function returns a smart pointer to a CPKIFTime object, if present, and NULL otherwise.
Definition at line 291 of file SingleResponse.cpp.
| void CPKIFSingleResponse::SetNextUpdate | ( | CPKIFTimePtr & | str | ) |
Interface: External
This function is used to set the nextUpdate time associated with a SingleResponse object.
- Returns:
- None
- Parameters:
-
str [in] Reference to a smart pointer to a CPKIFTime object containing the time for the nextUpdate field
Definition at line 302 of file SingleResponse.cpp.
| void CPKIFSingleResponse::GetExtensionByOID | ( | const CPKIFOID & | oid, | |
| CPKIFX509ExtensionPtr & | ref | |||
| ) | [virtual] |
Interface: External
This function is used to retrieve an extension from singleresponse 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 352 of file SingleResponse.cpp.
| void CPKIFSingleResponse::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 316 of file SingleResponse.cpp.
References CACASNWRAPPER_CREATE, and data.
| bool CPKIFSingleResponse::AreThereAnyUnprocessedCriticalExtensions | ( | std::vector< CPKIFX509ExtensionPtr > & | processedExts | ) |
Interface: External
This function determines if a SingleResponse object holds any unprocessed critical extensions
- Returns:
- Returns true if there are any critical extensions present in the SingleResponse 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 183 of file SingleResponse.cpp.
References LOG_STRING_DEBUG, ExtensionsMatch::SetRHS(), and TOOLKIT_OCSP_ASN.
The documentation for this class was generated from the following files:
