com.sendgrid

Class Client

java.lang.Object

com.sendgrid.Client

public class Client
extends java.lang.Object

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(org.apache.http.impl.client.CloseableHttpClient httpClient) Constructor for passing in an httpClient for mocking.

Method Summary

Methods

Modifier and Type	Method and Description
Response	api(Request request) A thin wrapper around the HTTP methods.
java.net.URI	buildUri(java.lang.String baseUri, java.lang.String endpoint, java.util.Map<java.lang.String,java.lang.String> queryParams) Add query parameters to a URL.
Response	delete(Request request) Make a DELETE request and provide the status code and response headers.
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, finalize, 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 for mocking.

Parameters:

httpClient - an Apache CloseableHttpClient

Method Detail

buildUri

public java.net.URI buildUri(java.lang.String baseUri,
                    java.lang.String endpoint,
                    java.util.Map<java.lang.String,java.lang.String> queryParams)
                      throws java.net.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:

java.net.URISyntaxException

getResponse

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

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

Parameters:

response - from a call to a CloseableHttpClient

Throws:

java.io.IOException

get

public Response get(Request request)
             throws java.net.URISyntaxException,
                    java.io.IOException

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

Throws:

java.net.URISyntaxException

java.io.IOException

post

public Response post(Request request)
              throws java.net.URISyntaxException,
                     java.io.IOException

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

Throws:

java.net.URISyntaxException

java.io.IOException

patch

public Response patch(Request request)
               throws java.net.URISyntaxException,
                      java.io.IOException

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

Throws:

java.net.URISyntaxException

java.io.IOException

put

public Response put(Request request)
             throws java.net.URISyntaxException,
                    java.io.IOException

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

Throws:

java.net.URISyntaxException

java.io.IOException

delete

public Response delete(Request request)
                throws java.net.URISyntaxException,
                       java.io.IOException

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

Throws:

java.net.URISyntaxException

java.io.IOException

api

public Response api(Request request)
             throws java.io.IOException

A thin wrapper around the HTTP methods.

Throws:

java.io.IOException