com.ibm.watson.developer_cloud.service

Class Request

java.lang.Object

com.ibm.watson.developer_cloud.service.Request

public class Request
extends Object

Convenience class for constructing HTTP/HTTPS requests.
Example:

 
  HttpRequestBase request = Request
     .Get("/v1/translate")
     .withQuery("from", "en", "to", "es", "text", "Good Morning")
     .build();
 

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

Method Summary

Modifier and Type	Method and Description
org.apache.http.client.methods.HttpRequestBase	build() Builds a request with the given set of parameters and files.
static Request	Delete(String url, Object... args) The DELETE method requests that the origin server delete the resource identified by the Request-URI.
static Request	Get(String url, Object... args) The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.
static Request	Post(String url, Object... args) The POST request method is designed to request that a web server accept the data enclosed in the request message's body for storage.
static Request	Put(String url, Object... args) The PUT method requests that the enclosed entity be stored under the supplied Request-URI.
String	toUrl() Create and return the URL being used in the request.
Request	withContent(com.google.gson.JsonObject json) Adds a JSON content to the request (used with POST/PUT).
Request	withContent(String content, String contentType) Adds string content to the request (used with POST/PUT).
Request	withEntity(org.apache.http.HttpEntity entity) Adds an arbitrary entity to the request (used with POST/PUT).
Request	withForm(Map<String,Object> parameters) Adds form parameters.
Request	withForm(Object... args) Adds form parameters.
Request	withHeader(Object... args) Adds header parameters.
Request	withQuery(Map<String,Object> parameters) Adds query parameters.
Request	withQuery(Object... args) Adds query parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

Delete

public static Request Delete(String url,
                             Object... args)

The DELETE method requests that the origin server delete the resource identified by the Request-URI.

Parameters:

url - the URL

args - the list of arguments to format the URL

Returns:

this

Get

public static Request Get(String url,
                          Object... args)

The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.

Parameters:

url - the URL

args - the list of arguments to format the URL

Returns:

this

Post

public static Request Post(String url,
                           Object... args)

The POST request method is designed to request that a web server accept the data enclosed in the request message's body for storage. It is often used when uploading a file or submitting a completed web form.

Parameters:

url - the URL

args - the list of arguments to format the URL

Returns:

this

Put

public static Request Put(String url,
                          Object... args)

The PUT method requests that the enclosed entity be stored under the supplied Request-URI.

Parameters:

url - the URL

args - the list of arguments to format the URL

Returns:

this

build

public org.apache.http.client.methods.HttpRequestBase build()

Builds a request with the given set of parameters and files.

Returns:

HTTP request, prepared to be executed

toUrl

public String toUrl()

Create and return the URL being used in the request.

Returns:

the URL as string

withContent

public Request withContent(com.google.gson.JsonObject json)

Adds a JSON content to the request (used with POST/PUT). This will encapsulate the json into a StringEntity encoded with UTF-8 and use "application/json" as Content-Type

Parameters:

json - the JsonObject json

Returns:

this

withContent

public Request withContent(String content,
                           String contentType)

Adds string content to the request (used with POST/PUT). This will encapsulate the string into a StringEntity encoded with UTF-8

Parameters:

content - the content to POST/PUT

contentType - the HTTP contentType to use.

Returns:

this

withEntity

public Request withEntity(org.apache.http.HttpEntity entity)

Adds an arbitrary entity to the request (used with POST/PUT).

Parameters:

entity - the entity to POST/PUT

Returns:

this

withForm

public Request withForm(Object... args)

Adds form parameters.

Parameters:

args - a list of name-value form parameters

Returns:

this

withHeader

public Request withHeader(Object... args)

Adds header parameters.

Parameters:

args - a list of name-value headers

Returns:

this

withQuery

public Request withQuery(Object... args)

Adds query parameters.

Parameters:

args - a list of name-value query parameters

Returns:

this

withQuery

public Request withQuery(Map<String,Object> parameters)

Adds query parameters.

Parameters:

parameters - a list of name-value query parameters

Returns:

this

withForm

public Request withForm(Map<String,Object> parameters)

Adds form parameters.

Parameters:

parameters - a list of name-value form parameters

Returns:

this