FileDocCategorySizeDatePackage
Group.javaAPI DocGlassfish v2 API4266Fri May 04 22:31:52 BST 2007org.apache.catalina

Group

public interface Group implements Principal

Abstract representation of a group of {@link User}s in a {@link UserDatabase}. Each user that is a member of this group inherits the {@link Role}s assigned to the group.

author
Craig R. McClanahan
version
$Revision: 1.3 $ $Date: 2007/05/05 05:31:51 $
since
4.1

Fields Summary
Constructors Summary
Methods Summary
public voidaddRole(Role role)
Add a new {@link Role} to those assigned specifically to this group.

param
role The new role

public java.lang.StringgetDescription()
Return the description of this group.

public java.lang.StringgetGroupname()
Return the group name of this group, which must be unique within the scope of a {@link UserDatabase}.

public java.util.IteratorgetRoles()
Return the set of {@link Role}s assigned specifically to this group.

public UserDatabasegetUserDatabase()
Return the {@link UserDatabase} within which this Group is defined.

public java.util.IteratorgetUsers()
Return the set of {@link User}s that are members of this group.

public booleanisInRole(Role role)
Is this group specifically assigned the specified {@link Role}?

param
role The role to check

public voidremoveRole(Role role)
Remove a {@link Role} from those assigned to this group.

param
role The old role

public voidremoveRoles()
Remove all {@link Role}s from those assigned to this group.

public voidsetDescription(java.lang.String description)
Set the description of this group.

param
description The new description

public voidsetGroupname(java.lang.String groupname)
Set the group name of this group, which must be unique within the scope of a {@link UserDatabase}.

param
groupname The new group name