org.apache.catalina
Interface Group
- Principal
- AbstractGroup, MemoryGroup
public interface Group
extends Principal
Abstract representation of a group of
User
s in a
UserDatabase
. Each user that is a member of this group
inherits the
Role
s assigned to the group.
Version:
- Craig R. McClanahan
- 4.1
addRole
public void addRole(Role role)
Add a new
Role
to those assigned specifically to this group.
role
- The new role
getDescription
public String getDescription()
Return the description of this group.
getGroupname
public String getGroupname()
Return the group name of this group, which must be unique
within the scope of a
UserDatabase
.
getRoles
public Iterator getRoles()
Return the set of
Role
s assigned specifically to this group.
getUsers
public Iterator getUsers()
Return the set of
User
s that are members of this group.
isInRole
public boolean isInRole(Role role)
Is this group specifically assigned the specified
Role
?
role
- The role to check
removeRole
public void removeRole(Role role)
Remove a
Role
from those assigned to this group.
role
- The old role
removeRoles
public void removeRoles()
Remove all
Role
s from those assigned to this group.
setDescription
public void setDescription(String description)
Set the description of this group.
description
- The new description
setGroupname
public void setGroupname(String groupname)
Set the group name of this group, which must be unique
within the scope of a
UserDatabase
.
groupname
- The new group name
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.