Interface GroupAction
-
- All Superinterfaces:
AuthorizableAction
- All Known Implementing Classes:
AbstractGroupAction
public interface GroupAction extends AuthorizableAction
TheGroupActioninterface 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
AuthorizableActionfor details on persisting changes, configuring actions and the API through which actions are invoked.For convenience, an
AbstractGroupActionis provided.- Since:
- OAK 1.6
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidonMemberAdded(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull org.apache.jackrabbit.api.security.user.Authorizable member, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)A specificAuthorizablewas added as a member of theGroup.voidonMemberRemoved(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull org.apache.jackrabbit.api.security.user.Authorizable member, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)A specificAuthorizablewas removed from theGroup.voidonMembersAdded(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull Iterable<String> memberIds, @NotNull Iterable<String> failedIds, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)Multiple members were added to theGroup.voidonMembersAddedContentId(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull Iterable<String> memberContentIds, @NotNull Iterable<String> failedIds, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper)Multiple members were added to theGroupduring XML group import.voidonMembersRemoved(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull Iterable<String> memberIds, @NotNull Iterable<String> failedIds, @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull 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, onCreate, onPasswordChange, onRemove
-
-
-
-
Method Detail
-
onMemberAdded
void onMemberAdded(@NotNull @NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull @NotNull org.apache.jackrabbit.api.security.user.Authorizable member, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws RepositoryExceptionA specificAuthorizablewas added as a member of theGroup. Implementations may perform specific modifications or validations.- Parameters:
group- TheGroupto which theAuthorizablewas added.member- TheAuthorizableadded.root- The root associated with the user manager.namePathMapper-- Throws:
RepositoryException- If an error occurs.
-
onMembersAdded
void onMembersAdded(@NotNull @NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull @NotNull Iterable<String> memberIds, @NotNull @NotNull Iterable<String> failedIds, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws RepositoryExceptionMultiple 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- TheGroupto which the members were added.memberIds- AnIterableof the member IDs.root- The root associated with the user manager.namePathMapper-- Throws:
RepositoryException- If an error occurs.
-
onMembersAddedContentId
void onMembersAddedContentId(@NotNull @NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull @NotNull Iterable<String> memberContentIds, @NotNull @NotNull Iterable<String> failedIds, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws RepositoryExceptionMultiple members were added to theGroupduring 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- TheGroupto which the members were added.memberContentIds- AnIterableof the member content IDs (UUIDs).root- The root associated with the user manager.namePathMapper-- Throws:
RepositoryException- If an error occurs.
-
onMemberRemoved
void onMemberRemoved(@NotNull @NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull @NotNull org.apache.jackrabbit.api.security.user.Authorizable member, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws RepositoryExceptionA specificAuthorizablewas removed from theGroup. Implementations may perform specific modifications or validations.- Parameters:
group- TheGroupfrom which theAuthorizablewas removed.member- TheAuthorizableremoved.root- The root associated with the user manager.namePathMapper-- Throws:
RepositoryException- If an error occurs.
-
onMembersRemoved
void onMembersRemoved(@NotNull @NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull @NotNull Iterable<String> memberIds, @NotNull @NotNull Iterable<String> failedIds, @NotNull @NotNull org.apache.jackrabbit.oak.api.Root root, @NotNull @NotNull org.apache.jackrabbit.oak.namepath.NamePathMapper namePathMapper) throws RepositoryExceptionMultiple 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- TheGroupfrom which the members were removed.memberIds- AnIterableof the member IDs.root- The root associated with the user manager.namePathMapper-- Throws:
RepositoryException- If an error occurs.
-
-