oracle.cloud.mobile.sync

Class Synchronization

java.lang.Object

ServiceProxy

oracle.cloud.mobile.sync.Synchronization

public final class Synchronization
extends ServiceProxy

The main class for the Synchronization service implementation. Contains methods to make requests and manipulate the cache.

Constructor Summary

Constructors

Constructor and Description
Synchronization()

Method Summary

Modifier and Type	Method and Description
void	cachedResourceChanged(SyncResourceUpdatedCallback callback) Event that is raised every time a cached resource is updated with new data from the service.
int	cacheHitCount() Get the cache Hit Count
int	cacheMissCount() Get the cache miss count
void	discardOfflineUpdates(SyncDiscardOfflineResourceCallback callback) Discards all offline/local edits for all the resources which are not yet successfully synchronized with server.
void	evictResource(java.lang.String uri) Evict the cached item specified by the input URL.
HttpConnection	getConnection(java.lang.String url) Returns the HTTP connection for the provided resource URL.
SyncNetworkStatus	getNetworkStatus() Gets device network status which is currently being used by Synchronization.
void	loadOfflineResources(SyncLocalLoadingCallback callback) Returns a list of all MobileResource objects that were updated offline/locally, and not yet successfully synchronized with the server.
void	offlineResourceSynchronized(SyncResourceUpdatedCallback callback) Event that is raised every time an offline resource is synchronized.
MobileEndpoint	openMobileEndpoint(java.lang.String apiName, java.lang.String endpointPath, java.lang.Class mobileClass) Returns an object that provides access to an endpoint in a custom API.
void	purge() Clears the cache by deleting all database tables that were created when a MobileEndpoint object was instantiated.
void	requestWithUri(java.lang.String uri, RequestMethod method, SyncPolicy policy, java.util.Map<java.lang.String,java.lang.String> requestHeaders, byte[] body, SynchronizationCallback callback) Allows you to perform GET/PUT/POST/DELETE on a resource.
void	setOfflineMode(boolean isOffline) Sets the device to offline mode, which is good for testing.
void	synchronizePinnedResource(boolean backgroundSync) Synchronizes all pinned resources with their mobile backends.

Methods inherited from class java.lang.Object

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

Constructor Detail

Synchronization

public Synchronization()

Method Detail

requestWithUri

public void requestWithUri(java.lang.String uri,
                           RequestMethod method,
                           SyncPolicy policy,
                           java.util.Map<java.lang.String,java.lang.String> requestHeaders,
                           byte[] body,
                           SynchronizationCallback callback)
                    throws java.lang.Exception

Allows you to perform GET/PUT/POST/DELETE on a resource. Request is sent to server or cache, depending on policy settings.

Parameters:

uri - The URI to send the request to

method - (optional) RequestMethod value. If not explicitly set, it will be GET

policy - (optional) SyncPolicy object containing all policy settings

requestHeaders - (optional) Map containing extra HTTP headers to support request

body - (optional) HTTP request body data; 'null' when there's no data

callback - SynchronizationCallback object used to return result when request completes

Throws:

java.lang.Exception

openMobileEndpoint

public MobileEndpoint openMobileEndpoint(java.lang.String apiName,
                                         java.lang.String endpointPath,
                                         java.lang.Class mobileClass)

Returns an object that provides access to an endpoint in a custom API.

Parameters:

apiName - The name of the API

endpointPath - The endpoint in the API

mobileClass - The type of objects that the API exposes

Returns:

A MobileEndpoint object to access the API endpoint

getConnection

public HttpConnection getConnection(java.lang.String url)
                             throws java.io.IOException,
                                    java.lang.InterruptedException

Returns the HTTP connection for the provided resource URL.

Parameters:

url - resource URL

Returns:

HTTP connection object

Throws:

java.io.IOException

java.lang.InterruptedException

purge

public void purge()
           throws java.io.IOException,
                  java.lang.InterruptedException

Clears the cache by deleting all database tables that were created when a MobileEndpoint object was instantiated. If this method is called, then re-instantiate (re-initialize) all MobileEndpoints objects to recreate the database tables.

Throws:

java.io.IOException

java.lang.InterruptedException

evictResource

public void evictResource(java.lang.String uri)
                   throws java.io.IOException,
                          java.lang.InterruptedException

Evict the cached item specified by the input URL.

Parameters:

uri - resource uri

Throws:

java.io.IOException

java.lang.InterruptedException

cacheHitCount

public int cacheHitCount()

Get the cache Hit Count

Returns:

Cache Hit Count

cacheMissCount

public int cacheMissCount()

Get the cache miss count

Returns:

Cache Miss Count

synchronizePinnedResource

public void synchronizePinnedResource(boolean backgroundSync)

Synchronizes all pinned resources with their mobile backends.

Parameters:

backgroundSync - to specify for background mode sync.

loadOfflineResources

public void loadOfflineResources(SyncLocalLoadingCallback callback)

Returns a list of all MobileResource objects that were updated offline/locally, and not yet successfully synchronized with the server.

Parameters:

callback - SyncLocalLoadingCallback object used to return result when request completes

discardOfflineUpdates

public void discardOfflineUpdates(SyncDiscardOfflineResourceCallback callback)

Discards all offline/local edits for all the resources which are not yet successfully synchronized with server. Persistent state of the resources will remain the same in the cache.

getNetworkStatus

public SyncNetworkStatus getNetworkStatus()

Gets device network status which is currently being used by Synchronization.

Returns:

SyncNetworkStatus enum representing device network status

setOfflineMode

public void setOfflineMode(boolean isOffline)

Sets the device to offline mode, which is good for testing. If the device is in real offline mode, then this setting will be ignored.

Parameters:

isOffline - boolean value which allows you to set the device online or offline

offlineResourceSynchronized

public void offlineResourceSynchronized(SyncResourceUpdatedCallback callback)

Event that is raised every time an offline resource is synchronized.

Parameters:

callback - SyncResourceUpdatedCallback object used to return result when request completes. This is called for each offline resource which is synchronized with the service

cachedResourceChanged

public void cachedResourceChanged(SyncResourceUpdatedCallback callback)

Event that is raised every time a cached resource is updated with new data from the service.

Parameters:

callback - SyncResourceUpdatedCallback object used to return result when request completes. This is called for each cache resource for which the latest data is updated from service