org.apache.catalina
Interface Group

All Superinterfaces:

java.security.Principal

All Known Implementing Classes:

AbstractGroup, MemoryGroup

public interface Group
extends java.security.Principal

Abstract representation of a group of Users in a UserDatabase. Each user that is a member of this group inherits the Roles assigned to the group.

Since:

4.1

Author:

Craig R. McClanahan

getDescription

java.lang.String getDescription()

Return the description of this group.

setDescription

void setDescription(java.lang.String description)

Set the description of this group.

Parameters:

description - The new description

getGroupname

java.lang.String getGroupname()

Return the group name of this group, which must be unique within the scope of a UserDatabase.

setGroupname

void setGroupname(java.lang.String groupname)

Set the group name of this group, which must be unique within the scope of a UserDatabase.

Parameters:

groupname - The new group name

getRoles

java.util.Iterator getRoles()

Return the set of Roles assigned specifically to this group.

getUserDatabase

UserDatabase getUserDatabase()

Return the UserDatabase within which this Group is defined.

getUsers

java.util.Iterator getUsers()

Return the set of Users that are members of this group.

addRole

void addRole(Role role)

Add a new Role to those assigned specifically to this group.

Parameters:

role - The new role

isInRole

boolean isInRole(Role role)

Is this group specifically assigned the specified Role?

Parameters:

role - The role to check

removeRole

void removeRole(Role role)

Remove a Role from those assigned to this group.

Parameters:

role - The old role

removeRoles

void removeRoles()

Remove all Roles from those assigned to this group.