Java

Send a Staged Form-URL-Encoded REST Request

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

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

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 form body is built from the query parameters added to the object.
            rest.addQueryParam("username", "alice");
            rest.addQueryParam("action", "login");

            // Send the application/x-www-form-urlencoded request.
            rest.sendReqFormUrlEncoded("POST", "/api/login");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // After sending, read the response status line and header fields.  The return value is the HTTP
        // status code, or -1 if no response was received.
        int statusCode = rest.readResponseHeader();
        if (statusCode < 0) {
            System.out.println(rest.getLastErrorText());
            return;
        }

        System.out.println("Response status code: " + statusCode);

        // Read the response body as text.
        String responseBody;
        try {
            responseBody = rest.readRespBodyString();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println(responseBody);
    }
}