com.xdev.security.authorization

Interface RoleUpdater

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RoleUpdater

Function type for updating a passed Role instance for a given role name and collections of parent roles and explicit permissions. For more details, see updateRole(Role, String, Set, Set).

Author:

XDEV Software (TM)

Method Summary

Modifier and Type	Method and Description
default void	cleanupRoleUpdate() Updating preparation callback hook that gets called once at the end of the updating process in any case (both success and encountered exception).
default void	commitRoleUpdate(Collection<Role> updatedRoles) Update committing callback hook that gets called once at the end of very successful updating process, after all authorization instances are updated.
default void	prepareRoleUpdate(Collection<Role> existingRoles) Updating preparation callback hook that gets called once on the beginning of very updating process, before any authorization instances are updated.
default void	rollbackRoleUpdate(Collection<Role> updatedRoles, Exception cause) Updating exception handling callback hook that gets called once if any Exception is encountered during the updating process.
void	updateRole(Role role, String name, Set<Role> parentRoles, Set<Permission> permissions) Updates the passed Role instance for the given role name and collections of parent roles and explicit permissions, where updating can mean anything from just validating to actually changing the passed subject's state with the passed content.

Method Detail

updateRole

void updateRole(Role role,
                String name,
                Set<Role> parentRoles,
                Set<Permission> permissions)

Updates the passed Role instance for the given role name and collections of parent roles and explicit permissions, where updating can mean anything from just validating to actually changing the passed subject's state with the passed content.

Parameters:

role - the Role instance to be updated.

name - the identifying name of the passed Role instance.

parentRoles - the parent roles that the Role instance must reference to be valid.

permissions - the explicit permissions that the Role instance must reference to be valid.

prepareRoleUpdate

default void prepareRoleUpdate(Collection<Role> existingRoles)

Updating preparation callback hook that gets called once on the beginning of very updating process, before any authorization instances are updated. The default implementation of this method is empty. An example usage for this method is to create and store rollback information on the passed roles.

Parameters:

existingRoles - the roles already existing before the updating process.

commitRoleUpdate

default void commitRoleUpdate(Collection<Role> updatedRoles)

Update committing callback hook that gets called once at the end of very successful updating process, after all authorization instances are updated. The default implementation of this method is empty. An example usage for this method is to relay committing of changes to some other data structure or application part.

Parameters:

updatedRoles - the updated and potentially newly created roles.

rollbackRoleUpdate

default void rollbackRoleUpdate(Collection<Role> updatedRoles,
                                Exception cause)

Updating exception handling callback hook that gets called once if any Exception is encountered during the updating process. The default implementation of this method is empty. An example usage for this method is to rollback (revert) all mutated Role instances that have already existed before the updating process.

Parameters:

updatedRoles - the updated and potentially newly created, empty or inconsistent roles.

cleanupRoleUpdate

default void cleanupRoleUpdate()

Updating preparation callback hook that gets called once at the end of the updating process in any case (both success and encountered exception). The default implementation of this method is empty. An example usage for this method is to clear any internally stored meta data (e.g. rollback information).