org.apache.catalina.users

Class AbstractGroup

Implemented Interfaces:
Group, Principal
Known Direct Subclasses:
MemoryGroup

public abstract class AbstractGroup
extends java.lang.Object
implements Group

Convenience base class for Group implementations.

Version:
$Revision: 1.3 $ $Date: 2004/02/27 14:58:50 $

Author:
Craig R. McClanahan

Since:
4.1

Field Summary

protected String
description
The description of this group.
protected String
groupname
The group name of this group.

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.
String
getName()
Make the principal name the same as the group name.
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.

Field Details

description

protected String description
The description of this group.


groupname

protected String groupname
The group name of this group.

Method Details

addRole

public void addRole(Role role)
Add a new Role to those assigned specifically to this group.
Specified by:
addRole in interface Group

Parameters:
role - The new role


getDescription

public String getDescription()
Return the description of this group.
Specified by:
getDescription in interface Group


getGroupname

public String getGroupname()
Specified by:
getGroupname in interface Group


getName

public String getName()
Make the principal name the same as the group name.


getRoles

public Iterator getRoles()
Return the set of Roles assigned specifically to this group.
Specified by:
getRoles in interface Group


getUserDatabase

public UserDatabase getUserDatabase()
Return the UserDatabase within which this Group is defined.
Specified by:
getUserDatabase in interface Group


getUsers

public Iterator getUsers()
Return the set of Users that are members of this group.
Specified by:
getUsers in interface Group


isInRole

public boolean isInRole(Role role)
Is this group specifically assigned the specified Role?
Specified by:
isInRole in interface Group

Parameters:
role - The role to check


removeRole

public void removeRole(Role role)
Remove a Role from those assigned to this group.
Specified by:
removeRole in interface Group

Parameters:
role - The old role


removeRoles

public void removeRoles()
Remove all Roles from those assigned to this group.
Specified by:
removeRoles in interface Group


setDescription

public void setDescription(String description)
Set the description of this group.
Specified by:
setDescription in interface Group

Parameters:
description - The new description


setGroupname

public void setGroupname(String groupname)
Specified by:
setGroupname in interface Group

Parameters:
groupname - The new group name


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