EvolutionSyncConfig Class Reference
[Configuration Handling]

#include <SyncEvolutionConfig.h>

Inheritance diagram for EvolutionSyncConfig:

[legend]

Collaboration diagram for EvolutionSyncConfig:

[legend]

List of all members.

Public Types
typedef list< pair< string, string > >	ServerList
Public Member Functions
	EvolutionSyncConfig (const string &server, boost::shared_ptr< ConfigTree > tree=boost::shared_ptr< ConfigTree >())
	EvolutionSyncConfig ()
string	getRootPath () const
bool	exists () const
void	flush ()
virtual void	setConfigFilter (bool sync, const FilterConfigNode::ConfigFilter &filter)
virtual boost::shared_ptr < FilterConfigNode >	getProperties (bool hidden=false)
virtual boost::shared_ptr < const FilterConfigNode >	getProperties (bool hidden=false) const
virtual boost::shared_ptr < PersistentEvolutionSyncSourceConfig >	getSyncSourceConfig (const string &name)
virtual boost::shared_ptr < const PersistentEvolutionSyncSourceConfig >	getSyncSourceConfig (const string &name) const
virtual list< string >	getSyncSources () const
SyncSourceNodes	getSyncSourceNodes (const string &name, const string &trackName="")
ConstSyncSourceNodes	getSyncSourceNodes (const string &name, const string &trackName="") const
void	setDefaults ()
void	setSourceDefaults (const string &name)
void	copy (const EvolutionSyncConfig &other, const set< string > *sourceFilter)
Settings specific to SyncEvolution
See the property definitions in SyncEvolutionConfig.cpp for the user-visible explanations of these settings.
virtual const char *	getLogDir () const
virtual void	setLogDir (const string &value, bool temporarily=false)
virtual int	getMaxLogDirs () const
virtual void	setMaxLogDirs (int value, bool temporarily=false)
virtual int	getLogLevel () const
virtual void	setLogLevel (int value, bool temporarily=false)
Settings inherited from Funambol
These settings are required by the Funambol C++ client library. Some of them are hard-coded in this class. A derived class could make them configurable again, should that be desired.
virtual AbstractSyncSourceConfig *	getAbstractSyncSourceConfig (const char *name) const
virtual AbstractSyncSourceConfig *	getAbstractSyncSourceConfig (unsigned int i) const
virtual unsigned int	getAbstractSyncSourceConfigsCount () const
virtual const char *	getUsername () const
virtual void	setUsername (const string &value, bool temporarily=false)
virtual const char *	getPassword () const
virtual void	setPassword (const string &value, bool temporarily=false)
virtual void	checkPassword (ConfigUserInterface &ui)
virtual bool	getUseProxy () const
virtual void	setUseProxy (bool value, bool temporarily=false)
virtual const char *	getProxyHost () const
virtual void	setProxyHost (const string &value, bool temporarily=false)
virtual int	getProxyPort () const
virtual const char *	getProxyUsername () const
virtual void	setProxyUsername (const string &value, bool temporarily=false)
virtual const char *	getProxyPassword () const
virtual void	checkProxyPassword (ConfigUserInterface &ui)
virtual void	setProxyPassword (const string &value, bool temporarily=false)
virtual const char *	getSyncURL () const
virtual void	setSyncURL (const string &value, bool temporarily=false)
virtual const char *	getClientAuthType () const
virtual void	setClientAuthType (const string &value, bool temporarily=false)
virtual bool	getLoSupport () const
virtual void	setLoSupport (bool value, bool temporarily=false)
virtual unsigned long	getMaxMsgSize () const
virtual void	setMaxMsgSize (unsigned long value, bool temporarily=false)
virtual unsigned int	getMaxObjSize () const
virtual void	setMaxObjSize (unsigned int value, bool temporarily=false)
virtual unsigned long	getReadBufferSize () const
virtual const char *	getSSLServerCertificates () const
virtual void	setSSLServerCertificates (const string &value, bool temporarily=false)
virtual bool	getSSLVerifyServer () const
virtual void	setSSLVerifyServer (bool value, bool temporarily=false)
virtual bool	getSSLVerifyHost () const
virtual void	setSSLVerifyHost (bool value, bool temporarily=false)
virtual bool	getCompression () const
virtual void	setCompression (bool value, bool temporarily=false)
virtual unsigned int	getResponseTimeout () const
virtual const char *	getDevID () const
virtual void	setDevID (const string &value, bool temporarily=false)
virtual bool	getServerAuthRequired () const
virtual const char *	getServerAuthType () const
virtual const char *	getServerPWD () const
virtual const char *	getServerID () const
virtual const char *	getUserAgent () const
virtual const char *	getVerDTD () const
virtual const char *	getMan () const
virtual const char *	getMod () const
virtual const char *	getOem () const
virtual const char *	getFwv () const
virtual const char *	getHwv () const
virtual const char *	getDsV () const
virtual const char *	getSwv () const
virtual const char *	getDevType () const
virtual bool	getUtc () const
virtual bool	getNocSupport () const
virtual const char *	getServerNonce () const
virtual void	setServerNonce (const char *value)
virtual const char *	getClientNonce () const
virtual void	setClientNonce (const char *value)
virtual const char *	getDevInfHash () const
virtual void	setDevInfHash (const char *value)
Static Public Member Functions
static ServerList	getServers ()
static ServerList	getServerTemplates ()
static boost::shared_ptr < EvolutionSyncConfig >	createServerTemplate (const string &server)
static ConfigPropertyRegistry &	getRegistry ()

