Package org.apache.jackrabbit.api.security.principal

Interface GroupPrincipal

All Superinterfaces:

Principal

All Known Implementing Classes:

EveryonePrincipal

@ProviderType
public interface GroupPrincipal
extends Principal

This interface is used to represent a group of principals. It is meant to replace the deprecated java.security.acl.Group.

Method Summary

Modifier and Type	Method	Description
boolean	isMember(@NotNull Principal member)	Returns true if the passed principal is a member of the group.
@NotNull Enumeration<? extends Principal>	members()	Returns an enumeration of the members in the group.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Method Details

isMember

boolean isMember(@NotNull
 @NotNull Principal member)

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned.

Parameters:

member - the principal whose membership is to be checked.

Returns:

true if the principal is a member of this group, false otherwise.

members

@NotNull
@NotNull Enumeration<? extends Principal> members()

Returns an enumeration of the members in the group. This includes both declared members and all principals that are indirect group members. The returned objects can be instances of either Principal or GroupPrincipal (which is a subclass of Principal).

Returns:

an enumeration of the group members.