UltraLite User's Guide
UltraLite Reference
Synchronization parameters
Reports the status of MobiLink user authentication. The MobiLink synchronization server provides this information to the client.
If you are implementing a custom authentication scheme, the authenticate_user or authenticate_user_hashed synchronization script must return one of the allowed values of this parameter.
The parameter is read-only.
After synchronization, the auth_status member of ul_synch_info holds one of the following values:
| Constant | Value | Description |
|---|---|---|
| UL_AUTH_STATUS_UNKNOWN | 0 | Authorization status is unknown, possibly because the connection has not yet synchronized. |
| UL_AUTH_STATUS_VALID | 1000 | User ID and password were valid at the time of synchronization. |
| UL_AUTH_STATUS_VALID_BUT_EXPIRES_SOON | 2000 | User ID and password were valid at thetime of synchronization but will expire soon. |
| UL_AUTH_STATUS_EXPIRED | 3000 | Authorization failed: user ID or password have expired. |
| UL_AUTH_STATUS_INVALID | 4000 | Authorization failed: bad user ID or password. |
| UL_AUTH_STATUS_IN_USE | 5000 | Authorization failed: user ID is already in use. |
If a custom authenticate_user synchronization script at the consolidated database returns a different value, the value is interpreted according to the rules given in authenticate_user connection event.
Access the parameter as follows:
ul_synch_info info; // ... returncode = info.auth_status;
Retrieve the authorization status using UlSynchOptions.getAuthStatus().
UlSynchOptions opts = new UlSynchOptions; // set options here conn.synchronize( opts ); returncode = opts.getAuthStatus();
The constants are the same as for C/C++, but prefixed with UlDefn.
Authenticating MobiLink Users.