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

Modifier and Type	Field and Description
protected String	fullName The full name of this user.
protected String	password The logon password of this user.
protected String	username The logon username of this user.

Access	Constructor and Description
public	AbstractUser()

Method Summary

Modifier and Type	Method and Description
public abstract void	addGroup(Group The new group group) Redeclares org.apache.catalina.User.addGroup. Add a new `Group` to those this user belongs to.
public abstract void	addRole(Role The new role role) Redeclares org.apache.catalina.User.addRole. Add a new `Role` to those assigned specifically to this user.
public String	getFullName() Implements org.apache.catalina.User.getFullName. Return the full name of this user.
public abstract Iterator<Group>	getGroups() Redeclares org.apache.catalina.User.getGroups. Return the set of `Group`s to which this user belongs.
public String	getName() Implements java.security.Principal.getName. Make the principal name the same as the group name.
public String	getPassword() Implements org.apache.catalina.User.getPassword. Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as `{md5}xxxxx`.
public abstract Iterator<Role>	getRoles() Redeclares org.apache.catalina.User.getRoles. Return the set of `Role`s assigned specifically to this user.
public String	getUsername() Implements org.apache.catalina.User.getUsername. Return the logon username of this user, which must be unique within the scope of a `org.apache.catalina.UserDatabase`.
public abstract boolean	isInGroup(Group The group to check group) Redeclares org.apache.catalina.User.isInGroup. Is this user in the specified `Group`?
public abstract boolean	isInRole(Role The role to check role) Redeclares org.apache.catalina.User.isInRole. Is this user specifically assigned the specified `Role`?
public abstract void	removeGroup(Group The old group group) Redeclares org.apache.catalina.User.removeGroup. Remove a `Group` from those this user belongs to.
public abstract void	removeGroups() Redeclares org.apache.catalina.User.removeGroups. Remove all `Group`s from those this user belongs to.
public abstract void	removeRole(Role The old role role) Redeclares org.apache.catalina.User.removeRole. Remove a `Role` from those assigned to this user.
public abstract void	removeRoles() Redeclares org.apache.catalina.User.removeRoles. Remove all `Role`s from those assigned to this user.
public void	setFullName(String The new full name fullName) Implements org.apache.catalina.User.setFullName. Set the full name of this user.
public void	setPassword(String The new logon password password) Implements org.apache.catalina.User.setPassword. Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as `{md5}xxxxx`.
public void	setUsername(String The new logon username username) Implements org.apache.catalina.User.setUsername. Set the logon username of this user, which must be unique within the scope of a `org.apache.catalina.UserDatabase`.

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

fullName	back to summary
protected String fullName The full name of this user.

password	back to summary
protected String password The logon password of this user.

username	back to summary
protected String username The logon username of this user.

AbstractUser	back to summary
public AbstractUser()

Method Detail

addGroup back to summary

addGroup	back to summary
public abstract void addGroup(Group group) Redeclares org.apache.catalina.User.addGroup. Add a new `Group` to those this user belongs to. Parameters group:Group The new group Annotations @Override

public abstract void addGroup(Group group)

Redeclares org.apache.catalina.User.addGroup.

Add a new Group to those this user belongs to.

Parameters

group:Group: The new group

Annotations

@Override

addRole back to summary

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

public abstract void addRole(Role role)

Redeclares org.apache.catalina.User.addRole.

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

Parameters

role:Role: The new role

Annotations

@Override

getFullName	back to summary
public String getFullName() Implements org.apache.catalina.User.getFullName. Return the full name of this user. Returns:String Doc from org.apache.catalina.User.getFullName. the full name of this user. Annotations @Override

getFullName

back to summary

public String getFullName()

Implements org.apache.catalina.User.getFullName.

Return the full name of this user.

Returns:String

Doc from org.apache.catalina.User.getFullName.

the full name of this user.

Annotations

@Override

getGroups back to summary

getGroups	back to summary
public abstract Iterator<Group> getGroups() Redeclares org.apache.catalina.User.getGroups. Return the set of `Group`s to which this user belongs. Returns:Iterator<Group> Doc from org.apache.catalina.User.getGroups. the set of `Group`s to which this user belongs. Annotations @Override

public abstract Iterator<Group> getGroups()

Redeclares org.apache.catalina.User.getGroups.

Return the set of Groups to which this user belongs.

Returns:Iterator<Group>

Doc from org.apache.catalina.User.getGroups.

the set of Groups to which this user belongs.

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

getPassword back to summary

getPassword	back to summary
public String getPassword() Implements org.apache.catalina.User.getPassword. Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as `{md5}xxxxx`. Returns:String Doc from org.apache.catalina.User.getPassword. the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as `{md5}xxxxx`. Annotations @Override

public String getPassword()

Implements org.apache.catalina.User.getPassword.

Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.

Returns:String

Doc from org.apache.catalina.User.getPassword.

