org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation 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.impl.operations;

import org.apache.commons.configuration2.HierarchicalConfiguration;
import org.craftercms.commons.config.ConfigurationException;
import org.craftercms.commons.upgrade.UpgradeOperation;
import org.craftercms.commons.upgrade.exception.UpgradeException;
import org.craftercms.commons.upgrade.impl.UpgradeContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.io.Resource;

/**
 * Base class for all {@link UpgradeOperation} implementations that provides access to system resources
 * Supported YAML properties:
 * 

 *     currentVersion: (required) the version number that will be upgraded
 *     nextVersion (required) the version number to use after the upgrade
 * 
 * 
 *
 * @param  The target type supported
 * @author joseross
 * @since 3.1.5
 */
public abstract class AbstractUpgradeOperation implements UpgradeOperation, ApplicationContextAware {

    protected Logger logger = LoggerFactory.getLogger(getClass());

    /**
     * The current version.
     */
    protected String currentVersion;

    /**
     * The next version.
     */
    protected String nextVersion;

    /**
     * Indicates if the operation should be executed, true by default
     */
    protected boolean enabled = true;

    /**
     * The application context
     */
    protected ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(final ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    @Override
    public void init(final String currentVersion, final String nextVersion, final HierarchicalConfiguration config)
            throws ConfigurationException {
        this.currentVersion = currentVersion;
        this.nextVersion = nextVersion;

        doInit(config);
    }

    protected void doInit(final HierarchicalConfiguration config) throws ConfigurationException {
        // do nothing by default
    }

    @Override
    public void execute(final UpgradeContext context) throws UpgradeException {
        if (!enabled) {
            logger.info("This operation is disabled, skipping execution");
            return;
        }
        logger.debug("Starting execution for target {}", context);
        try {
            doExecute(context);
        } catch (Exception e) {
            throw new UpgradeException("Error executing upgrade operation " + getClass(), e);
        } finally {
            logger.debug("Execution completed for target {}", context);
        }
    }

    protected abstract void doExecute(UpgradeContext context) throws Exception;

    protected Resource loadResource(String path) {
        return applicationContext.getResource(path);
    }

}