AbstractSyncConfig Class Reference
[Client]

This class provides access to all attributes of the client and its sources which the sync engine needs to read and (in a few cases) also write. More...

#include <AbstractSyncConfig.h>

Inheritance diagram for AbstractSyncConfig:
[legend]

List of all members.

Public Member Functions

virtual AbstractSyncSourceConfiggetAbstractSyncSourceConfig (const char *name) const =0
virtual AbstractSyncSourceConfiggetAbstractSyncSourceConfig (unsigned int i) const =0
virtual unsigned int getAbstractSyncSourceConfigsCount () const =0
virtual const char * getUsername () const =0
 Returns the username value.
virtual const char * getPassword () const =0
 Returns the password value.
virtual bool getUseProxy () const =0
 Should the sync engine use a HTTP proxy?
virtual const char * getProxyHost () const =0
 Returns the proxyHost value.
virtual int getProxyPort () const =0
virtual const char * getProxyUsername () const =0
 Returns the proxyUsername value.
virtual const char * getProxyPassword () const =0
 Returns the proxyPassword value.
virtual const char * getSyncURL () const =0
 Returns the syncURL value.
virtual void setBeginSync (unsigned long)
 Sets the new "beginSync" timestamp.
virtual void setEndSync (unsigned long)
 Sets the new "endSync" timestamp.
virtual bool getServerAuthRequired () const =0
 Does the server require authentication?
virtual const char * getClientAuthType () const =0
 the type of client authentication used by client:
  • syncml:basic-auth
  • syncml:md5-auth

virtual const char * getServerAuthType () const =0
 same as for client?
virtual const char * getServerPWD () const =0
 the server password
virtual const char * getServerID () const =0
 the server ID value
virtual const char * getServerNonce () const =0
 The server nonce value: from client to server.
virtual void setServerNonce (const char *v)=0
virtual const char * getClientNonce () const =0
 The client nonce value: from server to client.
virtual void setClientNonce (const char *v)=0
virtual unsigned long getMaxMsgSize () const =0
 The maximum message size (Byte) accepted for XML messages received from server (server to client).
virtual unsigned long getReadBufferSize () const =0
 Specifies the value for the size of the buffer used to store the incoming stream from server (byte).
virtual const char * getUserAgent () const =0
 The user agent string, will be attached to http messages to identify the client on server side.
virtual const char * getSSLServerCertificates () const
 A platform specific string specifying the location of the certificates used to authenticate the server.
virtual bool getSSLVerifyServer () const
 Enabled by default: the client refuses to establish the connection unless the server presents a valid certificate.
virtual bool getSSLVerifyHost () const
 Enabled by default: the client refuses to establish the connection unless the server's certificate matches its host name.
virtual bool getCompression () const =0
virtual unsigned int getResponseTimeout () const =0
 The number of seconds of waiting response timeout.
virtual const char * getMan () const =0
 Specifies the name of the manufacturer of the device.
virtual const char * getMod () const =0
 Specifies the model name or model number of the device.
virtual const char * getOem () const =0
 Specifies the OEM (Original Equipment Manufacturer) of the device.
virtual const char * getFwv () const =0
 Specifies the firmware version of the device.
virtual const char * getSwv () const =0
 Specifies the software version of the device.
virtual const char * getHwv () const =0
 Specifies the hardware version of the device.
virtual const char * getDevID () const =0
 Specifies the identifier of the source synchronization device.
virtual const char * getDevType () const =0
 Specifies the type of the source synchronization device.
virtual const char * getDsV () const =0
 Specifies the implemented DS version.
virtual bool getUtc () const =0
 Specifies that the device supports UTC based time.
virtual bool getLoSupport () const =0
 Specifies that the device supports handling of large objects.
virtual bool getNocSupport () const =0
 Specifies that the device supports number of changes.
virtual unsigned int getMaxObjSize () const =0
 Specifies the maximum object size allowed by the device.
virtual const char * getDevInfHash () const =0
 This is a hash value generated from all properties that are used for the <DevInf> element, plus the syncURL property.
virtual void setDevInfHash (const char *hash)=0
virtual bool getSendDevInfo () const =0
 Specifies if devinfo should be sent.
virtual bool getForceServerDevInfo () const =0
 Specifies if Server devinfo should be asked even if not necessary.
virtual const char * getServerSwv () const =0
 Specifies the Server software version.
virtual void setServerSwv (const char *v)=0
virtual const char * getServerLastSyncURL () const =0
 Specifies the Server URL correspondant to the devInf obtained.
virtual void setServerLastSyncURL (const char *v)=0
virtual void setServerMan (const char *v)=0
 Specifies the name of the manufacturer of the Server.
virtual void setServerMod (const char *v)=0
 Specifies the model name or model number of the Server.
