Stream a REST Response Body to a Destination

See more REST Examples

Demonstrates Rest.SetResponseBodyStream, which configures a Stream destination for response bodies received by the full-request convenience methods. The body is written to the stream only when the response status code matches the expected status.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    CkRest rest = new CkRest();
    boolean bTls = true;
    boolean bAutoReconnect = true;
    success = rest.Connect("example.com",443,bTls,bAutoReconnect);
    if (success == false) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    //  The file paths are relative to the application's current working directory.  Absolute paths
    //  may also be used.  Supply the paths appropriate to your own environment.

    //  Configure a Stream destination for response bodies received by the full-request convenience
    //  methods.  The body is written to the stream only when the response status code matches the 1st
    //  argument.
    CkStream respStream = new CkStream();
    respStream.put_SinkFile("qa_output/response_body.dat");

    //  The 2nd argument sets the stream character set from the response Content-Type charset for textual
    //  responses.  The 3rd argument is the destination Stream.
    boolean bAutoSetCharset = true;
    int expectedStatus = 200;
    success = rest.SetResponseBodyStream(expectedStatus,bAutoSetCharset,respStream);
    if (success == false) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    //  The full-request call now streams the response body to the sink instead of returning it.
    String responseText = rest.fullRequestNoBody("GET","/api/largefile");
    if (rest.get_LastMethodSuccess() == false) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    Log.i(TAG, "Response streamed to file.  Status: " + String.valueOf(rest.get_ResponseStatusCode()));

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}