com.unvired.sync

Class SyncEngine

java.lang.Object

com.unvired.sync.SyncEngine

public class SyncEngine
extends java.lang.Object

SyncEngine is responsible for exchanging data between the mobile application on the device and the server. SyncEngine can be used for the following:

• Exchange data both synchronously and asynchronously.
• Register for push notifications.
• Register a custom data handler to interrupt the incoming data from the server and process it in the application layer. This is required to override standard synchronization behaviour.

Data Exchange / Communication

Exchange of data between the mobile application on the device and the server can be done both synchronously and asynchronously. Communication Synchronous and asynchronous communication behave as follows:

• Synchronous:

  Exchange of data between the mobile application on the device and the server is done in one request-response cycle. Synchronous communication requires an active connection between the mobile application on the device and the server (and in turn to the enterprise backend system, if required). Synchronous communication is a blocking call. The response to the request is either auto saved or provided to the caller for further processing and storing data to the database, if required.

• Asynchronous:

  Exchange of data between the mobile application on the device and the server is done in two request-response cycles. Data from the mobile application on the device is queued to be the sent to the server. When the connectivity to the server is available the data is submitted to the server. Server responds with an acknowledgment. Server submits the data to the backend system. Once the response is available from the backend server the response is pushed / sent to the mobile application on the device. Once the data is sent to the mobile application on the device the data is stored in the database. Asynchronous communication allows users to use the application in a non-blocking manner without bothering about connectivity. Also the server can submit the data from the mobile application on the device to the backend server in a delayed manner to accommodate backend server load.

Method Summary

Modifier and Type	Method and Description
void	cancelHttpConnection(com.unvired.sync.out.ISyncAppCallback appCallback)
static void	destroy()
CustomDataHandler	getCustomDataHandler() Gets the registered custom data handler.
static SyncEngine	getInstance() Gets the single instance of SyncEngine.
boolean	getIsInDemoMode()
java.util.Hashtable<java.lang.String,java.lang.String>	getMobileApplicationSettings()
IDataStructure[]	getMobileUserSettings()
com.unvired.utils.NetworkChangeReceiver	getNetworkChangeReceiver()
NotificationListener	getNotificationListener()
com.unvired.sync.in.IConflictHandler	getSyncConflictHandler()
com.unvired.sync.notifier.SynchronizationStateListener	getSynchronizationStateListener()
void	initialize()
boolean	isInOutbox(java.lang.String beLid)
boolean	isInSentItems(java.lang.String beLid)
void	queuePushNotificationTestMessage()
void	receiveData()
void	registerCustomDataHandler(CustomDataHandler customDataHandler) Registers a custom data handler for callback.
void	registerDataRequestFunctionCallHandler(com.unvired.sync.in.DataRequestFunctionCallHandler dataRequestFunctionCallHandler)
void	registerNotificationListener(NotificationListener notificationListener) Registers a notification listener.
void	registerSyncConflictHandler(com.unvired.sync.in.IConflictHandler syncConflictHandler)
void	registerSynchronizationStateListener(com.unvired.sync.notifier.SynchronizationStateListener synchronizationStateListener) Registers a Synchronization State Listener.
void	resendDataInAsyncMode(com.unvired.model.OutObject outObject)
void	resubmitInAsyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType, IDataStructure dataStructure, java.lang.String customData, java.lang.String processAgentFunctionName, java.lang.String beName, java.lang.String beLid, boolean byPassAttachment) Resent data is same as send data in async mode #resubmitInAsyncMode(MESSAGE_REQUEST_TYPE, IDataStructure, String, String, String, String, boolean) has been sent to the server has resulted in an error then it can be resent using this method.
void	sendAttachmentToServerAsync(com.unvired.model.AttachmentOutObject attachmentOutObject) Do not use.
void	sendDataRequest(java.lang.String functionName, java.lang.String inputData) Request data for the given process agent function which is marked for pulling data from the backend servers.
void	sendDataRequestForAllFunctions() Request data for all process agent functions which are marked for pulling data from the backend servers.
void	sendDataRequests(java.util.Vector<java.lang.String> functions)
void	sendPushNotificationIdToServer(java.lang.String pushNotificationId)
void	sendToServerAsync(com.unvired.model.OutObject outObject) Do not use.
void	sendToServerSync(com.unvired.model.OutObject outObject) Do not use.
void	setMobileUserSettings(IDataStructure[] userSettingsDataStructures)
void	submitInAsyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType, IDataStructure dataStructure, java.lang.String customData, java.lang.String processAgentFunctionName, java.lang.String beName, java.lang.String beLid, boolean byPassAttachment) Exchange data with the server in asynchronous mode.
void	submitInSyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType, IDataStructure dataStructure, java.lang.String customData, java.lang.String processAgentFunctionName, boolean autoSave, com.unvired.sync.out.ISyncAppCallback appCallback) Exchange data with the server in synchronous mode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIsInDemoMode

