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

Modifier and Type	Field and Description
protected final UD	database The `UserDatabase` that owns this group.
protected final CopyOnWriteArrayList<Role>	roles The set of `Role`s associated with this group.

Access	Constructor and Description
pack-priv	GenericGroup(UD The `UserDatabase` that owns this group database, String Group name of this group groupname, String Description of this group description, List<Role> The roles of this group roles) Package-private constructor used by the factory method in `UserDatabase`.

Method Summary

Modifier and Type	Method and Description
public void	addRole(Role The new role role) Implements abstract org.apache.catalina.users.AbstractGroup.addRole. Implements org.apache.catalina.Group.addRole. Add a new `Role` to those assigned specifically to this group.
public boolean	equals(Object `Principal` to compare with. obj) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Compares this `Principal` to the specified object.
public Iterator<Role>	getRoles() Implements abstract org.apache.catalina.users.AbstractGroup.getRoles. Implements org.apache.catalina.Group.getRoles. Return the set of `Role`s assigned specifically to this group.
public UserDatabase	getUserDatabase() Implements abstract org.apache.catalina.users.AbstractGroup.getUserDatabase. Implements org.apache.catalina.Group.getUserDatabase. Return the `UserDatabase` within which this Group is defined.
public Iterator<User>	getUsers() Implements abstract org.apache.catalina.users.AbstractGroup.getUsers. Implements org.apache.catalina.Group.getUsers. Return the set of `org.apache.catalina.User`s that are members of this group.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Returns a hashcode for this `Principal`.
public boolean	isInRole(Role The role to check role) Implements abstract org.apache.catalina.users.AbstractGroup.isInRole. Implements org.apache.catalina.Group.isInRole. Is this group specifically assigned the specified `Role`?
public void	removeRole(Role The old role role) Implements abstract org.apache.catalina.users.AbstractGroup.removeRole. Implements org.apache.catalina.Group.removeRole. Remove a `Role` from those assigned to this group.
public void	removeRoles() Implements abstract org.apache.catalina.users.AbstractGroup.removeRoles. Implements org.apache.catalina.Group.removeRoles. Remove all `Role`s from those assigned to this group.

Inherited from org.apache.catalina.users.AbstractGroup:: getDescription getGroupname getName setDescription setGroupname

database	back to summary
protected final UD database The `UserDatabase` that owns this group.

roles	back to summary
protected final CopyOnWriteArrayList<Role> roles The set of `Role`s associated with this group.

GenericGroup	back to summary
pack-priv GenericGroup(UD database, String groupname, String description, List<Role> roles) Package-private constructor used by the factory method in `UserDatabase`. Parameters database:UD The `UserDatabase` that owns this group groupname:String Group name of this group description:String Description of this group roles:List<Role> The roles of this group

Method Detail

addRole back to summary

addRole	back to summary
public void addRole(Role role) Implements abstract org.apache.catalina.users.AbstractGroup.addRole. Implements 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 void addRole(Role role)

Implements abstract org.apache.catalina.users.AbstractGroup.addRole.

Implements org.apache.catalina.Group.addRole.

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

Parameters

role:Role: The new role

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Doc from java.security.Principal.equals. Compares this `Principal` to the specified object. Returns `true` if the object passed in matches the `Principal` represented by the implementation of this interface. Parameters obj:Object `Principal` to compare with. Returns:boolean `true` if the `Principal` passed in is the same as that encapsulated by this `Principal`, and `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Doc from java.security.Principal.equals.

Compares this Principal to the specified object. Returns true if the object passed in matches the Principal represented by the implementation of this interface.

Parameters

obj:Object: Principal to compare with.

Returns:boolean

true if the Principal passed in is the same as that encapsulated by this Principal, and false otherwise.

Annotations

@Override

getRoles back to summary

getRoles	back to summary
public Iterator<Role> getRoles() Implements abstract org.apache.catalina.users.AbstractGroup.getRoles. Implements 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 Iterator<Role> getRoles()

Implements abstract org.apache.catalina.users.AbstractGroup.getRoles.

Implements 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 UserDatabase getUserDatabase() Implements abstract org.apache.catalina.users.AbstractGroup.getUserDatabase. Implements 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 UserDatabase getUserDatabase()

Implements abstract org.apache.catalina.users.AbstractGroup.getUserDatabase.

Implements 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 Iterator<User> getUsers() Implements abstract org.apache.catalina.users.AbstractGroup.getUsers. Implements org.apache.catalina.Group.getUsers. Return 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 Iterator<User> getUsers()

Implements abstract org.apache.catalina.users.AbstractGroup.getUsers.

Implements org.apache.catalina.Group.getUsers.

Return 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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Doc from java.security.Principal.hashCode. Returns a hashcode for this `Principal`. Returns:int a hashcode for this `Principal` Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Doc from java.security.Principal.hashCode.

Returns a hashcode for this Principal.

Returns:int

a hashcode for this Principal

Annotations

@Override

isInRole back to summary

isInRole	back to summary
public boolean isInRole(Role role) Implements abstract org.apache.catalina.users.AbstractGroup.isInRole. Implements 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 boolean isInRole(Role role)

Implements abstract org.apache.catalina.users.AbstractGroup.isInRole.

Implements 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 void removeRole(Role role) Implements abstract org.apache.catalina.users.AbstractGroup.removeRole. Implements org.apache.catalina.Group.removeRole. Remove a `Role` from those assigned to this group. Parameters role:Role The old role Annotations @Override

public void removeRole(Role role)

Implements abstract org.apache.catalina.users.AbstractGroup.removeRole.

Implements 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 void removeRoles() Implements abstract org.apache.catalina.users.AbstractGroup.removeRoles. Implements org.apache.catalina.Group.removeRoles. Remove all `Role`s from those assigned to this group. Annotations @Override

public void removeRoles()

Implements abstract org.apache.catalina.users.AbstractGroup.removeRoles.

Implements org.apache.catalina.Group.removeRoles.

Remove all Roles from those assigned to this group.

Annotations

@Override

public Class GenericGroup<UD extends UserDatabase>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail