Read the REST Response Body into a Stream

See more REST Examples

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

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.

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.Stream;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        Rest rest = new Rest();
        boolean bTls = true;
        boolean bAutoReconnect = true;
        try {
            rest.connect("example.com", 443, bTls, bAutoReconnect);

            // 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.

            rest.sendReqNoBody("GET", "/api/images/1");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        int statusCode = rest.readResponseHeader();
        if (statusCode < 0) {
            System.out.println(rest.getLastErrorText());
            return;
        }

        // Check for the expected success status code.  If the response is not 200, the body is likely
        // error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
        // read the body as text, report it, and return.
        if (statusCode != 200) {
            StringBuilder sbError = new StringBuilder();
            try {
                rest.readRespSb(sbError);
            } catch (ChilkatException e) {
                System.out.println(e.getLastErrorText());
                return;
            }

            System.out.println("Request failed with status code " + statusCode);
            System.out.println(sbError.getAsString());
            return;
        }

        // The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
        // file, which is appropriate for large or binary responses.
        Stream respStream = new Stream();
        respStream.setSinkFile("qa_output/image.png");

        // If the 2nd argument is true and the response is textual, the stream's character set is set from
        // the response Content-Type charset.  It has no effect for binary responses.
        boolean bAutoSetCharset = true;
        try {
            rest.readRespBodyStream(respStream, bAutoSetCharset);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("Response body written to the stream sink.");
    }
}