com.bandwidth.sdk

Class BandwidthClient

java.lang.Object

com.bandwidth.sdk.BandwidthClient

All Implemented Interfaces:

Client, java.io.Closeable, java.lang.AutoCloseable

public class BandwidthClient
extends java.lang.Object
implements Client, java.io.Closeable

Helper class to abstract the HTTP interface. This class wraps the HttpClient and the HTTP methods POST, GET, PUT and DELETE. This class also holds the credentials to the back end and includes several convenience methods for building the appropriate resource URIs. This class is used as a singleton by the different resource classes in com.bandwidth.sdk.models. Created by sbarstow on 10/3/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BandwidthClient.IdleConnectionMonitorRunnable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiEndpoint
protected java.lang.String	apiVersion
protected java.lang.Integer	defaultMaxPerRoute
protected org.apache.http.client.HttpClient	httpClient
protected static BandwidthClient	INSTANCE
protected java.lang.Integer	maxTotal
static int	MONITOR_TIMER
protected java.lang.String	secret
protected java.lang.String	token
protected java.lang.String	usersUri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BandwidthClient(java.lang.String userId, java.lang.String apiToken, java.lang.String apiSecret, java.lang.String apiEndpoint, java.lang.String apiVersion, java.lang.Integer maxTotal, java.lang.Integer defaultMaxPerRoute) Constructor.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	buildMethod(java.lang.String method, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> params) Helper method that builds the request to the server.
protected org.apache.http.client.methods.HttpUriRequest	buildMethod(java.lang.String method, java.lang.String path, java.lang.String params) Helper method that builds the request to the server.
protected java.net.URI	buildUri(java.lang.String path) Helper method to return URI
protected java.net.URI	buildUri(java.lang.String path, java.util.List<org.apache.http.NameValuePair> queryStringParams) Helper method to return URI query parameters
void	close()
RestResponse	delete(java.lang.String uri) This method implements an HTTP delete.
void	download(java.lang.String uri, java.io.File destFile) Convenience method to download files from the server.
protected void	finalize()
protected org.apache.http.client.methods.HttpDelete	generateDeleteRequest(java.lang.String path) Helper method to build the HTTP DELETE request for the server.
protected org.apache.http.client.methods.HttpGet	generateGetRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap) Helper method to build the GET request for the server.
protected org.apache.http.client.methods.HttpPost	generatePostRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap) Helper method to build the POST request for the server.
protected org.apache.http.client.methods.HttpPost	generatePostRequest(java.lang.String path, java.lang.String param) Helper method to build the POST request for the server.
protected org.apache.http.client.methods.HttpPut	generatePutRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap) Helper method to build the PUT request for the server.
RestResponse	get(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) This method implements an HTTP GET.
java.lang.String	getBaseResourceUri(java.lang.String path) Convenience method that returns the base resource URI.
int	getDefaultMaxPerRoute()
static BandwidthClient	getInstance() getInstance() method returns a singleton instance of the BandwidthClient.
int	getMaxTotal()
java.lang.String	getPath(java.lang.String uri) Convenience method to return the full URL, including Endpoint and version, to a given resource.
java.lang.String	getUserResourceInstanceUri(java.lang.String path, java.lang.String instanceId) Convenience method that returns the resource instance uri.
java.lang.String	getUserResourceUri(java.lang.String path) Convenience method to return the resource URL with the users credentials, e.g.
java.lang.String	getUserUri() Returns API URL with userid
protected RestResponse	performRequest(org.apache.http.client.methods.HttpUriRequest request) Helper method that executes the request on the server.
RestResponse	post(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) This method implements an HTTP POST.
RestResponse	postJson(java.lang.String uri, java.lang.String params) This method implements an HTTP POST.
RestResponse	put(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) This method implements an HTTP put.
protected RestResponse	request(java.lang.String path, java.lang.String method) Helper method to build the request to the server.
protected RestResponse	request(java.lang.String path, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> paramList) Helper method to build the request to the server.
protected RestResponse	requestJson(java.lang.String path, java.lang.String method, java.lang.String param) Helper method to build the request to the server.
void	setCredentials(java.lang.String userId, java.lang.String apiToken, java.lang.String apiSecret) The setCredentials() provides a convenience method to pass the userId, API-token and API-secret after a client has been instantiated.
void	setEndpointandVersion(java.lang.String apiEndpoint, java.lang.String apiVersion) The setEndpointandVersion() method provides a convenience method to pass the apiEndpoint and apiVersion after a client has been instantiated.
protected org.apache.http.client.methods.HttpUriRequest	setupRequest(java.lang.String path, java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> params) Helper method to build the request to the server.
protected org.apache.http.client.methods.HttpUriRequest	setupRequestJson(java.lang.String path, java.lang.String method, java.lang.String params) Helper method to build the request to the server.
static void	shutdown()
void	upload(java.lang.String uri, java.io.File sourceFile, java.lang.String contentType) Convenience method to upload files to the server.

