CPKIFKeyIDBasedSearch Class Reference

#include <KeyIDBasedSearch.h>

Inheritance diagram for CPKIFKeyIDBasedSearch:

Inheritance graph
[legend]
Collaboration diagram for CPKIFKeyIDBasedSearch:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFKeyIDBasedSearch class is used to request a list of all certificates that match the specified issuer name and serial number from objects implementing the IPKIFCertSearch interface. CPKIFKeyIDBasedSearch implements the IPKIFSearchCriteria interface and returns KEYID from the GetSearchType function.

TSP-enforcing: No

Definition at line 25 of file KeyIDBasedSearch.h.


Public Member Functions

 CPKIFKeyIDBasedSearch ()
 ~CPKIFKeyIDBasedSearch ()
SearchType GetSearchType () const
CPKIFBufferPtr GetKeyID () const
void SetKeyID (CPKIFBufferPtr &keyID)

Constructor & Destructor Documentation

CPKIFKeyIDBasedSearch::CPKIFKeyIDBasedSearch (  ) 

Interface: External

This function creates and initializes CPKIFKeyIDBasedSearch objects

Returns:
None

Definition at line 27 of file KeyIDBasedSearch.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.

CPKIFKeyIDBasedSearch::~CPKIFKeyIDBasedSearch (  ) 

Interface: External

This function destroys CPKIFKeyIDBasedSearch objects

Returns:
None

Definition at line 39 of file KeyIDBasedSearch.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.


Member Function Documentation

SearchType CPKIFKeyIDBasedSearch::GetSearchType (  )  const [virtual]

Interface: External

This function returns KEYID

Returns:
KEYID

Implements IPKIFSearchCriteria.

Definition at line 55 of file KeyIDBasedSearch.cpp.

References KEYID.

CPKIFBufferPtr CPKIFKeyIDBasedSearch::GetKeyID (  )  const

Interface: External

This function is used to get the key identifier used to perform a key identifier-based search

Returns:
The GetKeyID function returns a pointer to a buffer containing a binary key identifier value or NULL, if no key identifier value has been set

Definition at line 68 of file KeyIDBasedSearch.cpp.

Referenced by CPKIFNSSRepository::FindCertificates(), CPKIFCAPIUserRepository2::FindCertificates(), CPKIFCAPITrustStore2::FindCertificates(), CPKIFCAPIRepository2::FindCertificates(), SimpleRootStore::FindKeys(), and SimpleCertCache::FindKeys().

void CPKIFKeyIDBasedSearch::SetKeyID ( CPKIFBufferPtr &  keyID  ) 

Interface: External

This function is used to set the key identifier used to perform a key identifier-based search

Returns:
Parameters:
keyID  [in] Pointer to a buffer containing a binary key identifier value

Definition at line 80 of file KeyIDBasedSearch.cpp.


The documentation for this class was generated from the following files:

Generated on Mon Nov 15 11:20:22 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6