com.xdev.security.authorization

Interface ResourceUpdater

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 ResourceUpdater

Functional type that updates Resource instances. For more details, see updateResource(Resource, String, Set).

Author:

XDEV Software (TM)

Method Summary

Modifier and Type	Method and Description
default void	cleanupResourceUpdate() 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	commitResourceUpdate(Collection<Resource> updatedResources) Update committing callback hook that gets called once at the end of very successful updating process, after all authorization instances are updated.
default void	prepareResourceUpdate(Collection<Resource> existingResources) Updating preparation callback hook that gets called once on the beginning of very updating process, before any authorization instances are updated.
default void	rollbackResourceUpdate(Collection<Resource> updatedResources, Exception cause) Updating exception handling callback hook that gets called once if any Exception is encountered during the updating process.
void	updateResource(Resource resource, String resourceName, Set<Resource> children) Updates the passed Resource instance for the given resource name and collection of child resources, where updating can mean anything from just validating to actually changing the passed resource's state with the passed content.

Method Detail

updateResource

void updateResource(Resource resource,
                    String resourceName,
                    Set<Resource> children)

Updates the passed Resource instance for the given resource name and collection of child resources, where updating can mean anything from just validating to actually changing the passed resource's state with the passed content.

Parameters:

resource - the Resource instance to be updated.

resourceName - the identifying name of the passed Resource instance.

children - the resource's defined children to be used for the updating process (potentially empty).

prepareResourceUpdate

default void prepareResourceUpdate(Collection<Resource> existingResources)

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 resources.

Parameters:

existingResources - the resources already existing before the updating process.

commitResourceUpdate

default void commitResourceUpdate(Collection<Resource> updatedResources)

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:

updatedResources - the updated and potentially newly created resources.

rollbackResourceUpdate

default void rollbackResourceUpdate(Collection<Resource> updatedResources,
                                    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 Resource instances that have already existed before the updating process.

Parameters:

updatedResources - the updated and potentially newly created, empty or inconsistent resources.

cleanupResourceUpdate

default void cleanupResourceUpdate()

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).