Package org.keycloak.models.map.authorization

Class MapPermissionTicketStore

java.lang.Object

org.keycloak.models.map.authorization.MapPermissionTicketStore

All Implemented Interfaces:

PermissionTicketStore

public class MapPermissionTicketStore
extends Object
implements PermissionTicketStore

Constructor Summary

Constructors

Constructor	Description
MapPermissionTicketStore(KeycloakSession session, MapStorage<MapPermissionTicketEntity,PermissionTicket> permissionTicketStore, AuthorizationProvider provider)

Method Summary

Modifier and Type	Method	Description
long	count(ResourceServer resourceServer, Map<PermissionTicket.FilterOption,String> attributes)	Returns count of PermissionTicket, filtered by the given attributes.
PermissionTicket	create(ResourceServer resourceServer, Resource resource, Scope scope, String requester)	Creates a new PermissionTicket instance.
void	delete(RealmModel realm, String id)	Deletes a permission from the underlying persistence mechanism.
List<PermissionTicket>	find(RealmModel realm, ResourceServer resourceServer, Map<PermissionTicket.FilterOption,String> attributes, Integer firstResult, Integer maxResult)	Returns a list of PermissionTicket, filtered by the given attributes.
PermissionTicket	findById(RealmModel realm, ResourceServer resourceServer, String id)	Returns a PermissionTicket with the given id
List<PermissionTicket>	findByResource(ResourceServer resourceServer, Resource resource)	Returns a list of PermissionTicket associated with the resource.
List<PermissionTicket>	findByScope(ResourceServer resourceServer, Scope scope)	Returns a list of PermissionTicket associated with the scope.
List<PermissionTicket>	findGranted(ResourceServer resourceServer, String userId)	Returns a list of PermissionTicket granted to the given userId.
List<PermissionTicket>	findGranted(ResourceServer resourceServer, String resourceName, String userId)	Returns a list of PermissionTicket with name equal to resourceName granted to the given userId.
List<Resource>	findGrantedOwnerResources(RealmModel realm, String owner, Integer firstResult, Integer maxResults)	Returns a list of Resource granted by the owner to other users
List<Resource>	findGrantedResources(RealmModel realm, String requester, String name, Integer first, Integer max)	Returns a list of Resource granted to the given requester
void	preRemove(RealmModel realm)
void	preRemove(RealmModel realm, ResourceServer resourceServer)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapPermissionTicketStore

public MapPermissionTicketStore(KeycloakSession session,
                                MapStorage<MapPermissionTicketEntity,PermissionTicket> permissionTicketStore,
                                AuthorizationProvider provider)

Method Detail

count

public long count(ResourceServer resourceServer,
                  Map<PermissionTicket.FilterOption,String> attributes)

Description copied from interface: PermissionTicketStore

Returns count of PermissionTicket, filtered by the given attributes.

Specified by:

count in interface PermissionTicketStore

Parameters:

resourceServer - the resource server. Cannot be null.

attributes - permission tickets that do not match the attributes are not included with the count; possible filter options are given by PermissionTicket.FilterOption

Returns:

an integer indicating the amount of permission tickets

create

public PermissionTicket create(ResourceServer resourceServer,
                               Resource resource,
                               Scope scope,
                               String requester)

Description copied from interface: PermissionTicketStore

Creates a new PermissionTicket instance.

Specified by:

create in interface PermissionTicketStore

Parameters:

resourceServer - the resource server to which this permission ticket belongs. Cannot be null.

resource - resource. Cannot be null.

scope - scope. Cannot be null

requester - requester of the permission

Returns:

a new instance of PermissionTicket

delete

public void delete(RealmModel realm,
                   String id)

Description copied from interface: PermissionTicketStore

Deletes a permission from the underlying persistence mechanism.

Specified by:

delete in interface PermissionTicketStore

Parameters:

realm - realm. Cannot be null.

id - the id of the policy to delete

