com.turbomanage.httpclient.android.AndroidHttpClient Maven / Gradle / Ivy

Go to download
package com.turbomanage.httpclient.android;

import android.os.AsyncTask;
import android.os.Build;

import com.turbomanage.httpclient.AsyncHttpClient;
import com.turbomanage.httpclient.RequestHandler;
import com.turbomanage.httpclient.RequestLogger;

import java.net.HttpURLConnection;

/**
 * HTTP client for Android providing both synchronous (blocking) and asynchronous
 * interfaces so it can be used on or off the UI thread.
 *
 * Sample usage:
 *
 * Synchronous (for use off the UI thread in an {@link AsyncTask} or {@link Runnable})
 *  *    AndroidHttpClient httpClient = new AndroidHttpClient("http://www.google.com");
 *    ParameterMap params = httpClient.newParams().add("q", "GOOG");
 *    HttpResponse httpResponse = httpClient.get("/finance", params);
 *    System.out.println(httpResponse.getBodyAsString());
 * 
 *
 * Asynchronous (can be used anywhere, automatically wraps in an {@link AsyncTask})
 *  *    AndroidHttpClient httpClient = new AndroidHttpClient("http://www.google.com");
 *    ParameterMap params = httpClient.newParams().add("q", "GOOG");
 *    httpClient.setMaxRetries(3);
 *    httpClient.get("/finance", params, new AsyncCallback() {
 *        public void onComplete(HttpResponse httpResponse) {
 *            System.out.println(httpResponse.getBodyAsString());
 *        }
 *        public void onError(Exception e) {
 *            e.printStackTrace();
 *        }
 *    });
 * 
 *
 * @author David M. Chandler
 */
public class AndroidHttpClient extends AsyncHttpClient {

    static {
        disableConnectionReuseIfNecessary();
        // See http://code.google.com/p/basic-http-client/issues/detail?id=8
        if (Build.VERSION.SDK_INT > 8)
        		ensureCookieManager();
    }

    /**
     * Constructs a new client with empty baseUrl. When used this way, the path
     * passed to a request method must be the complete URL.
     */
    public AndroidHttpClient() {
        this("");
    }

    /**
     * Constructs a new client using the default {@link RequestHandler} and
     * {@link RequestLogger}.
     */
    public AndroidHttpClient(String baseUrl) {
        super(new AsyncTaskFactory(), baseUrl);
    }

    /**
     * Constructs a client with baseUrl and custom {@link RequestHandler}.
     *
     * @param baseUrl
     * @param requestHandler
     */
    public AndroidHttpClient(String baseUrl, RequestHandler requestHandler) {
        super(new AsyncTaskFactory(), baseUrl, requestHandler);
    }

    /**
     * Work around bug in {@link HttpURLConnection} on older versions of
     * Android.
     * http://android-developers.blogspot.com/2011/09/androids-http-clients.html
     */
    private static void disableConnectionReuseIfNecessary() {
        // HTTP connection reuse which was buggy pre-froyo
        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.FROYO) {
            System.setProperty("http.keepAlive", "false");
        }
    }

}