com.here.account.http.java

Class JavaHttpProvider

java.lang.Object

com.here.account.http.java.JavaHttpProvider

All Implemented Interfaces:

HttpProvider, Closeable, AutoCloseable

public class JavaHttpProvider
extends Object
implements HttpProvider

A pure-Java implementation of the HttpProvider interface using HttpURLConnection.

Author:

kmccrack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaHttpProvider.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 JavaHttpProvider.Builder	builder()
void	close()
HttpProvider.HttpResponse	execute(HttpProvider.HttpRequest httpRequest) Execute the httpRequest.
protected long	getContentLength(HttpURLConnection connection)
protected static byte[]	getFormBody(Map<String,List<String>> formParams)
protected HttpURLConnection	getHttpUrlConnection(String urlString)
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

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRequest

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

Description copied from interface: HttpProvider

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)

Description copied from interface: HttpProvider

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

getContentLength

protected long getContentLength(HttpURLConnection connection)

getHttpUrlConnection

protected HttpURLConnection getHttpUrlConnection(String urlString)
                                          throws IOException

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

getFormBody

protected static byte[] getFormBody(Map<String,List<String>> formParams)
                             throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

builder

public static JavaHttpProvider.Builder builder()