| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.users.AbstractGroup
public abstract class AbstractGroup
Convenience base class for Group implementations.
| Field Summary | |
|---|---|
| protected  java.lang.String | descriptionThe description of this group. | 
| protected  java.lang.String | groupnameThe group name of this group. | 
| Constructor Summary | |
|---|---|
| AbstractGroup() | |
| Method Summary | |
|---|---|
| abstract  void | addRole(Role role)Add a new Roleto those assigned specifically to this group. | 
|  java.lang.String | getDescription()Return the description of this group. | 
|  java.lang.String | getGroupname()Return the group name of this group, which must be unique within the scope of a UserDatabase. | 
|  java.lang.String | getName()Make the principal name the same as the group name. | 
| abstract  java.util.Iterator | getRoles()Return the set of Roles assigned specifically to this group. | 
| abstract  UserDatabase | getUserDatabase()Return the UserDatabasewithin which this Group is defined. | 
| abstract  java.util.Iterator | getUsers()Return an Iterator over the set of Users that 
 are members of this group. | 
| abstract  boolean | isInRole(Role role)Is this group specifically assigned the specified Role? | 
| abstract  void | removeRole(Role role)Remove a Rolefrom those assigned to this group. | 
| abstract  void | removeRoles()Remove all Roles from those assigned to this group. | 
|  void | setDescription(java.lang.String description)Set the description of this group. | 
|  void | setGroupname(java.lang.String groupname)Set the group name of this group, which must be unique within the scope of a UserDatabase. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Methods inherited from interface java.security.Principal | 
|---|
| equals, hashCode, toString | 
| Field Detail | 
|---|
protected java.lang.String description
protected java.lang.String groupname
| Constructor Detail | 
|---|
public AbstractGroup()
| Method Detail | 
|---|
public java.lang.String getDescription()
getDescription in interface Grouppublic void setDescription(java.lang.String description)
setDescription in interface Groupdescription - The new descriptionpublic java.lang.String getGroupname()
UserDatabase.
getGroupname in interface Grouppublic void setGroupname(java.lang.String groupname)
UserDatabase.
setGroupname in interface Groupgroupname - The new group namepublic abstract java.util.Iterator getRoles()
Roles assigned specifically to this group.
getRoles in interface Grouppublic abstract UserDatabase getUserDatabase()
UserDatabase within which this Group is defined.
getUserDatabase in interface Grouppublic abstract java.util.Iterator getUsers()
Users that 
 are members of this group.
getUsers in interface Grouppublic abstract void addRole(Role role)
Role to those assigned specifically to this group.
addRole in interface Grouprole - The new rolepublic abstract boolean isInRole(Role role)
Role?
isInRole in interface Grouprole - The role to checkpublic abstract void removeRole(Role role)
Role from those assigned to this group.
removeRole in interface Grouprole - The old rolepublic abstract void removeRoles()
Roles from those assigned to this group.
removeRoles in interface Grouppublic java.lang.String getName()
getName in interface java.security.Principal| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||