com.sendgrid

Class Client

java.lang.Object

com.sendgrid.Client

All Implemented Interfaces:

Closeable, AutoCloseable

public class Client
extends Object
implements Closeable

Class Client allows for quick and easy access any REST or REST-like API.

Constructor Summary

Constructors

Constructor and Description
Client() Constructor for using the default CloseableHttpClient.
Client(Boolean test) Constructor for passing in a test parameter to allow for http calls.
Client(org.apache.http.impl.client.CloseableHttpClient httpClient) Constructor for passing in an httpClient, typically for mocking.
Client(org.apache.http.impl.client.CloseableHttpClient httpClient, Boolean test) Constructor for passing in an httpClient and test parameter to allow for http calls.

Method Summary

Modifier and Type	Method and Description
Response	api(Request request) A thin wrapper around the HTTP methods.
URI	buildUri(String baseUri, String endpoint, Map<String,String> queryParams) Add query parameters to a URL.
void	close() Closes the http client.
Response	delete(Request request) Make a DELETE request and provide the status code and response headers.
void	finalize() Closes and finalizes the http client.
Response	get(Request request) Make a GET request and provide the status code, response body and response headers.
Response	getResponse(org.apache.http.client.methods.CloseableHttpResponse response) Prepare a Response object from an API call via Apache's HTTP client.
Response	patch(Request request) Make a PATCH request and provide the status code, response body and response headers.
Response	post(Request request) Make a POST request and provide the status code, response body and response headers.
Response	put(Request request) Make a PUT request and provide the status code, response body and response headers.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Constructor for using the default CloseableHttpClient.

Client

public Client(org.apache.http.impl.client.CloseableHttpClient httpClient)

Constructor for passing in an httpClient, typically for mocking. Passed-in httpClient will not be closed by this Client.

Parameters:

httpClient - an Apache CloseableHttpClient

Client

public Client(Boolean test)

Constructor for passing in a test parameter to allow for http calls.

Parameters:

test - is a Bool

Client

public Client(org.apache.http.impl.client.CloseableHttpClient httpClient,
              Boolean test)

Constructor for passing in an httpClient and test parameter to allow for http calls.

Parameters:

httpClient - an Apache CloseableHttpClient

test - is a Bool

Method Detail

buildUri

public URI buildUri(String baseUri,
                    String endpoint,
                    Map<String,String> queryParams)
             throws URISyntaxException

Add query parameters to a URL.

Parameters:

baseUri - (e.g. "api.sendgrid.com")

endpoint - (e.g. "/your/endpoint/path")

queryParams - map of key, values representing the query parameters

Throws:

URISyntaxException - in of a URI syntax error

getResponse

public Response getResponse(org.apache.http.client.methods.CloseableHttpResponse response)
                     throws IOException

Prepare a Response object from an API call via Apache's HTTP client.

Parameters:

response - from a call to a CloseableHttpClient

Returns:

the response object

Throws:

IOException - in case of a network error

get

public Response get(Request request)
             throws URISyntaxException,
                    IOException

Make a GET request and provide the status code, response body and response headers.

Parameters:

request - the request object

Returns:

the response object

Throws:

URISyntaxException - in case of a URI syntax error

IOException - in case of a network error

post

public Response post(Request request)
              throws URISyntaxException,
                     IOException

Make a POST request and provide the status code, response body and response headers.

Parameters:

request - the request object

Returns:

the response object

Throws:

URISyntaxException - in case of a URI syntax error

IOException - in case of a network error

patch

public Response patch(Request request)
               throws URISyntaxException,
                      IOException

Make a PATCH request and provide the status code, response body and response headers.

Parameters:

request - the request object

Returns:

the response object

Throws:

URISyntaxException - in case of a URI syntax error

IOException - in case of a network error

put

public Response put(Request request)
             throws URISyntaxException,
                    IOException

Make a PUT request and provide the status code, response body and response headers.

Parameters:

request - the request object

Returns:

the response object

Throws:

URISyntaxException - in case of a URI syntax error

IOException - in case of a network error

delete

public Response delete(Request request)
                throws URISyntaxException,
                       IOException

Make a DELETE request and provide the status code and response headers.

Parameters:

request - the request object

Returns:

the response object

Throws:

URISyntaxException - in case of a URI syntax error

IOException - in case of a network error

api

public Response api(Request request)
             throws IOException

A thin wrapper around the HTTP methods.

Parameters:

request - the request object

Returns:

the response object

Throws:

IOException - in case of a network error

close

public void close()
           throws IOException

Closes the http client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - in case of a network error

finalize

public void finalize()
              throws Throwable

Closes and finalizes the http client.

Overrides:

finalize in class Object

Throws:

Throwable - in case of an error