FileDocCategorySizeDatePackage
CookieSyncManager.javaAPI DocAndroid 5.1 API5159Thu Mar 12 22:22:10 GMT 2015android.webkit

CookieSyncManager

public final class CookieSyncManager extends WebSyncManager
The CookieSyncManager is used to synchronize the browser cookie store between RAM and permanent storage. To get the best performance, browser cookies are saved in RAM. A separate thread saves the cookies between, driven by a timer.

To use the CookieSyncManager, the host application has to call the following when the application starts: 

CookieSyncManager.createInstance(context)

To set up for sync, the host application has to call

CookieSyncManager.getInstance().startSync()

in Activity.onResume(), and call 

CookieSyncManager.getInstance().stopSync()

in Activity.onPause().

To get instant sync instead of waiting for the timer to trigger, the host can call 

CookieSyncManager.getInstance().sync()

The sync interval is 5 minutes, so you will want to force syncs manually anyway, for instance in {@link WebViewClient#onPageFinished}. Note that even sync() happens asynchronously, so don't do it just as your activity is shutting down.

deprecated
The WebView now automatically syncs cookies as necessary. You no longer need to create or use the CookieSyncManager. To manually force a sync you can use the CookieManager method {@link CookieManager#flush} which is a synchronous replacement for {@link #sync}.

Fields Summary
private static CookieSyncManager
sRef
private static boolean
sGetInstanceAllowed
Constructors Summary
private CookieSyncManager()


      
        super(null, null);
Methods Summary
private static voidcheckInstanceIsAllowed()

        // Prior to Android KK, calling createInstance() or constructing a WebView is
        // a hard pre-condition for calling getInstance(). We retain that contract to aid
        // developers targeting a range of SDK levels.
        if (!sGetInstanceAllowed) {
            throw new IllegalStateException(
                    "CookieSyncManager::createInstance() needs to be called "
                            + "before CookieSyncManager::getInstance()");
        }
public static synchronized android.webkit.CookieSyncManagercreateInstance(android.content.Context context)
Create a singleton CookieSyncManager within a context

param
context
return
CookieSyncManager

        if (context == null) {
            throw new IllegalArgumentException("Invalid context argument");
        }
        setGetInstanceIsAllowed();
        return getInstance();
public static synchronized android.webkit.CookieSyncManagergetInstance()
Singleton access to a {@link CookieSyncManager}. An IllegalStateException will be thrown if {@link CookieSyncManager#createInstance(Context)} is not called before.

return
CookieSyncManager

        checkInstanceIsAllowed();
        if (sRef == null) {
            sRef = new CookieSyncManager();
        }
        return sRef;
public voidresetSync()
resetSync() resets sync manager's timer.

deprecated
Calling resetSync is no longer necessary as the WebView automatically syncs cookies.
static voidsetGetInstanceIsAllowed()

        sGetInstanceAllowed = true;
public voidstartSync()
startSync() requests sync manager to start sync.

deprecated
Calling startSync is no longer necessary as the WebView automatically syncs cookies.
public voidstopSync()
stopSync() requests sync manager to stop sync. remove any SYNC_MESSAGE in the queue to break the sync loop

deprecated
Calling stopSync is no longer useful as the WebView automatically syncs cookies.
public voidsync()
sync() forces sync manager to sync now

deprecated
Use {@link CookieManager#flush} instead.

        CookieManager.getInstance().flush();
protected voidsyncFromRamToFlash()

deprecated
Use {@link CookieManager#flush} instead.

        CookieManager.getInstance().flush();