com.bosch.iot.dm.groovy.http

Interface HttpRequest

public interface HttpRequest

Http Request.

Method Summary

Modifier and Type	Method and Description
HttpRequest	addQueryParam(java.lang.String key, java.lang.String value) Add a query parameter to the request.
HttpRequest	basicAuthentication(java.lang.String clientId, java.lang.String clientSecret) Configure the request to perform basic access authentication.
HttpRequest	bearerTokenAuthentication(java.lang.String value) Configure the request to perform bearer token authentication.
HttpRequest	putHeader(java.lang.String key, java.lang.String value) Configure the request to set a new HTTP header.
void	send(AsyncResult result) Send a request with empty body.
void	sendJson(java.lang.String jsonObject, AsyncResult result) Send a Json string.
void	sendJsonObject(java.lang.Object object, AsyncResult result) Send a Json object.
HttpRequest	ssl(java.lang.Boolean ssl) Configure ssl.
HttpRequest	timeout(long timeout) Configure the amount of time in milliseconds after which the request fails if no data is returned within the timeout.

Method Detail

putHeader

HttpRequest putHeader(java.lang.String key,
                      java.lang.String value)

Configure the request to set a new HTTP header.

Parameters:

key - the header key

value - the header value

Returns:

a reference to this HTTP request object, so the API can be used fluently

basicAuthentication

HttpRequest basicAuthentication(java.lang.String clientId,
                                java.lang.String clientSecret)

Configure the request to perform basic access authentication.

Parameters:

clientId - the client ID

clientSecret - the client secret

Returns:

a reference to this HTTP request object, so the API can be used fluently

bearerTokenAuthentication

HttpRequest bearerTokenAuthentication(java.lang.String value)

Configure the request to perform bearer token authentication.

Parameters:

value - the bearer token

Returns:

a reference to this HTTP request object, so the API can be used fluently

ssl

HttpRequest ssl(java.lang.Boolean ssl)

Configure ssl.

Parameters:

ssl - the ssl flag

Returns:

a reference to this HTTP request object, so the API can be used fluently

timeout

HttpRequest timeout(long timeout)

Configure the amount of time in milliseconds after which the request fails if no data is returned within the timeout.

Parameters:

timeout - the timeout in milliseconds

Returns:

a reference to this HTTP request object, so the API can be used fluently

addQueryParam

HttpRequest addQueryParam(java.lang.String key,
                          java.lang.String value)

Add a query parameter to the request.

Parameters:

key - the param key

value - the param value

Returns:

a reference to this HTTP request object, so the API can be used fluently

sendJsonObject

void sendJsonObject(java.lang.Object object,
                    AsyncResult result)

Send a Json object.

Parameters:

object - the object

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

sendJson

void sendJson(java.lang.String jsonObject,
              AsyncResult result)

Send a Json string.

Parameters:

jsonObject - the Json string

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}

send

void send(AsyncResult result)

Send a request with empty body.

Parameters:

result - This parameter is about to be skipped in groovy scripts, it only indicates the method is asynchronous. As for every asynchronous method, the script writers can optionally pass a groovy.lang.Closure as last argument that could consume the asynchronous method result or simply be run after the asynchronous completion.
Example:
Closure postAction = {result, error -> ...}