com.julienvey.trello.impl.http

Class OkHttpTrelloHttpClient

java.lang.Object

com.julienvey.trello.impl.http.OkHttpTrelloHttpClient

All Implemented Interfaces:

TrelloHttpClient

public class OkHttpTrelloHttpClient
extends java.lang.Object
implements TrelloHttpClient

The TrelloHttpClient backed by OkHttpClient.

Constructor Summary

Constructors

Constructor and Description
OkHttpTrelloHttpClient() Constructs new instance of OkHttpTrelloHttpClient with default values.
OkHttpTrelloHttpClient(okhttp3.OkHttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Constructs new instance of OkHttpTrelloHttpClient.

Method Summary

Modifier and Type	Method and Description
<T> T	delete(java.lang.String url, java.lang.Class<T> responseType, java.lang.String... params) Performs HTTP DELETE request and converts response.
<T> T	get(java.lang.String url, java.lang.Class<T> responseType, java.lang.String... params) Performs HTTP GET request and converts response.
<T> T	postFileForObject(java.lang.String url, java.io.File file, java.lang.Class<T> responseType, java.lang.String... params) Performs HTTP POST request and converts response.
java.net.URI	postForLocation(java.lang.String url, java.lang.Object body, java.lang.String... params) Performs HTTP POST request and returns the value of the Location header.
<T> T	postForObject(java.lang.String url, java.lang.Object body, java.lang.Class<T> responseType, java.lang.String... params) Performs HTTP POST request and converts response.
<T> T	putForObject(java.lang.String url, java.lang.Object body, java.lang.Class<T> responseType, java.lang.String... params) Performs HTTP PUT request and converts response.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpTrelloHttpClient

public OkHttpTrelloHttpClient(okhttp3.OkHttpClient httpClient,
                              com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Constructs new instance of OkHttpTrelloHttpClient.

Parameters:

httpClient - The HTTP client to perform network calls.

objectMapper - The request/response encoder/decoder.

Throws:

java.lang.NullPointerException - When any argument is null.

OkHttpTrelloHttpClient

public OkHttpTrelloHttpClient()

Constructs new instance of OkHttpTrelloHttpClient with default values.

Method Detail

get

public <T> T get(java.lang.String url,
                 java.lang.Class<T> responseType,
                 java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP GET request and converts response.

The template variables in url are expanded using the given params, if any.

Specified by:

get in interface TrelloHttpClient

Type Parameters:

T - The response object type.

Parameters:

url - The URL to make request to.

responseType - The response object class object.

params - The URL query part or path parameters that should be expanded.

Returns:

The converted response.

postForObject

public <T> T postForObject(java.lang.String url,
                           java.lang.Object body,
                           java.lang.Class<T> responseType,
                           java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP POST request and converts response.

The template variables in url are expanded using the given params, if any.

Specified by:

postForObject in interface TrelloHttpClient

Type Parameters:

T - The response object type.

Parameters:

url - The URL to make request to.

body - The object to be converted to its JSON representation and POSTed. Use null to send request with empty body.

responseType - The response object class object.

params - The URL query part or path parameters that should be expanded.

Returns:

The converted response.

postForLocation

public java.net.URI postForLocation(java.lang.String url,
                                    java.lang.Object body,
                                    java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP POST request and returns the value of the Location header.

The template variables in url are expanded using the given params, if any.

Specified by:

postForLocation in interface TrelloHttpClient

Parameters:

url - The URL to make request to.

body - The object to be converted to its JSON representation and POSTed. Use null to send request with empty body.

params - The URL query part or path parameters that should be expanded.

Returns:

The POSTed resource location.

putForObject

public <T> T putForObject(java.lang.String url,
                          java.lang.Object body,
                          java.lang.Class<T> responseType,
                          java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP PUT request and converts response.

The template variables in url are expanded using the given params, if any.

Specified by:

putForObject in interface TrelloHttpClient

Type Parameters:

T - The response object type.

Parameters:

url - The URL to make request to.

body - The object to be converted to its JSON representation and POSTed. Use null send request with empty body.

responseType - The response object class object.

params - The URL query part or path parameters that should be expanded.

Returns:

The converted response.

delete

public <T> T delete(java.lang.String url,
                    java.lang.Class<T> responseType,
                    java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP DELETE request and converts response.

The template variables in url are expanded using the given params, if any.

Specified by:

delete in interface TrelloHttpClient

Type Parameters:

T - The response object type.

Parameters:

url - The URL to make request to.

responseType - The response object class object.

params - The URL query part or path parameters that should be expanded.

Returns:

The converted response.

postFileForObject

public <T> T postFileForObject(java.lang.String url,
                               java.io.File file,
                               java.lang.Class<T> responseType,
                               java.lang.String... params)

Description copied from interface: TrelloHttpClient

Performs HTTP POST request and converts response. The file should be transmitted using multipart/form-data.

This is optional method.

The template variables in url are expanded using the given params, if any.

Specified by:

postFileForObject in interface TrelloHttpClient

Type Parameters:

T - The response object type.

Parameters:

url - The URL to make request to.

file - The file to upload.

responseType - The response object class object.

params - The URL query part or path parameters that should be expanded.

Returns:

The converted response.