Group
public interface Group
implements Principal
java.security.acl.Group |
This interface was deprecated in API level 33.
This class is deprecated and subject to removal in a future version of Java SE. It has been replaced by java.security.Policy
and related classes since 1.2.
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.
Summary
Public methods | |
---|---|
abstract boolean | addMember(Principal user) Adds the specified member to the group. |
abstract boolean | isMember(Principal member) Returns true if the passed principal is a member of the group. |
abstract Enumeration<? extends Principal> | members() Returns an enumeration of the members in the group. |
abstract boolean | removeMember(Principal user) Removes the specified member from the group. |
Inherited methods | |
---|---|
Public methods
addMember
public abstract boolean addMember (Principal user)
Adds the specified member to the group.
Parameters | |
---|---|
user | Principal : the principal to add to this group. |
Returns | |
---|---|
boolean | true if the member was successfully added, false if the principal was already a member. |
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 | Principal : the principal whose membership is to be checked. |
Returns | |
---|---|
boolean | true if the principal is a member of this group, false otherwise. |
members
public abstract Enumeration<? extends Principal> 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 | |
---|---|
Enumeration<? extends Principal> | an enumeration of the group members. |
removeMember
public abstract boolean removeMember (Principal user)
Removes the specified member from the group.
Parameters | |
---|---|
user | Principal : the principal to remove from this group. |
Returns | |
---|---|
boolean | true if the principal was removed, or false if the principal was not a member. |