Package co.ankatech.ankasecure.keymanagement

Class ConstraintPolicyOperations

java.lang.Object

co.ankatech.ankasecure.keymanagement.ConstraintPolicyOperations

public final class ConstraintPolicyOperations
extends Object

The tenant's constraint policies: the usage, time and payload bounds a capability grant can carry. Obtained from AuthenticatedKeyManagementSdk.constraintPolicies().

 ConstraintPolicyResponse policy = sdk.constraintPolicies().create(
         new CreateConstraintPolicyRequest().name("nightly-batch").maxUsage(1000));
 

Method Summary

Modifier and Type	Method	Description
ConstraintPolicyResponse	create(CreateConstraintPolicyRequest request)	Creates a constraint policy (POST /tenants/{t}/constraint-policies).
void	delete(UUID policyId)	Deletes a constraint policy (DELETE /tenants/{t}/constraint-policies/{p}).
ConstraintPolicyResponse	get(UUID policyId)	Reads one constraint policy (GET /tenants/{t}/constraint-policies/{p}).
PageConstraintPolicyResponse	list(ConstraintPolicyListQuery query)	Lists constraint policies (GET /tenants/{t}/constraint-policies).
ConstraintPolicyResponse	update(UUID policyId, CreateConstraintPolicyRequest request)	Updates a constraint policy (PATCH /tenants/{t}/constraint-policies/{p}).

Methods inherited from class java.lang.Object

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

Method Details

list

public PageConstraintPolicyResponse list(ConstraintPolicyListQuery query)

Lists constraint policies (GET /tenants/{t}/constraint-policies).

Parameters:

query - the page; must not be null

Returns:

one page of policies

Throws:

KeyManagementSdkException - when the call is refused

create

public ConstraintPolicyResponse create(CreateConstraintPolicyRequest request)

Creates a constraint policy (POST /tenants/{t}/constraint-policies).

Parameters:

request - the policy; must not be null

Returns:

the created policy

Throws:

KeyManagementSdkException - when the call is refused

get

public ConstraintPolicyResponse get(UUID policyId)

Reads one constraint policy (GET /tenants/{t}/constraint-policies/{p}).

Parameters:

policyId - the policy; must not be null

Returns:

the policy

Throws:

KeyManagementSdkException - when the call is refused

update

public ConstraintPolicyResponse update(UUID policyId,
 CreateConstraintPolicyRequest request)

Updates a constraint policy (PATCH /tenants/{t}/constraint-policies/{p}).

Parameters:

policyId - the policy; must not be null

request - the policy's new values; must not be null

Returns:

the updated policy

Throws:

KeyManagementSdkException - when the call is refused

delete

public void delete(UUID policyId)

Deletes a constraint policy (DELETE /tenants/{t}/constraint-policies/{p}).

Parameters:

policyId - the policy; must not be null

Throws:

KeyManagementSdkException - when a grant still carries the policy (409) or the call is refused