Package org.forgerock.openam.uma

Interface UmaPolicyService

All Known Implementing Classes:

UmaPolicyServiceImpl

public interface UmaPolicyService

Provides the contract for accessing and managing UMA policies that are in a backend store.

Since:

13.0.0

Method Summary

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException>	createPolicy(org.forgerock.services.context.Context context, org.forgerock.json.JsonValue policy)	Creates an UMA policy in the backend store.
org.forgerock.util.promise.Promise<Void,org.forgerock.json.resource.ResourceException>	deletePolicy(org.forgerock.services.context.Context context, String resourceSetId)	Deletes an UMA policy from the backend store.
org.forgerock.util.promise.Promise<org.forgerock.util.Pair<org.forgerock.json.resource.QueryResponse,Collection<UmaPolicy>>,org.forgerock.json.resource.ResourceException>	queryPolicies(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request)
org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException>	readPolicy(org.forgerock.services.context.Context context, String resourceSetId)	Reads an UMA policy from the backend store.
org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException>	updatePolicy(org.forgerock.services.context.Context context, String resourceSetId, org.forgerock.json.JsonValue policy)	Updates an UMA policy in the backend store.

Method Detail

createPolicy

org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException> createPolicy(org.forgerock.services.context.Context context,
                                                                                                               org.forgerock.json.JsonValue policy)

Creates an UMA policy in the backend store.

Parameters:

context - The request context.

policy - The UMA policy to create.

Returns:

A promise containing the created UmaPolicy or a ResourceException.

readPolicy

org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException> readPolicy(org.forgerock.services.context.Context context,
                                                                                                             String resourceSetId)

Reads an UMA policy from the backend store.

Parameters:

context - The request context.

resourceSetId - The unique ID of the UMA policy.

Returns:

A promise containing the UmaPolicy or a ResourceException.

updatePolicy

org.forgerock.util.promise.Promise<UmaPolicy,org.forgerock.json.resource.ResourceException> updatePolicy(org.forgerock.services.context.Context context,
                                                                                                               String resourceSetId,
                                                                                                               org.forgerock.json.JsonValue policy)

Updates an UMA policy in the backend store.

Parameters:

context - The request context.

resourceSetId - The unique ID of the UMA policy.

policy - The UMA policy to replace the current policy.

Returns:

A promise containing the updated UmaPolicy or a ResourceException.

deletePolicy

org.forgerock.util.promise.Promise<Void,org.forgerock.json.resource.ResourceException> deletePolicy(org.forgerock.services.context.Context context,
                                                                                                          String resourceSetId)

Deletes an UMA policy from the backend store.

Parameters:

context - The request context.

resourceSetId - The unique ID of the UMA policy.

Returns:

A promise containing null or a ResourceException.

queryPolicies

org.forgerock.util.promise.Promise<org.forgerock.util.Pair<org.forgerock.json.resource.QueryResponse,Collection<UmaPolicy>>,org.forgerock.json.resource.ResourceException> queryPolicies(org.forgerock.services.context.Context context,
                                                                                                                                                                                                     org.forgerock.json.resource.QueryRequest request)

Parameters:

context -

request -

Returns: