Sorry, you need to enable JavaScript to visit this website.

Feedback

Your feedback is important to keep improving our website and offer you a more reliable experience.

CPClient

The CPClient is a middleware component that provides support for wireless provisioning of application and connection settings and exposes d-Bus APIs. It implements the OMA Client Provisioning (CP) protocol controlling application and connection settings. It works with Provman, which directly modifies application and connection settings.

The CPClient allows multiple data synchronisation (OMA DS) accounts to be provisioned.

The only restriction on the provisioning of OMA DS accounts is that it is not possible to specify that a given connection or proxy should be used to access the OMA DS server. All connectoid references within an OMA DS application characteristic are ignored.

Each OMA DS characteristic defines a separate OMA DS account. The supported settings are specified in the table below.

OMA CP Parameter Occurrence Description Permissible Values
Supported Data Synchronisation Parameters
APPLICATION/APPID 1 Identifies the application characteristic as an OMA DS account w5
APPLICATION/NAME 0 or 1 Contains the user readable name of OMA DS server. A string
APPLICATION/PROVIDER-ID 0 or 1 ID of the OMA DS Server A string
APPLICATION/ADDR 0 or 1 Contains the address of the OMA DS server. This parameter is used if the client should connect to the server using the default port number. A string
APPLICATION/APPADDR 0 or 1 Characteristic for specifying the server address.  
APPLICATION/APPADDR/ADDR 1 Contains the address of the OMA DS server. This parameter should be used when explicitly specifying the port number. A w5 APPLICATION characteristic should not include both APPLICATION/ADDR and APPLICATION/APPADDR/ADDR. A string
APPLICATION/APPADDR/PORT 0 or 1 The port number of the OMA DS server An integer
APPLICATION/APPAUTH 0 or 1 Characteristic for specifying the server's login credentials  
APPLICATION/APPAUTH/AAUTHLEVEL 1 Determines what the credentials in the characteristic should be used for APPSRV (This is the only value supported)
APPLICATION/APPAUTH/AAUTHTYPE 1 Identifies the type of authentication being used HTTP-BASIC, HTTP-DIGEST, BASIC, DIGEST, X509, SECUREID, SAFEWORD, DIGIPASS
APPLICATION/APPAUTH/AAUTHNAME 0 or 1 The user name A string
APPLICATION/APPAUTH/AAUTHSECRET 0 or 1 The password A string
APPLICATION/RESOURCE 1 or more Characteristic that identifies a server resource to be synchronised  
APPLICATION/RESOURCE/AACCEPT 1 Specifies the content types accepted by the server It is a comma separated list of MIME Types
APPLICATION/RESOURCE/URI 1 URI of the server database A URI
APPLICATION/RESOURCE/NAME 0 or 1 User readable name of the server database contacts, calendar, todo or memo. Other names may be provided but the cpclient may choose to override the user supplied names if it can determine that one of the standard names would be more suitable by looking at the AACCEPT parameter
APPLICATION/RESOURCE/SYNCTYPE 0 or 1 Specifies the type of synchronisation to perform An integer. The following values are permitted: 1 (Slow Synch), 2 (Two-way Sync), 3 (One-way Sync), 4 (Refresh Sync from client), 5 (One way sync from server), 6 (Refresh Sync from Server).

Note that OMA DS APPLICATION characteristics must contain a server address. If a server address is not supplied by APPLICATION/ADRR or APPLICATION/APPADDR/ADDR, the characteristic is deemed to be invalid. In addition, each APPLICATION characteristic that provisions an OMA DS application must contain at least one RESOURCE characteristic.

An example of a OMA CP document that provisions an OMA data synchronisation account is shown below.

<wap-provisioningdoc version="1.0">

  <characteristic type="APPLICATION">
    <parm name="APPID" value="w5"/>
    <parm name="PROVIDER-ID" value="dslocal"/>
    <parm name="NAME" value="Data Sync Account"/>
    <parm name="ADDR" value="http://127.0.0.1/syncme"/>
    <characteristic type="APPAUTH">
      <parm name="AAUTHLEVEL" value="APPSRV"/>
      <parm name="AAUTHTYPE" value="BASIC"/>
      <parm name="AAUTHNAME" value="username"/>
      <parm name="AAUTHSECRET" value="password"/>
    </characteristic>
    <characteristic type="RESOURCE">
      <parm name="URI" value="./addressbook/myaddresses"/>
      <parm name="AACCEPT" value="text/x-vcard"/>
      <parm name="SYNCTYPE" value="1"/>
    </characteristic>
  </characteristic>

</wap-provisioningdoc>

It is converted into the following Provman keys by the CPClient.

/applications/sync/dslocal/name = Data Sync Account
/applications/sync/dslocal/url = http://127.0.0.1/syncme
/applications/sync/dslocal/client = 0
/applications/sync/dslocal/username = username
/applications/sync/dslocal/password = password
/applications/sync/dslocal/contacts/uri = ./addressbook/myaddresses
/applications/sync/dslocal/contacts/sync = slow
/applications/sync/dslocal/contacts/format = text/x-vcard

Provman defines four standard sub-directories for remote databases. These are "contacts", "calendar", "todo", "memo". The CPClient uses the RESOURCE/NAME to determine which sub-directory to use. If the RESOURCE/NAME parameter is not specified or it does not match one of the standard sub-directory names, mentioned above, the CPClient will attempt to determine the appropriate sub-directory from the resources' AACCEPT parameter. In the example above, contacts was chosen, as no name was explicitly specified and the AACEPT parameter contained a x-vcard MIME type.

Project: