Package org.apache.catalina
Interface Group
-
- All Superinterfaces:
Principal
- All Known Implementing Classes:
AbstractGroup,MemoryGroup
public interface Group extends Principal
Abstract 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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddRole(Role role)Add a newRoleto those assigned specifically to this group.StringgetDescription()StringgetGroupname()Iterator<Role>getRoles()UserDatabasegetUserDatabase()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(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 Detail
-
getDescription
String getDescription()
- Returns:
- the description of this group.
-
setDescription
void setDescription(String description)
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
void setGroupname(String groupname)
Set the group name of this group, which must be unique within the scope of aUserDatabase.- Parameters:
groupname- The new group name
-
getUserDatabase
UserDatabase getUserDatabase()
- Returns:
- the
UserDatabasewithin which this Group is defined.
-
addRole
void addRole(Role role)
Add a newRoleto those assigned specifically to this group.- Parameters:
role- The new role
-
isInRole
boolean 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 otherwisefalse
-
removeRole
void removeRole(Role role)
Remove aRolefrom those assigned to this group.- Parameters:
role- The old role
-
removeRoles
void removeRoles()
Remove allRoles from those assigned to this group.
-
-