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

Field Summary

Modifier and Type	Field and Description
private volatile boolean	connectionSuccess Last connection attempt.
protected final ConcurrentHashMap<String, Group>	createdGroups
protected final ConcurrentHashMap<String, Role>	createdRoles
protected final ConcurrentHashMap<String, User>	createdUsers
protected final DataSource	dataSource DataSource to use.
protected String	dataSourceName The name of the JNDI JDBC DataSource
private final ReentrantReadWriteLock	dbLock
private final Lock	dbReadLock
private final Lock	dbWriteLock
protected String	groupNameCol The column in the user group table that names a group
protected String	groupRoleTable The table that holds the relation between groups and roles
private final ReentrantReadWriteLock	groupsLock
private final Lock	groupsReadLock
private final Lock	groupsWriteLock
protected String	groupTable The table that holds user data.
protected final String	id The unique global identifier of this user database.
private static final Log	log
protected final ConcurrentHashMap<String, Group>	modifiedGroups
protected final ConcurrentHashMap<String, Role>	modifiedRoles
protected final ConcurrentHashMap<String, User>	modifiedUsers
private String	preparedAllGroups The generated string for the all groups PreparedStatement
private String	preparedAllRoles The generated string for the all roles PreparedStatement
private String	preparedAllUsers The generated string for the all users PreparedStatement
private String	preparedGroup The generated string for the group PreparedStatement
private String	preparedGroupRoles The generated string for the groups PreparedStatement
private String	preparedRole The generated string for the role PreparedStatement
private String	preparedUser The generated string for the user PreparedStatement
private String	preparedUserGroups The generated string for the groups PreparedStatement
private String	preparedUserRoles The generated string for the roles PreparedStatement
protected boolean	readonly A flag, indicating if the user database is read only.
protected final ConcurrentHashMap<String, Group>	removedGroups
protected final ConcurrentHashMap<String, Role>	removedRoles
protected final ConcurrentHashMap<String, User>	removedUsers
protected String	roleAndGroupDescriptionCol The column in the role and group tables for the description
protected String	roleNameCol The column in the user role table that names a role
private final ReentrantReadWriteLock	rolesLock
private final Lock	rolesReadLock
private final Lock	rolesWriteLock
protected String	roleTable The table that holds user data.
private static final StringManager	sm
protected String	userCredCol The column in the user table that holds the user's credentials
protected String	userFullNameCol The column in the user table that holds the user's full name
protected String	userGroupTable The table that holds the relation between users and groups
protected String	userNameCol The column in the user table that holds the user's name
protected String	userRoleTable The table that holds the relation between users and roles
private final ReentrantReadWriteLock	usersLock
private final Lock	usersReadLock
private final Lock	usersWriteLock
protected String	userTable The table that holds user data.

Constructor Summary

