Package org.apache.jackrabbit.oak.spi.security.user.action

Interface UserAction

All Superinterfaces:

AuthorizableAction

public interface UserAction
extends AuthorizableAction

The UserAction interface allows for implementations to be informed about and react to the following changes to a User:

• onDisable(User, String, Root, NamePathMapper)

See AuthorizableAction for details on persisting changes, configuring actions and the API through which actions are invoked.

Since:

OAK 1.10

Method Summary

Modifier and Type	Method	Description
void	onDisable(@NotNull User user, @Nullable String disableReason, @NotNull Root root, @NotNull NamePathMapper namePathMapper)	Allows to add application specific behavior associated with disabling (or re-enabling) an user.
void	onGrantImpersonation(@NotNull User user, @NotNull Principal principal, @NotNull Root root, @NotNull NamePathMapper namePathMapper)	Allows to add application specific behavior associated with granting a given principal the ability to impersonate the user.
void	onRevokeImpersonation(@NotNull User user, @NotNull Principal principal, @NotNull Root root, @NotNull NamePathMapper namePathMapper)	Allows to add application specific behavior associated with revoking a given principal the ability to impersonate the user.

Methods inherited from interface org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableAction

init, onCreate, onCreate, onCreate, onPasswordChange, onRemove

Method Details

onDisable

void onDisable(@NotNull
 @NotNull User user,
 @Nullable
 @Nullable String disableReason,
 @NotNull
 @NotNull Root root,
 @NotNull
 @NotNull NamePathMapper namePathMapper)
        throws RepositoryException

Allows to add application specific behavior associated with disabling (or re-enabling) an user.

Parameters:

user - The user to be disabled or re-enabled.

disableReason - The reason passed to User.disable(String) or null if the user is to be enabled again.

root - The root associated with the user manager.

namePathMapper - The mapper associated with the user manager.

Throws:

RepositoryException - If an error occurs.

onGrantImpersonation

void onGrantImpersonation(@NotNull
 @NotNull User user,
 @NotNull
 @NotNull Principal principal,
 @NotNull
 @NotNull Root root,
 @NotNull
 @NotNull NamePathMapper namePathMapper)
                   throws RepositoryException

Allows to add application specific behavior associated with granting a given principal the ability to impersonate the user.

Parameters:

user - The user associated with the given Impersonation.grantImpersonation(Principal) call.

principal - The target principal to be granted impersonation.

root - The root associated with the user manager.

namePathMapper - The mapper associated with the user manager.

Throws:

RepositoryException - If an error occurs.

onRevokeImpersonation

void onRevokeImpersonation(@NotNull
 @NotNull User user,
 @NotNull
 @NotNull Principal principal,
 @NotNull
 @NotNull Root root,
 @NotNull
 @NotNull NamePathMapper namePathMapper)
                    throws RepositoryException

Allows to add application specific behavior associated with revoking a given principal the ability to impersonate the user.

Parameters:

user - The user associated with the given Impersonation.revokeImpersonation(Principal) call.

principal - The target principal for which impersonation is revoked.

root - The root associated with the user manager.

namePathMapper - The mapper associated with the user manager.

Throws:

RepositoryException - If an error occurs.