CPKIFNameBasedSearch Class Reference
#include <NameBasedSearch.h>
Detailed Description
The CPKIFNameBasedSearch class is used to request a list of all certificates that match the specified subject name from objects implementing the IPKIFCertSearch interface. CPKIFNameBasedSearch implements the IPKIFSearchCriteria interface and returns SUBJECTNAME from the GetSearchType function.TSP-enforcing: No
Definition at line 25 of file NameBasedSearch.h.
Public Member Functions | |
| CPKIFNameBasedSearch () | |
| ~CPKIFNameBasedSearch () | |
| SearchType | GetSearchType () const |
| void | SetSearchType (SearchType st) |
| CPKIFNamePtr | GetName () const |
| void | SetName (CPKIFNamePtr &name) |
| void | SetStringName (char *s) |
| const char * | GetStringName () const |
Constructor & Destructor Documentation
| CPKIFNameBasedSearch::CPKIFNameBasedSearch | ( | ) |
Interface: External
This function creates and initializes CPKIFNameBasedSearch objects
- Returns:
- None
Definition at line 32 of file NameBasedSearch.cpp.
References LOG_STRING_DEBUG, SUBJECTNAME, and TOOLKIT_SR_MISC.
| CPKIFNameBasedSearch::~CPKIFNameBasedSearch | ( | ) |
Interface: External
This function destroys CPKIFNameBasedSearch objects
- Returns:
- None
Definition at line 47 of file NameBasedSearch.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.
Member Function Documentation
| SearchType CPKIFNameBasedSearch::GetSearchType | ( | ) | const [virtual] |
Interface: External
This functions are used to get search type for CPKIFNameBasedSearch object
- Returns:
- This function returns SUBJECTNAME
Implements IPKIFSearchCriteria.
Definition at line 61 of file NameBasedSearch.cpp.
| void CPKIFNameBasedSearch::SetSearchType | ( | SearchType | st | ) |
Interface: External
This functions are used to set search type for CPKIFNameBasedSearch object
- Returns:
- None
- Parameters:
-
st [in] SearchType parameter
Definition at line 72 of file NameBasedSearch.cpp.
| CPKIFNamePtr CPKIFNameBasedSearch::GetName | ( | ) | const |
Interface: External
This function is used to get the name used to perform a subject name-based search.
- Returns:
- The GetName function returns a pointer to a CPKIFName object containing a subject name value or NULL, if no subject name value has been specified.
Definition at line 85 of file NameBasedSearch.cpp.
Referenced by CPKIFNSSRepository::FindCertificates(), SimpleRootStore::FindKeys(), and SimpleCertCache::FindKeys().
| void CPKIFNameBasedSearch::SetName | ( | CPKIFNamePtr & | name | ) |
Interface: External
This function is used to set the name used to perform a subject name-based search.
- Returns:
- None
- Parameters:
-
name [in] Pointer to a CPKIFName object containing the subject name value to use as search criteria
Definition at line 96 of file NameBasedSearch.cpp.
| void CPKIFNameBasedSearch::SetStringName | ( | char * | s | ) |
Interface: External
This function sets teh distinguished name to use as search criteria
- Returns:
- None
- Parameters:
-
s [in] Pointer to a buffer containing a NULL-terminated string representation of the distinguished name to use as search criteria
Definition at line 109 of file NameBasedSearch.cpp.
References GetPKIFNameFromStr().
| const char * CPKIFNameBasedSearch::GetStringName | ( | ) | const |
Interface: External
The GetStringName function returns a pointer to a buffer containing a NULL-terminated string representation of a distinguished name if a name has been specified and NULL otherwise. If a pointer is returned, it is valid only for the life to the associated CPKIFNameBasedSearch object or until either SetName or SetNameString is invoked on the same CPKIFNamedBasedSearch object.
- Returns:
- Buffer containing a NULL-terminated string representation of a distinguished name.
Definition at line 127 of file NameBasedSearch.cpp.
Referenced by CPKIFCAPIUserRepository2::FindCertificates(), CPKIFCAPITrustStore2::FindCertificates(), and CPKIFCAPIRepository2::FindCertificates().
The documentation for this class was generated from the following files:
