Package com.avoka.component.http

Class PostRequest

java.lang.Object
com.avoka.component.http.HttpRequest
com.avoka.component.http.PostRequest
public class PostRequest extends HttpRequest
Provides a POST Request class for performing simple HTTP request operations. This class provides an easier and safer interface for the Apache HTTP Components library.

The default connection timeout is 10 seconds and socket read timeout is 60 seconds. Socket connections will also apply any JVM proxy settings automatically.

By default the maximum response read size is 16 MB. If the response is larger than this an IOException will be thrown. To increase the maximum read limit use the HttpRequest.setReadLimit(int) method.

In RESTful services the POST method is used to create resources (however its often used to perform updates as well).

Examples

The example below performs POST request and converts the response into a JSON document

 import com.avoka.component.http.PostRequest

 def message = '{ "name":"John Doe", "email":"[email protected]", "age":42 }'

 def username = serviceParameters.username
 def password = serviceParameters.password

 // execute POST request and return a HttpResponse object
 def response = new PostRequest('https://service.mycorp.com/secure/rest/accounts/')
       .setMessage(message)
       .setBasicAuth(username, password)
       .execute()

 // check HttpResponse status code
 if (response.status != 200) {
     throw new RuntimeException(response.statusLine)
 }

 // get JSON object from the response
 def json = response.getJsonContent()
 ...
Since:
4.2.0
See Also:

  • Constructor Details

    • PostRequest

      public PostRequest(String url)
      Create a POST HTTP request object with the given URL.
      Parameters:
      url - the request URL (required)