SyncManagerConfig Class Reference
[Client]
#include <SyncManagerConfig.h>
Public Member Functions | |
| SyncManagerConfig () | |
| virtual | ~SyncManagerConfig () |
| virtual AbstractSyncSourceConfig * | getAbstractSyncSourceConfig (const char *name) const |
| virtual AbstractSyncSourceConfig * | getAbstractSyncSourceConfig (unsigned int i) const |
| virtual unsigned int | getAbstractSyncSourceConfigsCount () const |
| virtual unsigned int | getSyncSourceConfigsCount () const |
| virtual SyncSourceConfig * | getSyncSourceConfigs () const |
| virtual SyncSourceConfig * | getSyncSourceConfig (const char *name, bool refresh=false) const |
| virtual SyncSourceConfig * | getSyncSourceConfig (unsigned int i, bool refresh=false) const |
| virtual bool | setSyncSourceConfig (SyncSourceConfig &sc) |
| virtual const AccessConfig & | getAccessConfig () const |
| virtual AccessConfig & | getAccessConfig () |
| virtual void | setAccessConfig (AccessConfig &ac) |
| virtual const DeviceConfig & | getDeviceConfig () const |
| virtual DeviceConfig & | getDeviceConfig () |
| virtual void | setDeviceConfig (DeviceConfig &dc) |
| unsigned int | isDirty () const |
| void | setClientDefaults () |
| void | setSourceDefaults (const char *name) |
| virtual const char * | getUsername () const |
| virtual const char * | getPassword () const |
| virtual bool | getUseProxy () const |
| virtual const char * | getProxyHost () const |
| virtual int | getProxyPort () const |
| virtual const char * | getProxyUsername () const |
| virtual const char * | getProxyPassword () const |
| virtual const char * | getSyncURL () const |
| virtual void | setBeginSync (unsigned long timestamp) |
| virtual void | setEndSync (unsigned long timestamp) |
| virtual bool | getServerAuthRequired () const |
| virtual const char * | getClientAuthType () const |
| virtual const char * | getServerAuthType () const |
| virtual const char * | getServerPWD () const |
| virtual const char * | getServerID () const |
| virtual const char * | getServerNonce () const |
| virtual void | setServerNonce (const char *v) |
| virtual const char * | getClientNonce () const |
| virtual void | setClientNonce (const char *v) |
| virtual unsigned long | getMaxMsgSize () const |
| virtual unsigned long | getReadBufferSize () const |
| virtual const char * | getUserAgent () const |
| virtual bool | getCompression () const |
| virtual unsigned int | getResponseTimeout () const |
| virtual const char * | getMan () const |
| virtual const char * | getMod () const |
| virtual const char * | getOem () const |
| virtual const char * | getFwv () const |
| virtual const char * | getSwv () const |
| virtual const char * | getHwv () const |
| virtual const char * | getDevID () const |
| virtual const char * | getDevType () const |
| virtual const char * | getDsV () const |
| virtual bool | getUtc () const |
| virtual bool | getLoSupport () const |
| virtual bool | getNocSupport () const |
| virtual unsigned int | getMaxObjSize () const |
| virtual const char * | getDevInfHash () const |
| virtual void | setDevInfHash (const char *hash) |
Protected Member Functions | |
| virtual bool | addSyncSourceConfig (SyncSourceConfig &sc) |
Protected Attributes | |
| AccessConfig | accessConfig |
| DeviceConfig | deviceConfig |
| SyncSourceConfig * | sourceConfigs |
| unsigned int | sourceConfigsCount |
Detailed Description
This implementation is just a transient configuration information repository; persisting configuration settings is delegated to subclasses.Definition at line 53 of file SyncManagerConfig.h.
Constructor & Destructor Documentation
| SyncManagerConfig::SyncManagerConfig | ( | ) |
| virtual SyncManagerConfig::~SyncManagerConfig | ( | ) | [virtual] |
Member Function Documentation
| virtual bool SyncManagerConfig::addSyncSourceConfig | ( | SyncSourceConfig & | sc | ) | [protected, virtual] |
| virtual AbstractSyncSourceConfig* SyncManagerConfig::getAbstractSyncSourceConfig | ( | unsigned int | i | ) | const [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 74 of file SyncManagerConfig.h.
References getSyncSourceConfig().
| virtual AbstractSyncSourceConfig* SyncManagerConfig::getAbstractSyncSourceConfig | ( | const char * | name | ) | const [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 70 of file SyncManagerConfig.h.
References getSyncSourceConfig().
| virtual unsigned int SyncManagerConfig::getAbstractSyncSourceConfigsCount | ( | ) | const [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 78 of file SyncManagerConfig.h.
References getSyncSourceConfigsCount().
| virtual AccessConfig& SyncManagerConfig::getAccessConfig | ( | ) | [inline, virtual] |
| virtual const AccessConfig& SyncManagerConfig::getAccessConfig | ( | ) | const [inline, virtual] |
Definition at line 89 of file SyncManagerConfig.h.
References accessConfig.
Referenced by getClientAuthType(), getClientNonce(), getCompression(), getMaxMsgSize(), getPassword(), getProxyHost(), getProxyPassword(), getProxyPort(), getProxyUsername(), getReadBufferSize(), getResponseTimeout(), getServerAuthRequired(), getServerAuthType(), getServerID(), getServerNonce(), getServerPWD(), getSyncURL(), getUseProxy(), getUserAgent(), getUsername(), setBeginSync(), setClientNonce(), setEndSync(), and setServerNonce().
| virtual const char* SyncManagerConfig::getClientAuthType | ( | ) | const [inline, virtual] |
the type of client authentication used by client:
- syncml:basic-auth
- syncml:md5-auth
Implements AbstractSyncConfig.
Definition at line 123 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getClientNonce | ( | ) | const [inline, virtual] |
The client nonce value: from server to client
Implements AbstractSyncConfig.
Definition at line 129 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual bool SyncManagerConfig::getCompression | ( | ) | const [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 134 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual DeviceConfig& SyncManagerConfig::getDeviceConfig | ( | ) | [inline, virtual] |
| virtual const DeviceConfig& SyncManagerConfig::getDeviceConfig | ( | ) | const [inline, virtual] |
Definition at line 93 of file SyncManagerConfig.h.
References deviceConfig.
Referenced by getDevID(), getDevInfHash(), getDevType(), getDsV(), getFwv(), getHwv(), getLoSupport(), getMan(), getMaxObjSize(), getMod(), getNocSupport(), getOem(), getSwv(), getUtc(), and setDevInfHash().
| virtual const char* SyncManagerConfig::getDevID | ( | ) | const [inline, 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 143 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getDevInfHash | ( | ) | const [inline, 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 150 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getDevType | ( | ) | const [inline, 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 144 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getDsV | ( | ) | const [inline, virtual] |
Specifies the implemented DS version. This property is optional.
Implements AbstractSyncConfig.
Definition at line 145 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getFwv | ( | ) | const [inline, virtual] |
Specifies the firmware version of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 140 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getHwv | ( | ) | const [inline, virtual] |
Specifies the hardware version of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 142 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual bool SyncManagerConfig::getLoSupport | ( | ) | const [inline, virtual] |
Specifies that the device supports handling of large objects.
Implements AbstractSyncConfig.
Definition at line 147 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getMan | ( | ) | const [inline, virtual] |
Specifies the name of the manufacturer of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 137 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual unsigned long SyncManagerConfig::getMaxMsgSize | ( | ) | const [inline, virtual] |
The maximum message size (Byte) accepted for XML messages received from server (server to client)
Implements AbstractSyncConfig.
Definition at line 131 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual unsigned int SyncManagerConfig::getMaxObjSize | ( | ) | const [inline, virtual] |
Specifies the maximum object size allowed by the device. Value 0 means "no maxObjSize set".
Implements AbstractSyncConfig.
Definition at line 149 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getMod | ( | ) | const [inline, virtual] |
Specifies the model name or model number of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 138 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual bool SyncManagerConfig::getNocSupport | ( | ) | const [inline, virtual] |
Specifies that the device supports number of changes. Must be false.
Implements AbstractSyncConfig.
Definition at line 148 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getOem | ( | ) | const [inline, virtual] |
Specifies the OEM (Original Equipment Manufacturer) of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 139 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual const char* SyncManagerConfig::getPassword | ( | ) | const [inline, virtual] |
Returns the password value.
Implements AbstractSyncConfig.
Definition at line 113 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getProxyHost | ( | ) | const [inline, virtual] |
Returns the proxyHost value.
Implements AbstractSyncConfig.
Definition at line 115 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getProxyPassword | ( | ) | const [inline, virtual] |
Returns the proxyPassword value.
Implements AbstractSyncConfig.
Definition at line 118 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual int SyncManagerConfig::getProxyPort | ( | ) | const [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 116 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getProxyUsername | ( | ) | const [inline, virtual] |
Returns the proxyUsername value.
Implements AbstractSyncConfig.
Definition at line 117 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual unsigned long SyncManagerConfig::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 132 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual unsigned int SyncManagerConfig::getResponseTimeout | ( | ) | const [inline, virtual] |
The number of seconds of waiting response timeout
Implements AbstractSyncConfig.
Definition at line 135 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual bool SyncManagerConfig::getServerAuthRequired | ( | ) | const [inline, virtual] |
Does the server require authentication?
Implements AbstractSyncConfig.
Definition at line 122 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getServerAuthType | ( | ) | const [inline, virtual] |
same as for client?
Implements AbstractSyncConfig.
Definition at line 124 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getServerID | ( | ) | const [inline, virtual] |
the server ID value
Implements AbstractSyncConfig.
Definition at line 126 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getServerNonce | ( | ) | const [inline, virtual] |
The server nonce value: from client to server
Implements AbstractSyncConfig.
Definition at line 127 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getServerPWD | ( | ) | const [inline, virtual] |
the server password
Implements AbstractSyncConfig.
Definition at line 125 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getSwv | ( | ) | const [inline, virtual] |
Specifies the software version of the device. This property is optional.
Implements AbstractSyncConfig.
Definition at line 141 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual SyncSourceConfig* SyncManagerConfig::getSyncSourceConfig | ( | unsigned int | i, | |
| bool | refresh = false | |||
| ) | const [virtual] |
| virtual SyncSourceConfig* SyncManagerConfig::getSyncSourceConfig | ( | const char * | name, | |
| bool | refresh = false | |||
| ) | const [virtual] |
Referenced by getAbstractSyncSourceConfig().
| virtual SyncSourceConfig* SyncManagerConfig::getSyncSourceConfigs | ( | ) | const [inline, virtual] |
| virtual unsigned int SyncManagerConfig::getSyncSourceConfigsCount | ( | ) | const [inline, virtual] |
Definition at line 83 of file SyncManagerConfig.h.
References sourceConfigsCount.
Referenced by getAbstractSyncSourceConfigsCount().
| virtual const char* SyncManagerConfig::getSyncURL | ( | ) | const [inline, 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 119 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual bool SyncManagerConfig::getUseProxy | ( | ) | const [inline, virtual] |
Should the sync engine use a HTTP proxy?
Implements AbstractSyncConfig.
Definition at line 114 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::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 133 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual const char* SyncManagerConfig::getUsername | ( | ) | const [inline, virtual] |
Returns the username value.
- Returns:
- The username value. The caller MUST NOT release the memory itself.
Implements AbstractSyncConfig.
Definition at line 112 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual bool SyncManagerConfig::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 146 of file SyncManagerConfig.h.
References getDeviceConfig().
| unsigned int SyncManagerConfig::isDirty | ( | ) | const [inline] |
| virtual void SyncManagerConfig::setAccessConfig | ( | AccessConfig & | ac | ) | [inline, virtual] |
| virtual void SyncManagerConfig::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 from AbstractSyncConfig.
Definition at line 120 of file SyncManagerConfig.h.
References getAccessConfig().
| void SyncManagerConfig::setClientDefaults | ( | ) |
Initializes the access and device config with default values from DefaultConfigFactory.
| virtual void SyncManagerConfig::setClientNonce | ( | const char * | v | ) | [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 130 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual void SyncManagerConfig::setDeviceConfig | ( | DeviceConfig & | dc | ) | [inline, virtual] |
| virtual void SyncManagerConfig::setDevInfHash | ( | const char * | hash | ) | [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 151 of file SyncManagerConfig.h.
References getDeviceConfig().
| virtual void SyncManagerConfig::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 from AbstractSyncConfig.
Definition at line 121 of file SyncManagerConfig.h.
References getAccessConfig().
| virtual void SyncManagerConfig::setServerNonce | ( | const char * | v | ) | [inline, virtual] |
Implements AbstractSyncConfig.
Definition at line 128 of file SyncManagerConfig.h.
References getAccessConfig().
| void SyncManagerConfig::setSourceDefaults | ( | const char * | name | ) |
Initializes the given source with default values from DefaultConfigFactory.
| virtual bool SyncManagerConfig::setSyncSourceConfig | ( | SyncSourceConfig & | sc | ) | [virtual] |
Member Data Documentation
AccessConfig SyncManagerConfig::accessConfig [protected] |
Definition at line 56 of file SyncManagerConfig.h.
Referenced by getAccessConfig(), isDirty(), and setAccessConfig().
DeviceConfig SyncManagerConfig::deviceConfig [protected] |
Definition at line 57 of file SyncManagerConfig.h.
Referenced by getDeviceConfig(), and setDeviceConfig().
SyncSourceConfig* SyncManagerConfig::sourceConfigs [protected] |
unsigned int SyncManagerConfig::sourceConfigsCount [protected] |
The documentation for this class was generated from the following file:
- build-client-api/include/common/spds/SyncManagerConfig.h