Methods inherited from class java.lang.Object

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

Field Detail

MONITOR_TIMER

public static final int MONITOR_TIMER

See Also:

Constant Field Values

token

protected java.lang.String token

secret

protected java.lang.String secret

apiVersion

protected java.lang.String apiVersion

apiEndpoint

protected java.lang.String apiEndpoint

usersUri

protected java.lang.String usersUri

maxTotal

protected java.lang.Integer maxTotal

defaultMaxPerRoute

protected java.lang.Integer defaultMaxPerRoute

httpClient

protected org.apache.http.client.HttpClient httpClient

INSTANCE

protected static BandwidthClient INSTANCE

Constructor Detail

BandwidthClient

protected BandwidthClient(java.lang.String userId,
                          java.lang.String apiToken,
                          java.lang.String apiSecret,
                          java.lang.String apiEndpoint,
                          java.lang.String apiVersion,
                          java.lang.Integer maxTotal,
                          java.lang.Integer defaultMaxPerRoute)

Constructor. Instances are created through getInstance() method.

Parameters:

userId - the user id.

apiToken - the user API token.

apiSecret - the user API secret.

apiEndpoint - the API Endpoint.

apiVersion - the API version.

maxTotal - the API Endpoint.

defaultMaxPerRoute - the API version.

Method Detail

getInstance

public static BandwidthClient getInstance()

getInstance() method returns a singleton instance of the BandwidthClient. Looks for user-id, api-token and api-secret as environment variables or system properties. These can also be set using the setCredentials method.

Returns:

the BandwidthClient

shutdown

public static void shutdown()

setCredentials

public void setCredentials(java.lang.String userId,
                           java.lang.String apiToken,
                           java.lang.String apiSecret)

The setCredentials() provides a convenience method to pass the userId, API-token and API-secret after a client has been instantiated.

Parameters:

userId - the user id.

apiToken - the API token.

apiSecret - the API secret.

setEndpointandVersion

public void setEndpointandVersion(java.lang.String apiEndpoint,
                                  java.lang.String apiVersion)

The setEndpointandVersion() method provides a convenience method to pass the apiEndpoint and apiVersion after a client has been instantiated.

Parameters:

apiEndpoint - the API Endpoint.

apiVersion - the API version.

getMaxTotal

public int getMaxTotal()

getDefaultMaxPerRoute

public int getDefaultMaxPerRoute()

getUserResourceUri

public java.lang.String getUserResourceUri(java.lang.String path)

Convenience method to return the resource URL with the users credentials, e.g.

Parameters:

path - the path.

Returns:

the joined path.

getUserResourceInstanceUri

public java.lang.String getUserResourceInstanceUri(java.lang.String path,
                                                   java.lang.String instanceId)

Convenience method that returns the resource instance uri. E.g.

Parameters:

path - the path.

instanceId - the instance id.

Returns:

The user Instance URI.

getBaseResourceUri

public java.lang.String getBaseResourceUri(java.lang.String path)

Convenience method that returns the base resource URI. E.g.

Parameters:

path - the path.

Returns:

the base resource URI.

getPath

public java.lang.String getPath(java.lang.String uri)

Convenience method to return the full URL, including Endpoint and version, to a given resource. E.g.

Parameters:

uri - the URI.

Returns:

the path.

getUserUri

public java.lang.String getUserUri()

Returns API URL with userid

Returns:

usersUri

post

public RestResponse post(java.lang.String uri,
                         java.util.Map<java.lang.String,java.lang.Object> params)
                  throws java.io.IOException,
                         AppPlatformException

This method implements an HTTP POST. Use this method to create a new resource.

Parameters:

uri - the URI.

params - the parameters.

Returns:

the post response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

postJson

public RestResponse postJson(java.lang.String uri,
                             java.lang.String params)
                      throws java.io.IOException,
                             AppPlatformException

This method implements an HTTP POST. Use this method to create a new resource.

Parameters:

uri - the URI.

params - the parameters.

Returns:

the post response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

get

public RestResponse get(java.lang.String uri,
                        java.util.Map<java.lang.String,java.lang.Object> params)
                 throws java.lang.Exception

This method implements an HTTP GET. Use this method to retrieve a resource.

Specified by:

get in interface Client

Parameters:

uri - the URI.

params - the parameters.

Returns:

the get response.

Throws:

java.lang.Exception - unexpected exception.

put

public RestResponse put(java.lang.String uri,
                        java.util.Map<java.lang.String,java.lang.Object> params)
                 throws java.io.IOException,
                        AppPlatformException

This method implements an HTTP put. Use this method to update a resource.

Parameters:

uri - the URI

params - the parameters.

Returns:

the put response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

delete

public RestResponse delete(java.lang.String uri)
                    throws java.io.IOException,
                           AppPlatformException

This method implements an HTTP delete. Use this method to remove a resource.

Parameters:

uri - the URI.

Returns:

the response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

upload

