org.forgerock.oauth2.resources

Interface ResourceSetStore

All Known Implementing Classes:

OpenAMResourceSetStore

public interface ResourceSetStore

Allows the storage of ResourceSetDescription objects in a store.

Since:

13.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceSetStore.FilterType Different ways to combine criteria in a filter.

Method Summary

Modifier and Type	Method and Description
void	create(OAuth2Request request, ResourceSetDescription resourceSetDescription) Create a ResourceSetDescription.
void	delete(String resourceSetId, String resourceOwnerId) Remove a ResourceSetDescription with the given ID from the store.
Set<ResourceSetDescription>	query(org.forgerock.util.query.QueryFilter<String> query) Query the store for ResourceSetDescription instances.
ResourceSetDescription	read(String resourceSetId, ResourceSetFilter filter) Reads a ResourceSetDescription out of the store using its OpenAM Unique ID.
ResourceSetDescription	read(String resourceSetId, String resourceOwnerId) Reads a ResourceSetDescription out of the store using its OpenAM Unique ID.
void	update(ResourceSetDescription resourceSetDescription) Update a given ResourceSetDescription instance.

Method Detail

create

void create(OAuth2Request request,
            ResourceSetDescription resourceSetDescription)
     throws ServerException,
            NotFoundException,
            BadRequestException

Create a ResourceSetDescription. The id field will be populated with the resulting identifier.

Parameters:

request - The OAuth2Request.

resourceSetDescription - The resource set description being created.

Throws:

ServerException - When an error occurs during creation.

NotFoundException - If the OAuth2ProviderSettings could not be found.

BadRequestException

read

ResourceSetDescription read(String resourceSetId,
                            ResourceSetFilter filter)
                     throws NotFoundException,
                            ServerException

Reads a ResourceSetDescription out of the store using its OpenAM Unique ID.

Parameters:

resourceSetId - The resource set ID.

filter - A filter to apply to the read elements.

Returns:

The ResourceSetDescription.

Throws:

NotFoundException - If the resource set is not found.

ServerException - When the resource set description cannot be loaded.

read

ResourceSetDescription read(String resourceSetId,
                            String resourceOwnerId)
                     throws NotFoundException,
                            ServerException

Reads a ResourceSetDescription out of the store using its OpenAM Unique ID. Only returns a set which is owned by the specified resource owner.

Parameters:

resourceSetId - The resource set ID.

resourceOwnerId - The ID of the resource owner.

Returns:

The ResourceSetDescription.

Throws:

NotFoundException - If the resource set is not found.

ServerException - When the resource set description cannot be loaded.

update

void update(ResourceSetDescription resourceSetDescription)
     throws NotFoundException,
            ServerException

Update a given ResourceSetDescription instance.

Parameters:

resourceSetDescription - The resource set description being updated.

Throws:

ServerException - When the ResourceSetDescription cannot be found, or an error occurs during update.

NotFoundException

delete

void delete(String resourceSetId,
            String resourceOwnerId)
     throws NotFoundException,
            ServerException

Remove a ResourceSetDescription with the given ID from the store.

Parameters:

resourceSetId - The identifier of the ResourceSetDescription being removed.

resourceOwnerId - The resource owner id.

Throws:

ServerException - When an error occurs during removal.

NotFoundException

query

Set<ResourceSetDescription> query(org.forgerock.util.query.QueryFilter<String> query)
                           throws ServerException

Query the store for ResourceSetDescription instances.

Parameters:

query - The criteria of the query.

Returns:

A set of all matching resource set descriptions.

Throws:

ServerException - When an error occurs when querying the store.