com.here.account.http

Interface HttpProvider

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ApacheHttpClientProvider, JavaHttpProvider

public interface HttpProvider
extends Closeable

An interface to the HTTP wireline provider implementation of your choosing.

Author:

kmccrack

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpProvider.HttpRequest Wrapper for an HTTP request.
static interface	HttpProvider.HttpRequestAuthorizer Wrapper for authorizing HTTP requests.
static interface	HttpProvider.HttpResponse Wrapper for HTTP responses.

Method Summary

Modifier and Type	Method and Description
HttpProvider.HttpResponse	execute(HttpProvider.HttpRequest httpRequest) Execute the httpRequest.
HttpProvider.HttpRequest	getRequest(HttpProvider.HttpRequestAuthorizer httpRequestAuthorizer, String method, String url, Map<String,List<String>> formParams) Gets the RequestBuilder, with the specified method, url, and formParams.
HttpProvider.HttpRequest	getRequest(HttpProvider.HttpRequestAuthorizer httpRequestAuthorizer, String method, String url, String requestBodyJson) Gets the RequestBuilder, with the specified method, url, and requestBodyJson.

Methods inherited from interface java.io.Closeable

close

Method Detail

getRequest

HttpProvider.HttpRequest getRequest(HttpProvider.HttpRequestAuthorizer httpRequestAuthorizer,
                                    String method,
                                    String url,
                                    String requestBodyJson)

Gets the RequestBuilder, with the specified method, url, and requestBodyJson. The Authorization header has already been set according to the httpRequestAuthorizer implementation.

Parameters:

httpRequestAuthorizer - for adding the Authorization header value

method - HTTP method value

url - HTTP request URL

requestBodyJson - the Content-Type: application/json JSON request body.

Returns:

the HttpRequest object you can execute(HttpRequest).

getRequest

HttpProvider.HttpRequest getRequest(HttpProvider.HttpRequestAuthorizer httpRequestAuthorizer,
                                    String method,
                                    String url,
                                    Map<String,List<String>> formParams)

Gets the RequestBuilder, with the specified method, url, and formParams. The Authorization header has already been set according to the httpRequestAuthorizer implementation.

Parameters:

httpRequestAuthorizer - for adding the Authorization header value

method - HTTP method value

url - HTTP request URL

formParams - the Content-Type: application/x-www-form-urlencoded form parameters.

Returns:

the HttpRequest object you can execute(HttpRequest).

execute

HttpProvider.HttpResponse execute(HttpProvider.HttpRequest httpRequest)
                           throws HttpException,
                                  IOException

Execute the httpRequest. Implementing classes would commonly invoke or schedule a RESTful HTTPS API call over the wire to the configured Service as part of execute.

Parameters:

httpRequest - the HttpRequest

Returns:

the HttpResponse to the request

Throws:

HttpException - if there is trouble executing the httpRequest

IOException - if there is I/O trouble executing the httpRequest