com.here.account.client

Class Client

java.lang.Object

com.here.account.client.Client

public class Client
extends Object

An OLP Client that talks to an OLP Resource Server, in OAuth2-speak. It is expected that a wrapper class invokes methods on an instance of this class, so that simple Java create(), read(), update(), and delete() methods can be written with POJOs. Suitable for use with JSON-object response APIs.

Author:

kmccrack

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Builder

Method Summary

Modifier and Type	Method and Description
static Client.Builder	builder()
HttpProvider.HttpRequestAuthorizer	getClientAuthorizer()
<T,U> T	sendMessage(HttpProvider.HttpRequest httpRequest, Class<T> responseClass, Class<U> errorResponseClass, BiFunction<Integer,U,RuntimeException> newExceptionFunction) Sends the requested HTTP Message to the Server.
<R,T,U> T	sendMessage(String method, String url, R request, Class<T> responseClass, Class<U> errorResponseClass, BiFunction<Integer,U,RuntimeException> newExceptionFunction) Sends the requested HTTP Message to the Server.
<R,T,U> T	sendMessage(String method, String url, R request, Map<String,String> additionalHeaders, Class<T> responseClass, Class<U> errorResponseClass, BiFunction<Integer,U,RuntimeException> newExceptionFunction) Sends the requested HTTP Message to the Server, with additional headers.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Client.Builder builder()

getClientAuthorizer

public HttpProvider.HttpRequestAuthorizer getClientAuthorizer()

sendMessage

public <R,T,U> T sendMessage(String method,
                             String url,
                             R request,
                             Class<T> responseClass,
                             Class<U> errorResponseClass,
                             BiFunction<Integer,U,RuntimeException> newExceptionFunction)
                      throws RequestExecutionException,
                             ResponseParsingException

Sends the requested HTTP Message to the Server. This method is useful if you want to interact with your Resource Server using serializable Java objects as inputs and outputs. It covers the case where your Resource Server API uses Content-Type: application/json for request and response documents.

Type Parameters:

R - the Request parameterized type

T - the Response parameterized type

U - the Response Error parameterized type

Parameters:

method - the HTTP method

url - the HTTP request URL

request - the request object of type R, or null if no request object

responseClass - the response object class, for deserialization

errorResponseClass - the response error object class, for deserialization

newExceptionFunction - the function for getting a new RuntimeException based on the statusCode and error response object

Returns:

the Response of type T

Throws:

RequestExecutionException - if trouble executing the request

ResponseParsingException - if trouble serializing the request, or deserializing the response

sendMessage

public <R,T,U> T sendMessage(String method,
                             String url,
                             R request,
                             Map<String,String> additionalHeaders,
                             Class<T> responseClass,
                             Class<U> errorResponseClass,
                             BiFunction<Integer,U,RuntimeException> newExceptionFunction)
                      throws RequestExecutionException,
                             ResponseParsingException

Sends the requested HTTP Message to the Server, with additional headers. This method is useful if you want to interact with your Resource Server using serializable Java objects as inputs and outputs. It covers the case where your Resource Server API uses Content-Type: application/json for request and response documents. This method provides the ability to specify HTTP Headers beyond that (those) possibly added by your HttpRequestAuthorizer.

Type Parameters:

R - the Request parameterized type

T - the Response parameterized type

U - the Response Error parameterized type

Parameters:

method - the HTTP method

url - the HTTP request URL

request - the request object of type R, or null if no request object

additionalHeaders - additional headers to add to the request, beyond that (those) possibly added by your HttpRequestAuthorizer.

responseClass - the response object class, for deserialization

errorResponseClass - the response error object class, for deserialization

newExceptionFunction - the function for getting a new RuntimeException based on the statusCode and error response object

Returns:

the Response of type T

Throws:

RequestExecutionException - if trouble executing the request

ResponseParsingException - if trouble serializing the request, or deserializing the response

sendMessage

public <T,U> T sendMessage(HttpProvider.HttpRequest httpRequest,
                           Class<T> responseClass,
                           Class<U> errorResponseClass,
                           BiFunction<Integer,U,RuntimeException> newExceptionFunction)
                    throws RequestExecutionException,
                           ResponseParsingException

Sends the requested HTTP Message to the Server. This method is useful if you have already constructed your HttpRequest, and your API supports Content-Type: application/json response documents.

Type Parameters:

T - the Response parameterized type

U - the Response Error parameterized type

Parameters:

httpRequest - the HTTP Request

responseClass - the Response class

errorResponseClass - the class for Error Responses

newExceptionFunction - the new RuntimeException-creating function that takes a statusCode and an Error Response object.

Returns:

the Response of type T

Throws:

RequestExecutionException - if trouble executing the request

ResponseParsingException - if trouble serializing the request, or deserializing the response