Package org.craftercms.deployer.impl.processors

Class AbstractPostDeploymentProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractPostDeploymentProcessor

All Implemented Interfaces:

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

Direct Known Subclasses:

FileOutputProcessor, MailNotificationProcessor

public abstract class AbstractPostDeploymentProcessor
extends AbstractDeploymentProcessor

Base class for DeploymentProcessors that are executed during the post deployment phase, which is the phase that happens after all the files from the change set have been processed.

Author:

avasquez

Field Summary

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
AbstractPostDeploymentProcessor()

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	doPostProcess(Deployment deployment, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)
boolean	isPostDeployment()	Returns true if this processor runs after the deployment has finalized.
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, init, isJumpToActive, 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

Constructor Detail

AbstractPostDeploymentProcessor

public AbstractPostDeploymentProcessor()

Method Detail

isPostDeployment

public boolean isPostDeployment()

Description copied from interface: DeploymentProcessor

Returns true if this processor runs after the deployment has finalized.

Specified by:

isPostDeployment in interface DeploymentProcessor

Overrides:

isPostDeployment in class AbstractDeploymentProcessor

doExecute

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

Description copied from class: AbstractDeploymentProcessor

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)

Description copied from class: AbstractDeploymentProcessor

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

doPostProcess

protected abstract ChangeSet doPostProcess(Deployment deployment,
                                           ChangeSet filteredChangeSet,
                                           ChangeSet originalChangeSet)
                                    throws DeployerException

Throws:

DeployerException