com.ibm.watson.developer_cloud.http

Class RequestBuilder

java.lang.Object

com.ibm.watson.developer_cloud.http.RequestBuilder

public class RequestBuilder
extends Object

Convenience class for constructing HTTP/HTTPS requests.

Method Summary

Modifier and Type	Method and Description
com.squareup.okhttp.Request	build() Builds a request with the given set of parameters and files.
static RequestBuilder	delete(String url) The DELETE method requests that the origin server delete the resource identified by the Request-URI.
static RequestBuilder	get(String url) The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.
static RequestBuilder	post(String url) 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 RequestBuilder	put(String url) The PUT method requests that the enclosed entity be stored under the supplied Request-URI.
String	toString()
String	toUrl() Create and return the URL being used in the request.
RequestBuilder	withBody(com.squareup.okhttp.RequestBody body) Adds an arbitrary entity to the request (used with POST/PUT).
RequestBuilder	withBodyContent(String content, String contentType) Adds string content to the request (used with POST/PUT).
RequestBuilder	withBodyJson(com.google.gson.JsonObject json) Adds a JSON content to the request (used with POST/PUT).
RequestBuilder	withForm(Object... args) Adds form parameters.
RequestBuilder	withFormMap(Map<String,Object> parameters) Adds form parameters.
RequestBuilder	withHeader(Object... args) Adds header parameters.
RequestBuilder	withQuery(Object... args) Adds query parameters.
RequestBuilder	withQueryMap(Map<String,Object> parameters) Adds query parameters.

Methods inherited from class java.lang.Object

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

Method Detail

delete

public static RequestBuilder delete(String url)

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

Parameters:

url - the URL

Returns:

this

get

public static RequestBuilder get(String url)

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

Parameters:

url - the URL

Returns:

this

post

public static RequestBuilder post(String url)

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

Returns:

this

put

public static RequestBuilder put(String url)

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

Parameters:

url - the URL

Returns:

this

build

public com.squareup.okhttp.Request build()

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

Returns:

HTTP request, prepared to be executed

toString

public String toString()

Overrides:

toString in class Object

toUrl

public String toUrl()

Create and return the URL being used in the request.

Returns:

the URL as string

withBody

public RequestBuilder withBody(com.squareup.okhttp.RequestBody body)

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

Parameters:

body - the request body to POST/PUT

Returns:

this

withBodyContent

public RequestBuilder withBodyContent(String content,
                                      String contentType)

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

Parameters:

content - the content to POST/PUT

contentType - the HTTP contentType to use.

Returns:

this

withBodyJson

public RequestBuilder withBodyJson(com.google.gson.JsonObject json)

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

Parameters:

json - the JsonObject json

Returns:

this

withForm

public RequestBuilder withForm(Object... args)

Adds form parameters.

Parameters:

args - a list of name-value form parameters

Returns:

this

withFormMap

public RequestBuilder withFormMap(Map<String,Object> parameters)

Adds form parameters.

Parameters:

parameters - a list of name-value form parameters

Returns:

this

withHeader

public RequestBuilder withHeader(Object... args)

Adds header parameters.

Parameters:

args - a list of name-value headers

Returns:

this

withQuery

public RequestBuilder withQuery(Object... args)

Adds query parameters.

Parameters:

args - a list of name-value query parameters

Returns:

this

withQueryMap

public RequestBuilder withQueryMap(Map<String,Object> parameters)

Adds query parameters.

Parameters:

parameters - a list of name-value query parameters

Returns:

this