CPKIFMediatorSerializer Class Reference

#include <PKIFMediatorSerializer.h>

List of all members.

---

Detailed Description

The CPKIFMediatorSerializer class can be used to serialize/deserialize the structure of mediator/colleague sets.

TSP-enforcing: No

Definition at line 32 of file PKIFMediatorSerializer.h.

Public Member Functions
	CPKIFMediatorSerializer (void)
	~CPKIFMediatorSerializer (void)
IPKIFMediatorPtr	LoadSettings (const char *application, const char *company, const char *localFile=NULL, bool useFile=false, bool bAllUsers=false, const char *pathRelToCompanyApp=NULL)
void	SaveSettings (IPKIFMediatorPtr &settingsToSave, const char *application, const char *company, const char *localFile=NULL, bool useFile=false, bool bAllUsers=false, const char *pathRelToCompanyApp=NULL)

---

Constructor & Destructor Documentation

CPKIFMediatorSerializer::CPKIFMediatorSerializer

(

void

)

Interface: External

Default constructor.

Returns:

None

Definition at line 110 of file PKIFMediatorSerializer.cpp.

CPKIFMediatorSerializer::~CPKIFMediatorSerializer

(

void

)

Interface: External

Default destructor.

Returns:

None

Definition at line 120 of file PKIFMediatorSerializer.cpp.

---

Member Function Documentation

IPKIFMediatorPtr CPKIFMediatorSerializer::LoadSettings	(	const char *	application,
		const char *	company,
		const char *	localFile = NULL,
		bool	useFile = false,
		bool	bAllUsers = false,
		const char *	pathRelToCompanyApp = NULL
	)

Interface: External

This functions loads mediator setttings from registry or file.

Returns:

None

Definition at line 130 of file PKIFMediatorSerializer.cpp.

References LoadCryptoComponents(), LoadPathProcessingComponents(), LoadRevocationStatusComponents(), and LoadStorageAndRetrievalComponents().

Referenced by LoadPathProcessingComponents().

void CPKIFMediatorSerializer::SaveSettings	(	IPKIFMediatorPtr &	m,
		const char *	application,
		const char *	company,
		const char *	localFile = NULL,
		bool	useFile = false,
		bool	bAllUsers = false,
		const char *	pathRelToCompanyApp = NULL
	)

Interface: External

SaveSettings accepts an instance of IPKIFMediator, a company name and an application name. The company name and the application name are used to determine where the settings stored in the IPKIFMediator object are stored. If no company name and no application name are supplied (i.e., the parameters are passed as NULL), then "Orion Security Solutions" is used as the company name and "PKIFv2" is used as the application name.

Prior to writing out new settings, previously existing settings are deleted. If this method does not complete successfully, previously existing settings will not be available and new settings will not be saved. If failure occurs during serialization of a particular value, the value will be indicated in the descriptive text returned via the exception object.

Returns:

None

Parameters:

m	[in]Smart pointer to a IPKIFMediator object containing the settings to serialize
application	[in]Pointer to a NULL terminated string indicating an application name for use in storing the settings (or NULL for default value)
company	[in]Pointer to a NULL terminated string indicating a company name for use in storing the settings (or NULL for default value)
localFile	[in]Pointer to a NULL terminated string indicating a file name for use in storing the settings
useFile	[in] Boolean value indicating if a file should be used to store settings.

Definition at line 2299 of file PKIFMediatorSerializer.cpp.

References SaveSettings_wx().

---

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

• PKIFMediatorSerializer.h
• PKIFMediatorSerializer.cpp