Tomcat 10.1.19 · org.apache.catalina.users.AbstractGroup

Modifier and Type	Field and Description
protected String	description The description of this group.
protected String	groupname The group name of this group.

Access	Constructor and Description
public	AbstractGroup()

Method Summary

Modifier and Type	Method and Description
public abstract void	addRole(Role The new role role) Redeclares org.apache.catalina.Group.addRole. Add a new `Role` to those assigned specifically to this group.
public String	getDescription() Implements org.apache.catalina.Group.getDescription. Return the description of this group.
public String	getGroupname() Implements org.apache.catalina.Group.getGroupname. Return the group name of this group, which must be unique within the scope of a `UserDatabase`.
public String	getName() Implements java.security.Principal.getName. Make the principal name the same as the group name.
public abstract Iterator<Role>	getRoles() Redeclares org.apache.catalina.Group.getRoles. Return the set of `Role`s assigned specifically to this group.
public abstract UserDatabase	getUserDatabase() Redeclares org.apache.catalina.Group.getUserDatabase. Return the `UserDatabase` within which this Group is defined.
public abstract Iterator<User>	getUsers() Redeclares org.apache.catalina.Group.getUsers. Return an Iterator over the set of `org.apache.catalina.User`s that are members of this group.
public abstract boolean	isInRole(Role The role to check role) Redeclares org.apache.catalina.Group.isInRole. Is this group specifically assigned the specified `Role`?
public abstract void	removeRole(Role The old role role) Redeclares org.apache.catalina.Group.removeRole. Remove a `Role` from those assigned to this group.
public abstract void	removeRoles() Redeclares org.apache.catalina.Group.removeRoles. Remove all `Role`s from those assigned to this group.
public void	setDescription(String The new description description) Implements org.apache.catalina.Group.setDescription. Set the description of this group.
public void	setGroupname(String The new group name groupname) Implements org.apache.catalina.Group.setGroupname. Set the group name of this group, which must be unique within the scope of a `UserDatabase`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

description	back to summary
protected String description The description of this group.

groupname	back to summary
protected String groupname The group name of this group.

AbstractGroup	back to summary
public AbstractGroup()

Method Detail

addRole back to summary

addRole	back to summary
public abstract void addRole(Role role) Redeclares org.apache.catalina.Group.addRole. Add a new `Role` to those assigned specifically to this group. Parameters role:Role The new role Annotations @Override

public abstract void addRole(Role role)

Redeclares org.apache.catalina.Group.addRole.

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

Parameters

role:Role: The new role

Annotations

@Override

getDescription	back to summary
public String getDescription() Implements org.apache.catalina.Group.getDescription. Return the description of this group. Returns:String Doc from org.apache.catalina.Group.getDescription. the description of this group. Annotations @Override

getDescription

back to summary

public String getDescription()

Implements org.apache.catalina.Group.getDescription.

Return the description of this group.

Returns:String

Doc from org.apache.catalina.Group.getDescription.

the description of this group.

Annotations

@Override

getGroupname back to summary

getGroupname	back to summary
public String getGroupname() Implements org.apache.catalina.Group.getGroupname. Return the group name of this group, which must be unique within the scope of a `UserDatabase`. Returns:String Doc from org.apache.catalina.Group.getGroupname. the group name of this group, which must be unique within the scope of a `UserDatabase`. Annotations @Override

public String getGroupname()

Implements org.apache.catalina.Group.getGroupname.

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

Returns:String

Doc from org.apache.catalina.Group.getGroupname.

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

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements java.security.Principal.getName. Make the principal name the same as the group name. Returns:String Doc from java.security.Principal.getName. the name of this `Principal`. Annotations @Override

public String getName()

Implements java.security.Principal.getName.

Make the principal name the same as the group name.

Returns:String

Doc from java.security.Principal.getName.

the name of this Principal.

Annotations

@Override

getRoles back to summary

getRoles	back to summary
public abstract Iterator<Role> getRoles() Redeclares org.apache.catalina.Group.getRoles. Return the set of `Role`s assigned specifically to this group. Returns:Iterator<Role> Doc from org.apache.catalina.Group.getRoles. the set of `Role`s assigned specifically to this group. Annotations @Override

