com.feedhenry.sdk.sync

Class FHSyncClient

java.lang.Object

com.feedhenry.sdk.sync.FHSyncClient

public class FHSyncClient
extends Object

The sync client is part of the FeedHenry data sync framework. It provides a mechanism to manage bi-direction data synchronization. For more details, please check data sync framework docs.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LOG_TAG

Constructor Summary

Constructors

Constructor and Description
FHSyncClient()

Method Summary

Methods

Modifier and Type	Method and Description
JSONObject	create(String pDataId, JSONObject pData) Creates a new data record in dataset with pDataId.
JSONObject	delete(String pDataId, String pUID) Deletes a data record in the dataset with pDataId.
void	destroy() Stops all sync processes for all the datasets managed by the sync client.
void	forceSync(String pDataId) Causes the sync framework to schedule for immediate execution a sync.
static FHSyncClient	getInstance() Gets the singleton instance of the sync client.
void	init(android.content.Context pContext, FHSyncConfig pConfig, FHSyncListener pListener) Initializes the sync client.
JSONObject	list(String pDataId) Lists all the data in the dataset with pDataId.
void	listCollisions(String pDataId, FHActCallback pCallback) Lists sync collisions in dataset with id pDataId.
void	manage(String pDataId, FHSyncConfig pConfig, JSONObject pQueryParams) Uses the sync client to manage a dataset.
void	manage(String pDataId, FHSyncConfig pConfig, JSONObject pQueryParams, JSONObject pMetaData) Uses the sync client to manage a dataset.
void	pauseSync() This method will pause synchronization.
JSONObject	read(String pDataId, String pUID) Reads a data record with pUID in dataset with pDataId.
void	removeCollision(String pDataId, String pCollisionHash, FHActCallback pCallback) Removes a sync collision record in the dataset with id pDataId.
void	resumeSync(FHSyncListener listener) This method will begin synchronization.
void	setListener(FHSyncListener pListener) Re-sets the sync listener.
void	stop(String pDataId) Stops the sync process for dataset with id pDataId.
JSONObject	update(String pDataId, String pUID, JSONObject pData) Updates an existing data record in dataset with pDataId.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final String LOG_TAG

See Also:

Constant Field Values

Constructor Detail

FHSyncClient

public FHSyncClient()

Method Detail

getInstance

public static FHSyncClient getInstance()

Gets the singleton instance of the sync client.

Returns:

the sync client instance

init

public void init(android.content.Context pContext,
        FHSyncConfig pConfig,
        FHSyncListener pListener)

Initializes the sync client. Should be called every time an app/activity starts.

Parameters:

pContext - The app context

pConfig - The sync configuration

pListener - The sync listener

setListener

public void setListener(FHSyncListener pListener)

Re-sets the sync listener.

Parameters:

pListener - the new sync listener

manage

public void manage(String pDataId,
          FHSyncConfig pConfig,
          JSONObject pQueryParams)

Uses the sync client to manage a dataset.

Parameters:

pDataId - The id of the dataset.

pConfig - The sync configuration for the dataset. If not specified, the sync configuration passed in the initDev method will be used

pQueryParams - Query parameters for the dataset

Throws:

IllegalStateException - thrown if FHSyncClient isn't initialised.

manage

public void manage(String pDataId,
          FHSyncConfig pConfig,
          JSONObject pQueryParams,
          JSONObject pMetaData)

Uses the sync client to manage a dataset.

Parameters:

pDataId - The id of the dataset.

pConfig - The sync configuration for the dataset. If not specified, the sync configuration passed in the initDev method will be used

pQueryParams - Query parameters for the dataset

pMetaData - Meta for the dataset

Throws:

IllegalStateException - thrown if FHSyncClient isn't initialised.

forceSync

public void forceSync(String pDataId)

Causes the sync framework to schedule for immediate execution a sync.

Parameters:

pDataId - The id of the dataset

list

public JSONObject list(String pDataId)

Lists all the data in the dataset with pDataId.

Parameters:

pDataId - The id of the dataset

Returns:

all data records. Each record contains a key "uid" with the id value and a key "data" with the JSON data.

read

public JSONObject read(String pDataId,
              String pUID)

Reads a data record with pUID in dataset with pDataId.

Parameters:

pDataId - the id of the dataset

pUID - the id of the data record

Returns:

the data record. Each record contains a key "uid" with the id value and a key "data" with the JSON data.

create

public JSONObject create(String pDataId,
                JSONObject pData)
                  throws DataSetNotFound

Creates a new data record in dataset with pDataId.

Parameters:

pDataId - the id of the dataset

pData - the actual data

Returns:

the created data record. Each record contains a key "uid" with the id value and a key "data" with the JSON data.

Throws:

DataSetNotFound - if the dataId is not known

update

public JSONObject update(String pDataId,
                String pUID,
                JSONObject pData)
                  throws DataSetNotFound

Updates an existing data record in dataset with pDataId.

Parameters:

pDataId - the id of the dataset

pUID - the id of the data record

pData - the new content of the data record

Returns:

the updated data record. Each record contains a key "uid" with the id value and a key "data" with the JSON data.

Throws:

DataSetNotFound - if the dataId is not known

delete

public JSONObject delete(String pDataId,
                String pUID)
                  throws DataSetNotFound

Deletes a data record in the dataset with pDataId.

Parameters:

pDataId - the id of the dataset

pUID - the id of the data record

Returns:

the deleted data record. Each record contains a key "uid" with the id value and a key "data" with the JSON data.

Throws:

DataSetNotFound - if the dataId is not known

listCollisions

public void listCollisions(String pDataId,
                  FHActCallback pCallback)
                    throws FHNotReadyException

Lists sync collisions in dataset with id pDataId.

Parameters:

pDataId - the id of the dataset

pCallback - the callback function

Throws:

FHNotReadyException - if FH is not initialized.

removeCollision

public void removeCollision(String pDataId,
                   String pCollisionHash,
                   FHActCallback pCallback)
                     throws FHNotReadyException

Removes a sync collision record in the dataset with id pDataId.

Parameters:

pDataId - the id of the dataset

pCollisionHash - the hash value of the collision record

pCallback - the callback function

Throws:

FHNotReadyException - thrown if FH is not initialized.

resumeSync

public void resumeSync(FHSyncListener listener)

This method will begin synchronization. It should be called in the Activity.onResume() block.

Parameters:

listener - the listener to. If null the current listener will be used.

pauseSync

public void pauseSync()

This method will pause synchronization. It should be called in the Activity.onPause() block.

stop

public void stop(String pDataId)

Stops the sync process for dataset with id pDataId.

Parameters:

pDataId - the id of the dataset

destroy

public void destroy()

Stops all sync processes for all the datasets managed by the sync client.