Access	Constructor and Description
public	DataSourceUserDatabase(DataSource dataSource, String id)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.apache.catalina.UserDatabase.close. Finalize access to this user database.
protected void	closeConnection(Connection The connection to be closed dbConnection) Close the specified database connection.
public Group	createGroup(String The group name of the new group (must be unique) groupname, String The description of this group description) Implements org.apache.catalina.UserDatabase.createGroup. Create and return a new `Group` defined in this user database.
public Role	createRole(String The role name of the new role (must be unique) rolename, String The description of this role description) Implements org.apache.catalina.UserDatabase.createRole. Create and return a new `Role` defined in this user database.
public User	createUser(String The logon username of the new user (must be unique) username, String The logon password of the new user password, String The full name of the new user fullName) Implements org.apache.catalina.UserDatabase.createUser. Create and return a new `User` defined in this user database.
public Group	findGroup(String Name of the group to return groupname) Implements org.apache.catalina.UserDatabase.findGroup.
public Group	findGroupInternal(Connection dbConnection, String groupName)
public Role	findRole(String Name of the role to return rolename) Implements org.apache.catalina.UserDatabase.findRole.
public Role	findRoleInternal(Connection dbConnection, String roleName)
public User	findUser(String Name of the user to return username) Implements org.apache.catalina.UserDatabase.findUser.
public User	findUserInternal(Connection dbConnection, String userName)
public String	Returns: the name of the JNDI JDBC DataSource. getDataSourceName()
public String	Returns: the groupNameCol getGroupNameCol()
public String	Returns: the groupRoleTable getGroupRoleTable()
public Iterator<Group>	getGroups() Implements org.apache.catalina.UserDatabase.getGroups.
public String	Returns: the groupTable getGroupTable()
public String	getId() Implements org.apache.catalina.UserDatabase.getId.
public boolean	Returns: the readonly getReadonly()
public String	Returns: the roleAndGroupDescriptionCol getRoleAndGroupDescriptionCol()
public String	Returns: the column in the user role table that names a role. getRoleNameCol()
public Iterator<Role>	getRoles() Implements org.apache.catalina.UserDatabase.getRoles.
public String	Returns: the roleTable getRoleTable()
public String	Returns: the column in the user table that holds the user's credentials. getUserCredCol()
public String	Returns: the userFullNameCol getUserFullNameCol()
public String	Returns: the userGroupTable getUserGroupTable()
public String	Returns: the column in the user table that holds the user's name. getUserNameCol()
public String	Returns: the table that holds the relation between user's and roles. getUserRoleTable()
public Iterator<User>	getUsers() Implements org.apache.catalina.UserDatabase.getUsers.
public String	Returns: the table that holds user data.. getUserTable()
public boolean	isAvailable() Overrides default org.apache.catalina.UserDatabase.isAvailable. Is the database available.
protected boolean	Returns: true when groups are used isGroupStoreDefined() Only use groups if the tables are fully defined.
protected boolean	Returns: true when roles are used isRoleStoreDefined() Only use roles if the tables are fully defined.
public void	modifiedGroup(Group The group that has been modified group) Overrides default org.apache.catalina.UserDatabase.modifiedGroup. Signal the specified `Group` from this user database has been modified.
public void	modifiedRole(Role The role that has been modified role) Overrides default org.apache.catalina.UserDatabase.modifiedRole. Signal the specified `Role` from this user database has been modified.
public void	modifiedUser(User The user that has been modified user) Overrides default org.apache.catalina.UserDatabase.modifiedUser. Signal the specified `User` from this user database has been modified.
public void	open() Implements org.apache.catalina.UserDatabase.open. Initialize access to this user database.
protected Connection	Returns: Connection to the database openConnection() Open the specified database connection.
public void	removeGroup(Group The group to be removed group) Implements org.apache.catalina.UserDatabase.removeGroup. Remove the specified `Group` from this user database.
public void	removeRole(Role The role to be removed role) Implements org.apache.catalina.UserDatabase.removeRole. Remove the specified `Role` from this user database.
public void	removeUser(User The user to be removed user) Implements org.apache.catalina.UserDatabase.removeUser. Remove the specified `User` from this user database.
public void	save() Implements org.apache.catalina.UserDatabase.save. Save any updated information to the persistent storage location for this user database.
protected void	saveInternal(Connection dbConnection)
public void	setDataSourceName(String the name of the JNDI JDBC DataSource dataSourceName) Set the name of the JNDI JDBC DataSource.
public void	setGroupNameCol(String the groupNameCol to set groupNameCol)
public void	setGroupRoleTable(String the groupRoleTable to set groupRoleTable)
public void	setGroupTable(String the groupTable to set groupTable)
public void	setReadonly(boolean the readonly to set readonly)
public void	setRoleAndGroupDescriptionCol(String the roleAndGroupDescriptionCol to set roleAndGroupDescriptionCol)
public void	setRoleNameCol(String The column name roleNameCol) Set the column in the user role table that names a role.
public void	setRoleTable(String the roleTable to set roleTable)
public void	setUserCredCol(String The column name userCredCol) Set the column in the user table that holds the user's credentials.
public void	setUserFullNameCol(String the userFullNameCol to set userFullNameCol)
public void	setUserGroupTable(String the userGroupTable to set userGroupTable)
public void	setUserNameCol(String The column name userNameCol) Set the column in the user table that holds the user's name.
public void	setUserRoleTable(String The table name userRoleTable) Set the table that holds the relation between user's and roles.
public void	setUserTable(String The table name userTable) Set the table that holds user data.

