org.apache.catalina

Interface Group

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.

Since: 4.1

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

Author: Craig R. McClanahan

Method Summary
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.
IteratorgetRoles()
Return the set of Roles assigned specifically to this group.
UserDatabasegetUserDatabase()
Return the UserDatabase within which this Group is defined.
IteratorgetUsers()
Return the set of Users that are members of this group.
booleanisInRole(Role role)
Is this group specifically assigned the specified Role?
voidremoveRole(Role role)
Remove a Role from those assigned to this group.
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.

Method Detail

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()
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 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)
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.