atg.service.jdbc.HSQLDBDataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atgdust Show documentation

ATG DUST is a framework for building JUnit tests for applications built on the ATG Dynamo platform. This framework allows one to quickly write test code that depends up Nucleus or ATG Repositories. By using this framework one can drastically cut down on development time. It takes only a few seconds to start up a test with a repository, but it may take multiple minutes to start up an application server. To get started with DUST, take a look at http://atgdust.sourceforge.net/first-test.html. This page will walk you through the process of running a basic test which starts Nucleus. After that, read the other getting started guides to describe how to create standalone Junit tests which can startup repositories and use the DynamoHttpServletResponse classes. For only ATG10 and tested.

The newest version!

/**
 * Copyright 2009 ATG DUST Project 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.
 */

package atg.service.jdbc;

import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Properties;

import atg.nucleus.ServiceException;
import atg.test.util.DBUtils;

/**
 * This datasource is used for testing. It starts up an HSQLDB in memory
 * instance on localhost automatically. The database will be named "testdb" by
 * default. If you need to name it something else set the "databaseName"
 * property on this component. You may want to change the name if your test
 * requires running two databases at the same time.
 * 
 * @author adamb
 * @version $Id:n HSQLDB
 *          //test/UnitTests/base/main/src/Java/atg/service/jdbc/HSQLDBDataSource
 *          .java#2 $
 */
public class HSQLDBDataSource extends InitializingDataSourceBase {

  // Don't shutdown HSQLDB by default. It might stop before other components
  // that require it.
  public boolean mShutdownHSQLDB = true;

  /**
   * Returns true if the "SHUTDOWN" sql statment should be sent to HSQLDB
   * when doStopService is called on this component.
   * @return
   */
  public boolean isShutdownHSQLDB() {
    return mShutdownHSQLDB;
  }

  /**
   * Sets the boolean which controls if HSQLDB should be shutdown when doStopService
   * is called on this component.
   * @param shouldShutdownHSQLDB
   */
  public void setShutdownHSQLDB(boolean shouldShutdownHSQLDB) {
    mShutdownHSQLDB = shouldShutdownHSQLDB;
  }

  // --------------------------
  /**
   * Starts this DataSource. Since the datasource uses an in memory HSQL
   * database, the database actually is started on the first call to
   * getConnection().
   */
  @Override
  public void doStartService() throws ServiceException {
    Properties props = DBUtils.getHSQLDBInMemoryDBConnection(getName());
    // set our properties from this object
    this.setDriver(props.getProperty("driver"));
    this.setURL(props.getProperty("URL"));
    this.setUser(props.getProperty("user"));
    this.setPassword(props.getProperty("password"));
    if (isLoggingInfo())
      logInfo("HSQLDB DataSource starting with properties " + props.toString());
    super.doStartService();
  }

  // --------------------------
  /**
   * Called when Nucleus is shutdown. Issues the "SHUTDOWN" command to the
   * HSQLDB database.
   */
  @Override
  public void doStopService() {
    if (mShutdownHSQLDB) {
      if (isLoggingInfo())
        logInfo("HSQLDB DataSource shutting down.");
      Connection connection = null;
      try {
        connection = this.getDriverManagerConnection();
        Statement st = connection.createStatement();
        st.execute("SHUTDOWN");
      } catch (SQLException e) {
        if (isLoggingError())
          logError(e.getMessage());
      } finally {
        if (connection != null) {
          try {
            connection.close();
          } catch (SQLException e) {
            ; // eat it
          }
        }
      }
    }

  }
}