org.apache.catalina

Interface Group

All Superinterfaces:
Principal
Known Implementing Classes:
AbstractGroup, MemoryGroup

public interface Group
extends Principal

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.

Version:
$Revision: 1.2 $ $Date: 2004/02/27 14:58:38 $

Author:
Craig R. McClanahan

Since:
4.1

Method Summary

void
addRole(Role role)
Add a new Role to those assigned specifically to this group.
String
getDescription()
Return the description of this group.
String
getGroupname()
Return the group name of this group, which must be unique within the scope of a UserDatabase.
Iterator
getRoles()
Return the set of Roles assigned specifically to this group.
UserDatabase
getUserDatabase()
Return the UserDatabase within which this Group is defined.
Iterator
getUsers()
Return the set of Users that are members of this group.
boolean
isInRole(Role role)
Is this group specifically assigned the specified Role?
void
removeRole(Role role)
Remove a Role from those assigned to this group.
void
removeRoles()
Remove all Roles from those assigned to this group.
void
setDescription(String description)
Set the description of this group.
void
setGroupname(String groupname)
Set the group name of this group, which must be unique within the scope of a UserDatabase.

Method Details

addRole

public void addRole(Role role)
Add a new Role to those assigned specifically to this group.

Parameters:
role - The new role


getDescription

public String getDescription()
Return the description of this group.


getGroupname

public String getGroupname()


getRoles

public Iterator getRoles()
Return the set of Roles assigned specifically to this group.


getUserDatabase

public UserDatabase getUserDatabase()
Return the UserDatabase within which this Group is defined.


getUsers

public Iterator getUsers()
Return the set of Users that are members of this group.


isInRole

public boolean isInRole(Role role)
Is this group specifically assigned the specified Role?

Parameters:
role - The role to check


removeRole

public void removeRole(Role role)
Remove a Role from those assigned to this group.

Parameters:
role - The old role


removeRoles

public void removeRoles()
Remove all Roles from those assigned to this group.


setDescription

public void setDescription(String description)
Set the description of this group.

Parameters:
description - The new description


setGroupname

public void setGroupname(String groupname)

Parameters:
groupname - The new group name


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.