com.here.account.http.apache

Class ApacheHttpClientProvider

java.lang.Object

com.here.account.http.apache.ApacheHttpClientProvider

All Implemented Interfaces:

HttpProvider, Closeable, AutoCloseable

public class ApacheHttpClientProvider
extends Object
implements HttpProvider

An HttpProvider that uses Apache HttpClient as the underlying implementation. See Apache HTTP Components for more information, specifically the HttpClient project.

If you just want the default 5000 ms for both connection timeout and request timeout, just use the following example code:

 
       HttpProvider httpProvider = ApacheHttpClientProvider.builder().build();
       // use httpProvider such as with HereAccessTokenProviders...
 
 

To set the HTTP connection pool size, use the following example code.
NOTE: the connection pool size is set to 200 in this example. Modify the value to fit your needs.

 
      PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager();
      // Increase max total connection to 200
      cm.setMaxTotal(200);

      CloseableHttpClient httpClient = HttpClients.custom().setConnectionManager(cm).build();
      HttpProvider httpProvider = ApacheHttpClientProvider.builder().setHttpClient(httpClient).build();
      // use httpProvider such as with HereAccessTokenProviders...
 
 

Author:

kmccrack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApacheHttpClientProvider.Builder

Nested classes/interfaces inherited from interface com.here.account.http.HttpProvider

HttpProvider.HttpRequest, HttpProvider.HttpRequestAuthorizer, HttpProvider.HttpResponse

Method Summary

Modifier and Type	Method and Description
static ApacheHttpClientProvider.Builder	builder()
void	close()
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 class java.lang.Object

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

Method Detail

builder

public static ApacheHttpClientProvider.Builder builder()

getRequest

public 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.

Specified by:

getRequest in interface HttpProvider

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 HttpProvider.execute(HttpRequest).

getRequest

public 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.

Specified by:

getRequest in interface HttpProvider

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 HttpProvider.execute(HttpRequest).

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

execute

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

Description copied from interface: HttpProvider

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.

Specified by:

execute in interface HttpProvider

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