CPKIFCertificateNodeEntry Class Reference
#include <PKIFCertificateNodeEntry.h>
Detailed Description
Definition at line 52 of file PKIFCertificateNodeEntry.h.
Public Member Functions | |
| CPKIFCertificateNodeEntry (void) | |
| CPKIFCertificateNodeEntry (CPKIFCertificatePtr &cert) | |
| virtual | ~CPKIFCertificateNodeEntry (void) |
| CPKIFCertificatePtr | GetCert () const |
| void | SetCert (const CPKIFCertificatePtr &cert) |
| void | SetIgnore () |
| void | ClearIgnore () |
| bool | GetIgnore () const |
| void | SetNameIgnore () |
| void | ClearNameIgnore () |
| bool | GetHardIgnore () const |
| void | ClearProcessedExtensions () |
| void | MarkExtensionAsProcessed (CPKIFX509ExtensionPtr &ref) |
| bool | AreThereAnyUnprocessedCriticalExtensions () |
| void | SetStatus (CPKIFCertStatusPtr &status) |
| void | GetStatus (CPKIFCertStatusPtr &status) const |
| CPKIFCertStatusPtr | GetStatus () const |
| bool | GetProcessedSuccessfully () const |
| void | ClearScore () |
| void | AddToScore (int add) |
| int | GetScore () const |
| PKIInfoSource | GetSource () const |
| void | SetSource (PKIInfoSource source) |
| bool | operator== (const CPKIFCertificateNodeEntry &rhs) const |
Constructor & Destructor Documentation
| CPKIFCertificateNodeEntry::CPKIFCertificateNodeEntry | ( | void | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 294 of file CACCertificateNodeEntry.cpp.
References PKIFENUMS::LOCAL, LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
| CPKIFCertificateNodeEntry::CPKIFCertificateNodeEntry | ( | CPKIFCertificatePtr & | cert | ) |
Interface: External
This is a convenience function that creates an instance and invokes SetCert to prepare the instance with a certificate.
- Returns:
- None
- Parameters:
-
cert [in] Reference to a smart pointer to a CPKIFCertificate object containing the certificate to associate with status information
Definition at line 313 of file CACCertificateNodeEntry.cpp.
References PKIFENUMS::LOCAL, LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
| CPKIFCertificateNodeEntry::~CPKIFCertificateNodeEntry | ( | void | ) | [virtual] |
Interface: External
This function destroys a CPKIFCertificateNodeEntry object.
- Returns:
- None
Definition at line 334 of file CACCertificateNodeEntry.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Member Function Documentation
| CPKIFCertificatePtr CPKIFCertificateNodeEntry::GetCert | ( | ) | const |
Interface: External
This function is used to retrieve the certificate contained by a CPKIFCertificateNodeEntry object.
- Returns:
- A smart pointer to CPKIFCertificate object that contains the certificate
Definition at line 34 of file CACCertificateNodeEntry.cpp.
Referenced by operator==(), and PrintCertInfo().
| void CPKIFCertificateNodeEntry::SetCert | ( | const CPKIFCertificatePtr & | cert | ) |
Interface: External
This function is used to set the certificate contained by a CPKIFCertificateNodeEntry object.
- Returns:
- None
- Parameters:
-
cert [in] Reference to a smart pointer to a CPKIFCertificate object
Definition at line 45 of file CACCertificateNodeEntry.cpp.
References PAS_AVAILABLE, and IPKIFPkiArtifact::SetState().
| void CPKIFCertificateNodeEntry::SetIgnore | ( | ) |
Interface: External
These functions are used internally by CPKIFPathBuilder2 and are not used by applications. These functions are used to get and set the Ignore property. The Ignore property is a boolean value that indicates the associated certificate should be tempoarily ignored within the context of a particular path building operation.
- Returns:
- None
Definition at line 62 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::ClearIgnore | ( | ) |
Interface: External
This function is used internally by CPKIFPathBuilder2. It is not used by applications.
- Returns:
- None
Definition at line 73 of file CACCertificateNodeEntry.cpp.
| bool CPKIFCertificateNodeEntry::GetIgnore | ( | ) | const |
Interface: External
These functions are used internally by CPKIFPathBuilder2 and are not used by applications. These functions are used to get and set the Ignore property. The Ignore property is a boolean value that indicates the associated certificate should be tempoarily ignored within the context of a particular path building operation.
- Returns:
- The ignore property
Definition at line 86 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::SetNameIgnore | ( | ) |
Interface: External
This function is used to set the NameIgnore property
- Returns:
- None
Definition at line 97 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::ClearNameIgnore | ( | ) |
Interface: External
This function is used to get the NameIgnore property
- Returns:
- NameIgnore property
Definition at line 108 of file CACCertificateNodeEntry.cpp.
| bool CPKIFCertificateNodeEntry::GetHardIgnore | ( | ) | const |
Interface: External
This function is used internally by CPKIFPathBuilder2 and are not used by applications. This function is used to get HardIgnore property. The HardIgnore property is a boolean value that indicates the associated certificate should be ignored within the context of a particular path building operation. For example, if a collection of certificates for a given subject may include certificates issued by different issuers. When building through a particular issuer, some certificates can be ignored.
- Returns:
- None
Definition at line 123 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::ClearProcessedExtensions | ( | ) |
Interface: External
This function resets the state for all extensions to unprocessed.
- Returns:
- None
Definition at line 134 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::MarkExtensionAsProcessed | ( | CPKIFX509ExtensionPtr & | ref | ) |
Interface: External
This function is used to indicate that a specific certificate extension has been processed by path validation logic. Typically, this function is invoked by the CPKIFBasicChecks class upon invocation by a CPKIFPathValidate2 instance. Applications may invoke this function when extending the validation logic, i.e. functors implemented by an application and added as an additional certificate check should mark any handled extensions as processed by invoking this function.
- Returns:
- None
- Parameters:
-
ref [in] Reference to a smart pointer to a CPKIFX509Extension object containing an extension that has been processed
Definition at line 149 of file CACCertificateNodeEntry.cpp.
| bool CPKIFCertificateNodeEntry::AreThereAnyUnprocessedCriticalExtensions | ( | ) |
Interface: External
This function returns true if the associated certificate contains extensions that have not yet been marked as processed via a call to MarkExtensionAsProcessed and false if all critical extensions have been processed.
- Returns:
- True if the associated certificate contains extensions that have not yet been marked as processed, false otherwise
Definition at line 164 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::SetStatus | ( | CPKIFCertStatusPtr & | status | ) |
Interface: External
This function is used to set the CPKIFCertStatus object associated with a certificate by a CPKIFCertificateNodeEntry object.
- Returns:
- None
- Parameters:
-
status [in] Reference to a smart pointer to a CPKIFCertStatus object containing status information for the associated certificate
Definition at line 175 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::GetStatus | ( | CPKIFCertStatusPtr & | status | ) | const |
Interface: External
This function is used to retrieve the CPKIFCertStatus object associated with a certificate by a CPKIFCertificateNodeEntry object.
- Returns:
- None
- Parameters:
-
status [out] Reference to a smart pointer to a CPKIFCertStatus object to receive status information
Definition at line 188 of file CACCertificateNodeEntry.cpp.
| CPKIFCertStatusPtr CPKIFCertificateNodeEntry::GetStatus | ( | ) | const |
Interface: External
This function is used to retrieve the CPKIFCertStatus object associated with a certificate by a CPKIFCertificateNodeEntry object.
- Returns:
- A smart pointer to a CPKIFCertStatus object containing status information for the associated certificate.
Definition at line 202 of file CACCertificateNodeEntry.cpp.
| bool CPKIFCertificateNodeEntry::GetProcessedSuccessfully | ( | ) | const |
Interface: External
GetProcessedSuccessfully is a convenience function that returns a Boolean indicating if the diagnostic code held by the associated CPKIFCertStatus object is zero.
- Returns:
- A Boolean indicating if the diagnostic code held by the associated CPKIFCertStatus object is zero.
Definition at line 214 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::ClearScore | ( | ) |
Interface: External
This function is used to reset the path building score calculated for the associated certificate to zero.
- Returns:
- None
Definition at line 228 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::AddToScore | ( | int | add | ) |
Interface: External
This function is used in the calculation of a path building score for the associated certificate. This score is used to sort a list of certificates that have been issued to a single entity. For example, when a CA has been issued multiple cross-certificates a set of scoring criteria is applied to each certificate issued to the CA and the set of certificates is sorted based on the calculated scores. This function is used to accumulate the score for a single certificate.
- Returns:
- None
- Parameters:
-
add [in] Integer to add to the path building score calculated for the associated certificate
Definition at line 243 of file CACCertificateNodeEntry.cpp.
| int CPKIFCertificateNodeEntry::GetScore | ( | ) | const |
Interface: External
This function returns the path building score calculated for the associated certificate.
- Returns:
- The path building score calculated for the associated certificate.
Definition at line 256 of file CACCertificateNodeEntry.cpp.
| PKIInfoSource CPKIFCertificateNodeEntry::GetSource | ( | ) | const |
Interface: External
This function is used to retrieve the source information indicating the type of location from which the associated certificate was retrieved.
- Returns:
- The GetSource function returns a PKIInfoSource value indicating the type of location from which the associated certificate was retrieved.
Definition at line 269 of file CACCertificateNodeEntry.cpp.
| void CPKIFCertificateNodeEntry::SetSource | ( | PKIInfoSource | source | ) |
Interface: External
This function is used to set the source information indicating the type of location from which the associated certificate was retrieved.
- Returns:
- None
- Parameters:
-
source [in] PKIInfoSource value indicating the type of location from which the associated certificate object was retrieved
Definition at line 281 of file CACCertificateNodeEntry.cpp.
| bool CPKIFCertificateNodeEntry::operator== | ( | const CPKIFCertificateNodeEntry & | rhs | ) | const |
Interface: External
This function compares two CPKIFCertificateNodeEntry objects for equality, i.e. it returns true if the two objects contain the same certificate and false otherwise.
- Returns:
- True if the two objects contain the same certificate and false otherwise.
- Parameters:
-
rhs [in] Const reference to a CPKIFCertificateNodeEntry object to compare
Definition at line 349 of file CACCertificateNodeEntry.cpp.
References GetCert().
The documentation for this class was generated from the following files:
