Package co.ankatech.ankasecure.keymanagement

Class ExchangeOperations

java.lang.Object

co.ankatech.ankasecure.keymanagement.ExchangeOperations

public final class ExchangeOperations
extends Object

The tenant's cryptographic exchanges: drafts, validation, activation and the lifecycle of an active exchange. Obtained from AuthenticatedKeyManagementSdk.exchanges(). The exchange routes carry no tenant in their path: the Admin API takes it from the token, like every other operation here.

 ExchangeDetailResponse draft = sdk.exchanges().create(new ExchangeCreateRequest().name("payroll-to-bank"));
 ValidationResultResponse verdict = sdk.exchanges().validate(draft.getId());
 

Method Summary

Modifier and Type	Method	Description
ExchangeDetailResponse	activate(UUID id, ActivateRequest request)	Activates a validated exchange (POST /exchanges/{id}/activate).
ExchangeDetailResponse	cloneExchange(UUID id, CloneRequest request)	Clones an exchange into a new draft (POST /exchanges/{id}/clone).
ExchangeDetailResponse	create(ExchangeCreateRequest request)	Creates a draft exchange (POST /exchanges).
void	discardDraft(UUID id, int version)	Discards a draft exchange (DELETE /exchanges/{id}).
ExchangeDetailResponse	get(UUID id)	Reads one exchange (GET /exchanges/{id}).
PageExchangeListItemResponse	list(ExchangeListQuery query)	Lists exchanges (GET /exchanges).
ExchangeActivationPreviewResponse	previewActivation(UUID id, String capability)	Previews what an activation would grant (GET /exchanges/{id}/activation-preview).
ExchangeDetailResponse	resume(UUID id, ResumeExchangeRequest request)	Resumes a suspended exchange (POST /exchanges/{id}/resume).
ExchangeDetailResponse	revoke(UUID id, RevokeExchangeRequest request)	Revokes an exchange for good (POST /exchanges/{id}/revoke).
ExchangeDetailResponse	suspend(UUID id, SuspendExchangeRequest request)	Suspends an active exchange (POST /exchanges/{id}/suspend).
ExchangeDetailResponse	update(UUID id, ExchangeUpdateRequest request)	Updates an exchange (PATCH /exchanges/{id}).
ValidationResultResponse	validate(UUID id)	Validates a draft exchange (POST /exchanges/{id}/validate).

Methods inherited from class java.lang.Object

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

Method Details

list

public PageExchangeListItemResponse list(ExchangeListQuery query)

Lists exchanges (GET /exchanges).

Parameters:

query - the filters and page; must not be null

Returns:

one page of exchanges

Throws:

KeyManagementSdkException - when the call is refused

create

public ExchangeDetailResponse create(ExchangeCreateRequest request)

Creates a draft exchange (POST /exchanges).

Parameters:

request - the exchange; must not be null

Returns:

the created draft

Throws:

KeyManagementSdkException - when the call is refused

get

public ExchangeDetailResponse get(UUID id)

Reads one exchange (GET /exchanges/{id}).

Parameters:

id - the exchange; must not be null

Returns:

the exchange

Throws:

KeyManagementSdkException - when the call is refused

update

public ExchangeDetailResponse update(UUID id,
 ExchangeUpdateRequest request)

Updates an exchange (PATCH /exchanges/{id}).

Parameters:

id - the exchange; must not be null

request - the members to change, with the version read; must not be null

Returns:

the updated exchange

Throws:

KeyManagementSdkException - when the call is refused (a stale version is 409)

discardDraft

public void discardDraft(UUID id,
 int version)

Discards a draft exchange (DELETE /exchanges/{id}).

Parameters:

id - the exchange; must not be null

version - the version read, so a concurrent change is refused (409)

Throws:

KeyManagementSdkException - when the call is refused

cloneExchange

public ExchangeDetailResponse cloneExchange(UUID id,
 CloneRequest request)

Clones an exchange into a new draft (POST /exchanges/{id}/clone).

Parameters:

id - the exchange to clone; must not be null

request - the clone's settings, or null for the defaults

Returns:

the new draft

Throws:

KeyManagementSdkException - when the call is refused

validate

public ValidationResultResponse validate(UUID id)

Validates a draft exchange (POST /exchanges/{id}/validate).

Parameters:

id - the exchange; must not be null

Returns:

the validation verdict and its findings

Throws:

KeyManagementSdkException - when the call is refused

previewActivation

public ExchangeActivationPreviewResponse previewActivation(UUID id,
 String capability)

Previews what an activation would grant (GET /exchanges/{id}/activation-preview).

Parameters:

id - the exchange; must not be null

capability - ENCRYPT, DECRYPT, SIGN or VERIFY to preview one capability, or null for all

Returns:

the preview

Throws:

KeyManagementSdkException - when the call is refused

activate

public ExchangeDetailResponse activate(UUID id,
 ActivateRequest request)

Activates a validated exchange (POST /exchanges/{id}/activate).

Parameters:

id - the exchange; must not be null

request - the activation; must not be null

Returns:

the active exchange

Throws:

KeyManagementSdkException - when the call is refused

suspend

public ExchangeDetailResponse suspend(UUID id,
 SuspendExchangeRequest request)

Suspends an active exchange (POST /exchanges/{id}/suspend).

Parameters:

id - the exchange; must not be null

request - the suspension; must not be null

Returns:

the suspended exchange

Throws:

KeyManagementSdkException - when the call is refused

resume

public ExchangeDetailResponse resume(UUID id,
 ResumeExchangeRequest request)

Resumes a suspended exchange (POST /exchanges/{id}/resume).

Parameters:

id - the exchange; must not be null

request - the resumption; must not be null

Returns:

the resumed exchange

Throws:

KeyManagementSdkException - when the call is refused

revoke

public ExchangeDetailResponse revoke(UUID id,
 RevokeExchangeRequest request)

Revokes an exchange for good (POST /exchanges/{id}/revoke).

Parameters:

id - the exchange; must not be null

request - the revocation; must not be null

Returns:

the revoked exchange

Throws:

KeyManagementSdkException - when the call is refused