mobile/android/base/sync/delegates/BaseGlobalSessionCallback.java

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 2 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 4
michael@0 5 package org.mozilla.gecko.sync.delegates;
michael@0 6
michael@0 7 import java.net.URI;
michael@0 8
michael@0 9 import org.mozilla.gecko.sync.GlobalSession;
michael@0 10 import org.mozilla.gecko.sync.stage.GlobalSyncStage.Stage;
michael@0 11
michael@0 12 public interface BaseGlobalSessionCallback {
michael@0 13 /**
michael@0 14 * Request that no further syncs occur within the next `backoff` milliseconds.
michael@0 15 * @param backoff a duration in milliseconds.
michael@0 16 */
michael@0 17 void requestBackoff(long backoff);
michael@0 18
michael@0 19 /**
michael@0 20 * Called on a 401 HTTP response.
michael@0 21 */
michael@0 22 void informUnauthorizedResponse(GlobalSession globalSession, URI oldClusterURL);
michael@0 23
michael@0 24
michael@0 25 /**
michael@0 26 * Called when an HTTP failure indicates that a software upgrade is required.
michael@0 27 */
michael@0 28 void informUpgradeRequiredResponse(GlobalSession session);
michael@0 29
michael@0 30 void handleAborted(GlobalSession globalSession, String reason);
michael@0 31 void handleError(GlobalSession globalSession, Exception ex);
michael@0 32 void handleSuccess(GlobalSession globalSession);
michael@0 33 void handleStageCompleted(Stage currentState, GlobalSession globalSession);
michael@0 34
michael@0 35 /**
michael@0 36 * Called when a {@link GlobalSession} wants to know if it should continue
michael@0 37 * to make storage requests.
michael@0 38 *
michael@0 39 * @return false if the session should make no further requests.
michael@0 40 */
michael@0 41 boolean shouldBackOffStorage();
michael@0 42 }

mercurial