public class BandwidthClient extends java.lang.Object implements Client, java.io.Closeable
Modifier and Type | Class and Description |
---|---|
static class |
BandwidthClient.IdleConnectionMonitorRunnable |
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 |
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.
|
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.
|
public static final int MONITOR_TIMER
protected java.lang.String token
protected java.lang.String secret
protected java.lang.String apiVersion
protected java.lang.String apiEndpoint
protected java.lang.String usersUri
protected java.lang.Integer maxTotal
protected java.lang.Integer defaultMaxPerRoute
protected org.apache.http.client.HttpClient httpClient
protected static BandwidthClient INSTANCE
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)
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.public static BandwidthClient getInstance()
public static void shutdown()
public void setCredentials(java.lang.String userId, java.lang.String apiToken, java.lang.String apiSecret)
userId
- the user id.apiToken
- the API token.apiSecret
- the API secret.public void setEndpointandVersion(java.lang.String apiEndpoint, java.lang.String apiVersion)
apiEndpoint
- the API Endpoint.apiVersion
- the API version.public int getMaxTotal()
public int getDefaultMaxPerRoute()
public java.lang.String getUserResourceUri(java.lang.String path)
path
- the path.public java.lang.String getUserResourceInstanceUri(java.lang.String path, java.lang.String instanceId)
path
- the path.instanceId
- the instance id.public java.lang.String getBaseResourceUri(java.lang.String path)
path
- the path.public java.lang.String getPath(java.lang.String uri)
uri
- the URI.public java.lang.String getUserUri()
public RestResponse post(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) throws java.io.IOException, AppPlatformException
uri
- the URI.params
- the parameters.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.public RestResponse postJson(java.lang.String uri, java.lang.String params) throws java.io.IOException, AppPlatformException
uri
- the URI.params
- the parameters.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.public RestResponse get(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) throws java.lang.Exception
public RestResponse put(java.lang.String uri, java.util.Map<java.lang.String,java.lang.Object> params) throws java.io.IOException, AppPlatformException
uri
- the URIparams
- the parameters.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.public RestResponse delete(java.lang.String uri) throws java.io.IOException, AppPlatformException
uri
- the URI.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.public void upload(java.lang.String uri, java.io.File sourceFile, java.lang.String contentType) throws java.io.IOException, AppPlatformException
uri
- the URIsourceFile
- the source filecontentType
- the content type.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.public void download(java.lang.String uri, java.io.File destFile) throws java.io.IOException
uri
- the URI.destFile
- the destination file.java.io.IOException
- unexpected exception.protected RestResponse request(java.lang.String path, java.lang.String method) throws java.io.IOException, AppPlatformException
path
- the path.method
- the method.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.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
path
- the pathmethod
- the methodparamList
- the parameter list.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.protected RestResponse requestJson(java.lang.String path, java.lang.String method, java.lang.String param) throws java.io.IOException, AppPlatformException
path
- the pathmethod
- the methodparam
- payload json stringjava.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.protected RestResponse performRequest(org.apache.http.client.methods.HttpUriRequest request) throws java.io.IOException, AppPlatformException
request
- the request.java.io.IOException
- unexpected exception.AppPlatformException
- unexpected exception.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)
path
- the path.method
- the method.params
- the parameters.protected org.apache.http.client.methods.HttpUriRequest setupRequestJson(java.lang.String path, java.lang.String method, java.lang.String params)
path
- the path.method
- the method.params
- the json string.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)
method
- the method.path
- the path.params
- the parameters.protected org.apache.http.client.methods.HttpUriRequest buildMethod(java.lang.String method, java.lang.String path, java.lang.String params)
method
- the method.path
- the path.params
- json string.protected org.apache.http.client.methods.HttpGet generateGetRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap)
path
- the path.paramMap
- the parameters map.protected org.apache.http.client.methods.HttpPost generatePostRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap)
path
- the path.paramMap
- the parameters map.protected org.apache.http.client.methods.HttpPost generatePostRequest(java.lang.String path, java.lang.String param)
path
- the path.param
- json string.protected org.apache.http.client.methods.HttpPut generatePutRequest(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> paramMap)
path
- the pathparamMap
- the parameters map.protected org.apache.http.client.methods.HttpDelete generateDeleteRequest(java.lang.String path)
path
- the pathprotected java.net.URI buildUri(java.lang.String path)
path
- the path.protected java.net.URI buildUri(java.lang.String path, java.util.List<org.apache.http.NameValuePair> queryStringParams)
path
- the path.queryStringParams
- the query string parameters.protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
Copyright © 2019. All Rights Reserved.