com.github.alexdlaird.http

Interface HttpClient

All Known Implementing Classes:

DefaultHttpClient

public interface HttpClient

A simple interface for executing HTTP requests.

Method Summary

Modifier and Type	Method and Description
default Response<java.util.Map>	delete(java.lang.String url) See delete(String, List, Map).
default Response<java.util.Map>	delete(java.lang.String url, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders) See delete(String, List, Map, Class).
<B> Response<B>	delete(java.lang.String url, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.lang.Class<B> clazz) Perform DELETE operation against an endpoint.
default <B> Response<B>	get(java.lang.String url, java.lang.Class<B> clazz) See get(String, List, Map, Class).
<B> Response<B>	get(java.lang.String url, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.lang.Class<B> clazz) Perform GET operation against an endpoint.
default void	get(java.lang.String url, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.nio.file.Path dest) See get(String, List, Map, Path, int).
void	get(java.lang.String url, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.nio.file.Path dest, int retries) Perform GET operation that downloads a file to the given path.
default void	modifyConnection(java.net.HttpURLConnection httpUrlConnection) Override this method if you could like to extend DefaultHttpClient and perform customer HTTP operations before URLConnection.connect() is called on the instance of the passed in connection.
default <R,B> Response<B>	post(java.lang.String url, R request, java.lang.Class<B> clazz) See post(String, Object, List, Map, Class).
<R,B> Response<B>	post(java.lang.String url, R request, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.lang.Class<B> clazz) Perform POST operation against an endpoint.
default <R,B> Response<B>	put(java.lang.String url, R request, java.lang.Class<B> clazz) See put(String, Object, List, Map, Class).
<R,B> Response<B>	put(java.lang.String url, R request, java.util.List<Parameter> parameters, java.util.Map<java.lang.String,java.lang.String> additionalHeaders, java.lang.Class<B> clazz) Perform PUT operation against an endpoint.

Method Detail

get

<B> Response<B> get(java.lang.String url,
                    java.util.List<Parameter> parameters,
                    java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                    java.lang.Class<B> clazz)

Perform GET operation against an endpoint.

Type Parameters:

B - The response body type.

Parameters:

url - The URL on which to perform the operation.

parameters - An arbitrary number of parameters to add to the URL.

additionalHeaders - Additional headers for the request.

clazz - The class for the Response's body.

Returns:

The results of the query.

Throws:

HttpClientException - An error has occurred while executing the HTTP request.

get

default <B> Response<B> get(java.lang.String url,
                            java.lang.Class<B> clazz)

See get(String, List, Map, Class).

get

void get(java.lang.String url,
         java.util.List<Parameter> parameters,
         java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
         java.nio.file.Path dest,
         int retries)
  throws java.lang.InterruptedException

Perform GET operation that downloads a file to the given path.

Parameters:

url - The URL on which to perform the operation.

parameters - An arbitrary number of parameters to add to the URL.

additionalHeaders - Additional headers for the request.

dest - The destination to which the file will be downloaded.

retries - The retry attempt index, if download fails.

Throws:

java.lang.InterruptedException - The thread was interrupted during retries.

HttpClientException - An error has occurred while executing the HTTP request.

get

default void get(java.lang.String url,
                 java.util.List<Parameter> parameters,
                 java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                 java.nio.file.Path dest)
          throws java.lang.InterruptedException

See get(String, List, Map, Path, int).

Throws:

java.lang.InterruptedException

post

<R,B> Response<B> post(java.lang.String url,
                       R request,
                       java.util.List<Parameter> parameters,
                       java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                       java.lang.Class<B> clazz)

Perform POST operation against an endpoint.

Type Parameters:

R - The Request type.

B - The Response body type.

Parameters:

url - The URL on which to perform the operation.

request - The element to be serialized into the request body.

parameters - An arbitrary number of parameters to add to the URL.

additionalHeaders - Additional headers for the request.

clazz - The class for the Response's body.

Returns:

The results of the query.

Throws:

HttpClientException - An error has occurred while executing the HTTP request.

post

default <R,B> Response<B> post(java.lang.String url,
                               R request,
                               java.lang.Class<B> clazz)

See post(String, Object, List, Map, Class).

put

<R,B> Response<B> put(java.lang.String url,
                      R request,
                      java.util.List<Parameter> parameters,
                      java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                      java.lang.Class<B> clazz)

Perform PUT operation against an endpoint.

Type Parameters:

R - The Request type.

B - The Response body type.

Parameters:

url - The URL on which to perform the operation.

request - The element to be serialized into the request body.

parameters - An arbitrary number of parameters to add to the URL.

additionalHeaders - Additional headers for the request.

clazz - The class for the Response's body.

Returns:

The results of the query.

Throws:

HttpClientException - An error has occurred while executing the HTTP request.

put

default <R,B> Response<B> put(java.lang.String url,
                              R request,
                              java.lang.Class<B> clazz)

See put(String, Object, List, Map, Class).

delete

<B> Response<B> delete(java.lang.String url,
                       java.util.List<Parameter> parameters,
                       java.util.Map<java.lang.String,java.lang.String> additionalHeaders,
                       java.lang.Class<B> clazz)

Perform DELETE operation against an endpoint.

Type Parameters:

B - The Response body type.

Parameters:

url - The URL on which to perform the operation.

parameters - An arbitrary number of parameters to add to the URL.

additionalHeaders - Additional headers for the request.

clazz - The class for the Response's body.

Returns:

The results of the query.

Throws:

HttpClientException - An error has occurred while executing the HTTP request.

delete

default Response<java.util.Map> delete(java.lang.String url,
                                       java.util.List<Parameter> parameters,
                                       java.util.Map<java.lang.String,java.lang.String> additionalHeaders)

See delete(String, List, Map, Class).

delete

default Response<java.util.Map> delete(java.lang.String url)

See delete(String, List, Map).

modifyConnection

default void modifyConnection(java.net.HttpURLConnection httpUrlConnection)

Override this method if you could like to extend DefaultHttpClient and perform customer HTTP operations before URLConnection.connect() is called on the instance of the passed in connection.

Parameters:

httpUrlConnection - The URL connection to modify.