public boolean getIsInDemoMode()

getInstance

public static SyncEngine getInstance()

Gets the single instance of SyncEngine.

Returns:

Returns an instance of SynEngine.

destroy

public static void destroy()

initialize

public void initialize()

getNetworkChangeReceiver

public com.unvired.utils.NetworkChangeReceiver getNetworkChangeReceiver()

registerCustomDataHandler

public void registerCustomDataHandler(CustomDataHandler customDataHandler)

Registers a custom data handler for callback. For asynchronous incoming data to the mobile device a custom data handler can be used to interrupt and handle data in the application layer. The synchronization layer calls back the registered custom data handler to provide the incoming data fromm the server.

Parameters:

customDataHandler - Custom data handler for call back

getCustomDataHandler

public CustomDataHandler getCustomDataHandler()

Gets the registered custom data handler.

Returns:

Returns the registered custom data handler, if a custom data handler is registered. Otherwise a null is returned.

registerSyncConflictHandler

public void registerSyncConflictHandler(com.unvired.sync.in.IConflictHandler syncConflictHandler)

getSyncConflictHandler

public com.unvired.sync.in.IConflictHandler getSyncConflictHandler()

registerNotificationListener

public void registerNotificationListener(NotificationListener notificationListener)

Registers a notification listener. Notification listener informs the application via call back about important events like the arrival of new data, push notifications, errors, exceptions, etc.

Parameters:

notificationListener - Set the Notification Listener

getNotificationListener

public NotificationListener getNotificationListener()

registerSynchronizationStateListener

public void registerSynchronizationStateListener(com.unvired.sync.notifier.SynchronizationStateListener synchronizationStateListener)

Registers a Synchronization State Listener. Listener informs the application via call back about important events like sending Outbox items, processing Inbox items, receiving data, waiting for network connection, being idle.

Parameters:

synchronizationStateListener -

getSynchronizationStateListener

public com.unvired.sync.notifier.SynchronizationStateListener getSynchronizationStateListener()

receiveData

public void receiveData()

resubmitInAsyncMode

public void resubmitInAsyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType,
                                IDataStructure dataStructure,
                                java.lang.String customData,
                                java.lang.String processAgentFunctionName,
                                java.lang.String beName,
                                java.lang.String beLid,
                                boolean byPassAttachment)
                         throws ApplicationException

Resent data is same as send data in async mode #resubmitInAsyncMode(MESSAGE_REQUEST_TYPE, IDataStructure, String, String, String, String, boolean) has been sent to the server has resulted in an error then it can be resent using this method.

Parameters:

dataStructure - Data structure to be sent to the server

processAgentFunctionName - Name of the process agent that is required to be called in the server

byPassAttachment - Flag to indicate if attachment bypass is required.Pass true if attachment bypass is required and false otherwise.

Throws:

ApplicationException - Throws ApplicationException if there is a failure while queuing the data.

resendDataInAsyncMode

public void resendDataInAsyncMode(com.unvired.model.OutObject outObject)
                           throws ApplicationException,
                                  DBException

Throws:

ApplicationException

DBException

sendToServerAsync

public void sendToServerAsync(com.unvired.model.OutObject outObject)
                       throws ApplicationException,
                              DBException

Do not use. Internal method for Unvired only.

Parameters:

outObject -

Throws:

ApplicationException

DBException

sendAttachmentToServerAsync

public void sendAttachmentToServerAsync(com.unvired.model.AttachmentOutObject attachmentOutObject)
                                 throws ApplicationException

Do not use. Internal method for Unvired only.

Parameters:

attachmentOutObject -

Throws:

ApplicationException

submitInSyncMode

public void submitInSyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType,
                             IDataStructure dataStructure,
                             java.lang.String customData,
                             java.lang.String processAgentFunctionName,
                             boolean autoSave,
                             com.unvired.sync.out.ISyncAppCallback appCallback)
                      throws ApplicationException,
                             DBException

Exchange data with the server in synchronous mode. Synchronous communication requires an active connection between the mobile application on the device and the server (and in turn to the enterprise backend system, if required). Synchronous communication is a blocking call till is response is obtained.

Use this method for 0:n BE exchange with the server i.e. for search / query scenarios. Input for the server process agent is optional. Process agents on the server can send 0 to n BEs.

If autoSave is true the data is auto saved in the database.

The response of this method is ISyncResponse. The response can either be SyncBEResponse or SyncRawResponse.

SyncBEResponse is provided as the response when the output data format is IBXML / standard data format. The data BEs in SyncBEResponse is saved automatically if autoSave flag is enabled. Otherwise the data BEs are provided to the caller for action.

SyncRawResponse is provided as the response when the output data format is custom.

Parameters:

requestType - MESSAGE_REQUEST_TYPE(RQST/PULL/PUSH/QUERY) to be sent to the server.

customData - customData Custom data that has to be sent to the server. Data can be in any format (as decided during the data modeling).

