public interface GroupAction extends AuthorizableAction
GroupAction
interface allows for implementations to be informed about and react to the following
changes to a Group
'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.
Modifier and Type | Method and Description |
---|---|
void |
onMemberAdded(@NotNull Group group,
@NotNull Authorizable member,
@NotNull Root root,
@NotNull NamePathMapper namePathMapper)
A specific
Authorizable was added as a member of the Group . |
void |
onMemberRemoved(@NotNull Group group,
@NotNull Authorizable member,
@NotNull Root root,
@NotNull NamePathMapper namePathMapper)
A specific
Authorizable was removed from the Group . |
void |
onMembersAdded(@NotNull Group group,
@NotNull java.lang.Iterable<java.lang.String> memberIds,
@NotNull java.lang.Iterable<java.lang.String> failedIds,
@NotNull Root root,
@NotNull NamePathMapper namePathMapper)
Multiple members were added to the
Group . |
void |
onMembersAddedContentId(@NotNull Group group,
@NotNull java.lang.Iterable<java.lang.String> memberContentIds,
@NotNull java.lang.Iterable<java.lang.String> failedIds,
@NotNull Root root,
@NotNull NamePathMapper namePathMapper)
Multiple members were added to the
Group during XML group import. |
void |
onMembersRemoved(@NotNull Group group,
@NotNull java.lang.Iterable<java.lang.String> memberIds,
@NotNull java.lang.Iterable<java.lang.String> failedIds,
@NotNull Root root,
@NotNull NamePathMapper namePathMapper)
Multiple members were removed from the
Group . |
init, onCreate, onCreate, onCreate, onPasswordChange, onRemove
void onMemberAdded(@NotNull @NotNull Group group, @NotNull @NotNull Authorizable member, @NotNull @NotNull Root root, @NotNull @NotNull NamePathMapper namePathMapper) throws RepositoryException
Authorizable
was added as a member of the Group
.
Implementations may perform specific modifications or validations.group
- The Group
to which the Authorizable
was added.member
- The Authorizable
added.root
- The root associated with the user manager.namePathMapper
- RepositoryException
- If an error occurs.void onMembersAdded(@NotNull @NotNull Group group, @NotNull @NotNull java.lang.Iterable<java.lang.String> memberIds, @NotNull @NotNull java.lang.Iterable<java.lang.String> failedIds, @NotNull @NotNull Root root, @NotNull @NotNull NamePathMapper namePathMapper) throws RepositoryException
Group
. 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.group
- The Group
to which the members were added.memberIds
- An Iterable
of the member IDs.root
- The root associated with the user manager.namePathMapper
- RepositoryException
- If an error occurs.void onMembersAddedContentId(@NotNull @NotNull Group group, @NotNull @NotNull java.lang.Iterable<java.lang.String> memberContentIds, @NotNull @NotNull java.lang.Iterable<java.lang.String> failedIds, @NotNull @NotNull Root root, @NotNull @NotNull NamePathMapper namePathMapper) throws RepositoryException
Group
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.
group
- The Group
to which the members were added.memberContentIds
- An Iterable
of the member content IDs (UUIDs).root
- The root associated with the user manager.namePathMapper
- RepositoryException
- If an error occurs.void onMemberRemoved(@NotNull @NotNull Group group, @NotNull @NotNull Authorizable member, @NotNull @NotNull Root root, @NotNull @NotNull NamePathMapper namePathMapper) throws RepositoryException
Authorizable
was removed from the Group
.
Implementations may perform specific modifications or validations.group
- The Group
from which the Authorizable
was removed.member
- The Authorizable
removed.root
- The root associated with the user manager.namePathMapper
- RepositoryException
- If an error occurs.void onMembersRemoved(@NotNull @NotNull Group group, @NotNull @NotNull java.lang.Iterable<java.lang.String> memberIds, @NotNull @NotNull java.lang.Iterable<java.lang.String> failedIds, @NotNull @NotNull Root root, @NotNull @NotNull NamePathMapper namePathMapper) throws RepositoryException
Group
. 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.group
- The Group
from which the members were removed.memberIds
- An Iterable
of the member IDs.root
- The root associated with the user manager.namePathMapper
- RepositoryException
- If an error occurs.Copyright © 2012–2022 The Apache Software Foundation. All rights reserved.