universum.studios.android.officium.sync

Class BaseSyncManager

java.lang.Object

universum.studios.android.officium.sync.BaseSyncManager

All Implemented Interfaces:

OnSyncTaskStateChangeListener

public abstract class BaseSyncManager
extends Object
implements OnSyncTaskStateChangeListener

Base class that can be used for implementation of managers responsible for requesting of synchronization operations to be performed. Each implementation of BaseSyncManager can request synchronization only for a single content authority specified during initialization of BaseSyncManager and for a single Account that should be picked by a specific BaseSyncManager implementation whenever pickAccountForSync() is called.

To request synchronization for a specific SyncTask call requestSync(SyncTask) method. If a global synchronization should be performed, call requestGlobalSync(). Base synchronization manager class implements also some configuration methods like to start/stop automatic synchronization via startAutomaticSync() and stopAutomaticSync() or to check whether there are some synchronization operations pending or active via isSyncPedning() and isSyncPedning(). Any additional methods may be freely implemented by the inheritance hierarchies.

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mAuthority Content authority with which has been this manager created.
protected Context	mContext Context with which has been this manager created.

Constructor Summary

Constructors

Constructor and Description
BaseSyncManager(Context context, String authority) Creates a new instance of BaseSyncManager with the given context and authority.

Method Summary

Modifier and Type	Method and Description
void	cancelSync() Cancels any active or pending synchronizations that match the content authority specified for this manager and account picked for synchronization by this manager implementation.
boolean	isSyncActive() Checks whether there is currently a synchronization being processed for the content authority specified for this manager and account picked for synchronization by this manager implementation.
boolean	isSyncPedning() Checks whether there are any pending synchronizations for the content authority specified for this manager and account picked for synchronization by this manager implementation.
protected void	onCancelSync(Account account) Invoked whenever cancelSync() is called.
void	onSyncTaskStateChanged(SyncTask syncTask, Account account) Invoked whenever a state of the specified syncTask has been changed.
protected abstract Account	pickAccountForSync() Called to pick account for the current synchronization related request dispatched to this manager.
void	requestGlobalSync() Same as requestSync(SyncTask) with sync task with SyncTask.DEFAULT_ID id.
void	requestSync(SyncTask syncTask) Requests synchronization operation to be performed for the specified syncTask.
protected boolean	shouldRequestSync(SyncTask syncTask, Account account) Called from requestSync(SyncTask) to check whether a synchronization should be requested for the specified syncTask and account.
void	startAutomaticSync() Starts automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.
void	stopAutomaticSync() Stops automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.

Methods inherited from class java.lang.Object

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

Field Detail

mContext

protected final Context mContext

Context with which has been this manager created.

mAuthority

protected final String mAuthority

Content authority with which has been this manager created. This authority is used to set up all synchronization requests via ContentResolver.

Constructor Detail

BaseSyncManager

public BaseSyncManager(@NonNull
                       Context context,
                       @NonNull
                       String authority)

Creates a new instance of BaseSyncManager with the given context and authority.

Parameters:

context - Context that may be used by inheritance hierarchies to access application data and services needed to perform requested synchronization.

authority - The content authority for which the manager should request synchronization via ContentResolver.requestSync(Account, String, Bundle).

Method Detail

startAutomaticSync

public void startAutomaticSync()

Starts automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.

See Also:

stopAutomaticSync(), ContentResolver.setSyncAutomatically(Account, String, boolean)

stopAutomaticSync

public void stopAutomaticSync()

Stops automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.

See Also:

startAutomaticSync(), ContentResolver.setSyncAutomatically(Account, String, boolean)

requestGlobalSync

public void requestGlobalSync()

Same as requestSync(SyncTask) with sync task with SyncTask.DEFAULT_ID id.

requestSync

public void requestSync(@NonNull
                        SyncTask syncTask)

Requests synchronization operation to be performed for the specified syncTask. Synchronization will be requested for the content authority specified for this manager and account picked for synchronization by this manager implementation.

If there is successfully picked synchronization account, a Bundle for sync adapter is created with the following extras:

• SYNC_EXTRAS_MANUAL: true
• SYNC_EXTRAS_EXPEDITED: true
• SyncTask put into the extras Bundle

Parameters:

syncTask - The desired task for which to request synchronization. This task will be put into Bundle along with other sync extras for the sync adapter registered for this Android application.

See Also:

requestGlobalSync(), ContentResolver.requestSync(Account, String, Bundle)

shouldRequestSync

protected boolean shouldRequestSync(@NonNull
                                    SyncTask syncTask,
                                    @NonNull
                                    Account account)

Called from requestSync(SyncTask) to check whether a synchronization should be requested for the specified syncTask and account.

This implementation returns always true.

Parameters:

syncTask - The sync task for which to check if synchronization should be requested.

account - The account for which to request synchronization.

Returns:

True if requestSync(SyncTask) should proceed and request synchronization via ContentResolver.requestSync(Account, String, Bundle) for the task and account, false otherwise.

See Also:

pickAccountForSync()

onSyncTaskStateChanged

@CallSuper
public void onSyncTaskStateChanged(@NonNull
                                               SyncTask syncTask,
                                               @NonNull
                                               Account account)

Description copied from interface: OnSyncTaskStateChangeListener

Invoked whenever a state of the specified syncTask has been changed.

Specified by:

onSyncTaskStateChanged in interface OnSyncTaskStateChangeListener

Parameters:

syncTask - The task of which state has changed.

account - The account for which has been requested synchronization associated with the sync task.

See Also:

SyncTask.getState()

isSyncActive

public boolean isSyncActive()

Checks whether there is currently a synchronization being processed for the content authority specified for this manager and account picked for synchronization by this manager implementation.

Returns:

True if synchronization is active at this time, false otherwise.

See Also:

ContentResolver.isSyncActive(Account, String), isSyncPedning(), cancelSync()

isSyncPedning

public boolean isSyncPedning()

Checks whether there are any pending synchronizations for the content authority specified for this manager and account picked for synchronization by this manager implementation.

Returns:

True if there are some synchronizations pending, false otherwise.

See Also:

ContentResolver.isSyncPending(Account, String), isSyncActive(), cancelSync()

cancelSync

public void cancelSync()

Cancels any active or pending synchronizations that match the content authority specified for this manager and account picked for synchronization by this manager implementation.

See Also:

ContentResolver.cancelSync(Account, String), isSyncActive(), isSyncPedning()

onCancelSync

protected void onCancelSync(@NonNull
                            Account account)

Invoked whenever cancelSync() is called.

Default implementation cancels current sync via ContentResolver.cancelSync(Account, String) for the specified account and authority specified for this manager.

Parameters:

account - The account picked via pickAccountForSync().

pickAccountForSync

@Nullable
protected abstract Account pickAccountForSync()

Called to pick account for the current synchronization related request dispatched to this manager.

Returns:

Account for which should be performed synchronization request, whether startAutomaticSync(), stopAutomaticSync(), requestGlobalSync(), requestSync(SyncTask), isSyncActive(), isSyncPedning(), cancelSync().