Inherited from org.apache.catalina.users.SparseUserDatabase:: isSparse

Field Detail

connectionSuccess	back to summary
private volatile boolean connectionSuccess Last connection attempt.

createdGroups	back to summary
protected final ConcurrentHashMap<String, Group> createdGroups

createdRoles	back to summary
protected final ConcurrentHashMap<String, Role> createdRoles

createdUsers	back to summary
protected final ConcurrentHashMap<String, User> createdUsers

dataSource	back to summary
protected final DataSource dataSource DataSource to use.

dataSourceName	back to summary
protected String dataSourceName The name of the JNDI JDBC DataSource

dbLock	back to summary
private final ReentrantReadWriteLock dbLock

dbReadLock	back to summary
private final Lock dbReadLock

dbWriteLock	back to summary
private final Lock dbWriteLock

groupNameCol	back to summary
protected String groupNameCol The column in the user group table that names a group

groupRoleTable	back to summary
protected String groupRoleTable The table that holds the relation between groups and roles

groupsLock	back to summary
private final ReentrantReadWriteLock groupsLock

groupsReadLock	back to summary
private final Lock groupsReadLock

groupsWriteLock	back to summary
private final Lock groupsWriteLock

groupTable	back to summary
protected String groupTable The table that holds user data.

id	back to summary
protected final String id The unique global identifier of this user database.

log	back to summary
private static final Log log

modifiedGroups	back to summary
protected final ConcurrentHashMap<String, Group> modifiedGroups

modifiedRoles	back to summary
protected final ConcurrentHashMap<String, Role> modifiedRoles

modifiedUsers	back to summary
protected final ConcurrentHashMap<String, User> modifiedUsers

preparedAllGroups	back to summary
private String preparedAllGroups The generated string for the all groups PreparedStatement

preparedAllRoles	back to summary
private String preparedAllRoles The generated string for the all roles PreparedStatement

preparedAllUsers	back to summary
private String preparedAllUsers The generated string for the all users PreparedStatement

preparedGroup	back to summary
private String preparedGroup The generated string for the group PreparedStatement

preparedGroupRoles	back to summary
private String preparedGroupRoles The generated string for the groups PreparedStatement

preparedRole	back to summary
private String preparedRole The generated string for the role PreparedStatement

preparedUser	back to summary
private String preparedUser The generated string for the user PreparedStatement

preparedUserGroups	back to summary
private String preparedUserGroups The generated string for the groups PreparedStatement

preparedUserRoles	back to summary
private String preparedUserRoles The generated string for the roles PreparedStatement

readonly	back to summary
protected boolean readonly A flag, indicating if the user database is read only.

removedGroups	back to summary
protected final ConcurrentHashMap<String, Group> removedGroups

removedRoles	back to summary
protected final ConcurrentHashMap<String, Role> removedRoles

removedUsers	back to summary
protected final ConcurrentHashMap<String, User> removedUsers

roleAndGroupDescriptionCol	back to summary
protected String roleAndGroupDescriptionCol The column in the role and group tables for the description

roleNameCol	back to summary
protected String roleNameCol The column in the user role table that names a role

rolesLock	back to summary
private final ReentrantReadWriteLock rolesLock

rolesReadLock	back to summary
private final Lock rolesReadLock

rolesWriteLock	back to summary
private final Lock rolesWriteLock

roleTable	back to summary
protected String roleTable The table that holds user data.