public void upload(java.lang.String uri,
                   java.io.File sourceFile,
                   java.lang.String contentType)
            throws java.io.IOException,
                   AppPlatformException

Convenience method to upload files to the server. User to upload media.

Parameters:

uri - the URI

sourceFile - the source file

contentType - the content type.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

download

public void download(java.lang.String uri,
                     java.io.File destFile)
              throws java.io.IOException

Convenience method to download files from the server. Used to retrieve media files.

Parameters:

uri - the URI.

destFile - the destination file.

Throws:

java.io.IOException - unexpected exception.

request

protected RestResponse request(java.lang.String path,
                               java.lang.String method)
                        throws java.io.IOException,
                               AppPlatformException

Helper method to build the request to the server.

Parameters:

path - the path.

method - the method.

Returns:

the request response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

request

protected RestResponse request(java.lang.String path,
                               java.lang.String method,
                               java.util.Map<java.lang.String,java.lang.Object> paramList)
                        throws java.io.IOException,
                               AppPlatformException

Helper method to build the request to the server.

Parameters:

path - the path

method - the method

paramList - the parameter list.

Returns:

the response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

requestJson

protected RestResponse requestJson(java.lang.String path,
                                   java.lang.String method,
                                   java.lang.String param)
                            throws java.io.IOException,
                                   AppPlatformException

Helper method to build the request to the server.

Parameters:

path - the path

method - the method

param - payload json string

Returns:

the response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

performRequest

protected RestResponse performRequest(org.apache.http.client.methods.HttpUriRequest request)
                               throws java.io.IOException,
                                      AppPlatformException

Helper method that executes the request on the server.

Parameters:

request - the request.

Returns:

the response.

Throws:

java.io.IOException - unexpected exception.

AppPlatformException - unexpected exception.

setupRequest

protected org.apache.http.client.methods.HttpUriRequest setupRequest(java.lang.String path,
                                                                     java.lang.String method,
                                                                     java.util.Map<java.lang.String,java.lang.Object> params)

Helper method to build the request to the server.

Parameters:

path - the path.

method - the method.

params - the parameters.

Returns:

the request.

setupRequestJson

protected org.apache.http.client.methods.HttpUriRequest setupRequestJson(java.lang.String path,
                                                                         java.lang.String method,
                                                                         java.lang.String params)

Helper method to build the request to the server.

Parameters:

path - the path.

method - the method.

params - the json string.

Returns:

the request.

buildMethod

protected org.apache.http.client.methods.HttpUriRequest buildMethod(java.lang.String method,
                                                                    java.lang.String path,
                                                                    java.util.Map<java.lang.String,java.lang.Object> params)

Helper method that builds the request to the server.

Parameters:

method - the method.

path - the path.

params - the parameters.

Returns:

the request.

buildMethod

protected org.apache.http.client.methods.HttpUriRequest buildMethod(java.lang.String method,
                                                                    java.lang.String path,
                                                                    java.lang.String params)

Helper method that builds the request to the server. Only POST is supported currently since we have cases in the API like token creation that accepts empty string payload "", instead of {}

Parameters:

method - the method.

path - the path.

params - json string.

Returns:

the request.

generateGetRequest

protected org.apache.http.client.methods.HttpGet generateGetRequest(java.lang.String path,
                                                                    java.util.Map<java.lang.String,java.lang.Object> paramMap)

Helper method to build the GET request for the server.

Parameters:

path - the path.

paramMap - the parameters map.

Returns:

the get object.

generatePostRequest

protected org.apache.http.client.methods.HttpPost generatePostRequest(java.lang.String path,
                                                                      java.util.Map<java.lang.String,java.lang.Object> paramMap)

Helper method to build the POST request for the server.

Parameters:

path - the path.

paramMap - the parameters map.

Returns:

the post object.

generatePostRequest

protected org.apache.http.client.methods.HttpPost generatePostRequest(java.lang.String path,
                                                                      java.lang.String param)

Helper method to build the POST request for the server.

Parameters:

path - the path.

param - json string.

Returns:

the post object.

generatePutRequest

protected org.apache.http.client.methods.HttpPut generatePutRequest(java.lang.String path,
                                                                    java.util.Map<java.lang.String,java.lang.Object> paramMap)

Helper method to build the PUT request for the server.

Parameters:

path - the path

paramMap - the parameters map.

Returns:

the put object.

generateDeleteRequest

protected org.apache.http.client.methods.HttpDelete generateDeleteRequest(java.lang.String path)

Helper method to build the HTTP DELETE request for the server.

Parameters:

path - the path

Returns:

the delete object.

buildUri

protected java.net.URI buildUri(java.lang.String path)

Helper method to return URI

Parameters:

path - the path.

Returns:

the URI object.

buildUri

protected java.net.URI buildUri(java.lang.String path,
                                java.util.List<org.apache.http.NameValuePair> queryStringParams)

Helper method to return URI query parameters

Parameters:

path - the path.

queryStringParams - the query string parameters.

Returns:

the URI object.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable