com.tacitknowledge.util.migration.jdbc.DistributedJdbcMigrationLauncher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of autopatch Show documentation
An automated Java patching system
There is a newer version: 1.4.2
/* Copyright 2004 Tacit Knowledge
 *  
 * 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 com.tacitknowledge.util.migration.jdbc;

import com.tacitknowledge.util.migration.DistributedMigrationProcess;
import com.tacitknowledge.util.migration.MigrationException;
import com.tacitknowledge.util.migration.MigrationProcess;

/**
 * Core starting point for a distributed database migration run.  
 * This class obtains a connection to the orchestration database, 
 * checks its patch level, delegates the actual execution of the 
 * migration tasks to a MigrationProcess instance, 
 * and then commits and cleans everything up at the end.
 * 
 * This class is NOT threadsafe.
 *
 * @author Mike Hardy ([email protected])
 */
public class DistributedJdbcMigrationLauncher extends JdbcMigrationLauncher
{
    /**
     * Create a new MigrationProcess and add a SqlScriptMigrationTaskSource
     */
    public DistributedJdbcMigrationLauncher()
    {
        super();
    }
    
    /**
     * Create a new MigrationLancher.
     *
     * @param context the JdbcMigrationContext to use.
     */
    public DistributedJdbcMigrationLauncher(JdbcMigrationContext context)
    {
        super(context);
    }
    
    /**
     * Override the sub-class so we get a DistributedMigrationProcess instead of the
     * normal one
     * 
     * @return DistributedMigrationProcess
     */
    public MigrationProcess getNewMigrationProcess()
    {
        return new DistributedMigrationProcess();
    }
    
    /**
     * Starts the application migration process across all configured contexts
     *
     * @return the number of patches applied
     * @throws MigrationException if an unrecoverable error occurs during
     *         the migration
     */
    public int doMigrations() throws MigrationException
    {
        if (getContexts().size() == 0)
        {
            throw new MigrationException("You must configure a migration context");
        }
        
        return super.doMigrations();
    }
    
    /**
     * Starts the application migration process across all configured contexts
     *
     * @return the number of patches applied
     * @throws MigrationException if an unrecoverable error occurs during
     *         the migration
     */
    public int doRollbacks(int rollbackLevel) throws MigrationException
    {
        if (getContexts().size() == 0)
        {
            throw new MigrationException("You must configure a migration context");
        }
        
        return super.doRollbacks(rollbackLevel);
    }    
}