CPKIFSynonymousSourceStore Class Reference

#include <PKIFSynonymousSourceStore.h>

Inheritance diagram for CPKIFSynonymousSourceStore:

[legend]

Collaboration diagram for CPKIFSynonymousSourceStore:

[legend]

List of all members.

Detailed Description

The CPKIFSynonymousSourceStore class provides a colleague that implements the IPKIFSynonymousSourceStore interface. This interface is used internally by the CPKIFCacheMediator2 class to improve performance of certificate and CRL storage and retrieval operations. Essentially, the mediator polls all associated colleagues that implement either the IPKIFSupportsSynonymousCRLSources or IPKIFSupportsSynonymousCertSources interfaces, depending on the object being retrieved. These objects produce a node object that contain, at a minimum, a URI and a state indication. Depending on the state, the nodes may also include the target object. This list of nodes is then passed to an instance of this class, which will try to fulfill requests from a local cache. If the item is found in the cache, the node is updated and the caller can avoid remotely accessing the object.

TSP-enforcing: No

Definition at line 33 of file PKIFSynonymousSourceStore.h.


Public Member Functions
	CPKIFSynonymousSourceStore (void)
virtual	~CPKIFSynonymousSourceStore (void)
void	Initialize ()
void	GetCRLs (const CPKIFCertificatePtr &cert, CPKIFCrlSourceList &crlSourceList, CPKIFCRLNodeList &crlNodeList)
void	GetCerts (CPKIFCertificateSourceList &certSources, CPKIFCertificateNodeList &certList, PathBuildingDirection pbd=PBD_FORWARD)
void	AddCRL (CPKIFCRLNodeEntryPtr &crl)
void	AddCert (CPKIFCertificateNodeEntryPtr &cert)
void	WriteCacheContentsToConsole (std::ostream &out)

Constructor & Destructor Documentation

CPKIFSynonymousSourceStore::CPKIFSynonymousSourceStore ( void )

Interface: External

Default constructor for the CPKIFSynonymousSourceStore class.

Returns:: None

Definition at line 919 of file PKIFSynonymousSourceStore.cpp.

CPKIFSynonymousSourceStore::~CPKIFSynonymousSourceStore ( void ) [virtual]

Interface: External

Default destructor for the CPKIFSynonymousSourceStore class.

Returns:: None

Definition at line 930 of file PKIFSynonymousSourceStore.cpp.

Member Function Documentation

void CPKIFSynonymousSourceStore::Initialize ( void ) [virtual]

Interface: External

This function provides an implementation of the IPKIFColleague::Intialize function.

Returns:: None

Reimplemented from IPKIFColleague.

Definition at line 942 of file PKIFSynonymousSourceStore.cpp.

void CPKIFSynonymousSourceStore::GetCRLs	(	const CPKIFCertificatePtr &	cert,
		CPKIFCrlSourceList &	crlSourceList,
		CPKIFCRLNodeList &	crlNodeList
	)			`[virtual]`

Interface: External

This function takes a certificate and a list of CRL nodes and returns CRLs that MAY be useful in determining the revocation status of the certificate. Each node in the node list is inspected. If an inbound node is in a PAS_PENDING state and an entry for that node is already in the cache, then the node is updated to include the state and, optionally, CRL from the store. If the node is not in a PAS_PENDING state and is not in the store, then it is added to the store. In addition to attempting to fulfill nodes included in the node list, this function searches the store for CRLs issued by the issuer of the certificate or that have a distribution point in common with the certificate. Nodes corresponding to CRLs that match the certificate-based criteria are added to the node list.

Returns:: None

Implements IPKIFSynonymousSourceStore.

Definition at line 961 of file PKIFSynonymousSourceStore.cpp.

References GottaMatch< T >::SetRHS().

void CPKIFSynonymousSourceStore::GetCerts	(	CPKIFCertificateSourceList &	certSources,
		CPKIFCertificateNodeList &	certNodeList,
		PathBuildingDirection	pbd = `PBD_FORWARD`
	)			`[virtual]`

Interface: External

This function retrives certificates from Synonymous Source Store. Items that are passed in that are in available state and are not in the store are added to the store.

Returns:: None

Parameters:

certSources	[in] List of sources that have been collected
certNodeList	[out] A reference to CPKIFCertificateNodeList object

Implements IPKIFSynonymousSourceStore.

Definition at line 1038 of file PKIFSynonymousSourceStore.cpp.

References COMMON_INVALID_INPUT, PAS_AVAILABLE, PAS_PENDING, PAS_UNAVAILABLE, GottaMatch< T >::SetRHS(), and TOOLKIT_SR_MISC.

void CPKIFSynonymousSourceStore::AddCRL ( CPKIFCRLNodeEntryPtr & crl ) [virtual]

Interface: External

This function adds a CRL node to the cache. After this call, each source URI returned by the call to crl->GetSources can be used to retrieve the CRL from the store.

CRL nodes that are in PAS_PENDING state when passed to this function are stored separately and periodically checked for state changes before being added to the store. Only nodes in PAS_AVAILABLE or PAS_UNAVAILABLE can be retrieved from the store.