public abstract class AbstractGroup extends java.lang.Object implements Group
Convenience base class for Group implementations.
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String |
description
The description of this group.
|
protected java.lang.String |
groupname
The group name of this group.
|
| Constructor and Description |
|---|
AbstractGroup() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
addRole(Role role)
Add a new
Role to 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<Role> |
getRoles()
Return the set of
Roles assigned specifically to this group. |
abstract UserDatabase |
getUserDatabase()
Return the
UserDatabase within which this Group is defined. |
abstract java.util.Iterator<User> |
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
Role from 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. |
protected java.lang.String description
protected java.lang.String groupname
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 GroupUserDatabase.public void setGroupname(java.lang.String groupname)
UserDatabase.setGroupname in interface Groupgroupname - The new group namepublic abstract java.util.Iterator<Role> getRoles()
Roles assigned specifically to this group.public abstract UserDatabase getUserDatabase()
UserDatabase within which this Group is defined.getUserDatabase in interface GroupUserDatabase within which this Group is defined.public abstract java.util.Iterator<User> getUsers()
Users that
are members of this group.public abstract void addRole(Role role)
Role to those assigned specifically to this group.public abstract boolean isInRole(Role role)
Role?public 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.PrincipalCopyright © 2000-2019 Apache Software Foundation. All Rights Reserved.