com.julienvey.trello

Interface TrelloHttpClient

All Known Implementing Classes:

ApacheHttpClient, AsyncTrelloHttpClient, AsyncTrelloHttpClient2, JDKTrelloHttpClient, OkHttpTrelloHttpClient, RestTemplateHttpClient

public interface TrelloHttpClient

The third-party HTTP clients wrapper. Allows to not hardy depend on particular HTTP clients.

Provides standard set of methods to perform GET, POST, PUT, DELETE method.

Exceptions

The implementation should not transparently rethrow any exception that comes with third-party HTTP client library. Implementors can use wrapping exceptions like NotFoundException, NotAuthorizedException etc. If there is no specific exception for particular case TrelloHttpException should be rethrown. It is very recommended to embed native exception as cause, to provide more details about exception occurred.

The Trello API does support gzip response compression when user send the Accept-Encoding: gzip, so implementor should at least consider (although many modern HTTP clients handles gzip compression/decompression transparently) to send appropriate header and subsequently decompress bodies.

The most basic implementation is JDKTrelloHttpClient, it is default implementation for this interface and does not require any additional dependencies.

See Also:

JDKTrelloHttpClient, ApacheHttpClient, RestTemplateHttpClient, OkHttpTrelloHttpClient, AsyncTrelloHttpClient, AsyncTrelloHttpClient2

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

Method Detail

get

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

Performs HTTP GET request and converts response.

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

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

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

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

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

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.

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

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

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

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

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

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

Performs HTTP DELETE request and converts response.

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

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

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

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.