org.unitils.dbmaintainer.util.BaseDatabaseAccessor Maven / Gradle / Ivy

Go to download

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

Unitils provides utilities to further simplify unit-testing with JUnit, DBUnit, EasyMock Hibernate and Spring. The goal is to make unit-testing easy and maintainable by offering utilities such as automatic DB-schema maintainance and equality assertion through reflection.

There is a newer version: 3.4.6

Show newest version

/*
 * Copyright 2008,  Unitils.org
 *
 * 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 org.unitils.dbmaintainer.util;

import org.unitils.core.dbsupport.DbSupport;
import org.unitils.core.dbsupport.DbSupportFactory;
import org.unitils.core.dbsupport.SQLHandler;

import static org.unitils.core.dbsupport.DbSupportFactory.getDbSupports;
import static org.unitils.core.dbsupport.DbSupportFactory.getDefaultDbSupport;

import javax.sql.DataSource;
import java.util.List;
import java.util.Properties;

/**
 * Base class for implementations that access the test database
 *
 * @author Filip Neven
 * @author Tim Ducheyne
 */
abstract public class BaseDatabaseAccessor implements DatabaseAccessing {

    /**
     * The unitils configuration
     */
    protected Properties configuration;

    /**
     * Provides connections to the unit test database
     */
    protected SQLHandler sqlHandler;

    /**
     * DbSupport for the default schema
     */
    protected DbSupport defaultDbSupport;

    /**
     * DbSupport for all schemas
     */
    protected List dbSupports;


    /**
     * Initializes the database operation class with the given {@link Properties}, {@link DataSource}.
     *
     * @param configuration The configuration, not null
     * @param sqlHandler    The sql handler, not null
     */
    public void init(Properties configuration, SQLHandler sqlHandler) {
        this.configuration = configuration;
        this.sqlHandler = sqlHandler;
        this.dbSupports = getDbSupports(configuration, sqlHandler);
        this.defaultDbSupport = getDefaultDbSupport(configuration, sqlHandler);

        doInit(configuration);
    }


    /**
     * Allows subclasses to perform some extra configuration using the given configuration.
     *
     * @param configuration The configuration, not null
     */
    protected void doInit(Properties configuration) {
        // do nothing
    }


    /**
     * Gets the db support for the given schema.
     *
     * @param schemaName The schema, not null
     * @return The db support, not null
     */
    public DbSupport getDbSupport(String schemaName) {
        return DbSupportFactory.getDbSupport(configuration, sqlHandler, schemaName);
    }

}