public abstract Iterator<Role> getRoles()

Redeclares org.apache.catalina.Group.getRoles.

Return the set of Roles assigned specifically to this group.

Returns:Iterator<Role>

Doc from org.apache.catalina.Group.getRoles.

the set of Roles assigned specifically to this group.

Annotations

@Override

getUserDatabase back to summary

getUserDatabase	back to summary
public abstract UserDatabase getUserDatabase() Redeclares org.apache.catalina.Group.getUserDatabase. Return the `UserDatabase` within which this Group is defined. Returns:UserDatabase Doc from org.apache.catalina.Group.getUserDatabase. the `UserDatabase` within which this Group is defined. Annotations @Override

public abstract UserDatabase getUserDatabase()

Redeclares org.apache.catalina.Group.getUserDatabase.

Return the UserDatabase within which this Group is defined.

Returns:UserDatabase

Doc from org.apache.catalina.Group.getUserDatabase.

the UserDatabase within which this Group is defined.

Annotations

@Override

getUsers back to summary

getUsers	back to summary
public abstract Iterator<User> getUsers() Redeclares org.apache.catalina.Group.getUsers. Return an Iterator over the set of `org.apache.catalina.User`s that are members of this group. Returns:Iterator<User> Doc from org.apache.catalina.Group.getUsers. the set of `User`s that are members of this group. Annotations @Override

public abstract Iterator<User> getUsers()

Redeclares org.apache.catalina.Group.getUsers.

Return an Iterator over the set of org.apache.catalina.Users that are members of this group.

Returns:Iterator<User>

Doc from org.apache.catalina.Group.getUsers.

the set of Users that are members of this group.

Annotations

@Override

isInRole back to summary

isInRole	back to summary
public abstract boolean isInRole(Role role) Redeclares org.apache.catalina.Group.isInRole. Is this group specifically assigned the specified `Role`? Parameters role:Role The role to check Returns:boolean Doc from org.apache.catalina.Group.isInRole. `true` if the group is assigned to the specified role otherwise `false` Annotations @Override

public abstract boolean isInRole(Role role)

Redeclares org.apache.catalina.Group.isInRole.

Is this group specifically assigned the specified Role?

Parameters

role:Role: The role to check

Returns:boolean

Doc from org.apache.catalina.Group.isInRole.

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

Annotations

@Override

removeRole back to summary

removeRole	back to summary
public abstract void removeRole(Role role) Redeclares org.apache.catalina.Group.removeRole. Remove a `Role` from those assigned to this group. Parameters role:Role The old role Annotations @Override

public abstract void removeRole(Role role)

Redeclares org.apache.catalina.Group.removeRole.

Remove a Role from those assigned to this group.

Parameters

role:Role: The old role

Annotations

@Override

removeRoles back to summary

removeRoles	back to summary
public abstract void removeRoles() Redeclares org.apache.catalina.Group.removeRoles. Remove all `Role`s from those assigned to this group. Annotations @Override

public abstract void removeRoles()

Redeclares org.apache.catalina.Group.removeRoles.

Remove all Roles from those assigned to this group.

Annotations

@Override

setDescription	back to summary
public void setDescription(String description) Implements org.apache.catalina.Group.setDescription. Set the description of this group. Parameters description:String The new description Annotations @Override

setDescription

back to summary

public void setDescription(String description)

Implements org.apache.catalina.Group.setDescription.

Set the description of this group.

Parameters

description:String: The new description

Annotations

@Override

setGroupname back to summary

setGroupname	back to summary
public void setGroupname(String groupname) Implements org.apache.catalina.Group.setGroupname. Set the group name of this group, which must be unique within the scope of a `UserDatabase`. Parameters groupname:String The new group name Annotations @Override

public void setGroupname(String groupname)

Implements org.apache.catalina.Group.setGroupname.

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

Parameters

groupname:String: The new group name

Annotations

@Override

public abstract Class AbstractGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail