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
Groupfor aUserDatabase.- Author:
- Craig R. McClanahan
-
-
Field Summary
Fields Modifier and Type Field Description protected UDdatabaseTheUserDatabasethat owns this group.protected java.util.concurrent.CopyOnWriteArrayList<Role>rolesThe set ofRoles 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 voidaddRole(Role role)Add a newRoleto those assigned specifically to this group.booleanequals(java.lang.Object obj)java.util.Iterator<Role>getRoles()Return the set ofRoles assigned specifically to this group.UserDatabasegetUserDatabase()Return theUserDatabasewithin which this Group is defined.java.util.Iterator<User>getUsers()Return the set ofUsers that are members of this group.inthashCode()booleanisInRole(Role role)Is this group specifically assigned the specifiedRole?voidremoveRole(Role role)Remove aRolefrom those assigned to this group.voidremoveRoles()Remove allRoles 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
TheUserDatabasethat owns this group.
-
-
Method Detail
-
getRoles
public java.util.Iterator<Role> getRoles()
Return the set ofRoles assigned specifically to this group.- Specified by:
getRolesin interfaceGroup- Specified by:
getRolesin classAbstractGroup- Returns:
- the set of
Roles assigned specifically to this group.
-
getUserDatabase
public UserDatabase getUserDatabase()
Return theUserDatabasewithin which this Group is defined.- Specified by:
getUserDatabasein interfaceGroup- Specified by:
getUserDatabasein classAbstractGroup- Returns:
- the
UserDatabasewithin which this Group is defined.
-
getUsers
public java.util.Iterator<User> getUsers()
Return the set ofUsers that are members of this group.- Specified by:
getUsersin interfaceGroup- Specified by:
getUsersin classAbstractGroup- Returns:
- the set of
Users that are members of this group.
-
addRole
public void addRole(Role role)
Add a newRoleto those assigned specifically to this group.- Specified by:
addRolein interfaceGroup- Specified by:
addRolein classAbstractGroup- Parameters:
role- The new role
-
isInRole
public boolean isInRole(Role role)
Is this group specifically assigned the specifiedRole?- Specified by:
isInRolein interfaceGroup- Specified by:
isInRolein classAbstractGroup- Parameters:
role- The role to check- Returns:
trueif the group is assigned to the specified role otherwisefalse
-
removeRole
public void removeRole(Role role)
Remove aRolefrom those assigned to this group.- Specified by:
removeRolein interfaceGroup- Specified by:
removeRolein classAbstractGroup- Parameters:
role- The old role
-
removeRoles
public void removeRoles()
Remove allRoles from those assigned to this group.- Specified by:
removeRolesin interfaceGroup- Specified by:
removeRolesin classAbstractGroup
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equalsin interfacejava.security.Principal- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacejava.security.Principal- Overrides:
hashCodein classjava.lang.Object
-
-