org.craftercms.commons.upgrade.UpgradePipelineFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-upgrade-manager Show documentation

Crafter Commons Upgrade Manager

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package org.craftercms.commons.upgrade;

import org.craftercms.commons.config.ConfigurationException;
import org.craftercms.commons.upgrade.exception.UpgradeException;
import org.craftercms.commons.upgrade.impl.UpgradeContext;

/**
 * Builds an {@link UpgradePipeline} with all the required operations
 *
 * @param  The target type supported
 * @author joseross
 * @since 3.1.5
 */
public interface UpgradePipelineFactory {

    String CONFIG_KEY_CURRENT_VERSION = "currentVersion";
    String CONFIG_KEY_NEXT_VERSION = "nextVersion";
    String CONFIG_KEY_OPERATIONS = "operations";
    String CONFIG_KEY_TYPE = "type";
    String CONFIG_KEY_REQUIRES = ".requires";
    String CONFIG_KEY_VERSIONS = ".versions";

    /**
     * Retrieves the needed upgrade operations for the given target
     *
     * @param context the upgrade context
     * @return the upgrade pipeline
     * @throws UpgradeException if there is any error retrieving the operations
     */
    UpgradePipeline getPipeline(UpgradeContext context) throws UpgradeException, ConfigurationException;

}