sm	back to summary
private static final StringManager sm

userCredCol	back to summary
protected String userCredCol The column in the user table that holds the user's credentials

userFullNameCol	back to summary
protected String userFullNameCol The column in the user table that holds the user's full name

userGroupTable	back to summary
protected String userGroupTable The table that holds the relation between users and groups

userNameCol	back to summary
protected String userNameCol The column in the user table that holds the user's name

userRoleTable	back to summary
protected String userRoleTable The table that holds the relation between users and roles

usersLock	back to summary
private final ReentrantReadWriteLock usersLock

usersReadLock	back to summary
private final Lock usersReadLock

usersWriteLock	back to summary
private final Lock usersWriteLock

userTable	back to summary
protected String userTable The table that holds user data.

Constructor Detail

DataSourceUserDatabase	back to summary
public DataSourceUserDatabase(DataSource dataSource, String id)

Method Detail

back to summary

public void close() throws Exception

Implements org.apache.catalina.UserDatabase.close.

Doc from org.apache.catalina.UserDatabase.close.

Finalize access to this user database.

Annotations

@Override

Exceptions

Exception:: if any exception is thrown during closing

closeConnection

back to summary

protected void closeConnection(Connection dbConnection)

Close the specified database connection.

Parameters

dbConnection:Connection: The connection to be closed

createGroup back to summary

public Group createGroup(String groupname, String description)

Implements org.apache.catalina.UserDatabase.createGroup.

Doc from org.apache.catalina.UserDatabase.createGroup.

Create and return a new Group defined in this user database.

Parameters

groupname:String: The group name of the new group (must be unique)
description:String: The description of this group

Returns:Group

The new group

Annotations

@Override

createRole back to summary

public Role createRole(String rolename, String description)

Implements org.apache.catalina.UserDatabase.createRole.

Doc from org.apache.catalina.UserDatabase.createRole.

Create and return a new Role defined in this user database.

Parameters

rolename:String: The role name of the new role (must be unique)
description:String: The description of this role

Returns:Role

The new role

Annotations

@Override

createUser back to summary

public User createUser(String username, String password, String fullName)

Implements org.apache.catalina.UserDatabase.createUser.

Doc from org.apache.catalina.UserDatabase.createUser.

Create and return a new User defined in this user database.

Parameters

username:String: The logon username of the new user (must be unique)
password:String: The logon password of the new user
fullName:String: The full name of the new user

Returns:User

The new user

Annotations

@Override

findGroup back to summary

public Group findGroup(String groupname)

Implements org.apache.catalina.UserDatabase.findGroup.

Parameters

groupname:String

Doc from org.apache.catalina.UserDatabase.findGroup.

Name of the group to return

Returns:Group

Doc from org.apache.catalina.UserDatabase.findGroup.

the Group with the specified group name, if any; otherwise return null.

Annotations

@Override

findGroupInternal	back to summary
public Group findGroupInternal(Connection dbConnection, String groupName)

findRole back to summary

public Role findRole(String rolename)

Implements org.apache.catalina.UserDatabase.findRole.

Parameters

rolename:String

Doc from org.apache.catalina.UserDatabase.findRole.

Name of the role to return

Returns:Role

Doc from org.apache.catalina.UserDatabase.findRole.

the Role with the specified role name, if any; otherwise return null.

Annotations

@Override

findRoleInternal	back to summary
public Role findRoleInternal(Connection dbConnection, String roleName)

findUser back to summary

public User findUser(String username)

Implements org.apache.catalina.UserDatabase.findUser.

Parameters

username:String

Doc from org.apache.catalina.UserDatabase.findUser.

Name of the user to return

Returns:User

Doc from org.apache.catalina.UserDatabase.findUser.

the User with the specified user name, if any; otherwise return null.

Annotations

@Override

findUserInternal	back to summary
public User findUserInternal(Connection dbConnection, String userName)

