com.softwareag.mobile.data.sync

Class DataSynchronization

java.lang.Object

com.softwareag.mobile.data.sync.DataSynchronization

public class DataSynchronization
extends java.lang.Object

This class exposes methods to download data from the server and to perform bidirectional data synchronization between the client and the server.

Constructor Summary

Constructors

Constructor and Description
DataSynchronization()

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup(boolean delLogsonly) Cleans up the logging table and internal tables used by the Mobile Support Client when a mobile application is uninstalled from a mobile device.
ResponseSet	download(java.lang.String mscAlias, Filter filter) Downloads data from the server for synchronization requests associated with a specific mobile sync component and user filter.
java.lang.String[]	getLogs() Returns a String array with all the contents present in the log table.
ResponseSet	sync(RowStructure[] rows, java.lang.String mscAlias) Performs a bidirectional synchronization by uploading data sent by the mobile application and downloading data from the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSynchronization

public DataSynchronization()

Method Detail

download

public ResponseSet download(java.lang.String mscAlias,
                   Filter filter)
                     throws com.softwareag.mobile.data.client.SyncClientException

Downloads data from the server for synchronization requests associated with a specific mobile sync component and user filter. To download all data, set the Filter instance to null.

Parameters:

mscAlias - Mobile sync component name.

filter - Filter Filter criteria defined in the add method of the Filter class. The Mobile Support Client will download the data that matches the values specified in the filter.

Returns:

ResponseSet Response for the data synchronization request.

Throws:

com.softwareag.mobile.data.client.SyncClientException - Handles errors related to data synchronization operations.

- Thrown when the request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.

- Thrown when the application attempts to connect to the server using invalid credentials.

- Thrown when the server has not found a value that matches the Request-URI.

- Thrown when the server encounters an unexpected condition that prevents the server from fulfilling the request.

- Thrown when the server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

- Thrown when the server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI.

See Also:

See HTTP status code descriptions for details.

sync

public ResponseSet sync(RowStructure[] rows,
               java.lang.String mscAlias)
                 throws com.softwareag.mobile.data.client.SyncClientException

Performs a bidirectional synchronization by uploading data sent by the mobile application and downloading data from the server.

Parameters:

mscAlias - Mobile sync component name.

RowStructure Array of RowStructure.

Returns:

ResponseSet Response for the data synchronization request.

Throws:

com.softwareag.mobile.data.client.SyncClientException - - Handles errors related to data synchronization operations.

- Thrown when the request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.

- Thrown when the application attempts to connect to the server using invalid credentials.

- Thrown when the server has not found a value that matches the Request-URI.

- Thrown when the server encounters an unexpected condition that prevented the server from fulfilling the request.

- Thrown when the server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

- Thrown when the server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI.

See Also:

Refer to Http status code for details.

getLogs

public java.lang.String[] getLogs()

Returns a String array with all the contents present in the log table. The caller of this method has the flexibility to display log messages on the screen. This can be useful for debugging purposes.

Returns:

Log table contents in string array format.

cleanup

public void cleanup(boolean delLogsonly)
             throws com.softwareag.mobile.data.client.SyncClientException

Cleans up the logging table and internal tables used by the Mobile Support Client when a mobile application is uninstalled from a mobile device.

Parameters:

delLogsonly - Indicates whether to delete the Log table only (true) or to delete all internal tables created and used by the Mobile Support Client (false).

Throws:

com.softwareag.mobile.data.client.SyncClientException - - Handles errors related to data synchronization operations.

- Thrown when the application encounters a database error while interacting with the device's local database.