Added sample for resuming downloads using RangeFileAsyncHttpResponseHandler

Author: smarek

sample/src/main/AndroidManifest.xml

@@ -41,6 +41,7 @@
         <activity android:name=".Http401AuthSample"/>
         <activity android:name=".AsyncBackgroundThreadSample"/>
         <activity android:name=".ContentTypeForHttpEntitySample"/>
+        <activity android:name=".ResumeDownloadSample"/>
 
         <service android:name=".services.ExampleIntentService"/>
     </application>

sample/src/main/java/com/loopj/android/http/sample/ResumeDownloadSample.java

@@ -0,0 +1,85 @@
+package com.loopj.android.http.sample;
+
+import android.util.Log;
+
+import com.loopj.android.http.AsyncHttpClient;
+import com.loopj.android.http.RangeFileAsyncHttpResponseHandler;
+import com.loopj.android.http.RequestHandle;
+import com.loopj.android.http.ResponseHandlerInterface;
+
+import org.apache.http.Header;
+import org.apache.http.HttpEntity;
+
+import java.io.File;
+import java.io.IOException;
+
+public class ResumeDownloadSample extends SampleParentActivity {
+
+    private File downloadTarget;
+    private static final String LOG_TAG = "ResumeDownloadSample";
+
+    private File getDownloadTarget() {
+        try {
+            if (downloadTarget == null) {
+                downloadTarget = File.createTempFile("download_", "_resume", getCacheDir());
+            }
+        } catch (IOException e) {
+            Log.e(LOG_TAG, "Couldn't create cache file to download to");
+        }
+        return downloadTarget;
+    }
+
+    @Override
+    public ResponseHandlerInterface getResponseHandler() {
+        return new RangeFileAsyncHttpResponseHandler(getDownloadTarget()) {
+            @Override
+            public void onFailure(int statusCode, Header[] headers, Throwable throwable, File file) {
+                debugStatusCode(LOG_TAG, statusCode);
+                debugHeaders(LOG_TAG, headers);
+                debugThrowable(LOG_TAG, throwable);
+                if (file != null) {
+                    addView(getColoredView(LIGHTGREEN, "Download interrupted (" + statusCode + "): (bytes=" + file.length() + "), path: " + file.getAbsolutePath()));
+                }
+            }
+
+            @Override
+            public void onSuccess(int statusCode, Header[] headers, File file) {
+                debugStatusCode(LOG_TAG, statusCode);
+                debugHeaders(LOG_TAG, headers);
+                if (file != null) {
+                    addView(getColoredView(LIGHTGREEN, "Request succeeded (" + statusCode + "): (bytes=" + file.length() + "), path: " + file.getAbsolutePath()));
+                }
+            }
+        };
+    }
+
+    @Override
+    public String getDefaultHeaders() {
+        return "Range=bytes=10-20";
+    }
+
+    @Override
+    public String getDefaultURL() {
+        return PROTOCOL + "www.google.com/images/srpr/logo11w.png";
+    }
+
+    @Override
+    public boolean isRequestHeadersAllowed() {
+        return true;
+    }
+
+    @Override
+    public boolean isRequestBodyAllowed() {
+        return false;
+    }
+
+    @Override
+    public int getSampleTitle() {
+        return R.string.title_resume_download;
+    }
+
+    @Override
+    public RequestHandle executeSample(AsyncHttpClient client, String URL, Header[] headers, HttpEntity entity, ResponseHandlerInterface responseHandler) {
+        return client.get(this, URL, headers, null, responseHandler);
+    }
+}

sample/src/main/java/com/loopj/android/http/sample/SampleInterface.java

@@ -56,6 +56,8 @@ public interface SampleInterface {
 
     String getDefaultURL();
 
+    String getDefaultHeaders();
+
     boolean isRequestHeadersAllowed();
 
     boolean isRequestBodyAllowed();

sample/src/main/java/com/loopj/android/http/sample/SampleParentActivity.java

@@ -66,6 +66,7 @@ protected AsyncHttpRequest newAsyncHttpRequest(DefaultHttpClient client, HttpCon
     private EditText urlEditText, headersEditText, bodyEditText;
     private LinearLayout responseLayout;
     private final List<RequestHandle> requestHandles = new LinkedList<RequestHandle>();
+    private static final String LOG_TAG = "SampleParentActivity";
 
     protected static final String PROTOCOL = "https://";
     protected static final int LIGHTGREEN = Color.parseColor("#00FF66");
@@ -89,6 +90,7 @@ protected void onCreate(Bundle savedInstanceState) {
         responseLayout = (LinearLayout) findViewById(R.id.layout_response);
 
         urlEditText.setText(getDefaultURL());
+        headersEditText.setText(getDefaultHeaders());
 
         bodyLayout.setVisibility(isRequestBodyAllowed() ? View.VISIBLE : View.GONE);
         headersLayout.setVisibility(isRequestHeadersAllowed() ? View.VISIBLE : View.GONE);
@@ -161,10 +163,11 @@ public List<Header> getRequestHeadersList() {
 
                     String headerName = line.substring(0, equalSignPos).trim();
                     String headerValue = line.substring(1 + equalSignPos).trim();
+                    Log.d(LOG_TAG, String.format("Added header: [%s:%s]", headerName, headerValue));
 
                     headers.add(new BasicHeader(headerName, headerValue));
                 } catch (Throwable t) {
-                    Log.e("SampleParentActivity", "Not a valid header line: " + line, t);
+                    Log.e(LOG_TAG, "Not a valid header line: " + line, t);
                 }
             }
         }
@@ -182,7 +185,7 @@ public HttpEntity getRequestEntity() {
             try {
                 return new StringEntity(bodyText);
             } catch (UnsupportedEncodingException e) {
-                Log.e("SampleParentActivity", "cannot create String entity", e);
+                Log.e(LOG_TAG, "cannot create String entity", e);
             }
         }
         return null;
@@ -277,6 +280,11 @@ protected View getColoredView(int bgColor, String msg) {
         return tv;
     }
 
+    @Override
+    public String getDefaultHeaders() {
+        return null;
+    }
+
     protected final void addView(View v) {
         responseLayout.addView(v);
     }

sample/src/main/java/com/loopj/android/http/sample/WaypointsActivity.java

@@ -54,7 +54,8 @@ public class WaypointsActivity extends ListActivity {
             new SampleConfig(R.string.title_range_sample, RangeResponseSample.class),
             new SampleConfig(R.string.title_401_unauth, Http401AuthSample.class),
             new SampleConfig(R.string.title_pre_post_processing, PrePostProcessingSample.class),
-            new SampleConfig(R.string.title_content_type_http_entity, ContentTypeForHttpEntitySample.class)
+            new SampleConfig(R.string.title_content_type_http_entity, ContentTypeForHttpEntitySample.class),
+            new SampleConfig(R.string.title_resume_download, ResumeDownloadSample.class)
     };
 
     @Override

sample/src/main/res/values/strings.xml

@@ -38,4 +38,5 @@
     <string name="title_pre_post_processing">Pre-/Post-processing</string>
     <string name="title_async_background_thread">Async on background thread</string>
     <string name="title_content_type_http_entity">Content-Type with HttpEntity</string>
+    <string name="title_resume_download">Resuming Download</string>
 </resources>