org.apache.catalina.users

Class AbstractGroup

public abstract class AbstractGroup extends Object implements Group

Convenience base class for Group implementations.

Since: 4.1

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Field Summary
protected Stringdescription
The description of this group.
protected Stringgroupname
The group name of this group.
Method Summary
abstract voidaddRole(Role role)
Add a new Role to those assigned specifically to this group.
StringgetDescription()
Return the description of this group.
StringgetGroupname()
Return the group name of this group, which must be unique within the scope of a UserDatabase.
StringgetName()
Make the principal name the same as the group name.
abstract IteratorgetRoles()
Return the set of Roles assigned specifically to this group.
abstract UserDatabasegetUserDatabase()
Return the UserDatabase within which this Group is defined.
abstract IteratorgetUsers()
Return an Iterator over the set of Users that are members of this group.
abstract booleanisInRole(Role role)
Is this group specifically assigned the specified Role?
abstract voidremoveRole(Role role)
Remove a Role from those assigned to this group.
abstract voidremoveRoles()
Remove all Roles 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 a UserDatabase.

Field Detail

description

protected String description
The description of this group.

groupname

protected String groupname
The group name of this group.

Method Detail

addRole

public abstract 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()
Return the group name of this group, which must be unique within the scope of a UserDatabase.

getName

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

getRoles

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

getUserDatabase

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

getUsers

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

isInRole

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

Parameters: role The role to check

removeRole

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

Parameters: role The old role

removeRoles

public abstract 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)
Set the group name of this group, which must be unique within the scope of a UserDatabase.

Parameters: groupname The new group name

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.