findById

public PermissionTicket findById(RealmModel realm,
                                 ResourceServer resourceServer,
                                 String id)

Description copied from interface: PermissionTicketStore

Returns a PermissionTicket with the given id

Specified by:

findById in interface PermissionTicketStore

Parameters:

realm - the realm. Cannot be null.

resourceServer - the resource server. Ignored if null.

id - the identifier of the permission

Returns:

a permission with the given identifier.

findByResource

public List<PermissionTicket> findByResource(ResourceServer resourceServer,
                                             Resource resource)

Description copied from interface: PermissionTicketStore

Returns a list of PermissionTicket associated with the resource.

Specified by:

findByResource in interface PermissionTicketStore

Parameters:

resourceServer - the resource server. Cannot be null.

resource - the resource. Cannot be null

Returns:

a list of permissions associated with the given resource

findByScope

public List<PermissionTicket> findByScope(ResourceServer resourceServer,
                                          Scope scope)

Description copied from interface: PermissionTicketStore

Returns a list of PermissionTicket associated with the scope.

Specified by:

findByScope in interface PermissionTicketStore

Parameters:

resourceServer - the resource server. Cannot be null.

scope - the scope. Cannot be null.

Returns:

a list of permissions associated with the given scopes

find

public List<PermissionTicket> find(RealmModel realm,
                                   ResourceServer resourceServer,
                                   Map<PermissionTicket.FilterOption,String> attributes,
                                   Integer firstResult,
                                   Integer maxResult)

Description copied from interface: PermissionTicketStore

Returns a list of PermissionTicket, filtered by the given attributes.

Specified by:

find in interface PermissionTicketStore

Parameters:

realm - the realm. Cannot be null.

resourceServer - a resource server that resulting tickets should belong to. Ignored if null.

attributes - a map of keys and values to filter on; possible filter options are given by PermissionTicket.FilterOption

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

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

Returns:

a list of filtered and paginated permissions

findGranted

public List<PermissionTicket> findGranted(ResourceServer resourceServer,
                                          String userId)

Description copied from interface: PermissionTicketStore

Returns a list of PermissionTicket granted to the given userId.

Specified by:

findGranted in interface PermissionTicketStore

Parameters:

resourceServer - the resource server. Cannot be null

userId - the user id

Returns:

a list of permissions granted for a particular user

findGranted

public List<PermissionTicket> findGranted(ResourceServer resourceServer,
                                          String resourceName,
                                          String userId)

Description copied from interface: PermissionTicketStore

Returns a list of PermissionTicket with name equal to resourceName granted to the given userId.

Specified by:

findGranted in interface PermissionTicketStore

Parameters:

resourceServer - the resource server. Cannot be null.

resourceName - the name of a resource

userId - the user id

Returns:

a list of permissions granted for a particular user TODO: investigate a way how to replace resourceName with Resource class

findGrantedResources

public List<Resource> findGrantedResources(RealmModel realm,
                                           String requester,
                                           String name,
                                           Integer first,
                                           Integer max)

Description copied from interface: PermissionTicketStore

Returns a list of Resource granted to the given requester

Specified by:

findGrantedResources in interface PermissionTicketStore

Parameters:

realm - realm that is searched. Cannot be null

requester - the requester

name - the keyword to query resources by name or null if any resource

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

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

Returns:

a list of Resource granted to the given requester

findGrantedOwnerResources

public List<Resource> findGrantedOwnerResources(RealmModel realm,
                                                String owner,
                                                Integer firstResult,
                                                Integer maxResults)

Description copied from interface: PermissionTicketStore

Returns a list of Resource granted by the owner to other users

Specified by:

findGrantedOwnerResources in interface PermissionTicketStore

owner - the owner

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 of Resource granted by the owner

preRemove

public void preRemove(RealmModel realm)

preRemove

public void preRemove(RealmModel realm,
                      ResourceServer resourceServer)