Package org.apache.catalina.users
Class AbstractGroup
java.lang.Object
org.apache.catalina.users.AbstractGroup
- Direct Known Subclasses:
- GenericGroup
Convenience base class for Group implementations.
- Since:
- 4.1
- Author:
- Craig R. McClanahan
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionabstract voidAdd a newRoleto those assigned specifically to this group.Return the description of this group.Return the group name of this group, which must be unique within the scope of aUserDatabase.getName()Make the principal name the same as the group name.getRoles()Return the set ofRoles assigned specifically to this group.abstract UserDatabaseReturn theUserDatabasewithin which this Group is defined.getUsers()Return an Iterator over the set ofUsers that are members of this group.abstract booleanIs this group specifically assigned the specifiedRole?abstract voidremoveRole(Role role) Remove aRolefrom those assigned to this group.abstract voidRemove allRoles from those assigned to this group.voidsetDescription(String description) Set the description of this group.voidsetGroupname(String groupname) Set the group name of this group, which must be unique within the scope of aUserDatabase.
- 
Field Details- 
descriptionThe description of this group.
- 
groupnameThe group name of this group.
 
- 
- 
Constructor Details- 
AbstractGrouppublic AbstractGroup()
 
- 
- 
Method Details- 
getDescriptionReturn the description of this group.- Specified by:
- getDescriptionin interface- Group
- Returns:
- the description of this group.
 
- 
setDescriptionSet the description of this group.- Specified by:
- setDescriptionin interface- Group
- Parameters:
- description- The new description
 
- 
getGroupnameReturn the group name of this group, which must be unique within the scope of aUserDatabase.- Specified by:
- getGroupnamein interface- Group
- Returns:
- the group name of this group, which must be unique
 within the scope of a UserDatabase.
 
- 
setGroupnameSet the group name of this group, which must be unique within the scope of aUserDatabase.- Specified by:
- setGroupnamein interface- Group
- Parameters:
- groupname- The new group name
 
- 
getRolesReturn the set ofRoles assigned specifically to this group.
- 
getUserDatabaseReturn theUserDatabasewithin which this Group is defined.- Specified by:
- getUserDatabasein interface- Group
- Returns:
- the UserDatabasewithin which this Group is defined.
 
- 
getUsersReturn an Iterator over the set ofUsers that are members of this group.
- 
addRoleAdd a newRoleto those assigned specifically to this group.
- 
isInRoleIs this group specifically assigned the specifiedRole?
- 
removeRoleRemove aRolefrom those assigned to this group.- Specified by:
- removeRolein interface- Group
- Parameters:
- role- The old role
 
- 
removeRolespublic abstract void removeRoles()Remove allRoles from those assigned to this group.- Specified by:
- removeRolesin interface- Group
 
- 
getNameMake the principal name the same as the group name.
 
-