com.cloudant.sync.replication

Class ReplicationService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.cloudant.sync.replication.ReplicationService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, ReplicationPolicyManager.ReplicationsCompletedListener

Direct Known Subclasses:

PeriodicReplicationService

public abstract class ReplicationService
extends android.app.Service
implements ReplicationPolicyManager.ReplicationsCompletedListener

This abstract class forms the basis for creating replication policies on Android. The replications run in a Service so that they can properly manage the lifecycle and handle being killed or restarted by the operating system

API Status: Public

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ReplicationService.LocalBinder
static interface	ReplicationService.ReplicationCompleteListener
static class	ReplicationService.SimpleReplicationCompleteListener A simple ReplicationService.ReplicationCompleteListener to save clients having to override every method if they are only interested in a subset of the events.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_NONE
static int	COMMAND_START_REPLICATION
static int	COMMAND_STOP_REPLICATION
static java.lang.String	EXTRA_COMMAND
static java.lang.String	EXTRA_INTENT

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, AUDIO_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, INPUT_METHOD_SERVICE, KEYGUARD_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MODE_APPEND, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NFC_SERVICE, NOTIFICATION_SERVICE, POWER_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELEPHONY_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, UI_MODE_SERVICE, USB_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
ReplicationService()

Method Summary

Modifier and Type	Method and Description
void	addListener(ReplicationService.ReplicationCompleteListener listener) Add a listener to the set of ReplicationService.ReplicationCompleteListeners that are notified when replications complete.
void	allReplicationsCompleted()
android.os.IBinder	onBind(android.content.Intent intent)
void	onCreate()
void	onRebind(android.content.Intent intent)
int	onStartCommand(android.content.Intent intent, int flags, int startId)
boolean	onUnbind(android.content.Intent intent)
void	removeListener(ReplicationService.ReplicationCompleteListener listener) Remove a listener from the set of ReplicationService.ReplicationCompleteListeners that are notified when replications complete.
void	replicationCompleted(int id)
void	replicationErrored(int id)
void	setOperationStartedListener(com.cloudant.sync.replication.ReplicationService.OperationStartedListener listener) Set a listener to be notified when an operation has started.
void	setReplicationPolicyManager(ReplicationPolicyManager replicationPolicyManager) Set the ReplicationPolicyManager to be used by this ReplicationService.
void	setReplicators(Replicator[] replicators) Set the Replicator objects configured to perform the required replications.

Methods inherited from class android.app.Service

getApplication, onConfigurationChanged, onDestroy, onLowMemory, onStart, onTaskRemoved, onTrimMemory, startForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalFilesDir, getFilesDir, getFileStreamPath, getMainLooper, getObbDir, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, revokeUriPermission, sendBroadcast, sendBroadcast, sendOrderedBroadcast, sendOrderedBroadcast, sendStickyBroadcast, sendStickyOrderedBroadcast, setTheme, setWallpaper, setWallpaper, startActivities, startActivity, startInstrumentation, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_INTENT

public static final java.lang.String EXTRA_INTENT

See Also:

Constant Field Values

EXTRA_COMMAND

public static final java.lang.String EXTRA_COMMAND

See Also:

Constant Field Values

COMMAND_NONE

public static final int COMMAND_NONE

See Also:

Constant Field Values

COMMAND_START_REPLICATION

public static final int COMMAND_START_REPLICATION

See Also:

Constant Field Values

COMMAND_STOP_REPLICATION

public static final int COMMAND_STOP_REPLICATION

See Also:

Constant Field Values

Constructor Detail

ReplicationService

public ReplicationService()

Method Detail

onCreate

public void onCreate()

Overrides:

onCreate in class android.app.Service

setReplicators

public void setReplicators(Replicator[] replicators)

Set the Replicator objects configured to perform the required replications. The ReplicationService will not begin replications until this method has been called. This operation should only be called once.

Parameters:

replicators - An array of the configured Replicator objects.

Throws:

java.lang.IllegalArgumentException - if replicators is null or empty.

java.lang.IllegalStateException - if called again after a previous call to this method with a valid array of Replicator objects.

onStartCommand

public int onStartCommand(android.content.Intent intent,
                          int flags,
                          int startId)

Overrides:

onStartCommand in class android.app.Service

onBind

public android.os.IBinder onBind(android.content.Intent intent)

Specified by:

onBind in class android.app.Service

onUnbind

public boolean onUnbind(android.content.Intent intent)

Overrides:

onUnbind in class android.app.Service

onRebind

public void onRebind(android.content.Intent intent)

Overrides:

onRebind in class android.app.Service

setReplicationPolicyManager

public void setReplicationPolicyManager(ReplicationPolicyManager replicationPolicyManager)

Set the ReplicationPolicyManager to be used by this ReplicationService.

Parameters:

replicationPolicyManager -

allReplicationsCompleted

public void allReplicationsCompleted()

Specified by:

allReplicationsCompleted in interface ReplicationPolicyManager.ReplicationsCompletedListener

replicationCompleted

public void replicationCompleted(int id)

Specified by:

replicationCompleted in interface ReplicationPolicyManager.ReplicationsCompletedListener

replicationErrored

public void replicationErrored(int id)

Specified by:

replicationErrored in interface ReplicationPolicyManager.ReplicationsCompletedListener

addListener

public void addListener(ReplicationService.ReplicationCompleteListener listener)

Add a listener to the set of ReplicationService.ReplicationCompleteListeners that are notified when replications complete.

Parameters:

listener - The listener to add.

removeListener

public void removeListener(ReplicationService.ReplicationCompleteListener listener)

Remove a listener from the set of ReplicationService.ReplicationCompleteListeners that are notified when replications complete.

Parameters:

listener - The listener to remove.

setOperationStartedListener

public void setOperationStartedListener(com.cloudant.sync.replication.ReplicationService.OperationStartedListener listener)

Set a listener to be notified when an operation has started.

Parameters:

listener - The listener to add