Class ServiceTokenClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<ServiceToken, ServiceTokenJson>

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

All Implemented Interfaces:

Pageable<ServiceToken>, PageablePost<ServiceToken>, ServiceTokenClient<ServiceToken>

public class ServiceTokenClientImpl
extends ResourceClientBase<ServiceToken, ServiceTokenJson>
implements ServiceTokenClient<ServiceToken>

Internal client for Fabric Service Tokens. Standard plumbing/paging come from ResourceClientBase.

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
ServiceTokenClientImpl(FabricConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
ServiceTokenJson	create(ServiceTokenCreatorJson serviceTokenCreatorJson)
ServiceTokenJson	createAction(String uuid, ServiceTokenAction type)
ServiceTokenJson	delete(String uuid)
ServiceTokenJson	dryRunCreate(ServiceTokenCreatorJson serviceTokenCreatorJson)
ServiceTokenJson	dryRunUpdate(String uuid, List<PatchOperation> operations)	Dry-run variant of ServiceTokenClient.update(String, List): sends the same change-operations array to PATCH /fabric/v4/serviceTokens/{uuid} with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed".
ServiceTokenJson	getByUuid(String uuid)
Page<ServiceTokenJson>	list()
ServiceTokenJson	refresh(String uuid)
Page<ServiceTokenJson>	search(FilterPropertyList filter, SortPropertyList sort)
ServiceTokenJson	update(String uuid, List<PatchOperation> operations)
protected ServiceToken	wrap(ServiceTokenJson 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 ServiceTokenJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected ServiceTokenJson	deleteOne(String serviceEndpoint, String uuid)
protected ServiceTokenJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected ServiceTokenJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected ServiceTokenJson	dryRunCreate(String serviceEndpoint, Object body)
protected ServiceTokenJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ServiceTokenJson	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 ServiceTokenJson	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 ServiceTokenJson	getOne(String serviceEndpoint, String uuid)
protected ServiceTokenJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected ServiceTokenJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<ServiceTokenJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<ServiceTokenJson>	listPage(String serviceEndpoint)
protected Page<ServiceTokenJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<ServiceTokenJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<ServiceToken>	nextPage(PaginatedPostRequest<ServiceToken> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<ServiceToken>	nextPage(PaginatedRequest<ServiceToken> equinixRequest)
protected ServiceTokenJson	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 ServiceTokenJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected ServiceTokenJson	postOne(String serviceEndpoint, Object creatorBody)
protected ServiceTokenJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected ServiceTokenJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<ServiceTokenJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<ServiceTokenJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<ServiceTokenJson>	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<ServiceTokenJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected ServiceTokenJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected ServiceTokenJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected ServiceTokenJson	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

ServiceTokenClientImpl

public ServiceTokenClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected ServiceToken wrap(ServiceTokenJson 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<ServiceToken, ServiceTokenJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

list

public Page<ServiceTokenJson> list()

Specified by:

list in interface ServiceTokenClient<ServiceToken>

search

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

Specified by:

search in interface ServiceTokenClient<ServiceToken>

getByUuid

public ServiceTokenJson getByUuid(String uuid)

Specified by:

getByUuid in interface ServiceTokenClient<ServiceToken>

update

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

Specified by:

update in interface ServiceTokenClient<ServiceToken>

dryRunUpdate

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

Description copied from interface: ServiceTokenClient

Dry-run variant of ServiceTokenClient.update(String, List): sends the same change-operations array to PATCH /fabric/v4/serviceTokens/{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 with the validated/simulated token entity.

Specified by:

dryRunUpdate in interface ServiceTokenClient<ServiceToken>

createAction

public ServiceTokenJson createAction(String uuid,
 ServiceTokenAction type)

Specified by:

createAction in interface ServiceTokenClient<ServiceToken>

create

public ServiceTokenJson create(ServiceTokenCreatorJson serviceTokenCreatorJson)

Specified by:

create in interface ServiceTokenClient<ServiceToken>

dryRunCreate

public ServiceTokenJson dryRunCreate(ServiceTokenCreatorJson serviceTokenCreatorJson)

Specified by:

dryRunCreate in interface ServiceTokenClient<ServiceToken>

delete

public ServiceTokenJson delete(String uuid)

Specified by:

delete in interface ServiceTokenClient<ServiceToken>

refresh

public ServiceTokenJson refresh(String uuid)

Specified by:

refresh in interface ServiceTokenClient<ServiceToken>