CPKIFPKIStatusInfo Class Reference
#include <PKIStatusInfo.h>
Detailed Description
The CPKIFPKIStatusInfo class provides an interface to RFC 3161 PKIStatusInfo objects, including an optional capability of generating digest values.TSP-enforcing: No
Definition at line 30 of file PKIStatusInfo.h.
Public Member Functions | |
| CPKIFPKIStatusInfo () | |
| CPKIFPKIStatusInfo (const CPKIFBufferPtr &psiBuf) | |
| ~CPKIFPKIStatusInfo () | |
| void | SetStatus (PKIStatus status) |
| PKIStatus | GetStatus () const |
| void | SetFailInfo (std::bitset< 8 > &failInfo) |
| void | GetFailInfo (std::bitset< 8 > &failInfo) const |
| void | AddStatusString (CPKIFStringPtr &statusString) |
| void | GetStatusStrings (CPKIFStringArray &strings) const |
Constructor & Destructor Documentation
| CPKIFPKIStatusInfo::CPKIFPKIStatusInfo | ( | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 34 of file PKIStatusInfo.cpp.
References LOG_STRING_DEBUG, REJECTION, and TOOLKIT_TSP_ASN.
| CPKIFPKIStatusInfo::CPKIFPKIStatusInfo | ( | const CPKIFBufferPtr & | psiBuf | ) |
Interface: External
This constructor is internally invoked; this version 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:
-
psiBuf [in] Reference to a PKIFTSPPKIStatusInfo structure containing information used to populate a new instance of CPKIFPKIStatusInfo
Definition at line 51 of file PKIStatusInfo.cpp.
References ADDINFONOTAVAILABLE, BADALG, BADDATAFORMAT, BADREQUEST, CACASNWRAPPER_CREATE, LOG_STRING_DEBUG, SYSTEMFAILURE, TIMENOTAVAILABLE, TOOLKIT_TSP_ASN, UNACCEPTEDEXTENSION, and UNACCEPTEDPOLICY.
| CPKIFPKIStatusInfo::~CPKIFPKIStatusInfo | ( | ) |
Interface: External
This function destroys an instance of CPKIFPKIStatusInfo.
- Returns:
- None
Definition at line 120 of file PKIStatusInfo.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_TSP_ASN.
Member Function Documentation
| void CPKIFPKIStatusInfo::SetStatus | ( | PKIStatus | status | ) |
Interface: External
This function is used to set the PKIStatus value contained in a PKIStatusInfo object.
- Returns:
- None
- Parameters:
-
status [in] PKIStatus containing the value to set
Definition at line 135 of file PKIStatusInfo.cpp.
| PKIStatus CPKIFPKIStatusInfo::GetStatus | ( | ) | const |
Interface: External
This function is used to get the PKIStatus value contained in a PKIStatusInfo object.
- Returns:
- The PKIStatus value contained in a PKIStatusInfo object.
Definition at line 148 of file PKIStatusInfo.cpp.
| void CPKIFPKIStatusInfo::SetFailInfo | ( | std::bitset< 8 > & | failInfo | ) |
Interface: External
This function is used to set the failure info value associated with a CPKIFPKIStatusInfo instance.
- Returns:
- None
- Parameters:
-
failInfo [in] Reference to a std::bitset object that is used to pass failure info to SetFailInfo
Definition at line 159 of file PKIStatusInfo.cpp.
References ADDINFONOTAVAILABLE, BADALG, BADDATAFORMAT, BADREQUEST, SYSTEMFAILURE, TIMENOTAVAILABLE, UNACCEPTEDEXTENSION, and UNACCEPTEDPOLICY.
| void CPKIFPKIStatusInfo::GetFailInfo | ( | std::bitset< 8 > & | failInfo | ) | const |
Interface: External
This function is used to get the failure info value associated with a CPKIFPKIStatusInfo instance.
- Returns:
- None
- Parameters:
-
failInfo [out] Reference to a std::bitset object that is used to receive failure info from GetFailInfo
Definition at line 188 of file PKIStatusInfo.cpp.
References ADDINFONOTAVAILABLE, BADALG, BADDATAFORMAT, BADREQUEST, SYSTEMFAILURE, TIMENOTAVAILABLE, UNACCEPTEDEXTENSION, and UNACCEPTEDPOLICY.
| void CPKIFPKIStatusInfo::AddStatusString | ( | CPKIFStringPtr & | statusString | ) |
Interface: External
This function is used to add a status string to the collection of status strings held by a CPKIFPKIStatusInfo instance.
- Returns:
- None
- Parameters:
-
statusString [in] Reference to a CPKIFStringPtr object containing the status string to add
Definition at line 217 of file PKIStatusInfo.cpp.
| void CPKIFPKIStatusInfo::GetStatusStrings | ( | CPKIFStringArray & | strings | ) | const |
Interface: External
This function is used to get the collection of status strings associated with a CPKIFPKIStatusInfo instance.
- Returns:
- None
- Parameters:
-
strings [out] Reference to a CPKIFStringArray object to receive the status strings
Definition at line 230 of file PKIStatusInfo.cpp.
The documentation for this class was generated from the following files:
