AbstractSyncConfig Class Reference
[Client]
#include <AbstractSyncConfig.h>
Public Member Functions | |
| virtual | ~AbstractSyncConfig () |
| virtual AbstractSyncSourceConfig * | getAbstractSyncSourceConfig (const char *name) const =0 |
| virtual AbstractSyncSourceConfig * | getAbstractSyncSourceConfig (unsigned int i) const =0 |
| virtual unsigned int | getAbstractSyncSourceConfigsCount () const =0 |
| virtual const char * | getUsername () const =0 |
| virtual const char * | getPassword () const =0 |
| virtual bool | getUseProxy () const =0 |
| virtual const char * | getProxyHost () const =0 |
| virtual int | getProxyPort () const =0 |
| virtual const char * | getProxyUsername () const =0 |
| virtual const char * | getProxyPassword () const =0 |
| virtual const char * | getSyncURL () const =0 |
| virtual void | setBeginSync (unsigned long) |
| virtual void | setEndSync (unsigned long) |
| virtual bool | getServerAuthRequired () const =0 |
| virtual const char * | getClientAuthType () const =0 |
| virtual const char * | getServerAuthType () const =0 |
| virtual const char * | getServerPWD () const =0 |
| virtual const char * | getServerID () const =0 |
| virtual const char * | getServerNonce () const =0 |
| virtual void | setServerNonce (const char *v)=0 |
| virtual const char * | getClientNonce () const =0 |
| virtual void | setClientNonce (const char *v)=0 |
| virtual unsigned long | getMaxMsgSize () const =0 |
| virtual unsigned long | getReadBufferSize () const =0 |
| virtual const char * | getUserAgent () const =0 |
| virtual const char * | getSSLServerCertificates () const |
| virtual bool | getSSLVerifyServer () const |
| virtual bool | getSSLVerifyHost () const |
| virtual bool | getCompression () const =0 |
| virtual unsigned int | getResponseTimeout () const =0 |
| virtual const char * | getMan () const =0 |
| virtual const char * | getMod () const =0 |
| virtual const char * | getOem () const =0 |
| virtual const char * | getFwv () const =0 |
| virtual const char * | getSwv () const =0 |
| virtual const char * | getHwv () const =0 |
| virtual const char * | getDevID () const =0 |
| virtual const char * | getDevType () const =0 |
| virtual const char * | getDsV () const =0 |
| virtual bool | getUtc () const =0 |
| virtual bool | getLoSupport () const =0 |
| virtual bool | getNocSupport () const =0 |
| virtual unsigned int | getMaxObjSize () const =0 |
| virtual const char * | getDevInfHash () const =0 |
| virtual void | setDevInfHash (const char *hash)=0 |
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.
Definition at line 57 of file AbstractSyncConfig.h.
Constructor & Destructor Documentation
| virtual AbstractSyncConfig::~AbstractSyncConfig | ( | ) | [inline, virtual] |
Definition at line 60 of file AbstractSyncConfig.h.
Member Function Documentation
| virtual AbstractSyncSourceConfig* AbstractSyncConfig::getAbstractSyncSourceConfig | ( | unsigned int | i | ) | const [pure virtual] |
Implemented in EvolutionSyncClient, EvolutionSyncConfig, and SyncManagerConfig.
| virtual AbstractSyncSourceConfig* AbstractSyncConfig::getAbstractSyncSourceConfig | ( | const char * | name | ) | const [pure virtual] |
Implemented in EvolutionSyncClient, EvolutionSyncConfig, and SyncManagerConfig.
| virtual unsigned int AbstractSyncConfig::getAbstractSyncSourceConfigsCount | ( | ) | const [pure virtual] |
Implemented in EvolutionSyncClient, EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getClientAuthType | ( | ) | const [pure virtual] |
the type of client authentication used by client:
- syncml:basic-auth
- syncml:md5-auth
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getClientNonce | ( | ) | const [pure virtual] |
The client nonce value: from server to client
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual bool AbstractSyncConfig::getCompression | ( | ) | const [pure virtual] |
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| 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 EvolutionSyncConfig, and 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 EvolutionSyncConfig, and 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 EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getDsV | ( | ) | const [pure virtual] |
Specifies the implemented DS version. This property is optional.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getFwv | ( | ) | const [pure virtual] |
Specifies the firmware version of the device. This property is optional.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getHwv | ( | ) | const [pure virtual] |
Specifies the hardware version of the device. This property is optional.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual bool AbstractSyncConfig::getLoSupport | ( | ) | const [pure virtual] |
Specifies that the device supports handling of large objects.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getMan | ( | ) | const [pure virtual] |
Specifies the name of the manufacturer of the device. This property is optional.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual unsigned long AbstractSyncConfig::getMaxMsgSize | ( | ) | const [pure virtual] |
The maximum message size (Byte) accepted for XML messages received from server (server to client)
Implemented in EvolutionSyncConfig, and 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 EvolutionSyncConfig, and 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 EvolutionSyncConfig, and SyncManagerConfig.
| virtual bool AbstractSyncConfig::getNocSupport | ( | ) | const [pure virtual] |
Specifies that the device supports number of changes. Must be false.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getOem | ( | ) | const [pure virtual] |
Specifies the OEM (Original Equipment Manufacturer) of the device. This property is optional.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getPassword | ( | ) | const [pure virtual] |
Returns the password value.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getProxyHost | ( | ) | const [pure virtual] |
Returns the proxyHost value.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getProxyPassword | ( | ) | const [pure virtual] |
Returns the proxyPassword value.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual int AbstractSyncConfig::getProxyPort | ( | ) | const [pure virtual] |
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getProxyUsername | ( | ) | const [pure virtual] |
Returns the proxyUsername value.
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual unsigned long AbstractSyncConfig::getReadBufferSize | ( | ) | const [pure virtual] |
Specifies the value for the size of the buffer used to store the incoming stream from server (byte).
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual unsigned int AbstractSyncConfig::getResponseTimeout | ( | ) | const [pure virtual] |
The number of seconds of waiting response timeout
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual bool AbstractSyncConfig::getServerAuthRequired | ( | ) | const [pure virtual] |
Does the server require authentication?
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getServerAuthType | ( | ) | const [pure virtual] |
same as for client?
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getServerID | ( | ) | const [pure virtual] |
the server ID value
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getServerNonce | ( | ) | const [pure virtual] |
The server nonce value: from client to server
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual const char* AbstractSyncConfig::getServerPWD | ( | ) | const [pure virtual] |
the server password
Implemented in EvolutionSyncConfig, and 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.
Reimplemented in EvolutionSyncConfig.
Definition at line 180 of file AbstractSyncConfig.h.
| 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.
Reimplemented in EvolutionSyncConfig.
Definition at line 198 of file AbstractSyncConfig.h.
| 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.
Reimplemented in EvolutionSyncConfig.
Definition at line 189 of file AbstractSyncConfig.h.
| virtual const char* AbstractSyncConfig::getSwv | ( | ) | const [pure virtual] |
Specifies the software version of the device. This property is optional.
Implemented in EvolutionSyncConfig, and 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 EvolutionSyncConfig, and SyncManagerConfig.
| virtual bool AbstractSyncConfig::getUseProxy | ( | ) | const [pure virtual] |
Should the sync engine use a HTTP proxy?
Implemented in EvolutionSyncConfig, and 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 EvolutionSyncConfig, and 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 EvolutionSyncConfig, and 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 EvolutionSyncConfig, and 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.
Definition at line 117 of file AbstractSyncConfig.h.
| virtual void AbstractSyncConfig::setClientNonce | ( | const char * | v | ) | [pure virtual] |
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
| virtual void AbstractSyncConfig::setDevInfHash | ( | const char * | hash | ) | [pure virtual] |
Implemented in EvolutionSyncConfig, and 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.
Definition at line 127 of file AbstractSyncConfig.h.
| virtual void AbstractSyncConfig::setServerNonce | ( | const char * | v | ) | [pure virtual] |
Implemented in EvolutionSyncConfig, and SyncManagerConfig.
The documentation for this class was generated from the following file:
- build-client-api/include/common/spds/AbstractSyncConfig.h
