CA ArcotID OTP Java Library Developer's Guide › Understanding ArcotID OTP APIs › Synchronizing the Client and Server › How a Synchronization Request Works

How a Synchronization Request Works

This section explains the sequence of events that take place when a synchronization request is sent to the server. Apply this information while using the syncRequest() method and callback() method in your implementation.

The following events take place when a synchronization request is sent to the server:

1. When the syncRequest() method is invoked the first time, it sends the synchronization request to the server. This request contains the following parameters:
   • ACCOUNT_OBJ
   • CONN_OBJECT (optional)
2. The callback() method is invoked. The parameters returned by this method depend on what happens next:

   Note: The client application must free up the parameters map after each provisionRequest() call and the corresponding callback() call.

   • If the request succeeds, then the callback() method returns the following parameter values:
     • REQUESTTYPE =”softsync”
     • ACCOUNT_OBJ
     • CONN_OBJECT (only if this parameter was sent in the initial request)
     • STATE=DONE
   • If the request fails, then the callback() method returns the following parameter values:
     • REQUESTTYPE=”softsync”
     • ERR_CODE=<error-code>
     • ERR_MSG=<error-message>
     • PLATFORM_MSG=<error-message-returned-by-the-underlying-platform>