dataStructure - Data structure to be sent to the server.

processAgentFunctionName - Name of the process agent that is required to be called in the server.

autoSave - Flag to indicate if auto save is required.Pass true if auto save is required and flase otherwise.

Throws:

ApplicationException - Throws ApplicationException if there is a failure while queuing the data.

DBException - Throws a DBException is the relevant data cannot be accesses from the database.

submitInAsyncMode

public void submitInAsyncMode(SyncConstants.MESSAGE_REQUEST_TYPE requestType,
                              IDataStructure dataStructure,
                              java.lang.String customData,
                              java.lang.String processAgentFunctionName,
                              java.lang.String beName,
                              java.lang.String beLid,
                              boolean byPassAttachment)
                       throws ApplicationException,
                              DBException

Exchange data with the server in asynchronous mode. Add the data to the queue to be sent to the server. Exchange of data between the mobile application on the device and the server is done in two request-response cycles. Data from the mobile application on the device is queued to be the sent to the server. When the connectivity to the server is available the data is submitted to the server. Server responds with an acknowledgment. Server submits the data to the backend system. Once the response is available from the backend server the response is pushed / sent to the mobile application on the device. Once the data is sent to the mobile application on the device the data is stored in the database. Asynchronous communication allows users to use the application in a non-blocking manner without bothering about connectivity. Also the server can submit the data from the mobile application on the device to the backend server in a delayed manner to accommodate backend server load.

Use this method for 1:1 BE exchange with the server i.e. for create and update scenarios. Send one BE and get back one BE. Once the data is response is got back from the server the data is auto saved and the application is notified using the NotificationListener implementation registered by the application.

Parameters:

requestType - MESSAGE_REQUEST_TYPE(RQST/PULL/PUSH/QUERY) to be sent to the server.

dataStructure - Data structure to be sent to the server.

customData - customData Custom data that has to be sent to the server. Data can be in any format (as decided during the data modeling).

processAgentFunctionName - Name of the process agent that is required to be called in the server.

beName - String

beLid - Long

byPassAttachment - Flag to indicate if attachment bypass is required.Pass true if attachment bypass is required and false otherwise.

Throws:

ApplicationException - Throws ApplicationException if there is a failure while queuing the data.

DBException - Throws a DBException is the relevant data cannot be accesses from the database.

sendToServerSync

public void sendToServerSync(com.unvired.model.OutObject outObject)
                      throws ApplicationException,
                             DBException

Do not use. Internal method for Unvired only.

Parameters:

outObject -

Throws:

ApplicationException

DBException

isInOutbox

public boolean isInOutbox(java.lang.String beLid)
                   throws ApplicationException

Throws:

ApplicationException

isInSentItems

public boolean isInSentItems(java.lang.String beLid)
                      throws ApplicationException

Throws:

ApplicationException

sendDataRequestForAllFunctions

public void sendDataRequestForAllFunctions()
                                    throws ApplicationException,
                                           DBException

Request data for all process agent functions which are marked for pulling data from the backend servers. Once the server receives the request the server queues the request for data for all the process agent functions. Once the data is available the data is posted back to the mobile application on the device asynchronously.

Throws:

ApplicationException - Throws ApplicationException if there is a failure while requesting the data.

DBException

registerDataRequestFunctionCallHandler

public void registerDataRequestFunctionCallHandler(com.unvired.sync.in.DataRequestFunctionCallHandler dataRequestFunctionCallHandler)

sendDataRequests

public void sendDataRequests(java.util.Vector<java.lang.String> functions)
                      throws ApplicationException,
                             DBException

Throws:

ApplicationException

DBException

sendDataRequest

public void sendDataRequest(java.lang.String functionName,
                            java.lang.String inputData)
                     throws ApplicationException,
                            DBException

Request data for the given process agent function which is marked for pulling data from the backend servers. Once the server receives the request the server queues the request for data for the required process agent function. Once the data is available the data is posted back to the mobile application on the device asynchronously.

Parameters:

functionName - Process agent function name required to run in the server

inputData - Input data for the process agent function, if the process agent function take input (Optional).

Throws:

ApplicationException - Throws ApplicationException if there is a failure while requesting the data.

DBException - the dB exception

sendPushNotificationIdToServer

public void sendPushNotificationIdToServer(java.lang.String pushNotificationId)
                                    throws ApplicationException,
                                           DBException

Throws:

ApplicationException

DBException

getMobileApplicationSettings

public java.util.Hashtable<java.lang.String,java.lang.String> getMobileApplicationSettings()

getMobileUserSettings

public IDataStructure[] getMobileUserSettings()

setMobileUserSettings

public void setMobileUserSettings(IDataStructure[] userSettingsDataStructures)

cancelHttpConnection

public void cancelHttpConnection(com.unvired.sync.out.ISyncAppCallback appCallback)

queuePushNotificationTestMessage

public void queuePushNotificationTestMessage()