 | Provide APIs to manipulate users and groups |
| Type | JAR |
| Category | API |
| Developed by | |
| Rating | |
| License | GNU General Public License 1 |
Table of contents
Nothing yet. The org.xwiki.user.group.GroupManager component allows getting information about the groups and their members.Groups
Member's groups
/**
* Search groups the passed user or group is member of.
* <p>
* {code wikis} controls where to search for the groups and {@code recurse} only the direct group should be
* returned or the whole hierarchy.
*
* @param member the group member (user or group)
* @param wikiTarget the wikis where to search. The following types are supported:
* <ul>
* <li>{@link org.xwiki.user.group.WikiTarget}</li>
* <li>{@link String}</li>
* <li>{@code Collection<String>}</li>
* <li>{@code org.xwiki.model.reference.WikiReference}</li>
* <li>{@code Collection<org.xwiki.model.reference.WikiReference>}</li>
* </ul>
* @param recurse false if only the direct groups should be returned, true to take into account groups of groups
* @return the groups the passed user or group is member of
* @throws GroupException when failing to get groups
*/
Collection<DocumentReference> getGroups(DocumentReference member, Object wikiTarget, boolean recurse)
throws GroupException;Group's members
/**
* Retrieve the users and groups which are the members of the passed group.
*
* @param group the group for which to return the members
* @param recurse false if only the direct members should be returned, true to take into account groups of groups
* @return the members of the passed group
* @throws GroupException when failing to get members
*/
Collection<DocumentReference> getMembers(DocumentReference group, boolean recurse) throws GroupException;
