Package org.craftercms.deployer.impl.processors

Class AbstractMainDeploymentProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

All Implemented Interfaces:

DeploymentProcessor, InitializableByConfigBean, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

AbstractRemoteGitRepoAwareProcessor, AbstractS3Processor, AbstractSearchIndexingProcessor, CloudFrontInvalidationProcessor, CommandLineProcessor, DelayProcessor, FileBasedDeploymentEventProcessor, FindAndReplaceProcessor, GitDiffProcessor, GitUpdateCommitIdProcessor, HttpMethodCallProcessor, ScriptProcessor

public abstract class AbstractMainDeploymentProcessor
extends AbstractDeploymentProcessor

Base class for DeploymentProcessors that are executed during the main deployment phase, which is the phase where the change set is retrieved and the files are processed.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static String	FAIL_DEPLOYMENT_CONFIG_KEY
protected boolean	failDeploymentOnFailure

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

alwaysRun, env, excludeFiles, includeFiles, JUMPING_TO_PARAM_NAME, jumpTo, label, name, siteName, targetId

Constructor Summary

Constructors

Constructor	Description
AbstractMainDeploymentProcessor()

Method Summary

Modifier and Type	Method	Description
protected ChangeSet	doExecute(Deployment deployment, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)	Triggers the execution of the processor for the given Deployment and ChangeSet
protected abstract ChangeSet	doMainProcess(Deployment deployment, ProcessorExecution execution, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)	Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline
protected boolean	failDeploymentOnProcessorFailure()	Indicates if the deployment should be marked as failed if this processor throws an error
void	init(org.apache.commons.configuration2.Configuration config)	Initializes the bean using the specified configuration.
protected boolean	shouldExecute(Deployment deployment, ChangeSet filteredChangeSet)	Indicates if the processor should be executed for the given Deployment and ChangeSet

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

destroy, doDestroy, doInit, execute, getFilteredChangeSet, isJumpToActive, isPostDeployment, setBeanName, setEnv, setSiteName, setTargetId, shouldIncludeFile, startJumpTo, supportsMode

Methods inherited from class java.lang.Object

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

Field Detail

FAIL_DEPLOYMENT_CONFIG_KEY

public static final String FAIL_DEPLOYMENT_CONFIG_KEY

See Also:

Constant Field Values

failDeploymentOnFailure

protected boolean failDeploymentOnFailure

Constructor Detail

AbstractMainDeploymentProcessor

public AbstractMainDeploymentProcessor()

Method Detail

init

public void init(org.apache.commons.configuration2.Configuration config)
          throws org.craftercms.commons.config.ConfigurationException,
                 DeployerException

Initializes the bean using the specified configuration.

Specified by:

init in interface InitializableByConfigBean

Overrides:

init in class AbstractDeploymentProcessor

Parameters:

config - the bean's configuration

Throws:

org.craftercms.commons.config.ConfigurationException - if there's configuration related exception

DeployerException - if there's a general exception on init

doExecute

protected ChangeSet doExecute(Deployment deployment,
                              ChangeSet filteredChangeSet,
                              ChangeSet originalChangeSet)
                       throws Exception

Triggers the execution of the processor for the given Deployment and ChangeSet

Specified by:

doExecute in class AbstractDeploymentProcessor

Parameters:

deployment - the current deployment

filteredChangeSet - the filtered change set (as returned by AbstractDeploymentProcessor.getFilteredChangeSet(ChangeSet))

originalChangeSet - the original change set (as returned by the previous processors in the pipeline)

Returns:

a new ChangeSet or null

Throws:

Exception - if there is any error processing the ChangeSet

shouldExecute

protected boolean shouldExecute(Deployment deployment,
                                ChangeSet filteredChangeSet)

Indicates if the processor should be executed for the given Deployment and ChangeSet

Specified by:

shouldExecute in class AbstractDeploymentProcessor

Parameters:

deployment - the Deployment to check

filteredChangeSet - the ChangeSet to check

Returns:

true if the processor should be executed

doMainProcess

protected abstract ChangeSet doMainProcess(Deployment deployment,
                                           ProcessorExecution execution,
                                           ChangeSet filteredChangeSet,
                                           ChangeSet originalChangeSet)
                                    throws DeployerException

Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline

Parameters:

deployment - the current deployment

execution - the current execution

filteredChangeSet - the filtered change set (as returned by AbstractDeploymentProcessor.getFilteredChangeSet(ChangeSet))

originalChangeSet - the original change set (as returned by the previous processors in the pipeline)

Returns:

a new ChangeSet or null

Throws:

DeployerException - if there is any error processing the ChangeSet

failDeploymentOnProcessorFailure

protected boolean failDeploymentOnProcessorFailure()

Indicates if the deployment should be marked as failed if this processor throws an error