Retry requests, safer serializable cookies, better request params and smarter jsonresponse

Author: loopj

README.md

@@ -8,6 +8,7 @@ Features
 * Make asynchronous HTTP requests, handle responses in callbacks
 * HTTP requests do not happen in the android UI thread
 * Requests use a threadpool to cap concurrent resource usage
+* Retry requests to help with bad connectivity
 * GET/POST params builder (RequestParams)
 * Optional built-in response parsing into JSON (JsonHttpResponseHandler)
 * Optional persistent cookie store, saves cookies into your app's SharedPreferences

examples/TwitterRestClientUsage.java

@@ -5,9 +5,7 @@ class TwitterRestClientUsage {
     public void getPublicTimeline() {
         TwitterRestClient.get("statuses/public_timeline.json", null, new JsonHttpResponseHandler() {
             @Override
-            public void onSuccess(Object response) {
-                JSONArray timeline = (JSONArray)response;
-
+            public void onSuccess(JSONArray timeline) {
                 try {
                     JSONObject firstEvent = (JSONObject)timeline.get(0);
                     String tweetText = firstEvent.getString("text");

src/com/loopj/android/http/AsyncHttpClient.java

@@ -87,7 +87,6 @@ public AsyncHttpClient(String userAgent) {
         schemeRegistry.register(new Scheme("https", SSLSocketFactory.getSocketFactory(), 443));
         ThreadSafeClientConnManager cm = new ThreadSafeClientConnManager(httpParams, schemeRegistry);
 
-        threadPool = Executors.newCachedThreadPool();
         httpContext = new SyncBasicHttpContext(new BasicHttpContext());
         httpClient = new DefaultHttpClient(cm, httpParams);
         httpClient.addRequestInterceptor(new HttpRequestInterceptor() {
@@ -114,6 +113,8 @@ public void process(HttpResponse response, HttpContext context) {
         });
 
         httpClient.setHttpRequestRetryHandler(new RetryHandler(DEFAULT_MAX_RETRIES));
+
+        threadPool = Executors.newCachedThreadPool();
     }
 
     public void setCookieStore(CookieStore cookieStore) {

src/com/loopj/android/http/AsyncHttpResponseHandler.java

@@ -50,7 +50,16 @@ public void sendFinishMessage() {
     }
 
     public void sendResponseMessage(HttpResponse response) {
-        sendMessage(obtainMessage(RESPONSE_MESSAGE, response));
+        StatusLine status = response.getStatusLine();
+        if(status.getStatusCode() >= 300) {
+            sendErrorMessage(new HttpResponseException(status.getStatusCode(), status.getReasonPhrase()));
+        } else {
+            try {
+                sendMessage(obtainMessage(RESPONSE_MESSAGE, getResponseBody(response)));
+            } catch(IOException e) {
+                sendErrorMessage(e);
+            }
+        }
     }
 
     public void sendErrorMessage(Throwable e) {
@@ -61,7 +70,7 @@ public void sendErrorMessage(Throwable e) {
     public void handleMessage(Message msg) {
         switch(msg.what) {
             case RESPONSE_MESSAGE:
-                handleResponseMessage((HttpResponse)msg.obj);
+                handleResponseMessage((String)msg.obj);
                 break;
             case ERROR_MESSAGE:
                 handleErrorMessage((Throwable)msg.obj);
@@ -75,17 +84,8 @@ public void handleMessage(Message msg) {
         }
     }
 
-    protected void handleResponseMessage(HttpResponse response) {
-        StatusLine status = response.getStatusLine();
-        if(status.getStatusCode() >= 300) {
-            onFailure(new HttpResponseException(status.getStatusCode(), status.getReasonPhrase()));
-        } else {
-            try {
-                onSuccess(getResponseBody(response));
-            } catch(IOException e) {
-                onFailure(e);
-            }
-        }
+    protected void handleResponseMessage(String responseBody) {
+        onSuccess(responseBody);
     }
 
     protected void handleErrorMessage(Throwable e) {

src/com/loopj/android/http/JsonHttpResponseHandler.java

@@ -20,33 +20,29 @@
 
 import java.io.IOException;
 
+import org.json.JSONArray;
 import org.json.JSONException;
+import org.json.JSONObject;
 import org.json.JSONTokener;
 
-import org.apache.http.HttpResponse;
-import org.apache.http.StatusLine;
-import org.apache.http.client.HttpResponseException;
-
 public class JsonHttpResponseHandler extends AsyncHttpResponseHandler {
-    protected void handleResponseMessage(HttpResponse response) {
-        StatusLine status = response.getStatusLine();
-        if(status.getStatusCode() >= 300) {
-            onFailure(new HttpResponseException(status.getStatusCode(), status.getReasonPhrase()));
-        } else {
-            try {
-                String responseBody = getResponseBody(response);
-                onSuccess(responseBody);
-
-                Object jsonResponse = new JSONTokener(responseBody).nextValue();
-                onSuccess(jsonResponse);
-            } catch(JSONException e) {
-                onFailure(e);
-            } catch(IOException e) {
-                onFailure(e);
+    @Override
+    protected void handleResponseMessage(String responseBody) {
+        super.handleResponseMessage(responseBody);
+
+        try {
+            Object jsonResponse = new JSONTokener(responseBody).nextValue();
+            if(jsonResponse instanceof JSONObject) {
+                onSuccess((JSONObject)jsonResponse);
+            } else if(jsonResponse instanceof JSONArray) {
+                onSuccess((JSONArray)jsonResponse);
             }
+        } catch(JSONException e) {
+            onFailure(e);
         }
     }
 
     // Public callbacks
-    public void onSuccess(Object response) {}
+    public void onSuccess(JSONObject response) {}
+    public void onSuccess(JSONArray response) {}
 }

src/com/loopj/android/http/RequestParams.java

@@ -21,6 +21,7 @@
 import java.io.UnsupportedEncodingException;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 import org.apache.http.HttpEntity;
@@ -37,6 +38,14 @@ public RequestParams() {
         init();
     }
 
+    public RequestParams(Map<String, String> source) {
+        init();
+
+        for(Map.Entry<String, String> entry : source.entrySet()) {
+            put(entry.getKey(), entry.getValue());
+        }
+    }
+
     public RequestParams(String key, String value) {
         init();
         put(key, value);

src/com/loopj/android/http/SerializableCookie.java

@@ -28,6 +28,8 @@
 import org.apache.http.impl.cookie.BasicClientCookie;
 
 public class SerializableCookie implements Serializable {
+    private static final long serialVersionUID = 6374381828722046732L;
+
     private transient Cookie cookie;
     private transient BasicClientCookie clientCookie;