de.viaboxx.dbmigrate.spring.DBMigrateBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbmigrate Show documentation
There is a newer version: 2.5.27
package de.viaboxx.dbmigrate.spring;

import com.agimatec.dbmigrate.AutoMigrationTool;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.InitializingBean;

import javax.sql.DataSource;
import java.util.Map;

/**
 * Description:
 * Bean to integrate and configure dbmigrate via spring.
 * 

 * 

 * 
 * Supports spring access common options of AutoMigrationTool: 

 * - sim: simulation (false)

 * - exitJVM: exit Java VM after migration (false)

 * - stopOnException: true: log and re-throw exception to stop startup,

 *                    false: log exception and continue(true)

 * - migrateConfigFileName: xml setup file (migration.xml)

 * 

 * 
Currently not supported features via spring-configuration: 

 * - script: ScriptAction   

 * - op:     OperationAction

 * 

 * User: roman.stumm

 * Date: 03.11.2011

 * Time: 08:06:42

 * viaboxx GmbH, 2011
 */
public class DBMigrateBean implements InitializingBean, BeanNameAware {
    private final AutoMigrationTool tool;

    protected String beanName;

    protected DBCPAdapter dataSourceConfigurator;

    /**
     * disable running the tool
     */
    private boolean disabled = false;
    private boolean stopOnException = true;

    public DBMigrateBean() {
        tool = new AutoMigrationTool();
        tool.setExitJVM(false);
    }

    /**
     * @param fileName - default is "migration.xml", see BaseMigrationTool#migrateConfigFileName
     */
    public void setConfigFile(String fileName) {
        getTool().setMigrateConfigFileName(fileName);
    }

    public boolean isDisabled() {
        return disabled;
    }

    public void setDisabled(boolean disabled) {
        this.disabled = disabled;
    }

    public boolean isStopOnException() {
        return stopOnException;
    }

    public void setStopOnException(boolean stopOnException) {
        this.stopOnException = stopOnException;
    }

    public void setExitJVM(boolean exitJVM) {
        getTool().setExitJVM(exitJVM);
    }

    public boolean isExitJVM() {
        return getTool().isExitJVM();
    }

    /**
     * @param sim - default is 'false'
     */
    public void setSimulation(boolean sim) {
        getTool().setSim(sim);
    }

    public void setConfigRootUrl(String configRoot) {
        getTool().setConfigRootUrl(configRoot);
    }

    @SuppressWarnings({"unchecked"})
    public void setToVersion(String version) {
        getTool().getEnvironment().put("to-version", version);
    }

    @SuppressWarnings({"unchecked"})
    public void setFromVersion(String version) {
        getTool().getEnvironment().put("from-version", version);
    }

    public void setEnvironment(Map env) {
        for (Map.Entry entry : env.entrySet()) {
            if (null == System.getProperty(entry.getKey())) { // do not overwrite System properties
                //noinspection unchecked
                getTool().getEnvironment().put(entry.getKey(), entry.getValue());
            }
        }
    }

    public void setMigrateConfig(Map conf) {
        for (Map.Entry entry : conf.entrySet()) {
            tool.getMigrateConfig().put(entry.getKey(), entry.getValue());
        }
    }

    /**
     * @return the underlying dbmigrate tool instance (never null)
     */
    public AutoMigrationTool getTool() {
        return tool;
    }

    /**
     * Automatically start dbmigrate. Throw exception when something goes wrong.
     *
     * @throws Exception - all exceptions when dbmigrate not successful
     */
    public void afterPropertiesSet() throws Exception {
        int exitCode = 0;
        if (isDisabled()) {
            getTool().getLog().info(beanName + " - execution disabled!");
            if (tool.isExitJVM()) System.exit(exitCode);
            return; // do nothing
        }
        try {
            getTool().getLog().info(beanName + " - initializing");
            configure();
            getTool().setUp();
            getTool().startAutomaticMigration();
            getTool().getLog().info(beanName + " - successful");
        } catch (Exception ex) {
            exitCode = 1;
            getTool().getLog().error(beanName + " - failed", ex);
            if (isStopOnException()) throw ex; // propagate to stop spring from starting
        } finally {
            getTool().tearDown();
            getTool().getLog().info(beanName + " - finished");
            if (tool.isExitJVM()) System.exit(exitCode);

        }
    }

    @SuppressWarnings({"unchecked"})
    private void configure() {
        if (dataSourceConfigurator != null) dataSourceConfigurator.configure(getTool());
        if (getTool().getMigrateConfig().get("Scripts-Prefix") == null) {
            getTool().getMigrateConfig()
                    .put("Scripts-Prefix", "up_"); // change default so that groovy scripts have compatible names
        }
    }

    public void setBeanName(String name) {
        beanName = name;
    }

    /**
     * you can optionally configure the database connection for dbmigrate by
     * providing a BasicDataSource. Otherwise dbmigrate uses its proprietary database connection settings.
     * (for proprietary configuration, see properties file configured with
     * <file name="JdbcConfig" file="dbconnect.properties"/>
     * or provide these information in the xml configuration,
     * read more here:
     * DBMigrateConfigFile
     *
     * @param dataSource
     */
    public void setDataSource(DataSource dataSource) {
        if (dataSource != null) {
            // not yet implemented: support other dataSource types than apache.commons.dbcp
            // decouple this class from compile-dependencies to apache.commons.dbcp or other implementations
            dataSourceConfigurator = new DBCPAdapter();
            dataSourceConfigurator.setDataSource(dataSource);
        }
    }

}