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