com.tacitknowledge.util.migration.MigrationRunnerStrategy 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;

import java.util.List;

/**
 * Dictates the methods that different algorithms should run when we
 * try to apply patches or get information about the patches that need to be run.
 *
 * @author Oscar Gonzalez ([email protected])
 * @author Hemri Herrera ([email protected])
 * @author Ulises Pulido ([email protected])
 */

public interface MigrationRunnerStrategy
{
    /**
     * Determines if a MigrationTask is able to run.
     *
     * @param migrationLevel of the MigrationTask to be check as in int
     * @param patchInfoStore object representing patch level information
     * @return boolean value telling us if we should run the migration or not.
     */
    public boolean shouldMigrationRun(int migrationLevel, PatchInfoStore patchInfoStore) throws MigrationException;

    /**
     * Determines if two stores are synchronized to each other.
     *
     * @param currentPatchInfoStore
     * @param patchInfoStore
     * @return
     * @throws MigrationException
     */
    public boolean isSynchronized(PatchInfoStore currentPatchInfoStore, PatchInfoStore patchInfoStore) throws MigrationException;

    /**
     * Retrieves all tasks that are candidates for rollback.
     *
     * @param allMigrationTasks
     * @param rollbackLevels
     * @param currentPatchInfoStore
     * @return
     * @throws MigrationException
     */
    public List getRollbackCandidates(List allMigrationTasks, int[] rollbackLevels, PatchInfoStore currentPatchInfoStore) throws MigrationException;
}