Package org.keycloak.models.map.authorization

Class MapResourceStore

java.lang.Object

org.keycloak.models.map.authorization.MapResourceStore

All Implemented Interfaces:

ResourceStore

public class MapResourceStore
extends Object
implements ResourceStore

Constructor Summary

Constructors

Constructor	Description
MapResourceStore(KeycloakSession session, MapStorage<MapResourceEntity,Resource> resourceStore, AuthorizationProvider provider)

Method Summary

Modifier and Type	Method	Description
Resource	create(ResourceServer resourceServer, String id, String name, String owner)	Creates a Resource instance backed by this persistent storage implementation.
void	delete(String id)	Removes a Resource instance, with the given id from the persistent storage.
Resource	findById(ResourceServer resourceServer, String id)	Returns a Resource instance based on its identifier.
Resource	findByName(ResourceServer resourceServer, String name, String ownerId)	Find a Resource by its name where the owner is the given ownerId.
List<Resource>	findByOwner(ResourceServer resourceServer, String ownerId, Integer firstResult, Integer maxResults)
void	findByOwner(ResourceServer resourceServer, String ownerId, Consumer<Resource> consumer)
List<Resource>	findByResourceServer(ResourceServer resourceServer)	Finds all Resource instances associated with a given resource server.
List<Resource>	findByResourceServer(ResourceServer resourceServer, Map<Resource.FilterOption,String[]> attributes, Integer firstResult, Integer maxResults)	Finds all Resource instances associated with a given resource server.
void	findByScopes(ResourceServer resourceServer, Set<Scope> scopes, Consumer<Resource> consumer)
void	findByType(ResourceServer resourceServer, String type, String owner, Consumer<Resource> consumer)	Finds all Resource with the given type.
void	findByType(ResourceServer resourceServer, String type, Consumer<Resource> consumer)	Finds all Resource with the given type.
void	findByTypeInstance(ResourceServer resourceServer, String type, Consumer<Resource> consumer)
List<Resource>	findByUri(ResourceServer resourceServer, String uri)	Finds all Resource instances with the given uri.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.authorization.store.ResourceStore

create, findByName, findByOwner, findByScopes, findByType, findByType, findByTypeInstance

Constructor Detail

MapResourceStore

public MapResourceStore(KeycloakSession session,
                        MapStorage<MapResourceEntity,Resource> resourceStore,
                        AuthorizationProvider provider)

Method Detail

create

public Resource create(ResourceServer resourceServer,
                       String id,
                       String name,
                       String owner)

Description copied from interface: ResourceStore

Creates a Resource instance backed by this persistent storage implementation.

Specified by:

create in interface ResourceStore

Parameters:

resourceServer - the resource server to where the given resource belongs to

id - the id of this resource. It must be unique. Will be randomly generated if null.

name - the name of this resource. It must be unique.

owner - the owner of this resource or null if the resource server is the owner

Returns:

an instance backed by the underlying storage implementation

delete

public void delete(String id)

Description copied from interface: ResourceStore

Removes a Resource instance, with the given id from the persistent storage.

Specified by:

delete in interface ResourceStore

Parameters:

id - the identifier of an existing resource instance

findById

public Resource findById(ResourceServer resourceServer,
                         String id)

Description copied from interface: ResourceStore

Returns a Resource instance based on its identifier.

Specified by:

findById in interface ResourceStore

Parameters:

resourceServer - the resource server

id - the identifier of an existing resource instance

Returns:

the resource instance with the given identifier or null if no instance was found

findByOwner

public void findByOwner(ResourceServer resourceServer,
                        String ownerId,
                        Consumer<Resource> consumer)

Specified by:

findByOwner in interface ResourceStore

findByOwner

public List<Resource> findByOwner(ResourceServer resourceServer,
                                  String ownerId,
                                  Integer firstResult,
                                  Integer maxResults)

Specified by:

findByOwner in interface ResourceStore

findByUri

public List<Resource> findByUri(ResourceServer resourceServer,
                                String uri)

Description copied from interface: ResourceStore

Finds all Resource instances with the given uri.

Specified by:

findByUri in interface ResourceStore

uri - the identifier of the uri

Returns:

a list with all resource instances owned by the given owner

findByResourceServer

public List<Resource> findByResourceServer(ResourceServer resourceServer)

Description copied from interface: ResourceStore

Finds all Resource instances associated with a given resource server.

Specified by:

findByResourceServer in interface ResourceStore

Parameters:

resourceServer - the identifier of the resource server

Returns:

a list with all resources associated with the given resource server

findByResourceServer

public List<Resource> findByResourceServer(ResourceServer resourceServer,
                                           Map<Resource.FilterOption,String[]> attributes,
                                           Integer firstResult,
                                           Integer maxResults)

Description copied from interface: ResourceStore

Finds all Resource instances associated with a given resource server.

Specified by:

findByResourceServer in interface ResourceStore

Parameters:

resourceServer - the identifier of the resource server

attributes - a map holding the attributes that will be used as a filter; possible filter options are given by Resource.FilterOption

firstResult - first result to return. Ignored if negative or null.

maxResults - maximum number of results to return. Ignored if negative or null.

Returns:

a list with all resources associated with the given resource server

findByScopes

public void findByScopes(ResourceServer resourceServer,
                         Set<Scope> scopes,
                         Consumer<Resource> consumer)

Specified by:

findByScopes in interface ResourceStore

findByName

public Resource findByName(ResourceServer resourceServer,
                           String name,
                           String ownerId)

Description copied from interface: ResourceStore

Find a Resource by its name where the owner is the given ownerId.

Specified by:

findByName in interface ResourceStore

Parameters:

resourceServer - the identifier of the resource server

name - the name of the resource

ownerId - the owner id

Returns:

a resource with the given name

findByType

public void findByType(ResourceServer resourceServer,
                       String type,
                       Consumer<Resource> consumer)

Description copied from interface: ResourceStore

Finds all Resource with the given type.

Specified by:

findByType in interface ResourceStore

Parameters:

resourceServer - the resource server id

type - the type of the resource

consumer - the result consumer

findByType

public void findByType(ResourceServer resourceServer,
                       String type,
                       String owner,
                       Consumer<Resource> consumer)

Description copied from interface: ResourceStore

Finds all Resource with the given type.

Specified by:

findByType in interface ResourceStore

Parameters:

resourceServer - the resource server id

type - the type of the resource

owner - the resource owner or null for any resource with a given type

consumer - the result consumer

findByTypeInstance

public void findByTypeInstance(ResourceServer resourceServer,
                               String type,
                               Consumer<Resource> consumer)

Specified by:

findByTypeInstance in interface ResourceStore