the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.

Annotations

@Override

getRoles back to summary

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

public abstract Iterator<Role> getRoles()

Redeclares org.apache.catalina.User.getRoles.

Return the set of Roles assigned specifically to this user.

Returns:Iterator<Role>

Doc from org.apache.catalina.User.getRoles.

the set of Roles assigned specifically to this user.

Annotations

@Override

getUsername back to summary

getUsername	back to summary
public String getUsername() Implements org.apache.catalina.User.getUsername. Return the logon username of this user, which must be unique within the scope of a `org.apache.catalina.UserDatabase`. Returns:String Doc from org.apache.catalina.User.getUsername. the logon username of this user, which must be unique within the scope of a `UserDatabase`. Annotations @Override

public String getUsername()

Implements org.apache.catalina.User.getUsername.

Return the logon username of this user, which must be unique within the scope of a org.apache.catalina.UserDatabase.

Returns:String

Doc from org.apache.catalina.User.getUsername.

the logon username of this user, which must be unique within the scope of a UserDatabase.

Annotations

@Override

isInGroup back to summary

isInGroup	back to summary
public abstract boolean isInGroup(Group group) Redeclares org.apache.catalina.User.isInGroup. Is this user in the specified `Group`? Parameters group:Group The group to check Returns:boolean Doc from org.apache.catalina.User.isInGroup. `true` if the user is in the specified group Annotations @Override

public abstract boolean isInGroup(Group group)

Redeclares org.apache.catalina.User.isInGroup.

Is this user in the specified Group?

Parameters

group:Group: The group to check

Returns:boolean

Doc from org.apache.catalina.User.isInGroup.

true if the user is in the specified group

Annotations

@Override

isInRole back to summary

isInRole	back to summary
public abstract boolean isInRole(Role role) Redeclares org.apache.catalina.User.isInRole. Is this user specifically assigned the specified `Role`? This method does NOT check for roles inherited based on `Group` membership. Parameters role:Role The role to check Returns:boolean Doc from org.apache.catalina.User.isInRole. `true` if the user has the specified role Annotations @Override

public abstract boolean isInRole(Role role)

Redeclares org.apache.catalina.User.isInRole.

Is this user specifically assigned the specified Role? This method does NOT check for roles inherited based on Group membership.

Parameters

role:Role: The role to check

Returns:boolean

Doc from org.apache.catalina.User.isInRole.

true if the user has the specified role

Annotations

@Override

removeGroup back to summary

removeGroup	back to summary
public abstract void removeGroup(Group group) Redeclares org.apache.catalina.User.removeGroup. Remove a `Group` from those this user belongs to. Parameters group:Group The old group Annotations @Override

public abstract void removeGroup(Group group)

Redeclares org.apache.catalina.User.removeGroup.

Remove a Group from those this user belongs to.

Parameters

group:Group: The old group

Annotations

@Override

removeGroups back to summary

removeGroups	back to summary
public abstract void removeGroups() Redeclares org.apache.catalina.User.removeGroups. Remove all `Group`s from those this user belongs to. Annotations @Override

public abstract void removeGroups()

Redeclares org.apache.catalina.User.removeGroups.

Remove all Groups from those this user belongs to.

Annotations

@Override

removeRole back to summary

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

public abstract void removeRole(Role role)

Redeclares org.apache.catalina.User.removeRole.

Remove a Role from those assigned to this user.

Parameters

role:Role: The old role

Annotations

@Override

removeRoles back to summary

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

public abstract void removeRoles()

Redeclares org.apache.catalina.User.removeRoles.

Remove all Roles from those assigned to this user.

Annotations

@Override

setFullName	back to summary
public void setFullName(String fullName) Implements org.apache.catalina.User.setFullName. Set the full name of this user. Parameters fullName:String The new full name Annotations @Override

setFullName

back to summary

public void setFullName(String fullName)

Implements org.apache.catalina.User.setFullName.

Set the full name of this user.

Parameters

fullName:String: The new full name

Annotations

@Override

setPassword back to summary

setPassword	back to summary
public void setPassword(String password) Implements org.apache.catalina.User.setPassword. Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as `{md5}xxxxx`. Parameters password:String The new logon password Annotations @Override

public void setPassword(String password)

Implements org.apache.catalina.User.setPassword.

Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.

Parameters

password:String: The new logon password

Annotations

@Override

setUsername back to summary

setUsername	back to summary
public void setUsername(String username) Implements org.apache.catalina.User.setUsername. Set the logon username of this user, which must be unique within the scope of a `org.apache.catalina.UserDatabase`. Parameters username:String The new logon username Annotations @Override

public void setUsername(String username)

Implements org.apache.catalina.User.setUsername.

Set the logon username of this user, which must be unique within the scope of a org.apache.catalina.UserDatabase.

Parameters

username:String: The new logon username

Annotations

@Override

public abstract Class AbstractUser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail