Package org.craftercms.studio.impl.v2.upgrade.operations.site

Class MultiFindAndReplaceUpgradeOperation

java.lang.Object

org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation<String>

org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

org.craftercms.studio.impl.v2.upgrade.operations.site.AbstractContentUpgradeOperation

org.craftercms.studio.impl.v2.upgrade.operations.site.MultiFindAndReplaceUpgradeOperation

All Implemented Interfaces:

org.craftercms.commons.upgrade.UpgradeOperation<String>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

public class MultiFindAndReplaceUpgradeOperation
extends AbstractContentUpgradeOperation

Implementation of UpgradeOperation that replaces text in the content repository according to multiple 'pattern/replacement' rules.

Supported YAML properties:

• rules: (required) the list of rules to find and replace text. Each rule should contain the properties:
  • pattern: (required) the pattern to search in the files, can be a regular expression
  • replacement: (required) the expression to replace in the files, can use matched groups from the regular expression in the pattern

Author:

jmendeza

Nested Class Summary

Nested classes/interfaces inherited from class org.craftercms.studio.impl.v2.upgrade.operations.site.AbstractContentUpgradeOperation

AbstractContentUpgradeOperation.ListFileVisitor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_PATTERN
static final String	CONFIG_KEY_REPLACEMENT
static final String	CONFIG_KEY_RULES
protected List<org.craftercms.studio.impl.v2.upgrade.operations.site.MultiFindAndReplaceUpgradeOperation.Rule>	rules	The list of find-replace rules

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.operations.site.AbstractContentUpgradeOperation

CONFIG_KEY_INCLUDED_PATHS, includedPaths

Fields inherited from class org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

changedFiles, commitDetails, CONFIG_KEY_COMMIT_DETAILS, deletedFiles, servletContext, studioConfiguration

Fields inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

applicationContext, currentVersion, enabled, nextVersion

Constructor Summary

Constructors

Constructor	Description
MultiFindAndReplaceUpgradeOperation(StudioConfiguration studioConfiguration)

Method Summary

Modifier and Type	Method	Description
protected void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)
protected boolean	shouldBeUpdated(StudioUpgradeContext context, Path file)	Indicates if the given file should be updated by this class
protected void	updateFile(StudioUpgradeContext context, Path path)	Performs any needed updates on the content of the given file

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.operations.site.AbstractContentUpgradeOperation

doExecute, filterPaths, findIncludedPaths, readFile, writeFile

Methods inherited from class org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

commitAllChanges, doExecute, getCommitMessage, init, loadResource, setServletContext, trackChangedFiles, trackDeletedFiles

Methods inherited from class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation

execute, setApplicationContext, setEnabled

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_KEY_RULES

public static final String CONFIG_KEY_RULES

See Also:

• Constant Field Values

CONFIG_KEY_PATTERN

public static final String CONFIG_KEY_PATTERN

See Also:

• Constant Field Values

CONFIG_KEY_REPLACEMENT

public static final String CONFIG_KEY_REPLACEMENT

See Also:

• Constant Field Values

rules

protected List<org.craftercms.studio.impl.v2.upgrade.operations.site.MultiFindAndReplaceUpgradeOperation.Rule> rules

The list of find-replace rules

Constructor Details

MultiFindAndReplaceUpgradeOperation

public MultiFindAndReplaceUpgradeOperation(StudioConfiguration studioConfiguration)

Method Details

doInit

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

Overrides:

doInit in class AbstractContentUpgradeOperation

shouldBeUpdated

protected boolean shouldBeUpdated(StudioUpgradeContext context,
 Path file)

Description copied from class: AbstractContentUpgradeOperation

Indicates if the given file should be updated by this class

Specified by:

shouldBeUpdated in class AbstractContentUpgradeOperation

Parameters:

context - the current upgrade context

file - the file to check

Returns:

true if the file should be updated

updateFile

protected void updateFile(StudioUpgradeContext context,
 Path path)
                   throws org.craftercms.commons.upgrade.exception.UpgradeException

Description copied from class: AbstractContentUpgradeOperation

Performs any needed updates on the content of the given file

Specified by:

updateFile in class AbstractContentUpgradeOperation

Parameters:

context - the current upgrade context

path - the file to update

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException - if there is any error updating the file