mobile/android/base/sync/net/ResourceDelegate.java@6474c204b198 (annotated)
mobile/android/base/sync/net/ResourceDelegate.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| 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.net; |
| michael@0 | 6 | |
| michael@0 | 7 | import java.io.IOException; |
| michael@0 | 8 | import java.security.GeneralSecurityException; |
| michael@0 | 9 | |
| michael@0 | 10 | import ch.boye.httpclientandroidlib.HttpResponse; |
| michael@0 | 11 | import ch.boye.httpclientandroidlib.client.ClientProtocolException; |
| michael@0 | 12 | import ch.boye.httpclientandroidlib.client.methods.HttpRequestBase; |
| michael@0 | 13 | import ch.boye.httpclientandroidlib.impl.client.DefaultHttpClient; |
| michael@0 | 14 | |
| michael@0 | 15 | /** |
| michael@0 | 16 | * ResourceDelegate implementers must ensure that HTTP responses |
| michael@0 | 17 | * are fully consumed to ensure that connections are returned to |
| michael@0 | 18 | * the pool: |
| michael@0 | 19 | * |
| michael@0 | 20 | * EntityUtils.consume(entity); |
| michael@0 | 21 | * @author rnewman |
| michael@0 | 22 | * |
| michael@0 | 23 | */ |
| michael@0 | 24 | public interface ResourceDelegate { |
| michael@0 | 25 | // Request augmentation. |
| michael@0 | 26 | AuthHeaderProvider getAuthHeaderProvider(); |
| michael@0 | 27 | void addHeaders(HttpRequestBase request, DefaultHttpClient client); |
| michael@0 | 28 | |
| michael@0 | 29 | /** |
| michael@0 | 30 | * The value of the User-Agent header to include with the request. |
| michael@0 | 31 | * |
| michael@0 | 32 | * @return User-Agent header value; null means do not set User-Agent header. |
| michael@0 | 33 | */ |
| michael@0 | 34 | public String getUserAgent(); |
| michael@0 | 35 | |
| michael@0 | 36 | // Response handling. |
| michael@0 | 37 | |
| michael@0 | 38 | /** |
| michael@0 | 39 | * Override this to handle an HttpResponse. |
| michael@0 | 40 | * |
| michael@0 | 41 | * ResourceDelegate implementers <b>must</b> ensure that HTTP responses are |
| michael@0 | 42 | * fully consumed to ensure that connections are returned to the pool, for |
| michael@0 | 43 | * example by calling <code>EntityUtils.consume(response.getEntity())</code>. |
| michael@0 | 44 | */ |
| michael@0 | 45 | void handleHttpResponse(HttpResponse response); |
| michael@0 | 46 | void handleHttpProtocolException(ClientProtocolException e); |
| michael@0 | 47 | void handleHttpIOException(IOException e); |
| michael@0 | 48 | |
| michael@0 | 49 | // During preparation. |
| michael@0 | 50 | void handleTransportException(GeneralSecurityException e); |
| michael@0 | 51 | |
| michael@0 | 52 | // Connection parameters. |
| michael@0 | 53 | int connectionTimeout(); |
| michael@0 | 54 | int socketTimeout(); |
| michael@0 | 55 | } |
