Class ClientBase

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

Direct Known Subclasses:

AccessPolicyClientImpl, AgreementClientImpl, CoreClientImpl, CrossConnectClientImpl, DigitalLoasClientImpl, DiscoveryClientImpl, EffectivePermissionClientImpl, FilesClientImpl, HealthClientImpl, HierarchyClientImpl, LegacyEnvironmentalClientImpl, LegacyPowerClientImpl, LookupClientImpl, NotificationClientImpl, NotificationClientImpl, OidcProviderClientImpl, OrderHistoryClientImpl, PermissionSetClientImpl, PolicyMaskClientImpl, PortPackageClientImpl, PricingClientImpl, PrincipalPolicyClientImpl, ResourceClientBase, ResourceTypeClientImpl, RoleAssignmentClientImpl, RoleClientImpl, SecureCabinetClientImpl, ShipmentClientImpl, SmartHandsClientImpl, SmartViewAssetClientImpl, SupportCasesClientImpl, TokenClientImpl, TroubleTicketOrderClientImpl, UnifiedNotificationsClientImpl, WorkVisitClientImpl

public class ClientBase
extends Object

Author:

ianjones

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ClientBase.EquinixRequestBuilder	Fluent builder for constructing EquinixRequest instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientBase(Config configClient, String functionalArea, String requestParent)

Method Summary

Modifier and Type	Method	Description
protected boolean	booleanOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected byte[]	bytesOp(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams)
protected String	createReturningLocationUuid(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	POST a body, then return the created resource's uuid parsed from the response Location header (for endpoints that return 201 Location: .../{uuid} rather than a body).
protected <R> R	getAs(String serviceEndpoint, Class<R> responseType)
protected <R> R	getAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> responseType)
protected Config	getConfigClient()
protected <T> EquinixResponse<T>	invoke(EquinixRequest<T> equinixRequest)
protected <R> List<R>	listAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> elementType)
protected Map<String,String>	mapOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected ClientBase.EquinixRequestBuilder	newRequest(String serviceEndpoint)	Creates a fluent request builder for the given service endpoint.
protected <R> R	postAs(String serviceEndpoint, Object body, Class<R> responseType)
protected <R> R	postForType(String serviceEndpoint, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> List<R>	postListAs(String serviceEndpoint, Object body, Class<R> elementType)
protected String	stringOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected void	voidOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	Execute a request for its side effect only - the response body is validated (throws on API error) and discarded.

Methods inherited from class Object

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

Constructor Details

ClientBase

protected ClientBase(Config configClient,
 String functionalArea,
 String requestParent)

Method Details

getConfigClient

protected Config getConfigClient()

invoke

protected <T> EquinixResponse<T> invoke(EquinixRequest<T> equinixRequest)

newRequest

protected ClientBase.EquinixRequestBuilder newRequest(String serviceEndpoint)

Creates a fluent request builder for the given service endpoint.

EquinixRequest<Connection> request = this.newRequest("GetConnection")
    .withType(RequestType.SINGLE)
    .withPathParams(Map.of("uuid", uuid))
    .withTypeRef(ConnectionJson.getSingleTypeRef())
    .build();

Parameters:

serviceEndpoint - the service endpoint name from the apiParams JSON

Returns:

a new ClientBase.EquinixRequestBuilder

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType,
 Class<?> jsonClass)

buildRequestWithPathParams

protected <T> EquinixRequest<T> buildRequestWithPathParams(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Class<?> jsonClass)

buildRequestWithQueryParams

protected <T> EquinixRequest<T> buildRequestWithQueryParams(String serviceEndpoint,
 RequestType requestType,
 Map<String, List<String>> queryParams,
 Class<?> jsonClass)

buildRequest

protected <T> EquinixRequest<T> buildRequest(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Class<?> jsonClass)

getAs

protected <R> R getAs(String serviceEndpoint,
 Class<R> responseType)

getAs

protected <R> R getAs(String serviceEndpoint,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Class<R> responseType)

postAs

protected <R> R postAs(String serviceEndpoint,
 Object body,
 Class<R> responseType)

postForType

protected <R> R postForType(String serviceEndpoint,
 Object body,
 com.fasterxml.jackson.core.type.TypeReference<?> typeReference)

listAs

protected <R> List<R> listAs(String serviceEndpoint,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Class<R> elementType)

postListAs

protected <R> List<R> postListAs(String serviceEndpoint,
 Object body,
 Class<R> elementType)

mapOp

protected Map<String,String> mapOp(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body)

booleanOp

protected boolean booleanOp(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body)

stringOp

protected String stringOp(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body)

bytesOp

protected byte[] bytesOp(String serviceEndpoint,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams)

voidOp

protected void voidOp(String serviceEndpoint,
 RequestType requestType,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body)

Execute a request for its side effect only - the response body is validated (throws on API error) and discarded. Useful for update/action endpoints whose result is then re-fetched (e.g. voidOp("UpdateX", SINGLE, pathParams, null, body); return getByUuid(uuid);).

postForType

protected <R> R postForType(String serviceEndpoint,
 Map<String,String> pathParams,
 Object body,
 com.fasterxml.jackson.core.type.TypeReference<?> typeReference)

postForType

protected <R> R postForType(String serviceEndpoint,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body,
 com.fasterxml.jackson.core.type.TypeReference<?> typeReference)

createReturningLocationUuid

protected String createReturningLocationUuid(String serviceEndpoint,
 Map<String,String> pathParams,
 Map<String, List<String>> queryParams,
 Object body)

POST a body, then return the created resource's uuid parsed from the response Location header (for endpoints that return 201 Location: .../{uuid} rather than a body). Pair with getByUuid(...) to return the created resource.