virtual void setServerOem (const char *v)=0
 Specifies the OEM (Original Equipment Manufacturer) of the Server.
virtual void setServerFwv (const char *v)=0
 Specifies the firmware version of the Server.
virtual void setServerHwv (const char *v)=0
 Specifies the hardware version of the Server.
virtual void setServerDevID (const char *v)=0
 Specifies the Server identifier.
virtual void setServerDevType (const char *v)=0
 Specifies the Server type (expected "server").
virtual void setServerUtc (const bool v)=0
 Specifies if the Server supports UTC based time.
virtual void setServerLoSupport (const bool v)=0
 Specifies if the Server supports handling of large objects.
virtual void setServerNocSupport (const bool v)=0
 Specifies if the Server supports number of changes.
virtual void setServerVerDTD (const char *v)=0
 Specifies the DTD version of the Server (expected "1.2").
virtual void setServerSmartSlowSync (const int v)=0
 Specifies if the Server supports the Smart Slow sync.
virtual void setServerMultipleEmailAccount (const int v)=0
 Specifies if the Server supports MEA.
virtual void setServerDataStores (const ArrayList *dataStores)=0
 Specifies the array of DataStores supported by the Server.
virtual const ArrayList * getServerDataStores () const =0
 Returns the array of DataStores supported by the Server.
virtual bool isToAbort ()=0
virtual int getLastGlobalError ()=0
 Returns the global error code of last sync.
virtual void setLastGlobalError (const int val)=0
 Sets the global last error code.


Detailed Description

This class provides access to all attributes of the client and its sources which the sync engine needs to read and (in a few cases) also write.

Todo:
The documentation of these properties was copied more or less verbatim from the older AccessConfig.h and DeviceConfig.h and does not really explain much about these properties. It should be considerably enhanced.

Member Function Documentation

virtual const char* AbstractSyncConfig::getDevID (  )  const [pure 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.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getDevInfHash (  )  const [pure 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.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getDevType (  )  const [pure 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.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getDsV (  )  const [pure virtual]

Specifies the implemented DS version.

This property is optional.

Implemented in SyncManagerConfig.

virtual bool AbstractSyncConfig::getForceServerDevInfo (  )  const [pure virtual]

Specifies if Server devinfo should be asked even if not necessary.

Can be used by Clients to force asking Server caps.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getFwv (  )  const [pure virtual]

Specifies the firmware version of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getHwv (  )  const [pure virtual]

Specifies the hardware version of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getMan (  )  const [pure virtual]

Specifies the name of the manufacturer of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual unsigned int AbstractSyncConfig::getMaxObjSize (  )  const [pure virtual]

Specifies the maximum object size allowed by the device.

Value 0 means "no maxObjSize set".

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getMod (  )  const [pure virtual]

Specifies the model name or model number of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual bool AbstractSyncConfig::getNocSupport (  )  const [pure virtual]

Specifies that the device supports number of changes.

Must be false.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getOem (  )  const [pure virtual]

Specifies the OEM (Original Equipment Manufacturer) of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getServerLastSyncURL (  )  const [pure virtual]

Specifies the Server URL correspondant to the devInf obtained.

It's used to check if the Server URL changed from last time, in this case the Server devInf are obsolete (will ask them again).

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getSSLServerCertificates (  )  const [inline, 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.

virtual bool AbstractSyncConfig::getSSLVerifyHost (  )  const [inline, 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.

virtual bool AbstractSyncConfig::getSSLVerifyServer (  )  const [inline, 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.

virtual const char* AbstractSyncConfig::getSwv (  )  const [pure virtual]

Specifies the software version of the device.

This property is optional.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getSyncURL (  )  const [pure 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.

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getUserAgent (  )  const [pure 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

Implemented in SyncManagerConfig.

virtual const char* AbstractSyncConfig::getUsername (  )  const [pure virtual]

Returns the username value.

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

Implemented in SyncManagerConfig.

virtual bool AbstractSyncConfig::getUtc (  )  const [pure 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.

Implemented in SyncManagerConfig.

virtual void AbstractSyncConfig::setBeginSync ( unsigned long   )  [inline, virtual]

Sets the new "beginSync" timestamp.

The client can use this value if it wants to, but it doesn't have to store it persistently.

Parameters:
timestamp the beginSync timestamp

Reimplemented in SyncManagerConfig.

virtual void AbstractSyncConfig::setEndSync ( unsigned long   )  [inline, virtual]

Sets the new "endSync" timestamp.

The client can use this value if it wants to, but it doesn't have to store it persistently.

Parameters:
timestamp the endSync timestamp

Reimplemented in SyncManagerConfig.


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

Generated on Tue Apr 6 13:00:41 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1