Interface java.security.acl.Group 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.security.acl.Group

public interface Group
extends Principal
This interface is used to represent a group of principals. (A principal represents an entity such as an individual user or a company).

Note that Group extends Principal. Thus, either a Principal or a Group can be passed as an argument to methods containing a Principal parameter. For example, you can add either a Principal or a Group to a Group object by calling the object's addMember method, passing it the Principal or Group.

Author:
Satish Dharmaraj

Method Index

o addMember(Principal)
Adds the specified member to the group.
o isMember(Principal)
Returns true if the passed principal is a member of the group.
o members()
Returns an enumeration of the members in the group.
o removeMember(Principal)
Removes the specified member from the group.

Methods

o addMember 
public abstract boolean addMember(Principal user)
Adds the specified member to the group.

Parameters:
user - the principal to add to this group.
Returns:
true if the member was successfully added, false if the principal was already a member.
o isMember 
public abstract boolean isMember(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.
o members 
public abstract java.util.Enumeration members()
Returns an enumeration of the members in the group. The returned objects can be instances of either Principal or Group (which is a subclass of Principal).

Returns:
an enumeration of the group members.
o removeMember 
public abstract boolean removeMember(Principal user)
Removes the specified member from the group.

Parameters:
user - the principal to remove from this group.
Returns:
true if the principal was removed, or false if the principal was not a member. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index