com.sendgrid

Class SendGrid

java.lang.Object

com.sendgrid.SendGrid

All Implemented Interfaces:

SendGridAPI

public class SendGrid
extends java.lang.Object
implements SendGridAPI

Class SendGrid allows for quick and easy access to the SendGrid API.

Constructor Summary

Constructors

Constructor and Description
SendGrid(java.lang.String apiKey) Construct a new SendGrid API wrapper.
SendGrid(java.lang.String apiKey, java.lang.Boolean test) Construct a new SendGrid API wrapper.
SendGrid(java.lang.String apiKey, com.sendgrid.Client client) Construct a new SendGrid API wrapper.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	addRequestHeader(java.lang.String key, java.lang.String value) Add a new request header.
com.sendgrid.Response	api(com.sendgrid.Request request) Class api sets up the request to the SendGrid API, this is main interface.
void	attempt(com.sendgrid.Request request) Attempt an API call.
void	attempt(com.sendgrid.Request request, APICallback callback) Attempt an API call.
java.lang.String	getHost() Get the SendGrid host (api.sendgrid.com by default).
java.lang.String	getLibraryVersion() Retrieve the current library version.
int	getRateLimitRetry() Get the maximum number of retries on a rate limit response.
int	getRateLimitSleep() Get the duration of time (in milliseconds) to sleep between consecutive rate limit retries.
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Obtain the request headers.
java.lang.String	getVersion() Get the API version.
void	initializeSendGrid(java.lang.String apiKey) Initialize the client.
com.sendgrid.Response	makeCall(com.sendgrid.Request request) Makes the call to the SendGrid API, override this method for testing.
java.util.Map<java.lang.String,java.lang.String>	removeRequestHeader(java.lang.String key) Remove a request header.
void	setHost(java.lang.String host) Set the SendGrid host.
void	setRateLimitRetry(int rateLimitRetry) Set the maximum number of retries on a rate limit response.
void	setRateLimitSleep(int rateLimitSleep) Set the duration of time (in milliseconds) to sleep between consecutive rate limit retries.
void	setVersion(java.lang.String version) Set the API version.

Methods inherited from class java.lang.Object

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

Constructor Detail

SendGrid

public SendGrid(java.lang.String apiKey)

Construct a new SendGrid API wrapper.

Parameters:

apiKey - is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys

SendGrid

public SendGrid(java.lang.String apiKey,
                java.lang.Boolean test)

Construct a new SendGrid API wrapper.

Parameters:

apiKey - is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys

test - is true if you are unit testing

SendGrid

public SendGrid(java.lang.String apiKey,
                com.sendgrid.Client client)

Construct a new SendGrid API wrapper.

Parameters:

apiKey - is your SendGrid API Key: https://app.sendgrid.com/settings/api_keys

client - the Client to use (allows to customize its configuration)

Method Detail

initializeSendGrid

public void initializeSendGrid(java.lang.String apiKey)

Initialize the client.

Specified by:

initializeSendGrid in interface SendGridAPI

Parameters:

apiKey - the user's API key.

getLibraryVersion

public java.lang.String getLibraryVersion()

Retrieve the current library version.

Specified by:

getLibraryVersion in interface SendGridAPI

Returns:

the current version.

getVersion

public java.lang.String getVersion()

Get the API version.

Specified by:

getVersion in interface SendGridAPI

Returns:

the current API versioin (v3 by default).

setVersion

public void setVersion(java.lang.String version)

Set the API version.

Specified by:

setVersion in interface SendGridAPI

Parameters:

version - the new version.

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Obtain the request headers.

Specified by:

getRequestHeaders in interface SendGridAPI

Returns:

the request headers.

addRequestHeader

public java.util.Map<java.lang.String,java.lang.String> addRequestHeader(java.lang.String key,
                                                                         java.lang.String value)

Add a new request header.

Specified by:

addRequestHeader in interface SendGridAPI

Parameters:

key - the header key.

value - the header value.

Returns:

the new set of request headers.

removeRequestHeader

public java.util.Map<java.lang.String,java.lang.String> removeRequestHeader(java.lang.String key)

Remove a request header.

Specified by:

removeRequestHeader in interface SendGridAPI

Parameters:

key - the header key to remove.

Returns:

the new set of request headers.

getHost

public java.lang.String getHost()

Get the SendGrid host (api.sendgrid.com by default).

Specified by:

getHost in interface SendGridAPI

Returns:

the SendGrid host.

setHost

public void setHost(java.lang.String host)

Set the SendGrid host.

Specified by:

setHost in interface SendGridAPI

Parameters:

host - the new SendGrid host.

getRateLimitRetry

public int getRateLimitRetry()

Get the maximum number of retries on a rate limit response. The default is 5.

Returns:

the number of retries on a rate limit.

setRateLimitRetry

public void setRateLimitRetry(int rateLimitRetry)

Set the maximum number of retries on a rate limit response.

Parameters:

rateLimitRetry - the maximum retry count.

getRateLimitSleep

public int getRateLimitSleep()

Get the duration of time (in milliseconds) to sleep between consecutive rate limit retries. The SendGrid API enforces the rate limit to the second. The default value is 1.1 seconds.

Returns:

the sleep duration.

setRateLimitSleep

public void setRateLimitSleep(int rateLimitSleep)

Set the duration of time (in milliseconds) to sleep between consecutive rate limit retries.

Parameters:

rateLimitSleep - the sleep duration.

makeCall

public com.sendgrid.Response makeCall(com.sendgrid.Request request)
                               throws java.io.IOException

Makes the call to the SendGrid API, override this method for testing.

Specified by:

makeCall in interface SendGridAPI

Parameters:

request - the request to make.

Returns:

the response object.

Throws:

java.io.IOException - in case of a network error.

api

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

Class api sets up the request to the SendGrid API, this is main interface.

Specified by:

api in interface SendGridAPI

Parameters:

request - the request object.

Returns:

the response object.

Throws:

java.io.IOException - in case of a network error.

attempt

public void attempt(com.sendgrid.Request request)

Attempt an API call. This method executes the API call asynchronously on an internal thread pool. If the call is rate limited, the thread will retry up to the maximum configured time.

Parameters:

request - the API request.

attempt

public void attempt(com.sendgrid.Request request,
                    APICallback callback)

Attempt an API call. This method executes the API call asynchronously on an internal thread pool. If the call is rate limited, the thread will retry up to the maximum configured time. The supplied callback will be called in the event of an error, or a successful response.

Parameters:

request - the API request.

callback - the callback.