getDataSourceName	back to summary
public String getDataSourceName() Returns:String the name of the JNDI JDBC DataSource.

getGroupNameCol	back to summary
public String getGroupNameCol() Returns:String the groupNameCol

getGroupRoleTable	back to summary
public String getGroupRoleTable() Returns:String the groupRoleTable

getGroups back to summary

public Iterator<Group> getGroups()

Implements org.apache.catalina.UserDatabase.getGroups.

Returns:Iterator<Group>

Doc from org.apache.catalina.UserDatabase.getGroups.

the set of Groups defined in this user database.

Annotations

@Override

getGroupTable	back to summary
public String getGroupTable() Returns:String the groupTable

getId

back to summary

public String getId()

Implements org.apache.catalina.UserDatabase.getId.

Returns:String

Doc from org.apache.catalina.UserDatabase.getId.

the unique global identifier of this user database.

Annotations

@Override

getReadonly	back to summary
public boolean getReadonly() Returns:boolean the readonly

getRoleAndGroupDescriptionCol	back to summary
public String getRoleAndGroupDescriptionCol() Returns:String the roleAndGroupDescriptionCol

getRoleNameCol	back to summary
public String getRoleNameCol() Returns:String the column in the user role table that names a role.

getRoles back to summary

public Iterator<Role> getRoles()

Implements org.apache.catalina.UserDatabase.getRoles.

Returns:Iterator<Role>

Doc from org.apache.catalina.UserDatabase.getRoles.

the set of Roles defined in this user database.

Annotations

@Override

getRoleTable	back to summary
public String getRoleTable() Returns:String the roleTable

getUserCredCol	back to summary
public String getUserCredCol() Returns:String the column in the user table that holds the user's credentials.

getUserFullNameCol	back to summary
public String getUserFullNameCol() Returns:String the userFullNameCol

getUserGroupTable	back to summary
public String getUserGroupTable() Returns:String the userGroupTable

getUserNameCol	back to summary
public String getUserNameCol() Returns:String the column in the user table that holds the user's name.

getUserRoleTable	back to summary
public String getUserRoleTable() Returns:String the table that holds the relation between user's and roles.

getUsers back to summary

public Iterator<User> getUsers()

Implements org.apache.catalina.UserDatabase.getUsers.

Returns:Iterator<User>

Doc from org.apache.catalina.UserDatabase.getUsers.

the set of Users defined in this user database.

Annotations

@Override

getUserTable	back to summary
public String getUserTable() Returns:String the table that holds user data..

isAvailable

back to summary

public boolean isAvailable()

Overrides default org.apache.catalina.UserDatabase.isAvailable.

Doc from org.apache.catalina.UserDatabase.isAvailable.

Is the database available.

Returns:boolean

true

Annotations

@Override

isGroupStoreDefined

back to summary

protected boolean isGroupStoreDefined()

Only use groups if the tables are fully defined.

Returns:boolean: true when groups are used

isRoleStoreDefined

back to summary

protected boolean isRoleStoreDefined()

Only use roles if the tables are fully defined.

Returns:boolean: true when roles are used

modifiedGroup back to summary

public void modifiedGroup(Group group)

Overrides default org.apache.catalina.UserDatabase.modifiedGroup.

Doc from org.apache.catalina.UserDatabase.modifiedGroup.

Signal the specified Group from this user database has been modified.

Parameters

group:Group: The group that has been modified

Annotations

@Override

modifiedRole back to summary

public void modifiedRole(Role role)

Overrides default org.apache.catalina.UserDatabase.modifiedRole.

Doc from org.apache.catalina.UserDatabase.modifiedRole.

Signal the specified Role from this user database has been modified.

Parameters

role:Role: The role that has been modified

Annotations

@Override

modifiedUser back to summary

public void modifiedUser(User user)

Overrides default org.apache.catalina.UserDatabase.modifiedUser.

Doc from org.apache.catalina.UserDatabase.modifiedUser.

