Contents Index auth_parms parameter auth_value synchronization parameter

UltraLite Static Java User's Guide
  Synchronization Parameters Reference
    Synchronization parameters

auth_status parameter


Function 

Reports the status of MobiLink user authentication.

Access method 

short getAuthStatus( )

void setAuthStatus( short auth_status )

Usage 

Access the parameter as follows:

UlSynchOptions opts = new UlSynchOptions;
// set options here
conn.synchronize( opts );
returncode = opts.getAuthStatus();
Allowed values 

After synchronization, the parameter must hold one of the following values. 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.

Constant Value Description
UlDefnUL_AUTH_STATUS_UNKNOWN 0 Authorization status is unknown, possibly because the connection has not yet synchronized.
UlDefnUL_AUTH_STATUS_VALID 1000 User ID and password were valid at the time of synchronization.
UlDefnUL_AUTH_STATUS_VALID_BUT_EXPIRES_SOON 2000 User ID and password were valid at thetime of synchronization but will expire soon.
UlDefnUL_AUTH_STATUS_EXPIRED 3000 Authorization failed: user ID or password have expired.
UlDefnUL_AUTH_STATUS_INVALID 4000 Authorization failed: bad user ID or password.
UlDefnUL_AUTH_STATUS_IN_USE 5000 Authorization failed: user ID is already in use.
See also 

Authenticating MobiLink Users.


Contents Index auth_parms parameter auth_value synchronization parameter