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 Summary
Modifier 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
-
getDescription
String getDescription()- Returns:
- the description of this group.
-
setDescription
Set the description of this group.- Parameters:
description- The new description
-
getGroupname
String getGroupname()- Returns:
- the group name of this group, which must be unique within the scope of a
UserDatabase.
-
setGroupname
Set 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.
-
getUserDatabase
UserDatabase getUserDatabase()- Returns:
- the
UserDatabasewithin which this Group is defined.
-
getUsers
- Returns:
- the set of
Users that are members of this group.
-
addRole
Add a newRoleto those assigned specifically to this group.- Parameters:
role- The new role
-
isInRole
Is this group specifically assigned the specifiedRole?- Parameters:
role- The role to check- Returns:
trueif the group is assigned to the specified role otherwisefalse
-
removeRole
Remove aRolefrom those assigned to this group.- Parameters:
role- The old role
-
removeRoles
void removeRoles()Remove allRoles from those assigned to this group.
-