Android SyncAdapter

Presented at DaFED Meetup #23

Introduction to SyncAdapter API in Android with an overview of possible use cases.

Transcript

1. Android SyncAdapter What is it and why should we use it
2. Speaker Nemanja Nedić Software developer @ Levi9 IT Services about.me/nemanjanedic
3. What’s the goal?
4. Optimize cell radio usage
5. Optimize cell radio usage
6. Optimize data transfer timing “A good app is like a good butler. It has what you want before you have to ask for it.”
7. How to do this?
8. Optimizing network traffic Minimize the number of the radio state transitions Prefetch data for the next 2-5 minutes (1-5 MB) Batch all non-time critical transfers Bundle non-time critical with critical transfers Eliminate client-side pooling
9. SyncAdapter?
10. SyncAdapter advantages Automated execution Failed transfer queuing Built in connectivity checking Simplified app data transfer bundling and batching Cross device batching and bundling
11. Implementing a SyncAdapter public class SyncAdapter extends AbstractThreadedSyncAdapter { public SyncAdapter(Context context, boolean autoInitialize) { super(context, autoInitialize); } public SyncAdapter(Context context, boolean autoInitialize, boolean allowParallelSyncs) super(context, autoInitialize, allowParallelSyncs); } @Override public void onPerformSync(Account account, Bundle extras, String authority, ContentProviderClient provider, SyncResult syncResult) { //Synchronize your data between client and server } }
12. SyncAdapter service public class SyncService extends Service { private static final Object sSyncAdapterLock = new Object(); private static SyncAdapter sSyncAdapter = null; @Override public void onCreate() { synchronized (sSyncAdapterLock) { if (sSyncAdapter == null) { sSyncAdapter = new SyncAdapter(getApplicationContext(), true); } } } @Override public IBinder onBind(Intent intent) { return sSyncAdapter.getSyncAdapterBinder(); } }
13. Account authenticator public class AccountAuthenticator extends AbstractAccountAuthenticator { public static final String ACCOUNT_TYPE = "rs.dcsw.syncadapterdemo"; public static final String ACCOUNT_NAME = "STUB ACCOUNT"; private final Context mContext; public AccountAuthenticator(Context context) { super(context); mContext = context; } @Override public Bundle addAccount(AccountAuthenticatorResponse response, String accountType, String authTokenType, String[] requiredFeatures, Bundle options) throws NetworkErrorException { AccountManager manager = AccountManager.get(mContext); final Account account = new Account(ACCOUNT_NAME, ACCOUNT_TYPE); return null; } ... }
14. Account authenticator service public class AuthenticationService extends Service { private AccountAuthenticator mAccountAuthenticator; @Override public void onCreate() { mAccountAuthenticator = new AccountAuthenticator(this); } @Override public IBinder onBind(Intent intent) { return mAccountAuthenticator.getIBinder(); } }
15. Account authenticator metadata <?xml version="1.0" encoding="utf-8"?> <account-authenticator xmlns:android="http://schemas.android.com/apk/res/android" android:accountType="rs.dcsw.syncadapterdemo" android:icon="@drawable/ic_launcher" android:label="@string/app_name" android:smallIcon="@drawable/ic_launcher" />
16. Stub content provider public class SyncContentProvider extends ContentProvider { public static final String AUTHORITY = "rs.dcsw.syncadapterdemo.provider"; @Override public boolean onCreate() { return false; } @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { return null; } @Override public Uri insert(Uri uri, ContentValues values) { return null; } @Override public int delete(Uri uri, String selection, String[] selectionArgs) { return 0; } ... }
17. SyncAdapter metadata <?xml version="1.0" encoding="utf-8"?> <sync-adapter xmlns:android="http://schemas.android.com/apk/res/android" android:accountType="rs.dcsw.syncadapterdemo" android:allowParallelSyncs="false" android:contentAuthority="rs.dcsw.syncadapterdemo.provider" android:isAlwaysSyncable="true" android:supportsUploading="false" android:userVisible="false" />
18. Application manifest <provider android:name=".sync.SyncContentProvider" android:authorities="rs.dcsw.syncadapterdemo.provider" android:exported="false" android:syncable="true" />
19. Application manifest <service android:name=".sync.AuthenticationService" android:exported="true"> <intent-filter> <action android:name="android.accounts.AccountAuthenticator" /> </intent-filter> <meta-data android:name="android.accounts.AccountAuthenticator" android:resource="@xml/authenticator" /> </service>
20. Application manifest <service android:name=".sync.SyncService" android:exported="true"> <intent-filter> <action android:name="android.content.SyncAdapter" /> </intent-filter> <meta-data android:name="android.content.SyncAdapter" android:resource="@xml/syncadapter" /> </service>
21. Application manifest <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_SYNC_SETTINGS" /> <uses-permission android:name="android.permission.WRITE_SYNC_SETTINGS" /> <uses-permission android:name="android.permission.AUTHENTICATE_ACCOUNTS" />
22. Triggering a sync When server data changes When device (client) data changes On demand When the system sends out a network message At regular intervals
23. Triggering a sync private void requestSyncAutomatically() { final Account account = new Account(AccountAuthenticator.ACCOUNT_NAME, AccountAuthenticator.ACCOUNT_TYPE); ContentResolver.setSyncAutomatically(account, SyncContentProvider.AUTHORITY, true); }
24. Triggering a sync private void onDemandSync() { final Account account = new Account(AccountAuthenticator.ACCOUNT_NAME, AccountAuthenticator.ACCOUNT_TYPE); ContentResolver.requestSync(account, SyncContentProvider.AUTHORITY, null); }
25. Triggering a sync private void requestPeriodicSync() { final Account account = new Account(AccountAuthenticator.ACCOUNT_NAME, AccountAuthenticator.ACCOUNT_TYPE); long interval = 60 * 60; // one hour ContentResolver.addPeriodicSync(account, SyncContentProvider.AUTHORITY, null, interval); }
26. Where to go next?
27. Next steps Google Cloud Messaging JobScheduler API
28. Questions?
29. Thank you! http://developer.android.com/training/efficient-downloads http://developer.android.com/training/sync-adapters