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 forDeploymentProcessor
s 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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected ChangeSet
doExecute(Deployment deployment, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)
Triggers the execution of the processor for the givenDeployment
andChangeSet
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 givenDeployment
andChangeSet
-
Methods inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor
destroy, doDestroy, doInit, execute, getFilteredChangeSet, init, isJumpToActive, setBeanName, setEnv, setSiteName, setTargetId, shouldIncludeFile, startJumpTo, supportsMode
-
-
-
-
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 interfaceDeploymentProcessor
- Overrides:
isPostDeployment
in classAbstractDeploymentProcessor
-
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 givenDeployment
andChangeSet
- Specified by:
doExecute
in classAbstractDeploymentProcessor
- Parameters:
deployment
- the current deploymentfilteredChangeSet
- the filtered change set (as returned byAbstractDeploymentProcessor.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 theChangeSet
-
shouldExecute
protected boolean shouldExecute(Deployment deployment, ChangeSet filteredChangeSet)
Description copied from class:AbstractDeploymentProcessor
Indicates if the processor should be executed for the givenDeployment
andChangeSet
- Specified by:
shouldExecute
in classAbstractDeploymentProcessor
- Parameters:
deployment
- theDeployment
to checkfilteredChangeSet
- theChangeSet
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
-
-