---

Detailed Description

This class implements the client library configuration interface by mapping values to properties to entries in a ConfigTree. The mapping is either the traditional one used by SyncEvolution <= 0.7 and client library <= 6.5 or the new layout introduced with SyncEvolution >= 0.8. If for a given server name the old config exists, then it is used. Otherwise the new layout is used.

This class can be instantiated on its own and then provides access to properties actually stored in files. EvolutionSyncClient inherits from this class so that a derived client has the chance to override every single property (although it doesn't have to). Likewise EvolutionSyncSource is derived from EvolutionSyncSourceConfig.

Properties can be set permanently (this changes the underlying ConfigNode) and temporarily (this modifies the FilterConfigNode which wraps the ConfigNode).

The old layout is:

• $HOME/.sync4j/evolution/<server>/spds/syncml/config.txt -- spds/sources/<source>/config.txt --- changes_<changeid>/config.txt

The new layout is:

• ${XDG_CONFIG:-${HOME}/.config}/syncevolution/foo - base directory for server foo -- config.ini - constant per-server settings -- .internal.ini - read/write server properties - hidden from users because of the leading dot -- sources/bar - base directory for source bar --- config.ini - constant per-source settings --- .internal.ini - read/write source properties --- .changes_<changeid>.ini - change tracking node (content under control of sync source)

Because this class needs to handle different file layouts it always uses a FileConfigTree instance. Other implementations would be possible.

Definition at line 464 of file SyncEvolutionConfig.h.

---

Member Typedef Documentation

typedef list< pair<string, string> > EvolutionSyncConfig::ServerList

Definition at line 489 of file SyncEvolutionConfig.h.

---

Constructor & Destructor Documentation

EvolutionSyncConfig::EvolutionSyncConfig	(	const string &	server,
		boost::shared_ptr< ConfigTree >	tree = boost::shared_ptr<ConfigTree>()
	)

Opens the configuration for a specific server, searching for the config files in the usual places. Will succeed even if config does not yet exist: flushing such a config creates it.

Parameters:

tree

if non-NULL, then this is used as configuration tree instead of searching for it; always uses the current layout in that tree

Definition at line 64 of file SyncEvolutionConfig.cpp.

References ConfigTree::hidden, and ConfigTree::visible.

EvolutionSyncConfig::EvolutionSyncConfig

(

)

Creates a temporary configuration. Can be copied around, but not flushed.

Definition at line 56 of file SyncEvolutionConfig.cpp.

Referenced by createServerTemplate().

---

Member Function Documentation

void EvolutionSyncConfig::checkPassword

(

ConfigUserInterface &

ui

)

[virtual]

Look at the password setting and if it requires user interaction, get it from the user. Then store it for later usage in getPassword(). Without this call, getPassword() returns the original, unmodified config string.

Definition at line 399 of file SyncEvolutionConfig.cpp.

References PasswordConfigProperty::checkPassword().

Referenced by EvolutionSyncClient::sync().

void EvolutionSyncConfig::checkProxyPassword

(

ConfigUserInterface &

ui

)

[virtual]

Definition at line 453 of file SyncEvolutionConfig.cpp.

References PasswordConfigProperty::checkPassword().

Referenced by EvolutionSyncClient::sync().

void EvolutionSyncConfig::copy	(	const EvolutionSyncConfig &	other,
		const set< string > *	sourceFilter
	)

Copy all registered properties (hidden and visible) and the tracking node into the current config. This is done by reading all properties from the source config, which implies the unset properties will be set to their default values. The current config is not cleared so additional, unregistered properties (should they exist) will continue to exist unchanged.

The current config still needs to be flushed to make the changes permanent.

Parameters:

sourceFilter

if NULL, then copy all sources; if not NULL, then only copy sources listed here

Definition at line 539 of file SyncEvolutionConfig.cpp.

References getProperties(), EvolutionSyncSourceConfig::getRegistry(), getRegistry(), getSyncSourceNodes(), getSyncSources(), SyncSourceNodes::m_configNode, ConstSyncSourceNodes::m_configNode, SyncSourceNodes::m_hiddenNode, ConstSyncSourceNodes::m_hiddenNode, SyncSourceNodes::m_trackingNode, and ConstSyncSourceNodes::m_trackingNode.

Referenced by EvolutionSyncClient::sync().

boost::shared_ptr< EvolutionSyncConfig > EvolutionSyncConfig::createServerTemplate

(

const string &

server

)

[static]

Creates a new instance of a configuration template. The result can be modified to set filters, but it cannot be flushed.

Returns:

NULL if no such template

Definition at line 127 of file SyncEvolutionConfig.cpp.

References EvolutionSyncConfig().

Referenced by SyncEvolutionCmdline::run().

bool EvolutionSyncConfig::exists

(

)

const

true if the main configuration file already exists

Definition at line 205 of file SyncEvolutionConfig.cpp.

Referenced by EvolutionSyncClient::status(), EvolutionSyncClient::sync(), and TestEvolution::TestEvolution().

void EvolutionSyncConfig::flush

(

)

write changes

Definition at line 210 of file SyncEvolutionConfig.cpp.

Referenced by EvolutionSyncClient::sync(), and TestEvolution::TestEvolution().

virtual AbstractSyncSourceConfig* EvolutionSyncConfig::getAbstractSyncSourceConfig

(

unsigned int

i

)

const [inline, virtual]

Implements AbstractSyncConfig.

Reimplemented in EvolutionSyncClient.

Definition at line 646 of file SyncEvolutionConfig.h.

virtual AbstractSyncSourceConfig* EvolutionSyncConfig::getAbstractSyncSourceConfig

(

const char *

name

)

const [inline, virtual]

Implements AbstractSyncConfig.

Reimplemented in EvolutionSyncClient.

Definition at line 645 of file SyncEvolutionConfig.h.

virtual unsigned int EvolutionSyncConfig::getAbstractSyncSourceConfigsCount

(

)

const [inline, virtual]

Implements AbstractSyncConfig.

Reimplemented in EvolutionSyncClient.

Definition at line 647 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getClientAuthType

(

)

const [virtual]

the type of client authentication used by client:

• syncml:basic-auth
• syncml:md5-auth

Implements AbstractSyncConfig.

Definition at line 459 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

const char * EvolutionSyncConfig::getClientNonce

(

)

const [virtual]

The client nonce value: from server to client

Implements AbstractSyncConfig.

Definition at line 473 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

bool EvolutionSyncConfig::getCompression

(

)

const [virtual]

Implements AbstractSyncConfig.

Definition at line 467 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::getProperty().

const char * EvolutionSyncConfig::getDevID

(

)

const [virtual]

Specifies the identifier of the source synchronization device. The content information MUST specify an identifier which is unique among all devices accessing the same data on a SyncML server.

Implements AbstractSyncConfig.

Definition at line 469 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

Referenced by EvolutionSyncClient::sync().

const char * EvolutionSyncConfig::getDevInfHash

(

)

const [virtual]

This is a hash value generated from all properties that are used for the <DevInf> element, plus the syncURL property. If the hash changes between sync sessions the information has changed and must be resent.

Implements AbstractSyncConfig.

Definition at line 475 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

const char * EvolutionSyncConfig::getDevType

(

)

const [virtual]

Specifies the type of the source synchronization device. Type values for this element type can be e.g. "pager", "handheld", "pda", "phone", "smartphone", "server", "workstation". Other values can also be specified. This property is mandatory.

Implements AbstractSyncConfig.

Definition at line 563 of file SyncEvolutionConfig.cpp.

Referenced by EvolutionSyncClient::sync().

virtual const char* EvolutionSyncConfig::getDsV

(

)

const [inline, virtual]

Specifies the implemented DS version. This property is optional.

Implements AbstractSyncConfig.

Definition at line 707 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getFwv

(

)

const [inline, virtual]

Specifies the firmware version of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 705 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getHwv

(

)

const [inline, virtual]

Specifies the hardware version of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 706 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getLogDir

(

)

const [virtual]

Definition at line 477 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

Referenced by EvolutionSyncClient::status(), and EvolutionSyncClient::sync().

int EvolutionSyncConfig::getLogLevel

(

)

const [virtual]

Definition at line 481 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::getProperty().

Referenced by EvolutionSyncClient::sync().

bool EvolutionSyncConfig::getLoSupport

(

)

const [virtual]

Specifies that the device supports handling of large objects.

Implements AbstractSyncConfig.

Definition at line 461 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::getProperty().

virtual const char* EvolutionSyncConfig::getMan

(

)

const [inline, virtual]

Specifies the name of the manufacturer of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 702 of file SyncEvolutionConfig.h.

int EvolutionSyncConfig::getMaxLogDirs

(

)

const [virtual]

Definition at line 479 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::getProperty().

Referenced by EvolutionSyncClient::sync().

unsigned long EvolutionSyncConfig::getMaxMsgSize

(

)

const [virtual]

The maximum message size (Byte) accepted for XML messages received from server (server to client)

Implements AbstractSyncConfig.

Definition at line 463 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::getProperty().

unsigned int EvolutionSyncConfig::getMaxObjSize

(

)

const [virtual]

Specifies the maximum object size allowed by the device. Value 0 means "no maxObjSize set".

Implements AbstractSyncConfig.

Definition at line 465 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::getProperty().

virtual const char* EvolutionSyncConfig::getMod

(

)

const [inline, virtual]

Specifies the model name or model number of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 703 of file SyncEvolutionConfig.h.

virtual bool EvolutionSyncConfig::getNocSupport

(

)

const [inline, virtual]

Specifies that the device supports number of changes. Must be false.

Implements AbstractSyncConfig.

Definition at line 712 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getOem

(

)

const [inline, virtual]

Specifies the OEM (Original Equipment Manufacturer) of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 704 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getPassword

(

)

const [virtual]

Returns the password value.

Implements AbstractSyncConfig.

Definition at line 395 of file SyncEvolutionConfig.cpp.

References PasswordConfigProperty::getCachedProperty(), ConfigProperty::getName(), and ConfigStringCache::storeString().

virtual boost::shared_ptr<const FilterConfigNode> EvolutionSyncConfig::getProperties

(

bool

hidden = false

)

const [inline, virtual]

Definition at line 551 of file SyncEvolutionConfig.h.

References getProperties().

Referenced by getProperties().

virtual boost::shared_ptr<FilterConfigNode> EvolutionSyncConfig::getProperties

(

bool

hidden = false

)

[inline, virtual]

Read-write access to all configurable properties of the server. The visible properties are passed through the config filter, which can be modified.

Definition at line 544 of file SyncEvolutionConfig.h.

Referenced by copy().

const char * EvolutionSyncConfig::getProxyHost

(

)

const [virtual]

Returns the proxyHost value.

Implements AbstractSyncConfig.

Definition at line 445 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

const char * EvolutionSyncConfig::getProxyPassword

(

)

const [virtual]

Returns the proxyPassword value.

Implements AbstractSyncConfig.

Definition at line 449 of file SyncEvolutionConfig.cpp.

References PasswordConfigProperty::getCachedProperty(), ConfigProperty::getName(), and ConfigStringCache::storeString().

virtual int EvolutionSyncConfig::getProxyPort

(

)

const [inline, virtual]

Implements AbstractSyncConfig.

Definition at line 666 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getProxyUsername

(

)

const [virtual]

Returns the proxyUsername value.

Implements AbstractSyncConfig.

Definition at line 447 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

virtual unsigned long EvolutionSyncConfig::getReadBufferSize

(

)

const [inline, virtual]

Specifies the value for the size of the buffer used to store the incoming stream from server (byte).

Implements AbstractSyncConfig.

Definition at line 682 of file SyncEvolutionConfig.h.

ConfigPropertyRegistry & EvolutionSyncConfig::getRegistry

(

)

[static]

A list of all properties. Can be extended by derived clients.

Definition at line 351 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setHidden(), and ConfigProperty::setObligatory().

Referenced by copy(), and setDefaults().

virtual unsigned int EvolutionSyncConfig::getResponseTimeout

(

)

const [inline, virtual]

The number of seconds of waiting response timeout

Implements AbstractSyncConfig.

Definition at line 691 of file SyncEvolutionConfig.h.

string EvolutionSyncConfig::getRootPath

(

)

const

absolute directory name of the configuration root

Definition at line 93 of file SyncEvolutionConfig.cpp.

virtual bool EvolutionSyncConfig::getServerAuthRequired

(

)

const [inline, virtual]

Does the server require authentication?

Implements AbstractSyncConfig.

Definition at line 695 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getServerAuthType

(

)

const [inline, virtual]

same as for client?

Implements AbstractSyncConfig.

Definition at line 696 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getServerID

(

)

const [inline, virtual]

the server ID value

Implements AbstractSyncConfig.

Definition at line 698 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getServerNonce

(

)

const [virtual]

The server nonce value: from client to server

Implements AbstractSyncConfig.

Definition at line 471 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

virtual const char* EvolutionSyncConfig::getServerPWD

(

)

const [inline, virtual]

the server password

Implements AbstractSyncConfig.

Definition at line 697 of file SyncEvolutionConfig.h.

EvolutionSyncConfig::ServerList EvolutionSyncConfig::getServers

(

)

[static]

returns list of servers in either the old (.sync4j) or new config directory (.config), given as server name and absolute root of config

Definition at line 106 of file SyncEvolutionConfig.cpp.

Referenced by SyncEvolutionCmdline::run().

EvolutionSyncConfig::ServerList EvolutionSyncConfig::getServerTemplates

(

)

[static]

returns list of available config templates, given as server name and comment

Definition at line 122 of file SyncEvolutionConfig.cpp.

Referenced by SyncEvolutionCmdline::parse(), and SyncEvolutionCmdline::run().

const char * EvolutionSyncConfig::getSSLServerCertificates

(

)

const [virtual]

A platform specific string specifying the location of the certificates used to authenticate the server. When empty, the system's default location will be searched.

Reimplemented from AbstractSyncConfig.

Definition at line 483 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

bool EvolutionSyncConfig::getSSLVerifyHost

(

)

const [virtual]

Enabled by default: the client refuses to establish the connection unless the server's certificate matches its host name. In cases where the certificate still seems to be valid it might make sense to disable this option and allow such connections.

Reimplemented from AbstractSyncConfig.

Definition at line 487 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::getProperty().

bool EvolutionSyncConfig::getSSLVerifyServer

(

)

const [virtual]

Enabled by default: the client refuses to establish the connection unless the server presents a valid certificate. Disabling this option considerably reduces the security of SSL (man-in-the-middle attacks become possible) and is not recommended.

Reimplemented from AbstractSyncConfig.

Definition at line 485 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::getProperty().

const char * EvolutionSyncConfig::getSwv

(

)

const [virtual]

Specifies the software version of the device. This property is optional.

Implements AbstractSyncConfig.

Definition at line 562 of file SyncEvolutionConfig.cpp.

Referenced by EvolutionSyncClient::sync().

virtual boost::shared_ptr<const PersistentEvolutionSyncSourceConfig> EvolutionSyncConfig::getSyncSourceConfig

(

const string &

name

)

const [inline, virtual]

Definition at line 568 of file SyncEvolutionConfig.h.

References getSyncSourceConfig().

boost::shared_ptr< PersistentEvolutionSyncSourceConfig > EvolutionSyncConfig::getSyncSourceConfig

(

const string &

name

)

[virtual]

Returns a wrapper around all properties of the given source which are saved in the config tree. Note that this is different from the set of sync source configs used by the SyncManager: the SyncManger uses the AbstractSyncSourceConfig. In SyncEvolution those are implemented by the EvolutionSyncSource's actually instantiated by EvolutionSyncClient. Those are complete whereas PersistentEvolutionSyncSourceConfig only provides access to a subset of the properties.

Can be called for sources which do not exist yet.

Definition at line 215 of file SyncEvolutionConfig.cpp.

References getSyncSourceNodes().

Referenced by getSyncSourceConfig(), and TestEvolution::TestEvolution().

ConstSyncSourceNodes EvolutionSyncConfig::getSyncSourceNodes	(	const string &	name,
		const string &	trackName = ""
	)			const

Definition at line 244 of file SyncEvolutionConfig.cpp.

References getSyncSourceNodes().

SyncSourceNodes EvolutionSyncConfig::getSyncSourceNodes	(	const string &	name,
		const string &	trackName = ""
	)

Creates config nodes for a certain node. The nodes are not yet created in the backend if they do not yet exist.

Parameters:

	name	the name of the sync source
	trackName	additional part of the tracking node name (used for unit testing)

Definition at line 226 of file SyncEvolutionConfig.cpp.

References ConfigTree::hidden, ConfigTree::other, and ConfigTree::visible.

Referenced by copy(), EvolutionSyncSource::createTestingSource(), getSyncSourceConfig(), getSyncSourceNodes(), and setSourceDefaults().

list< string > EvolutionSyncConfig::getSyncSources

(

)

const [virtual]

Returns list of all configured (not active!) sync sources.

Definition at line 221 of file SyncEvolutionConfig.cpp.

Referenced by copy().

const char * EvolutionSyncConfig::getSyncURL

(

)

const [virtual]

Returns the syncURL value. If the URL does not start with http:// (or HTTP://) or https:// (or HTTPS://), http:// is prepended to the given string.

Implements AbstractSyncConfig.

Definition at line 457 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

bool EvolutionSyncConfig::getUseProxy

(

)

const [virtual]

Should the sync engine use a HTTP proxy?

Implements AbstractSyncConfig.

Definition at line 443 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::getProperty().

Referenced by EvolutionSyncClient::sync().

virtual const char* EvolutionSyncConfig::getUserAgent

(

)

const [inline, virtual]

The user agent string, will be attached to http messages to identify the client on server side. It should be a short description with the client name plus its version

Implements AbstractSyncConfig.

Definition at line 700 of file SyncEvolutionConfig.h.

const char * EvolutionSyncConfig::getUsername

(

)

const [virtual]

Returns the username value.

Returns:

The username value. The caller MUST NOT release the memory itself.

Implements AbstractSyncConfig.

Definition at line 393 of file SyncEvolutionConfig.cpp.

References ConfigStringCache::getProperty().

Referenced by EvolutionSyncClient::sync().

virtual bool EvolutionSyncConfig::getUtc

(

)

const [inline, virtual]

Specifies that the device supports UTC based time. If utc = true, the server SHOULD send time in UTC format, else MUST send in local time.

Implements AbstractSyncConfig.

Definition at line 711 of file SyncEvolutionConfig.h.

virtual const char* EvolutionSyncConfig::getVerDTD

(

)

const [inline, virtual]

Definition at line 701 of file SyncEvolutionConfig.h.

void EvolutionSyncConfig::setClientAuthType	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 460 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setClientNonce

(

const char *

value

)

[virtual]

Implements AbstractSyncConfig.

Definition at line 474 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setCompression	(	bool	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 468 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::setProperty().

virtual void EvolutionSyncConfig::setConfigFilter	(	bool	sync,
		const FilterConfigNode::ConfigFilter &	filter
	)			[inline, virtual]

Replaces the property filter of either the sync properties or all sources. This can be used to e.g. temporarily override the active sync mode.

Reimplemented in EvolutionSyncClient.

Definition at line 529 of file SyncEvolutionConfig.h.

void EvolutionSyncConfig::setDefaults

(

)

initialize all properties with their default value

Definition at line 500 of file SyncEvolutionConfig.cpp.

References getRegistry().

Referenced by TestEvolution::TestEvolution().

void EvolutionSyncConfig::setDevID	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 470 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

Referenced by TestEvolution::TestEvolution().

void EvolutionSyncConfig::setDevInfHash

(

const char *

value

)

[virtual]

Implements AbstractSyncConfig.

Definition at line 476 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setLogDir	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 478 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setLogLevel	(	int	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 482 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::setProperty().

void EvolutionSyncConfig::setLoSupport	(	bool	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 462 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::setProperty().

void EvolutionSyncConfig::setMaxLogDirs	(	int	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 480 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::setProperty().

void EvolutionSyncConfig::setMaxMsgSize	(	unsigned long	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 464 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::setProperty().

void EvolutionSyncConfig::setMaxObjSize	(	unsigned int	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 466 of file SyncEvolutionConfig.cpp.

References TypedConfigProperty< T >::setProperty().

void EvolutionSyncConfig::setPassword	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 442 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setProxyHost	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 446 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setProxyPassword	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 456 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setProxyUsername	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 448 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setServerNonce

(

const char *

value

)

[virtual]

Implements AbstractSyncConfig.

Definition at line 472 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setSourceDefaults

(

const string &

name

)

create a new sync source configuration with default values

Definition at line 505 of file SyncEvolutionConfig.cpp.

References EvolutionSyncSourceConfig::getRegistry(), getSyncSourceNodes(), and SyncSourceNodes::m_configNode.

Referenced by TestEvolution::TestEvolution().

void EvolutionSyncConfig::setSSLServerCertificates	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 484 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setSSLVerifyHost	(	bool	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 488 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::setProperty().

void EvolutionSyncConfig::setSSLVerifyServer	(	bool	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 486 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::setProperty().

void EvolutionSyncConfig::setSyncURL	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 458 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

void EvolutionSyncConfig::setUseProxy	(	bool	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 444 of file SyncEvolutionConfig.cpp.

References BoolConfigProperty::setProperty().

void EvolutionSyncConfig::setUsername	(	const string &	value,
		bool	temporarily = false
	)			[virtual]

Definition at line 394 of file SyncEvolutionConfig.cpp.

References ConfigProperty::setProperty().

---

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

• src/core/SyncEvolutionConfig.h
• src/core/SyncEvolutionConfig.cpp