DataSourceUserDatabaseFactory (Apache Tomcat 11.0.24 API Documentation)
Description: declaration: package: org.apache.catalina.users, class: DataSourceUserDatabaseFactory

# Class DataSourceUserDatabaseFactory

java.lang.Object
org.apache.catalina.users.DataSourceUserDatabaseFactory

All Implemented Interfaces:
  `ObjectFactory`

public class DataSourceUserDatabaseFactory extends Object implements ObjectFactory

JNDI object creation factory for `DataSourceUserDatabase` instances. This makes it convenient to configure a user database in the global JNDI resources associated with this Catalina instance, and then link to that resource for web applications that administer the contents of the user database.

The `DataSourceUserDatabase` instance is configured based on the following parameter values:

- dataSourceName - JNDI name of the DataSource, which must be located in the same Context environment as the UserDatabase

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DataSourceUserDatabaseFactory()`
  Default constructor.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment)`
  Create and return a new `DataSourceUserDatabase` instance that has been configured according to the properties of the specified `Reference`.

  ### Methods inherited from class Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### DataSourceUserDatabaseFactory

    public DataSourceUserDatabaseFactory()
    Default constructor.

- ## Method Details

  - ### getObjectInstance

    public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment) throws Exception

    Create and return a new `DataSourceUserDatabase` instance that has been configured according to the properties of the specified `Reference`. If the instance cannot be created, return `null` instead.

    Specified by:
      `getObjectInstance` in interface `ObjectFactory`
    Parameters:
      `obj` - The possibly null object containing location or reference information that can be used in creating an object
      `name` - The name of this object relative to `nameCtx`
      `nameCtx` - The context relative to which the `name` parameter is specified, or `null` if `name` is relative to the default initial context
      `environment` - The possibly null environment that is used in creating this object
    Throws:
      `Exception`