Package org.craftercms.deployer.impl.processors

Class FindAndReplaceProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.FindAndReplaceProcessor

All Implemented Interfaces:

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

public class FindAndReplaceProcessor
extends AbstractMainDeploymentProcessor

Implementation of DeploymentProcessor to replace a pattern on the content of the created or updated files of a Deployment.

Note: the files changed by this processor will not be committed to the git repository and will be discarded when the next deployment starts.

Can be configured with the following YAML properties:

• textPattern: Regular expression to search in files
• replacement: Expression to replace the matches

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CONFIG_KEY_REPLACEMENT
protected static String	CONFIG_KEY_TEXT_PATTERN
protected String	localRepoUrl	URL for the local git repository.
protected String	replacement	Expression to replace the matches.
protected String	textPattern	Regular expression to search in files.

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

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
void	setLocalRepoUrl(String localRepoUrl)

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, 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

CONFIG_KEY_TEXT_PATTERN

protected static final String CONFIG_KEY_TEXT_PATTERN

See Also:

Constant Field Values

CONFIG_KEY_REPLACEMENT

protected static final String CONFIG_KEY_REPLACEMENT

See Also:

Constant Field Values

localRepoUrl

protected String localRepoUrl

URL for the local git repository.

textPattern

protected String textPattern

Regular expression to search in files.

replacement

protected String replacement

Expression to replace the matches.

Constructor Detail

FindAndReplaceProcessor

public FindAndReplaceProcessor()

Method Detail

setLocalRepoUrl

public void setLocalRepoUrl(String localRepoUrl)

doInit

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

Allows extending classes perform any custom initialization

Specified by:

doInit in class AbstractDeploymentProcessor

Parameters:

config - the bean's configuration

Throws:

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

doMainProcess

protected 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

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

Throws:

DeployerException - if there is any error processing the ChangeSet

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