OpenAB_Sync::Parameters Class Reference

Generic storage for Sync plugin parameters. Allows to store map of parameters with different types (OpenAB::Variant) and parameters specific to OpenAB_Source::Source and OpenAB_Storage::Storage plugins. Additionally allow for serialization and deserialization to/from JSON format. More...

#include <Sync.hpp>

Inheritance diagram for OpenAB_Sync::Parameters:

Collaboration diagram for OpenAB_Sync::Parameters:

Public Member Functions
	Parameters ()
	Default constructor. More...
	Parameters (const std::string &json)
	Deserializes parameters from JSON sting. More...
	~Parameters ()
	Destructor, virtual by default. More...
Public Member Functions inherited from OpenAB_Plugin::GenericParameters
	GenericParameters ()
	Default constructor. More...
	GenericParameters (const std::string &json)
	Deserializes parameters from JSON sting. More...
virtual	~GenericParameters ()
	Destructor, virtual by default. More...
std::string	toJSON () const
	Serializes parameters to JSON string. More...
bool	fromJSON (const std::string &json)
	Deserializes parameters from JSON string. More...
OpenAB::Variant	getValue (const std::string &key) const
	Returns value assigned to given key. More...
void	setValue (const std::string &key, const OpenAB::Variant &value)
	Assigns or updates value to/of given key. More...
void	removeKey (const std::string &key)
	Removes key and its assigned value. More...
std::vector< std::string >	getAllKeys () const
	Returns list of all keys. list of all keys. More...
Public Member Functions inherited from OpenAB_Plugin::Parameters
	Parameters ()

Public Attributes
OpenAB_Source::Parameters	localSourcePluginParams
	Parameters to be used by local OpenAB_Source::Source plugin. More...
OpenAB_Source::Parameters	remoteSourcePluginParams
	Parameters to be used by remote OpenAB_Source::Source plugin. More...
OpenAB_Storage::Parameters	localStoragePluginParams
	parameters to be used by local OpenAB_Storage::Storage plugin More...
OpenAB_Storage::Parameters	remoteStoragePluginParams
	Parameters to be used by remote OpenAB_Storage::Storage plugin. More...

Detailed Description

Generic storage for Sync plugin parameters. Allows to store map of parameters with different types (OpenAB::Variant) and parameters specific to OpenAB_Source::Source and OpenAB_Storage::Storage plugins. Additionally allow for serialization and deserialization to/from JSON format.

Constructor & Destructor Documentation

OpenAB_Sync::Parameters::Parameters

(

)

Default constructor.

OpenAB_Sync::Parameters::Parameters

(

const std::string &

json

)

Deserializes parameters from JSON sting.

Parameters

[in]

json

JSON string to deserialize from.

OpenAB_Sync::Parameters::~Parameters ( )

virtual

Destructor, virtual by default.

Reimplemented from OpenAB_Plugin::Parameters.

Member Data Documentation

OpenAB_Source::Parameters OpenAB_Sync::Parameters::localSourcePluginParams

Parameters to be used by local OpenAB_Source::Source plugin.

OpenAB_Storage::Parameters OpenAB_Sync::Parameters::localStoragePluginParams

parameters to be used by local OpenAB_Storage::Storage plugin

Todo:

make this field private, add getter and setter for this field

OpenAB_Source::Parameters OpenAB_Sync::Parameters::remoteSourcePluginParams

Parameters to be used by remote OpenAB_Source::Source plugin.

OpenAB_Storage::Parameters OpenAB_Sync::Parameters::remoteStoragePluginParams

Parameters to be used by remote OpenAB_Storage::Storage plugin.

---

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

• /home/one/open-address-book/src/plugin/sync/Sync.hpp
• /home/one/open-address-book/src/plugin/sync/Sync.cpp