Package org.apache.catalina.users
Class GenericGroup<UD extends UserDatabase>
- java.lang.Object
-
- org.apache.catalina.users.AbstractGroup
-
- org.apache.catalina.users.GenericGroup<UD>
-
- Type Parameters:
UD
- The specific type of UserDase with which this group is associated
- All Implemented Interfaces:
java.security.Principal
,Group
- Direct Known Subclasses:
MemoryGroup
public class GenericGroup<UD extends UserDatabase> extends AbstractGroup
Concrete implementation of
Group
for aUserDatabase
.- Author:
- Craig R. McClanahan
-
-
Field Summary
Fields Modifier and Type Field Description protected UD
database
TheUserDatabase
that owns this group.protected java.util.concurrent.CopyOnWriteArrayList<Role>
roles
The set ofRole
s associated with this group.-
Fields inherited from class org.apache.catalina.users.AbstractGroup
description, groupname
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addRole(Role role)
Add a newRole
to those assigned specifically to this group.boolean
equals(java.lang.Object obj)
java.util.Iterator<Role>
getRoles()
UserDatabase
getUserDatabase()
java.util.Iterator<User>
getUsers()
int
hashCode()
boolean
isInRole(Role role)
Is this group specifically assigned the specifiedRole
?void
removeRole(Role role)
Remove aRole
from those assigned to this group.void
removeRoles()
Remove allRole
s from those assigned to this group.-
Methods inherited from class org.apache.catalina.users.AbstractGroup
getDescription, getGroupname, getName, setDescription, setGroupname
-
-
-
-
Field Detail
-
database
protected final UD extends UserDatabase database
TheUserDatabase
that owns this group.
-
-
Method Detail
-
getRoles
public java.util.Iterator<Role> getRoles()
- Returns:
- the set of
Role
s assigned specifically to this group.
-
getUserDatabase
public UserDatabase getUserDatabase()
- Returns:
- the
UserDatabase
within which this Group is defined.
-
getUsers
public java.util.Iterator<User> getUsers()
- Returns:
- the set of
User
s that are members of this group.
-
addRole
public void addRole(Role role)
Description copied from interface:Group
Add a newRole
to those assigned specifically to this group.- Parameters:
role
- The new role
-
isInRole
public boolean isInRole(Role role)
Description copied from interface:Group
Is this group specifically assigned the specifiedRole
?- Parameters:
role
- The role to check- Returns:
true
if the group is assigned to the specified role otherwisefalse
-
removeRole
public void removeRole(Role role)
Description copied from interface:Group
Remove aRole
from those assigned to this group.- Parameters:
role
- The old role
-
removeRoles
public void removeRoles()
Description copied from interface:Group
Remove allRole
s from those assigned to this group.
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacejava.security.Principal
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacejava.security.Principal
- Overrides:
hashCode
in classjava.lang.Object
-
-