Signal the specified User from this user database has been modified.

Parameters

user:User: The user that has been modified

Annotations

@Override

open

back to summary

public void open() throws Exception

Implements org.apache.catalina.UserDatabase.open.

Doc from org.apache.catalina.UserDatabase.open.

Initialize access to this user database.

Annotations

@Override

Exceptions

Exception:: if any exception is thrown during opening

openConnection

back to summary

protected Connection openConnection()

Open the specified database connection.

Returns:Connection: Connection to the database

removeGroup back to summary

public void removeGroup(Group group)

Implements org.apache.catalina.UserDatabase.removeGroup.

Doc from org.apache.catalina.UserDatabase.removeGroup.

Remove the specified Group from this user database.

Parameters

group:Group: The group to be removed

Annotations

@Override

removeRole back to summary

public void removeRole(Role role)

Implements org.apache.catalina.UserDatabase.removeRole.

Doc from org.apache.catalina.UserDatabase.removeRole.

Remove the specified Role from this user database.

Parameters

role:Role: The role to be removed

Annotations

@Override

removeUser back to summary

public void removeUser(User user)

Implements org.apache.catalina.UserDatabase.removeUser.

Doc from org.apache.catalina.UserDatabase.removeUser.

Remove the specified User from this user database.

Parameters

user:User: The user to be removed

Annotations

@Override

save

back to summary

public void save() throws Exception

Implements org.apache.catalina.UserDatabase.save.

Doc from org.apache.catalina.UserDatabase.save.

Save any updated information to the persistent storage location for this user database.

Annotations

@Override

Exceptions

Exception:: if any exception is thrown during saving

saveInternal	back to summary
protected void saveInternal(Connection dbConnection)

setDataSourceName

back to summary

public void setDataSourceName(String dataSourceName)

Set the name of the JNDI JDBC DataSource.

Parameters

dataSourceName:String: the name of the JNDI JDBC DataSource

setGroupNameCol	back to summary
public void setGroupNameCol(String groupNameCol) Parameters groupNameCol:String the groupNameCol to set

setGroupRoleTable	back to summary
public void setGroupRoleTable(String groupRoleTable) Parameters groupRoleTable:String the groupRoleTable to set

setGroupTable	back to summary
public void setGroupTable(String groupTable) Parameters groupTable:String the groupTable to set

setReadonly	back to summary
public void setReadonly(boolean readonly) Parameters readonly:boolean the readonly to set

setRoleAndGroupDescriptionCol	back to summary
public void setRoleAndGroupDescriptionCol(String roleAndGroupDescriptionCol) Parameters roleAndGroupDescriptionCol:String the roleAndGroupDescriptionCol to set

setRoleNameCol

back to summary

public void setRoleNameCol(String roleNameCol)

Set the column in the user role table that names a role.

Parameters

roleNameCol:String: The column name

setRoleTable	back to summary
public void setRoleTable(String roleTable) Parameters roleTable:String the roleTable to set

setUserCredCol

back to summary

public void setUserCredCol(String userCredCol)

Set the column in the user table that holds the user's credentials.

Parameters

userCredCol:String: The column name

setUserFullNameCol	back to summary
public void setUserFullNameCol(String userFullNameCol) Parameters userFullNameCol:String the userFullNameCol to set

setUserGroupTable	back to summary
public void setUserGroupTable(String userGroupTable) Parameters userGroupTable:String the userGroupTable to set

setUserNameCol

back to summary

public void setUserNameCol(String userNameCol)

Set the column in the user table that holds the user's name.

Parameters

userNameCol:String: The column name

setUserRoleTable

back to summary

public void setUserRoleTable(String userRoleTable)

Set the table that holds the relation between user's and roles.

Parameters

userRoleTable:String: The table name

setUserTable

back to summary

public void setUserTable(String userTable)

Set the table that holds user data.

Parameters

userTable:String: The table name

public Class DataSourceUserDatabase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail