Tomcat 10.1.19 · org.apache.catalina.Group · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addRole(Role The new role role) Add a new `Role` to those assigned specifically to this group.
public String	Returns: the description of this group. getDescription()
public String	Returns: the group name of this group, which must be unique within the scope of a `UserDatabase`. getGroupname()
public Iterator<Role>	Returns: the set of `Role`s assigned specifically to this group. getRoles()
public UserDatabase	Returns: the `UserDatabase` within which this Group is defined. getUserDatabase()
public Iterator<User>	Returns: the set of `User`s that are members of this group. getUsers()
public boolean	Returns: `true` if the group is assigned to the specified role otherwise `false` isInRole(Role The role to check role) Is this group specifically assigned the specified `Role`?
public void	removeRole(Role The old role role) Remove a `Role` from those assigned to this group.
public void	removeRoles() Remove all `Role`s from those assigned to this group.
public void	setDescription(String The new description description) Set the description of this group.
public void	setGroupname(String The new group name groupname) Set the group name of this group, which must be unique within the scope of a `UserDatabase`.

Inherited from java.security.Principal:: equals getName hashCode implies toString

addRole back to summary

addRole	back to summary
public void addRole(Role role) Add a new `Role` to those assigned specifically to this group. Parameters role:Role The new role

public void addRole(Role role)

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

Parameters

getDescription	back to summary
public String getDescription() Returns:String the description of this group.

getGroupname	back to summary
public String getGroupname() Returns:String the group name of this group, which must be unique within the scope of a `UserDatabase`.

getRoles	back to summary
public Iterator<Role> getRoles() Returns:Iterator<Role> the set of `Role`s assigned specifically to this group.

getUserDatabase	back to summary
public UserDatabase getUserDatabase() Returns:UserDatabase the `UserDatabase` within which this Group is defined.

getUsers	back to summary
public Iterator<User> getUsers() Returns:Iterator<User> the set of `User`s that are members of this group.

isInRole back to summary

isInRole	back to summary
public boolean isInRole(Role role) Is this group specifically assigned the specified `Role`? Parameters role:Role The role to check Returns:boolean `true` if the group is assigned to the specified role otherwise `false`

public boolean isInRole(Role role)

Is this group specifically assigned the specified Role?

Parameters

Returns:boolean

true if the group is assigned to the specified role otherwise false

removeRole back to summary

removeRole	back to summary
public void removeRole(Role role) Remove a `Role` from those assigned to this group. Parameters role:Role The old role

public void removeRole(Role role)

Remove a Role from those assigned to this group.

Parameters

removeRoles	back to summary
public void removeRoles() Remove all `Role`s from those assigned to this group.

setDescription	back to summary
public void setDescription(String description) Set the description of this group. Parameters description:String The new description

setDescription

public void setDescription(String description)

Set the description of this group.

Parameters

setGroupname back to summary

setGroupname	back to summary
public void setGroupname(String groupname) Set the group name of this group, which must be unique within the scope of a `UserDatabase`. Parameters groupname:String The new group name

public void setGroupname(String groupname)

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

Parameters