1 /* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.content; 18 19 import android.os.Bundle; 20 import android.os.RemoteException; 21 import android.accounts.Account; 22 23 /** 24 * @hide 25 */ 26 public abstract class SyncAdapter { 27 private static final String TAG = "SyncAdapter"; 28 29 /** Kernel event log tag. Also listed in data/etc/event-log-tags. */ 30 public static final int LOG_SYNC_DETAILS = 2743; 31 32 class Transport extends ISyncAdapter.Stub { startSync(ISyncContext syncContext, String authority, Account account, Bundle extras)33 public void startSync(ISyncContext syncContext, String authority, Account account, 34 Bundle extras) throws RemoteException { 35 SyncAdapter.this.startSync(new SyncContext(syncContext), account, authority, extras); 36 } 37 cancelSync(ISyncContext syncContext)38 public void cancelSync(ISyncContext syncContext) throws RemoteException { 39 SyncAdapter.this.cancelSync(); 40 } 41 } 42 43 Transport mTransport = new Transport(); 44 45 /** 46 * Get the Transport object. 47 */ getISyncAdapter()48 public final ISyncAdapter getISyncAdapter() 49 { 50 return mTransport; 51 } 52 53 /** 54 * Initiate a sync for this account. SyncAdapter-specific parameters may 55 * be specified in extras, which is guaranteed to not be null. IPC invocations 56 * of this method and cancelSync() are guaranteed to be serialized. 57 * 58 * @param syncContext the ISyncContext used to indicate the progress of the sync. When 59 * the sync is finished (successfully or not) ISyncContext.onFinished() must be called. 60 * @param account the account that should be synced 61 * @param authority the authority if the sync request 62 * @param extras SyncAdapter-specific parameters 63 */ startSync(SyncContext syncContext, Account account, String authority, Bundle extras)64 public abstract void startSync(SyncContext syncContext, Account account, String authority, 65 Bundle extras); 66 67 /** 68 * Cancel the most recently initiated sync. Due to race conditions, this may arrive 69 * after the ISyncContext.onFinished() for that sync was called. IPC invocations 70 * of this method and startSync() are guaranteed to be serialized. 71 */ cancelSync()72 public abstract void cancelSync(); 73 } 74