Package com.bandwidth.controllers

Class BaseController

java.lang.Object

com.bandwidth.controllers.BaseController

Direct Known Subclasses:

APIController, APIController

public abstract class BaseController
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	BaseController.RequestExecutor	RequestExecutor
protected static interface	BaseController.RequestSupplier	RequestSupplier
protected static interface	BaseController.ResponseHandler<T>	ResponseHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,AuthManager>	authManagers
protected Configuration	config	Protected variables to hold an instance of Configuration
protected static java.lang.String	userAgent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseController(Configuration config, HttpClient httpClient, java.util.Map<java.lang.String,AuthManager> authManagers)

Method Summary

Modifier and Type	Method	Description
HttpClient	getClientInstance()	Shared instance of the Http client
<T> java.util.concurrent.CompletableFuture<ApiResponse<T>>	makeHttpCallAsync(BaseController.RequestSupplier requestSupplier, BaseController.RequestExecutor requestExecutor, BaseController.ResponseHandler<T> responseHandler)	Make an asynchronous HTTP endpoint call
protected void	validateResponse(HttpResponse response, HttpContext context)	Validates the response against HTTP errors defined at the API level

Methods inherited from class java.lang.Object

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

Field Details

config

protected final Configuration config

Protected variables to hold an instance of Configuration

userAgent

protected static final java.lang.String userAgent

See Also:

Constant Field Values

authManagers

protected java.util.Map<java.lang.String,AuthManager> authManagers

Constructor Details

BaseController

protected BaseController(Configuration config, HttpClient httpClient, java.util.Map<java.lang.String,AuthManager> authManagers)

Method Details

getClientInstance

public HttpClient getClientInstance()

Shared instance of the Http client

Returns:

The shared instance of the http client

validateResponse

protected void validateResponse(HttpResponse response, HttpContext context) throws ApiException

Validates the response against HTTP errors defined at the API level

Parameters:

response - The response recieved

context - Context of the request and the recieved response

Throws:

ApiException

makeHttpCallAsync

public <T> java.util.concurrent.CompletableFuture<ApiResponse<T>> makeHttpCallAsync(BaseController.RequestSupplier requestSupplier, BaseController.RequestExecutor requestExecutor, BaseController.ResponseHandler<T> responseHandler)

Make an asynchronous HTTP endpoint call

Parameters:

requestSupplier - An object of RequestSupplier to supply an instance of HttpRequest

requestExecutor - An object of RequestExecutor to execute the request & get the response

responseHandler - An object of ResponseHandler to handle the endpoint response

Returns:

An object of type CompletableFuture