Copyright (c) 2003 Mike Martin (TJDO) and others. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

Contributors:

2003 Kelly Grizzle (TJDO)

2003 Erik Bengtson  - removed exist() operation

2003 Erik Bengtson  - refactored the persistent id generator System property

2003 Andy Jefferson - added localiser

2003 Andy Jefferson - updated exception handling with SchemaTable

2003 Andy Jefferson - restructured to remove SchemaTable, and add StoreManagerHelper

2003 Andy Jefferson - updated getSubClassesForClass to recurse

2004 Erik Bengtson  - removed unused method and variables

2004 Erik Bengtson  - fixed problem with getObjectById for App ID in getClassForOID

2004 Andy Jefferson - re-emergence of SchemaTable. Addition of addClass().

2004 Andy Jefferson - Addition of AutoStartMechanism interface

2004 Andy Jefferson - Update to use Logger

2004 Andy Jefferson - Addition of Catalog name to accompany Schema name

2004 Marco Schulze  - replaced catch(NotPersistenceCapableException ...)

                  by advance-check via TypeManager.isSupportedType(...)

2004 Andy Jefferson - split StoreData into superclass.

2004 Andy Jefferson - added support for other inheritance types

2004 Andy Jefferson - added capability to dynamically add columns

2005 Marco Schulze - prevent closing starter during recursion of ClassAdder.addClassTables(...)

    ...

**********************************************************************/

* StoreManager for RDBMS datastores.

* Provided by the "store-manager" extension key "rdbms" and accepts datastore URLs valid for JDBC.

* <p>

* The RDBMS manager's responsibilities extend those for StoreManager to add :

* <ul>

* <li>creates and controls access to the data sources required for this datastore instance</li>

* <li>implements insert(), fetch(), update(), delete() in the interface to the StateManager.</li>

* <li>Providing cached access to JDBC database metadata (in particular column information).</li>

* <li>Resolving SQL identifier macros to actual SQL identifiers.</li>

* </ul>

* TODO Change RDBMSManager to share schema information (DatabaseMetaData) with other RDBMSManager.

*/

    /** Localiser for messages. */

    protected static final Localiser LOCALISER_RDBMS = Localiser.getInstance(

        "org.datanucleus.store.rdbms.Localisation", RDBMSStoreManager.class.getClassLoader());

    /** Controller for SQL executed on this store. */

    private SQLController sqlController = null;

    /** Factory for expressions using the generic query SQL mechanism. */

    protected SQLExpressionFactory expressionFactory;

    /**

     * The active class adder transaction, if any. Some RDBMSManager methods are

     * called recursively in the course of adding new classes. This field allows

     * such methods to coordinate with the active ClassAdder transaction.

     * Recursive methods include:

     * <ul>

     * <li>addClasses()</li>

     * <li>addSetTable()</li>

     * <li>addMapTable()</li>

     * <li>addListTable()</li>

     * <li>addArrayTable()</li>

     * </ul>

     * Access is synchronized on the RDBMSManager itself.

     * Invariant: classAdder == null if RDBMSManager is unlocked.

     */

    private ClassAdder classAdder = null;

    /**

     * Object to use for locking the ClassAdder process. This could be revised with CORE-3409

     * and the above ClassAdder field to find a better locking strategy.

     */

    private final Object classAdditionLock = new Object();

    /** Writer for use when this RDBMSManager is configured to write DDL. */

    private Writer ddlWriter = null;

    /**

     * Flag for use when this RDBMSManager is configured to write DDL, whether we should generate

     * complete DDL or upgrade DDL

     */

    private boolean completeDDL = false;

    /**

     * DDL statements already written when in DDL mode.

     * This is used to eliminate duplicate statements from bidirectional relations.

     */

    private Set<String> writtenDdlStatements = null;

    /** State variable for schema generation of the callback information to be processed. */

    private MultiMap schemaCallbacks = new MultiMap();

    /** Calendar for this datastore. */

    private transient Calendar dateTimezoneCalendar = null;

    /**

     * Constructs a new RDBMSManager. On successful return the new RDBMSManager

     * will have successfully connected to the database with the given

     * credentials and determined the schema name, but will not have inspected

     * the schema contents any further. The contents (tables, views, etc.) will

     * be subsequently created and/or validated on-demand as the application

     * accesses persistent classes.

     *

     * @param clr the ClassLoaderResolver

     * @param ctx The corresponding Context. This factory's non-tx data source will be

     *     used to get database connections as needed to perform management functions.

     * @param props Properties for the datastore

     * @exception NucleusDataStoreException If the database could not be accessed or the name of the

     *                schema could not be determined.

     */

    public RDBMSStoreManager(ClassLoaderResolver clr, NucleusContext ctx, Map<String, Object> props)

    {

        super("rdbms", clr, ctx, props);

        persistenceHandler = new RDBMSPersistenceHandler(this);

        schemaHandler = new RDBMSSchemaHandler(this);

        expressionFactory = new SQLExpressionFactory(this);

        // Retrieve the Database Adapter for this datastore

        try

        {

            ManagedConnection mc = getConnection(-1);

            Connection conn = (Connection)mc.getConnection();

            if (conn == null)

            {

                //somehow we haven't got an exception from the JDBC driver

                //to troubleshoot the user should telnet to ip/port of database and check if he can open a connection

                //this may be due to security / firewall things.

                throw new NucleusDataStoreException(LOCALISER_RDBMS.msg("050007"));

            }

            try

            {

                dba = RDBMSAdapterFactory.getInstance().getDatastoreAdapter(clr, conn,

                    getStringProperty("datanucleus.rdbms.datastoreAdapterClassName"),

                    ctx.getPluginManager());

                dba.initialiseTypes(schemaHandler, mc);

                dba.removeUnsupportedMappings(schemaHandler, mc);

                // User specified default catalog/schema name - check for validity, and store

                if (hasPropertyNotNull("datanucleus.mapping.Catalog"))

                {

                    if (!((RDBMSAdapter)dba).supportsOption(RDBMSAdapter.CATALOGS_IN_TABLE_DEFINITIONS))

                    {

                        NucleusLogger.DATASTORE.warn(LOCALISER_RDBMS.msg("050002",

                            getStringProperty("datanucleus.mapping.Catalog")));

                    }

                    else

                    {

                        catalogName = getStringProperty("datanucleus.mapping.Catalog");

                    }

                }

                if (hasPropertyNotNull("datanucleus.mapping.Schema"))

                {

                    if (!((RDBMSAdapter)dba).supportsOption(DatastoreAdapter.SCHEMAS_IN_TABLE_DEFINITIONS))

                    {

                        NucleusLogger.DATASTORE.warn(LOCALISER_RDBMS.msg("050002",

                            getStringProperty("datanucleus.mapping.Schema")));

                    }

                    else

                    {

                        schemaName = getStringProperty("datanucleus.mapping.Schema");

                    }