com.squareup.square.api

Class BaseApi

java.lang.Object

com.squareup.square.api.BaseApi

Direct Known Subclasses:

DefaultApplePayApi, DefaultBankAccountsApi, DefaultCashDrawersApi, DefaultCatalogApi, DefaultCheckoutApi, DefaultCustomerGroupsApi, DefaultCustomersApi, DefaultCustomerSegmentsApi, DefaultDevicesApi, DefaultDisputesApi, DefaultEmployeesApi, DefaultInventoryApi, DefaultInvoicesApi, DefaultLaborApi, DefaultLocationsApi, DefaultLoyaltyApi, DefaultMerchantsApi, DefaultMobileAuthorizationApi, DefaultOAuthApi, DefaultOrdersApi, DefaultPaymentsApi, DefaultRefundsApi, DefaultSubscriptionsApi, DefaultTeamApi, DefaultTerminalApi, DefaultTransactionsApi, DefaultV1EmployeesApi, DefaultV1ItemsApi, DefaultV1LocationsApi, DefaultV1TransactionsApi

public abstract class BaseApi
extends Object

Base class for all Apis.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,AuthManager>	authManagers
protected Configuration	config Protected variables to hold an instance of Configuration
protected HttpCallback	httpCallback Protected variable to hold an instance of HttpCallback if the user provides it
protected static String	userAgent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers)
protected	BaseApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback)

Method Summary

Modifier and Type	Method and Description
HttpClient	getClientInstance() Shared instance of the Http client
HttpCallback	getHttpCallback() Get httpCallback associated with this controller
<T> CompletableFuture<T>	makeHttpCallAsync(BaseApi.RequestSupplier requestSupplier, BaseApi.RequestExecutor requestExecutor, BaseApi.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 Detail

config

protected final Configuration config

Protected variables to hold an instance of Configuration

userAgent

protected static final String userAgent

See Also:

Constant Field Values

httpCallback

protected final HttpCallback httpCallback

Protected variable to hold an instance of HttpCallback if the user provides it

authManagers

protected Map<String,AuthManager> authManagers

Constructor Detail

BaseApi

protected BaseApi(Configuration config,
                  HttpClient httpClient,
                  Map<String,AuthManager> authManagers)

BaseApi

protected BaseApi(Configuration config,
                  HttpClient httpClient,
                  Map<String,AuthManager> authManagers,
                  HttpCallback httpCallback)

Method Detail

getHttpCallback

public HttpCallback getHttpCallback()

Get httpCallback associated with this controller

Returns:

HttpCallback

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> CompletableFuture<T> makeHttpCallAsync(BaseApi.RequestSupplier requestSupplier,
                                                  BaseApi.RequestExecutor requestExecutor,
                                                  BaseApi.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