com.tacitknowledge.util.migration.MigrationContext Maven / Gradle / Ivy

Go to download
/* 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;


/**
 * Provides system resources to migration tasks.
 *
 * @author Scott Askew ([email protected])
 */
public interface MigrationContext
{
    /**
     * The name of the migration configuration file
     */
    public static final String MIGRATION_CONFIG_FILE = "migration.properties";

    /**
     * Commits the current migration transaction.
     *
     * @throws MigrationException if there was an unrecoverable error committing
     *                            the transaction
     */
    public void commit() throws MigrationException;

    /**
     * Rolls back the current migration transaction.
     *
     * @throws MigrationException if there was an unrecoverable error committing
     *                            the transaction
     */
    public void rollback() throws MigrationException;
}