Package org.craftercms.deployer.impl.upgrade.operations

Class ConditionalEnvUpgradeOperation

java.lang.Object

org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation<Target>

org.craftercms.deployer.impl.upgrade.operations.AbstractTargetUpgradeOperation

org.craftercms.deployer.impl.upgrade.operations.ConditionalEnvUpgradeOperation

All Implemented Interfaces:

org.craftercms.commons.upgrade.UpgradeOperation<Target>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

AbstractProcessorUpgradeOperation, RemovePropertyUpgradeOperation

public abstract class ConditionalEnvUpgradeOperation
extends AbstractTargetUpgradeOperation

Base class for upgrade operations that are executed only if the environment of the target matches the configuration.

Since:

4.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_KEY_ENV_PATTERN
protected String	envPattern	The pattern to match the environment

Fields inherited from class org.craftercms.deployer.impl.upgrade.operations.AbstractTargetUpgradeOperation

CONFIG_KEY_ADD, CONFIG_KEY_DEPLOYMENT, CONFIG_KEY_EXPRESSION, CONFIG_KEY_HOOK_NAME, CONFIG_KEY_LIFECYCLE_HOOKS, CONFIG_KEY_PATTERN, CONFIG_KEY_PIPELINE, CONFIG_KEY_PROCESSOR, CONFIG_KEY_PROCESSOR_NAME, CONFIG_KEY_PROPERTY, CONFIG_KEY_REMOVE, CONFIG_KEY_REPLACE, CONFIG_KEY_TARGET, CONFIG_KEY_VALUE, CONFIG_KEY_VALUES, yaml

Fields inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

applicationContext, currentVersion, enabled, logger, nextVersion

Constructor Summary

Constructors

Constructor	Description
ConditionalEnvUpgradeOperation()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(Target target, Map<String,Object> targetConfig)
protected abstract void	doExecuteInternal(Target target, Map<String,Object> targetConfig)
void	init(String currentVersion, String nextVersion, org.apache.commons.configuration2.HierarchicalConfiguration config)

Methods inherited from class org.craftercms.deployer.impl.upgrade.operations.AbstractTargetUpgradeOperation

doExecute, getPipeline

Methods inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

doInit, execute, loadResource, setApplicationContext, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_KEY_ENV_PATTERN

public static final String CONFIG_KEY_ENV_PATTERN

See Also:

Constant Field Values

envPattern

protected String envPattern

The pattern to match the environment

Constructor Detail

ConditionalEnvUpgradeOperation

public ConditionalEnvUpgradeOperation()

Method Detail

init

public void init(String currentVersion,
                 String nextVersion,
                 org.apache.commons.configuration2.HierarchicalConfiguration config)
          throws org.craftercms.commons.config.ConfigurationException

Specified by:

init in interface org.craftercms.commons.upgrade.UpgradeOperation<Target>

Overrides:

init in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation<Target>

Throws:

org.craftercms.commons.config.ConfigurationException

doExecute

protected void doExecute(Target target,
                         Map<String,Object> targetConfig)
                  throws Exception

Specified by:

doExecute in class AbstractTargetUpgradeOperation

Throws:

Exception

doExecuteInternal

protected abstract void doExecuteInternal(Target target,
                                          Map<String,Object> targetConfig)