public interface Group
extends java.security.Principal
Abstract representation of a group of Users in a
UserDatabase. Each user that is a member of this group
inherits the Roles assigned to the group.
| Modifier and Type | Method and Description | 
|---|---|
| void | addRole(Role role)Add a new  Roleto those assigned specifically to this group. | 
| java.lang.String | getDescription()Return the description of this group. | 
| java.lang.String | getGroupname()Return the group name of this group, which must be unique
within the scope of a  UserDatabase. | 
| java.util.Iterator<Role> | getRoles()Return the set of  Roles assigned specifically to this group. | 
| UserDatabase | getUserDatabase()Return the  UserDatabasewithin which this Group is defined. | 
| java.util.Iterator<User> | getUsers()Return the set of  Users that are members of this group. | 
| boolean | isInRole(Role role)Is this group specifically assigned the specified  Role? | 
| void | removeRole(Role role)Remove a  Rolefrom those assigned to this group. | 
| void | removeRoles()Remove all  Roles from those assigned to this group. | 
| void | setDescription(java.lang.String description)Set the description of this group. | 
| void | setGroupname(java.lang.String groupname)Set the group name of this group, which must be unique
within the scope of a  UserDatabase. | 
java.lang.String getDescription()
void setDescription(java.lang.String description)
description - The new descriptionjava.lang.String getGroupname()
UserDatabase.void setGroupname(java.lang.String groupname)
UserDatabase.groupname - The new group namejava.util.Iterator<Role> getRoles()
Roles assigned specifically to this group.UserDatabase getUserDatabase()
UserDatabase within which this Group is defined.java.util.Iterator<User> getUsers()
Users that are members of this group.void addRole(Role role)
Role to those assigned specifically to this group.role - The new roleboolean isInRole(Role role)
Role?role - The role to checkvoid removeRole(Role role)
Role from those assigned to this group.role - The old rolevoid removeRoles()
Roles from those assigned to this group.Copyright © 2000-2015 Apache Software Foundation. All Rights Reserved.