Class ConnectionClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Connection, ConnectionJson>

com.eqixiac.equinix.fabric.client.internal.implementation.ConnectionClientImpl

All Implemented Interfaces:

Pageable<Connection>, PageablePost<Connection>, ConnectionClient<Connection>

public class ConnectionClientImpl
extends ResourceClientBase<Connection, ConnectionJson>
implements ConnectionClient<Connection>

Internal client for Fabric Connections. Standard CRUD + paging come from ResourceClientBase; the Connection-specific operations (dry-run, actions, statistics) remain bespoke below.

Author:

ianjones

Nested Class Summary

Nested classes/interfaces inherited from class ClientBase

ClientBase.EquinixRequestBuilder

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

Constructor Summary

Constructors

Constructor	Description
ConnectionClientImpl(FabricConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
RouteAggregationAttachment	attachRouteAggregation(String connectionId, String routeAggregationId)
RouteFilterAttachment	attachRouteFilter(String connectionId, String routeFilterId, Direction direction)
ConnectionJson	create(ConnectionCreatorJson connectionCreatorJson)
ConnectionJson	delete(String uuid)
Boolean	detachRouteAggregation(String connectionId, String routeAggregationId)
Boolean	detachRouteFilter(String connectionId, String routeFilterId)
ConnectionJson	dryRunCreate(ConnectionCreatorJson connectionCreatorJson)
ConnectionJson	dryRunUpdate(String uuid, List<PatchOperation> operations)	Dry-run variant of ConnectionClient.update(String, List): sends the same JSON Patch to PATCH /fabric/v4/connections/{uuid} with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed".
ConnectionJson	getByUuid(String uuid)
RouteAggregationAttachment	getRouteAggregation(String connectionId, String routeAggregationId)
List<RouteAggregationAttachment>	getRouteAggregations(String connectionId)
RouteFilterAttachment	getRouteFilter(String connectionId, String routeFilterId)
List<RouteFilterAttachment>	getRouteFilters(String connectionId)
ConnectionActionJson	performOperation(String uuid, ConnectionOperationType connectionOperationType, String description, Object bodyObject)
ConnectionJson	refresh(String uuid)
Page<ConnectionJson>	search(FilterPropertyList filter, SortPropertyList sort)
ConnectionJson	update(String uuid, List<PatchOperation> operations)
List<ValidateConnectionResult>	validate(FilterPropertyList filter)	Validates connections against the supplied filter (auth key or VLAN availability).
protected Connection	wrap(ConnectionJson json)	Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Methods inherited from class ResourceClientBase

createOne, deleteOne, deleteOne, deleteOneByUuid, dryRunCreate, dryRunCreate, dryRunPatch, dryRunUpdate, getOne, getOne, getOneByUuid, listPage, listPage, listPage, listPagePath, nextPage, nextPage, patchOne, patchOne, postOne, postOne, postOne, searchPage, searchPage, searchPageQueryPaginated, searchPageQueryPaginated, updateOne, updateOne, updateOneByUuid

Modifier and Type	Method	Description
protected ConnectionJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected ConnectionJson	deleteOne(String serviceEndpoint, String uuid)
protected ConnectionJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected ConnectionJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected ConnectionJson	dryRunCreate(String serviceEndpoint, Object body)
protected ConnectionJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ConnectionJson	dryRunPatch(String serviceEndpoint, String uuid, List<PatchOperation> operations)	Dry-run variant of ResourceClientBase.patchOne(String, String, List): sends the identical RFC 6902 JSON Patch request (same application/json-patch+json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected ConnectionJson	dryRunUpdate(String serviceEndpoint, String uuid, Object body)	Dry-run variant of ResourceClientBase.updateOne(String, String, Object): sends the identical update request (same default application/json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected ConnectionJson	getOne(String serviceEndpoint, String uuid)
protected ConnectionJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected ConnectionJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<ConnectionJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<ConnectionJson>	listPage(String serviceEndpoint)
protected Page<ConnectionJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<ConnectionJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Connection>	nextPage(PaginatedPostRequest<Connection> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Connection>	nextPage(PaginatedRequest<Connection> equinixRequest)
protected ConnectionJson	patchOne(String serviceEndpoint, String uuid, List<PatchOperation> operations)	PATCH a resource by uuid with an RFC 6902 JSON Patch operations array, sent with content-type application/json-patch+json.
protected ConnectionJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected ConnectionJson	postOne(String serviceEndpoint, Object creatorBody)
protected ConnectionJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ConnectionJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<ConnectionJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<ConnectionJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<ConnectionJson>	searchPageQueryPaginated(String serviceEndpoint, Object filterBody)	POST search whose pagination travels as offset/limit query parameters (per the endpoint's spec) rather than inside the body - e.g. assets v1 and the EIA services/prices searches.
protected Page<ConnectionJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected ConnectionJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected ConnectionJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected ConnectionJson	updateOneByUuid(String uuid, Object body)	update(uuid, body) via the derived Update<Singular> endpoint name.

Methods inherited from class ClientBase

booleanOp, buildRequest, buildRequest, buildRequestWithPathParams, buildRequestWithQueryParams, bytesOp, createReturningLocationUuid, getAs, getAs, getConfigClient, invoke, listAs, mapOp, newRequest, postAs, postForType, postForType, postForType, postListAs, stringOp, voidOp

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

ConnectionClientImpl

public ConnectionClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected Connection wrap(ConnectionJson json)

Description copied from class: ResourceClientBase

Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Specified by:

wrap in class ResourceClientBase<Connection, ConnectionJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

search

public Page<ConnectionJson> search(FilterPropertyList filter,
 SortPropertyList sort)

Specified by:

search in interface ConnectionClient<Connection>

validate

public List<ValidateConnectionResult> validate(FilterPropertyList filter)

Description copied from interface: ConnectionClient

Validates connections against the supplied filter (auth key or VLAN availability).

Specified by:

validate in interface ConnectionClient<Connection>

Returns:

a List of ValidateConnectionResult objects.

getByUuid

public ConnectionJson getByUuid(String uuid)

Specified by:

getByUuid in interface ConnectionClient<Connection>

create

public ConnectionJson create(ConnectionCreatorJson connectionCreatorJson)

Specified by:

create in interface ConnectionClient<Connection>

delete

public ConnectionJson delete(String uuid)

refresh

public ConnectionJson refresh(String uuid)

dryRunCreate

public ConnectionJson dryRunCreate(ConnectionCreatorJson connectionCreatorJson)

Specified by:

dryRunCreate in interface ConnectionClient<Connection>

performOperation

public ConnectionActionJson performOperation(String uuid,
 ConnectionOperationType connectionOperationType,
 String description,
 Object bodyObject)

Specified by:

performOperation in interface ConnectionClient<Connection>

update

public ConnectionJson update(String uuid,
 List<PatchOperation> operations)

Specified by:

update in interface ConnectionClient<Connection>

dryRunUpdate

public ConnectionJson dryRunUpdate(String uuid,
 List<PatchOperation> operations)

Description copied from interface: ConnectionClient

Dry-run variant of ConnectionClient.update(String, List): sends the same JSON Patch to PATCH /fabric/v4/connections/{uuid} with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed". Nothing is persisted; the API responds 200 (the real update responds 202) with a simulation of the post-update connection.

Specified by:

dryRunUpdate in interface ConnectionClient<Connection>

getRouteAggregations

public List<RouteAggregationAttachment> getRouteAggregations(String connectionId)

Specified by:

getRouteAggregations in interface ConnectionClient<Connection>

getRouteAggregation

public RouteAggregationAttachment getRouteAggregation(String connectionId,
 String routeAggregationId)

Specified by:

getRouteAggregation in interface ConnectionClient<Connection>

attachRouteAggregation

public RouteAggregationAttachment attachRouteAggregation(String connectionId,
 String routeAggregationId)

Specified by:

attachRouteAggregation in interface ConnectionClient<Connection>

detachRouteAggregation

public Boolean detachRouteAggregation(String connectionId,
 String routeAggregationId)

Specified by:

detachRouteAggregation in interface ConnectionClient<Connection>

getRouteFilters

public List<RouteFilterAttachment> getRouteFilters(String connectionId)

Specified by:

getRouteFilters in interface ConnectionClient<Connection>

getRouteFilter

public RouteFilterAttachment getRouteFilter(String connectionId,
 String routeFilterId)

Specified by:

getRouteFilter in interface ConnectionClient<Connection>

attachRouteFilter

public RouteFilterAttachment attachRouteFilter(String connectionId,
 String routeFilterId,
 Direction direction)

Specified by:

attachRouteFilter in interface ConnectionClient<Connection>

detachRouteFilter

public Boolean detachRouteFilter(String connectionId,
 String routeFilterId)

Specified by:

detachRouteFilter in interface ConnectionClient<Connection>