Package org.apache.jackrabbit.api.security.user

Interface Group

All Superinterfaces:

Authorizable

@ProviderType
public interface Group
extends Authorizable

A Group is a collection of Authorizables.

Method Summary

Modifier and Type	Method	Description
boolean	addMember(@NotNull Authorizable authorizable)	Add a member to this Group.
@NotNull java.util.Set<java.lang.String>	addMembers(@NotNull java.lang.String... memberIds)	Add one or more member(s) to this Group.
@NotNull java.util.Iterator<Authorizable>	getDeclaredMembers()
@NotNull java.util.Iterator<Authorizable>	getMembers()
boolean	isDeclaredMember(@NotNull Authorizable authorizable)	Test whether an Authorizable is a declared member of this group.
boolean	isMember(@NotNull Authorizable authorizable)
boolean	removeMember(@NotNull Authorizable authorizable)	Remove a member from this Group.
@NotNull java.util.Set<java.lang.String>	removeMembers(@NotNull java.lang.String... memberIds)	Remove one or several members from this Group.

Methods inherited from interface org.apache.jackrabbit.api.security.user.Authorizable

declaredMemberOf, getID, getPath, getPrincipal, getProperty, getPropertyNames, getPropertyNames, hasProperty, isGroup, memberOf, remove, removeProperty, setProperty, setProperty

Method Detail

getDeclaredMembers

@NotNull
@NotNull java.util.Iterator<Authorizable> getDeclaredMembers()
                                                      throws javax.jcr.RepositoryException

Returns:

Iterator of Authorizables which are declared members of this Group.

Throws:

javax.jcr.RepositoryException - If an error occurs.

getMembers

@NotNull
@NotNull java.util.Iterator<Authorizable> getMembers()
                                              throws javax.jcr.RepositoryException

Returns:

Iterator of Authorizables which are members of this Group. This includes both declared members and all authorizables that are indirect group members.

Throws:

javax.jcr.RepositoryException - If an error occurs.

isDeclaredMember

boolean isDeclaredMember(@NotNull
                         @NotNull Authorizable authorizable)
                  throws javax.jcr.RepositoryException

Test whether an Authorizable is a declared member of this group.

Parameters:

authorizable - The Authorizable to test.

Returns:

true if the Authorizable to test is a direct member

Throws:

javax.jcr.RepositoryException - If an error occurs.

isMember

boolean isMember(@NotNull
                 @NotNull Authorizable authorizable)
          throws javax.jcr.RepositoryException

Parameters:

authorizable - The Authorizable to test.

Returns:

true if the Authorizable to test is a direct or indirect member of this Group.

Throws:

javax.jcr.RepositoryException - If an error occurs.

addMember

boolean addMember(@NotNull
                  @NotNull Authorizable authorizable)
           throws javax.jcr.RepositoryException

Add a member to this Group.

Parameters:

authorizable - The Authorizable to be added as member to this group.

Returns:

true if the Authorizable has successfully been added to this Group, false otherwise (e.g. unknown implementation or if it already is a member or if the passed authorizable is this group itself or for some implementation specific constraint).

Throws:

javax.jcr.RepositoryException - If an error occurs.

addMembers

@NotNull
@NotNull java.util.Set<java.lang.String> addMembers(@NotNull
                                                    @NotNull java.lang.String... memberIds)
                                             throws javax.jcr.RepositoryException

Add one or more member(s) to this Group. Note, that an implementation may define circumstances under which this method allows to add non-existing Authorizables as new members. Also an implementation may choose to (partially) postpone validation/verification util Session.save().

Parameters:

memberIds - The Ids of the authorizables to be added as members to this group.

Returns:

a set of those memberIds that could not be added or an empty set of all ids have been successfully processed. The former may include those cases where a given id cannot be resolved to an existing authorizable, one that is already member or if adding the member would create a cyclic group membership.

Throws:

javax.jcr.RepositoryException - If one of the specified memberIds is invalid or if some other error occurs.

removeMember

boolean removeMember(@NotNull
                     @NotNull Authorizable authorizable)
              throws javax.jcr.RepositoryException

Remove a member from this Group.

Parameters:

authorizable - The Authorizable to be removed from the list of group members.

Returns:

true if the Authorizable was successfully removed. False otherwise.

Throws:

javax.jcr.RepositoryException - If an error occurs.

removeMembers

@NotNull
@NotNull java.util.Set<java.lang.String> removeMembers(@NotNull
                                                       @NotNull java.lang.String... memberIds)
                                                throws javax.jcr.RepositoryException

Remove one or several members from this Group. Note, that an implementation may define circumstances under which this method allows to remove members that (no longer) exist. An implementation may choose to (partially) postpone validation/verification util Session.save().

Parameters:

memberIds - The Ids of the authorizables to be removed from the members of this group.

Returns:

a set of those memberIds that could not be removed or an empty set if all ids have been successfully processed. The former may include those cases where a given id cannot be resolved to an existing authorizable.

Throws:

javax.jcr.RepositoryException - If one of the specified memberIds is invalid or if some other error occurs.