com.bandwidth.sdk

Class BandwidthRestClient

java.lang.Object

com.bandwidth.sdk.BandwidthRestClient

All Implemented Interfaces:

Client

public class BandwidthRestClient
extends Object
implements Client

Main point of using Bandwidth API.

Author:

vpotapenko

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiEndpoint
protected String	apiVersion
static String	BANDWIDTH_API_ENDPOINT
static String	BANDWIDTH_API_SECRET
static String	BANDWIDTH_API_TOKEN
static String	BANDWIDTH_API_VERSION
static String	BANDWIDTH_USER_ID
protected String	baseUri
protected static String	DELETE
protected static String	GET
protected org.apache.http.client.HttpClient	httpClient
protected static BandwidthRestClient	INSTANCE
protected static String	POST
protected static String	PUT
protected String	secret
protected String	token
protected String	usersUri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BandwidthRestClient(String userId, String token, String secret, String apiEndpoint, String apiVersion)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	buildMethod(String method, String path, Map<String,Object> params)
protected URI	buildUri(String path)
protected URI	buildUri(String path, List<org.apache.http.NameValuePair> queryStringParams)
org.json.simple.JSONObject	create(String uri, Map<String,Object> params)
void	delete(String uri)
void	downloadFileTo(String uri, File destFile)
protected org.apache.http.client.methods.HttpDelete	generateDeleteRequest(String path)
protected org.apache.http.client.methods.HttpGet	generateGetRequest(String path, Map<String,Object> paramMap)
protected org.apache.http.client.methods.HttpPost	generatePostRequest(String path, Map<String,Object> paramMap)
protected org.apache.http.client.methods.HttpPut	generatePutRequest(String path, Map<String,Object> paramMap)
RestResponse	get(String uri, Map<String,Object> params) HTTP get method.
org.json.simple.JSONArray	getArray(String uri, Map<String,Object> params)
String	getBaseResourceUri(String path)
static BandwidthRestClient	getInstance()
NumberInfo	getNumberInfoByNumber(String number) Returns information about this number.
org.json.simple.JSONObject	getObject(String uri)
org.json.simple.JSONObject	getObjectFromLocation(String locationUrl)
String	getPath(String uri)
String	getUserResourceInstanceUri(String path, String instanceId)
String	getUserResourceUri(String path)
String	getUserUri() Returns API url with userid
protected RestResponse	performRequest(org.apache.http.client.methods.HttpUriRequest request)
RestResponse	post(String uri, Map<String,Object> params)
protected RestResponse	request(String path, String method)
protected RestResponse	request(String path, String method, Map<String,Object> paramList)
protected void	setHeaders(org.apache.http.HttpRequest request)
protected org.apache.http.client.methods.HttpUriRequest	setupRequest(String path, String method, Map<String,Object> params)
void	uploadFile(String uri, File sourceFile, String contentType)

Methods inherited from class java.lang.Object

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

Field Detail

GET

protected static final String GET

See Also:

Constant Field Values

POST

protected static final String POST

See Also:

Constant Field Values

PUT

protected static final String PUT

See Also:

Constant Field Values

DELETE

protected static final String DELETE

See Also:

Constant Field Values

BANDWIDTH_USER_ID

public static String BANDWIDTH_USER_ID

BANDWIDTH_API_TOKEN

public static String BANDWIDTH_API_TOKEN

BANDWIDTH_API_SECRET

public static String BANDWIDTH_API_SECRET

BANDWIDTH_API_ENDPOINT

public static String BANDWIDTH_API_ENDPOINT

BANDWIDTH_API_VERSION

public static String BANDWIDTH_API_VERSION

usersUri

protected final String usersUri

baseUri

protected final String baseUri

token

protected final String token

secret

protected final String secret

httpClient

protected org.apache.http.client.HttpClient httpClient

INSTANCE

protected static BandwidthRestClient INSTANCE

apiEndpoint

protected String apiEndpoint

apiVersion

protected String apiVersion

Constructor Detail

BandwidthRestClient

protected BandwidthRestClient(String userId,
                   String token,
                   String secret,
                   String apiEndpoint,
                   String apiVersion)

Method Detail

getInstance

public static BandwidthRestClient getInstance()

getUserResourceUri

public String getUserResourceUri(String path)

getUserResourceInstanceUri

public String getUserResourceInstanceUri(String path,
                                String instanceId)

getBaseResourceUri

public String getBaseResourceUri(String path)

getUserUri

public String getUserUri()

Returns API url with userid

Returns:

usersUri

getNumberInfoByNumber

public NumberInfo getNumberInfoByNumber(String number)
                                 throws IOException

Returns information about this number.

Parameters:

number - searching number

Returns:

information about the number

Throws:

IOException

get

public RestResponse get(String uri,
               Map<String,Object> params)
                 throws IOException

HTTP get method. Returns a RestResponse object

Specified by:

get in interface Client

Parameters:

uri -

params -

Returns:

Throws:

IOException

setHeaders

protected void setHeaders(org.apache.http.HttpRequest request)

getArray

public org.json.simple.JSONArray getArray(String uri,
                                 Map<String,Object> params)
                                   throws IOException

Throws:

IOException

getObject

public org.json.simple.JSONObject getObject(String uri)
                                     throws IOException

Throws:

IOException

getObjectFromLocation

public org.json.simple.JSONObject getObjectFromLocation(String locationUrl)
                                                 throws IOException

Throws:

IOException

create

public org.json.simple.JSONObject create(String uri,
                                Map<String,Object> params)
                                  throws IOException

Throws:

IOException

post

public RestResponse post(String uri,
                Map<String,Object> params)
                  throws IOException

Throws:

IOException

delete

public void delete(String uri)
            throws IOException

Throws:

IOException

uploadFile

public void uploadFile(String uri,
              File sourceFile,
              String contentType)
                throws IOException

Throws:

IOException

downloadFileTo

public void downloadFileTo(String uri,
                  File destFile)
                    throws IOException

Throws:

IOException

getPath

public String getPath(String uri)

request

protected RestResponse request(String path,
                   String method)
                        throws IOException

Throws:

IOException

request

protected RestResponse request(String path,
                   String method,
                   Map<String,Object> paramList)
                        throws IOException

Throws:

IOException

performRequest

protected RestResponse performRequest(org.apache.http.client.methods.HttpUriRequest request)
                               throws IOException

Throws:

IOException

setupRequest

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

buildMethod

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

generateGetRequest

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

generatePostRequest

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

generatePutRequest

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

generateDeleteRequest

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

buildUri

protected URI buildUri(String path)

buildUri

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