Package org.apache.catalina
Interface Group
- All Superinterfaces:
- Principal
- All Known Implementing Classes:
- AbstractGroup,- GenericGroup,- MemoryGroup
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.
- Since:
- 4.1
- Author:
- Craig R. McClanahan
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a newRoleto those assigned specifically to this group.getRoles()getUsers()booleanIs this group specifically assigned the specifiedRole?voidremoveRole(Role role) Remove aRolefrom those assigned to this group.voidRemove allRoles from those assigned to this group.voidsetDescription(String description) Set the description of this group.voidsetGroupname(String groupname) Set the group name of this group, which must be unique within the scope of aUserDatabase.
- 
Method Details- 
getDescriptionString getDescription()- Returns:
- the description of this group.
 
- 
setDescriptionSet the description of this group.- Parameters:
- description- The new description
 
- 
getGroupnameString getGroupname()- Returns:
- the group name of this group, which must be unique
 within the scope of a UserDatabase.
 
- 
setGroupnameSet the group name of this group, which must be unique within the scope of aUserDatabase.- Parameters:
- groupname- The new group name
 
- 
getRoles- Returns:
- the set of Roles assigned specifically to this group.
 
- 
getUserDatabaseUserDatabase getUserDatabase()- Returns:
- the UserDatabasewithin which this Group is defined.
 
- 
getUsers- Returns:
- the set of Users that are members of this group.
 
- 
addRoleAdd a newRoleto those assigned specifically to this group.- Parameters:
- role- The new role
 
- 
isInRoleIs this group specifically assigned the specifiedRole?- Parameters:
- role- The role to check
- Returns:
- trueif the group is assigned to the specified role otherwise- false
 
- 
removeRoleRemove aRolefrom those assigned to this group.- Parameters:
- role- The old role
 
- 
removeRolesvoid removeRoles()Remove allRoles from those assigned to this group.
 
-