Package org.craftercms.deployer.impl.processors

Class DelayProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.DelayProcessor

All Implemented Interfaces:

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

public class DelayProcessor
extends AbstractMainDeploymentProcessor

Implementation of DeploymentProcessor that stops the pipeline execution for a given number of seconds. Can be configured with the following YAML properties:

• seconds: Amount of seconds to wait

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIG_KEY_SECONDS
protected long	seconds	Amount of seconds to wait

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

FAIL_DEPLOYMENT_CONFIG_KEY, 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
DelayProcessor()

Method Summary

Modifier and Type	Method	Description
protected void	doDestroy()	Allows extending classes perform any custom cleanup
protected void	doInit(org.apache.commons.configuration2.Configuration config)	Allows extending classes perform any custom initialization
protected 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

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

doExecute, failDeploymentOnProcessorFailure, init, shouldExecute

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

destroy, execute, getDeploymentParam, 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 Details

CONFIG_KEY_SECONDS

protected static final String CONFIG_KEY_SECONDS

See Also:

• Constant Field Values

seconds

protected long seconds

Amount of seconds to wait

Constructor Details

DelayProcessor

public DelayProcessor()

Method Details

doInit

protected void doInit(org.apache.commons.configuration2.Configuration config)

Allows extending classes perform any custom initialization

Specified by:

doInit in class AbstractDeploymentProcessor

Parameters:

config - the bean's configuration

doMainProcess

protected 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

Specified by:

doMainProcess in class AbstractMainDeploymentProcessor

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

doDestroy

protected void doDestroy()
                  throws DeployerException

Allows extending classes perform any custom cleanup

Specified by:

doDestroy in class AbstractDeploymentProcessor

Throws:

DeployerException - if an error occurs