Interface ResourceDelegationFilter
-
- All Superinterfaces:
Comparable<ResourceDelegationFilter>
@SupportedAll public interface ResourceDelegationFilter extends Comparable<ResourceDelegationFilter>
Extension filter that will be called before a resource is shared, after a resource is shared, before a shared resource is modified and on a resource no longer being shared.Implementations of this interface can use the Guice setter based injection.
- Since:
- 13.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
afterResourceShared(org.forgerock.openam.uma.UmaPolicy umaPolicy)
Invoked after a resource "share" is created.QueryFilter<JsonPointer>
beforeQueryResourceSets(String userId, QueryFilter<JsonPointer> queryFilter)
Invoked before a users, owned and shared with, resource sets a queried.void
beforeResourceShared(org.forgerock.openam.uma.UmaPolicy umaPolicy)
Invoked before a resource "share" is created.void
beforeResourceSharedModification(org.forgerock.openam.uma.UmaPolicy currentUmaPolicy, org.forgerock.openam.uma.UmaPolicy updatedUmaPolicy)
Invoked before a resource "share" is modified.void
onResourceSharedDeletion(org.forgerock.openam.uma.UmaPolicy umaPolicy)
Invoked before a resource "share" is deleted.-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Method Detail
-
beforeResourceShared
void beforeResourceShared(org.forgerock.openam.uma.UmaPolicy umaPolicy) throws ResourceException
Invoked before a resource "share" is created.Changes to the umaPolicy will be persisted.
- Parameters:
umaPolicy
- The UMA policy representation.- Throws:
ResourceException
- If the resource "share" is not to be shared.
-
afterResourceShared
void afterResourceShared(org.forgerock.openam.uma.UmaPolicy umaPolicy)
Invoked after a resource "share" is created.Changes to the umaPolicy will not be persisted.
- Parameters:
umaPolicy
- The UMA policy representation.
-
beforeResourceSharedModification
void beforeResourceSharedModification(org.forgerock.openam.uma.UmaPolicy currentUmaPolicy, org.forgerock.openam.uma.UmaPolicy updatedUmaPolicy) throws ResourceException
Invoked before a resource "share" is modified.Changes to the updatedUmaPolicy will be persisted.
- Parameters:
currentUmaPolicy
- The current UMA policy representation.updatedUmaPolicy
- The updated UMA policy representation.- Throws:
ResourceException
- If the resource "share" is not to be modified.
-
onResourceSharedDeletion
void onResourceSharedDeletion(org.forgerock.openam.uma.UmaPolicy umaPolicy) throws ResourceException
Invoked before a resource "share" is deleted.- Parameters:
umaPolicy
- The UMA policy representation.- Throws:
ResourceException
- If the resource "share" is not to be deleted.
-
beforeQueryResourceSets
QueryFilter<JsonPointer> beforeQueryResourceSets(String userId, QueryFilter<JsonPointer> queryFilter)
Invoked before a users, owned and shared with, resource sets a queried.- Parameters:
userId
- The id of the user making the query request.queryFilter
- The incoming request query filter.- Returns:
- A
QueryFilter
which will be used to return a users resource sets.
-
-