Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.catalina.users

Class MemoryGroup

Implemented Interfaces:
Group, Principal
public class MemoryGroup
extends AbstractGroup
Concrete implementation of Group for the MemoryUserDatabase implementation of UserDatabase.

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

Author:
Craig R. McClanahan

Since:
4.1

Field Summary

protected MemoryUserDatabase
database
The MemoryUserDatabase that owns this group.
protected ArrayList
roles
The set of Roles associated with this group.

Fields inherited from class org.apache.catalina.users.AbstractGroup

description, groupname

Method Summary

void
addRole(Role role)
Add a new Role to those assigned specifically to this group.
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.
String
toString()
Return a String representation of this group in XML format.

Methods inherited from class org.apache.catalina.users.AbstractGroup

addRole, getDescription, getGroupname, getName, getRoles, getUserDatabase, getUsers, isInRole, removeRole, removeRoles, setDescription, setGroupname

Field Details

database

protected MemoryUserDatabase database
The MemoryUserDatabase that owns this group.

roles

protected ArrayList roles
The set of Roles associated with 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
Overrides:
addRole in interface AbstractGroup

Parameters:
role - The new role

getRoles

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

getUserDatabase

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

getUsers

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

isInRole

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

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
Overrides:
removeRole in interface AbstractGroup

Parameters:
role - The old role

removeRoles

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

toString

public String toString()
Return a String representation of this group in XML format.

Overview Package Tree Index Deprecated About
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.