-
- All Superinterfaces:
- Principal
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.
-
-
Method Summary
Methods Modifier and Type Method and Description boolean
addMember(Principal user)
Adds the specified member to the group.boolean
isMember(Principal member)
Returns true if the passed principal is a member of the group.Enumeration<? extends Principal>
members()
Returns an enumeration of the members in the group.boolean
removeMember(Principal user)
Removes the specified member from the group.
-
-
-
Method Detail
-
addMember
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.
-
removeMember
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.
-
isMember
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.
-
members
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:
- an enumeration of the group members.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/security/acl/Group.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.