org.apache.jackrabbit.core.security.user.action

Interface AuthorizableAction

All Known Implementing Classes:

AbstractAuthorizableAction, AccessControlAction, ClearMembershipAction, PasswordValidationAction

public interface AuthorizableAction

The AuthorizableAction interface provide an implementation specific way to execute additional validation or write tasks upon

• User creation,
• Group creation,
• Authorizable removal and
• User password modification.

The actions are attached to a given UserManager instance upon creation by calling UserManagerImpl.setAuthorizableActions(AuthorizableAction[]).

See Also:

UserManagerConfig

Method Summary

Methods

Modifier and Type	Method and Description
void	onCreate(Group group, javax.jcr.Session session) Allows to add application specific modifications or validation associated with the creation of a new group.
void	onCreate(User user, String password, javax.jcr.Session session) Allows to add application specific modifications or validation associated with the creation of a new user.
void	onPasswordChange(User user, String newPassword, javax.jcr.Session session) Allows to add application specific action or validation associated with changing a user password.
void	onRemove(Authorizable authorizable, javax.jcr.Session session) Allows to add application specific behavior associated with the removal of an authorizable.

Method Detail

onCreate

void onCreate(Group group,
            javax.jcr.Session session)
              throws javax.jcr.RepositoryException

Allows to add application specific modifications or validation associated with the creation of a new group. Note, that this method is called before any Session.save call.

Parameters:

group - The new group that has not yet been persisted; e.g. the associated node is still 'NEW'.

session - The editing session associated with the user manager.

Throws:

javax.jcr.RepositoryException - If an error occurs.

onCreate

void onCreate(User user,
            String password,
            javax.jcr.Session session)
              throws javax.jcr.RepositoryException

Allows to add application specific modifications or validation associated with the creation of a new user. Note, that this method is called before any Session.save call.

Parameters:

user - The new user that has not yet been persisted; e.g. the associated node is still 'NEW'.

password - The password that was specified upon user creation.

session - The editing session associated with the user manager.

Throws:

javax.jcr.RepositoryException - If an error occurs.

onRemove

void onRemove(Authorizable authorizable,
            javax.jcr.Session session)
              throws javax.jcr.RepositoryException

Allows to add application specific behavior associated with the removal of an authorizable. Note, that this method is called before Authorizable.remove() is executed (and persisted); thus the target authorizable still exists.

Parameters:

authorizable - The authorizable to be removed.

session - The editing session associated with the user manager.

Throws:

javax.jcr.RepositoryException - If an error occurs.

onPasswordChange

void onPasswordChange(User user,
                    String newPassword,
                    javax.jcr.Session session)
                      throws javax.jcr.RepositoryException

Allows to add application specific action or validation associated with changing a user password. Note, that this method is called before the password property is being modified in the content.

Parameters:

user - The user that whose password is going to change.

newPassword - The new password as specified in User.changePassword(java.lang.String)

session - The editing session associated with the user manager.

Throws:

javax.jcr.RepositoryException - If an exception or error occurs.