Package org.apache.catalina
Interface Group
- 
- All Superinterfaces:
- java.security.Principal
 - All Known Implementing Classes:
- AbstractGroup,- MemoryGroup
 
 public interface Group extends java.security.PrincipalAbstract representation of a group of Users in aUserDatabase. Each user that is a member of this group inherits theRoles assigned to the group.- Since:
- 4.1
- Author:
- Craig R. McClanahan
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddRole(Role role)Add a newRoleto those assigned specifically to this group.java.lang.StringgetDescription()java.lang.StringgetGroupname()java.util.Iterator<Role>getRoles()UserDatabasegetUserDatabase()java.util.Iterator<User>getUsers()booleanisInRole(Role role)Is this group specifically assigned the specifiedRole?voidremoveRole(Role role)Remove aRolefrom those assigned to this group.voidremoveRoles()Remove allRoles from those assigned to this group.voidsetDescription(java.lang.String description)Set the description of this group.voidsetGroupname(java.lang.String groupname)Set the group name of this group, which must be unique within the scope of aUserDatabase.
 
- 
- 
- 
Method Detail- 
getDescriptionjava.lang.String getDescription() - Returns:
- the description of this group.
 
 - 
setDescriptionvoid setDescription(java.lang.String description) Set the description of this group.- Parameters:
- description- The new description
 
 - 
getGroupnamejava.lang.String getGroupname() - Returns:
- the group name of this group, which must be unique
 within the scope of a UserDatabase.
 
 - 
setGroupnamevoid setGroupname(java.lang.String groupname) Set the group name of this group, which must be unique within the scope of aUserDatabase.- Parameters:
- groupname- The new group name
 
 - 
getRolesjava.util.Iterator<Role> getRoles() - Returns:
- the set of Roles assigned specifically to this group.
 
 - 
getUserDatabaseUserDatabase getUserDatabase() - Returns:
- the UserDatabasewithin which this Group is defined.
 
 - 
getUsersjava.util.Iterator<User> getUsers() - Returns:
- the set of Users that are members of this group.
 
 - 
addRolevoid addRole(Role role) Add a newRoleto those assigned specifically to this group.- Parameters:
- role- The new role
 
 - 
isInRoleboolean isInRole(Role role) Is this group specifically assigned the specifiedRole?- Parameters:
- role- The role to check
- Returns:
- trueif the group is assigned to the specified role otherwise- false
 
 - 
removeRolevoid removeRole(Role role) Remove aRolefrom those assigned to this group.- Parameters:
- role- The old role
 
 - 
removeRolesvoid removeRoles() Remove allRoles from those assigned to this group.
 
- 
 
-