FileDocCategorySizeDatePackage
AbstractGroup.javaAPI DocApache Tomcat 6.0.144040Fri Jul 20 04:20:32 BST 2007org.apache.catalina.users

AbstractGroup

public abstract class AbstractGroup extends Object implements org.apache.catalina.Group

Convenience base class for {@link Group} implementations.

author
Craig R. McClanahan
version
$Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
since
4.1

(Omit source code)

Fields Summary
protected String
description
The description of this group.
protected String
groupname
The group name of this group.
Constructors Summary
Methods Summary
public abstract voidaddRole(org.apache.catalina.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.



    // ------------------------------------------------------------- Properties


               
       

        return (this.description);

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


        return (this.groupname);

    
public java.lang.StringgetName()
Make the principal name the same as the group name.


        return (getGroupname());

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

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

public abstract java.util.IteratorgetUsers()
Return an Iterator over the set of {@link org.apache.catalina.User}s that are members of this group.

public abstract booleanisInRole(org.apache.catalina.Role role)
Is this group specifically assigned the specified {@link Role}?

param
role The role to check

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

param
role The old role

public abstract 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


        this.description = 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


        this.groupname = groupname;