Java

PostUrlEncoded Clarified

This example is intended to help clarify the behavior of the PostUrlEncoded method.

The intent of PostUrlEncoded is to send a POST request with the HTTP request parameters located in the HTTP request body using the x-www-form-urlencoded format. In many cases, the developer already has the desired request params in a typical GET URL format, where the params are specified in the URL (after the "?" character). For example:

https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ

The PostUrlEncoded method makes it possible to send this request as a POST, where the "key=ABC123&value=XYZ" is contained in the body of the request. The path part of the URL is "/blah/moreblah". Therefore, the POST request would look like this:

POST /blah/moreblah HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: www.chilkatsoft.com
Content-Length: 20

key=ABC123&value=XYZ

Sometimes the desire is to send a POST, such that some (or all) request parameters are found in the path, and not in the request body. For example, let's say a program wants to send this request:

POST /blah/moreblah?key=ABC123 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: www.chilkatsoft.com
Content-Length: 10

value=XYZ

This can be done by calling SynchronousRequest. The SynchronousRequest method allows for the parts of the request to be explicitly built via the HTTP request object. (see the example code below).

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    //  This example requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();

    //  To see the exact HTTP request sent and the response, set the SessionLogFilename property:
    http.put_SessionLogFilename("/httpLogs/chilkatHttpLog.txt");

    //  Send the POST where all request parameters are located in the HTTP request body
    //  in the x-www-form-urlencoded format.  (We are passing a default/empty HTTP request object.
    //  The HTTP request object is where additional headers, or additional request parameters
    //  be added.)
    CkHttpRequest req = new CkHttpRequest();
    CkHttpResponse resp = http.PostUrlEncoded("https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ",req);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    //  Do whatever is desired with the response object...

    //  Show how to call SynchronousRequest to send a POST where "key=ABC123" is in the path 
    //  of the request, and the "value=XYZ" is in the request body.
    CkHttpRequest req2 = new CkHttpRequest();
    req2.put_Path("/blah/moreblah?key=ABC123");
    req2.AddParam("value","XYZ");
    req2.put_HttpVerb("POST");

    boolean bUseTls = true;
    String domain = "www.chilkatsoft.com";
    int port = 443;
    resp = http.SynchronousRequest(domain,port,bUseTls,req2);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    //  Do whatever is desired with the response object...
  }
}