Interface GroupAction
-
- All Superinterfaces:
AuthorizableAction
- All Known Implementing Classes:
AbstractGroupAction
public interface GroupAction extends AuthorizableAction
TheGroupAction
interface allows for implementations to be informed about and react to the following changes to aGroup
's members:onMemberAdded(Group, Authorizable, Root, NamePathMapper)
onMembersAdded(Group, Iterable, Iterable, Root, NamePathMapper)
onMembersAddedContentId(Group, Iterable, Iterable, Root, NamePathMapper)
onMemberRemoved(Group, Authorizable, Root, NamePathMapper)
onMembersRemoved(Group, Iterable, Iterable, Root, NamePathMapper)
Please consult the parent interface
AuthorizableAction
for details on persisting changes, configuring actions and the API through which actions are invoked.For convenience, an
AbstractGroupAction
is provided.- Since:
- OAK 1.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
onMemberAdded(org.apache.jackrabbit.api.security.user.Group group, org.apache.jackrabbit.api.security.user.Authorizable member, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
A specificAuthorizable
was added as a member of theGroup
.void
onMemberRemoved(org.apache.jackrabbit.api.security.user.Group group, org.apache.jackrabbit.api.security.user.Authorizable member, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
A specificAuthorizable
was removed from theGroup
.void
onMembersAdded(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
Multiple members were added to theGroup
.void
onMembersAddedContentId(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberContentIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
Multiple members were added to theGroup
during XML group import.void
onMembersRemoved(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)
Multiple members were removed from theGroup
.-
Methods inherited from interface org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableAction
init, onCreate, onCreate, onPasswordChange, onRemove
-
-
-
-
Method Detail
-
onMemberAdded
void onMemberAdded(org.apache.jackrabbit.api.security.user.Group group, org.apache.jackrabbit.api.security.user.Authorizable member, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws javax.jcr.RepositoryException
A specificAuthorizable
was added as a member of theGroup
. Implementations may perform specific modifications or validations.- Parameters:
group
- TheGroup
to which theAuthorizable
was added.member
- TheAuthorizable
added.root
- The root associated with the user manager.namePathMapper
-- Throws:
javax.jcr.RepositoryException
- If an error occurs.
-
onMembersAdded
void onMembersAdded(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws javax.jcr.RepositoryException
Multiple members were added to theGroup
. The members are provided as an iterable of their string-based IDs, as some members may no longer or not yet exist. Implementations may perform specific modifications or validations.- Parameters:
group
- TheGroup
to which the members were added.memberIds
- AnIterable
of the member IDs.root
- The root associated with the user manager.namePathMapper
-- Throws:
javax.jcr.RepositoryException
- If an error occurs.
-
onMembersAddedContentId
void onMembersAddedContentId(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberContentIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws javax.jcr.RepositoryException
Multiple members were added to theGroup
during XML group import. The members are provided as an iterable of their string-based content IDs (UUIDs), as these members do not exist yet (group imported before users). Implementations may track such content ids for later processing once the user identified by the content id is added.Implementations may perform specific modifications or validations.
- Parameters:
group
- TheGroup
to which the members were added.memberContentIds
- AnIterable
of the member content IDs (UUIDs).root
- The root associated with the user manager.namePathMapper
-- Throws:
javax.jcr.RepositoryException
- If an error occurs.
-
onMemberRemoved
void onMemberRemoved(org.apache.jackrabbit.api.security.user.Group group, org.apache.jackrabbit.api.security.user.Authorizable member, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws javax.jcr.RepositoryException
A specificAuthorizable
was removed from theGroup
. Implementations may perform specific modifications or validations.- Parameters:
group
- TheGroup
from which theAuthorizable
was removed.member
- TheAuthorizable
removed.root
- The root associated with the user manager.namePathMapper
-- Throws:
javax.jcr.RepositoryException
- If an error occurs.
-
onMembersRemoved
void onMembersRemoved(org.apache.jackrabbit.api.security.user.Group group, Iterable<String> memberIds, Iterable<String> failedIds, org.apache.jackrabbit.oak.api.Root root, org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws javax.jcr.RepositoryException
Multiple members were removed from theGroup
. The members are provided as an iterable of their string-based IDs, as some members may no longer or not yet exist. Implementations may perform specific modifications or validations.- Parameters:
group
- TheGroup
from which the members were removed.memberIds
- AnIterable
of the member IDs.root
- The root associated with the user manager.namePathMapper
-- Throws:
javax.jcr.RepositoryException
- If an error occurs.
-
-