de.valtech.aecu.api.groovy.console.bindings

Interface ContentUpgrade

@ProviderType
public interface ContentUpgrade

This class provides the builder methods to perform a content upgrade.

Author:

Roxana Muresan, Roland Gruber

Method Summary

Modifier and Type	Method and Description
ContentUpgrade	doActivateContainingPage() Activates the page where the resource is located.
ContentUpgrade	doActivateResource() Activates the resource.
ContentUpgrade	doAddTagsToContainingPage(String... tags) Adds tags to the containing page of the matching resource.
ContentUpgrade	doAddValuesToMultiValueProperty(String name, String[] values) Adds values to a multivalue property.
ContentUpgrade	doCheckPageRendering() Checks if the containing page renders with status code 200.
ContentUpgrade	doCheckPageRendering(int code) Checks if the containing page renders with given status code.
ContentUpgrade	doCheckPageRendering(String textPresent) Checks if the containing page renders with status code 200 and contains given text.
ContentUpgrade	doCheckPageRendering(String textPresent, String textNotPresent) Checks if the containing page renders with status code 200 and (not) contains given text.
ContentUpgrade	doCopyPropertyToRelativePath(String name, String newName, String relativeResourcePath) Copies a property to a relative path.
ContentUpgrade	doCopyResourceToRelativePath(String relativePath) Copies a resource to a relative path.
ContentUpgrade	doCustomResourceBasedAction(CustomResourceAction action) Performs a custom action with providing a function.
ContentUpgrade	doDeactivateContainingPage() Deactivates the page where the resource is located.
ContentUpgrade	doDeactivateResource() Deactivates the resource.
ContentUpgrade	doDeleteContainingPage() Deletes the page where the resource is located.
ContentUpgrade	doDeleteProperty(String name) Deletes a property if existing.
ContentUpgrade	doDeleteResource() Deletes the resource.
ContentUpgrade	doMovePropertyToRelativePath(String name, String newName, String relativeResourcePath) Moves a property to a relative path.
ContentUpgrade	doMoveResourceToPathRegex(String matchPattern, String targetPathExpr) Moves a resource if its path matches the pattern to the path obtained by applying the replacement expression
ContentUpgrade	doMoveResourceToRelativePath(String relativePath) Moves a resource to a relative path.
ContentUpgrade	doRemoveTagsFromContainingPage(String... tags) Removes tags from the containing page of the matching resource.
ContentUpgrade	doRemoveValuesOfMultiValueProperty(String name, String[] values) Removes values of a multivalue property.
ContentUpgrade	doRename(String newName) Renames a resource to the given name.
ContentUpgrade	doRenameProperty(String oldName, String newName) Renames a property if existing.
ContentUpgrade	doReplaceValueInAllProperties(String oldValue, String newValue) Replaces a substring in all properties of the matching resource.
ContentUpgrade	doReplaceValueInAllPropertiesRegex(String searchRegex, String replacement) Replaces a substring in all properties of the matching resource using a regular expression.
ContentUpgrade	doReplaceValueInProperties(String oldValue, String newValue, String[] propertyNames) Replaces a substring in specific properties of the matching resource.
ContentUpgrade	doReplaceValueInPropertiesRegex(String searchRegex, String replacement, String[] propertyNames) Replaces a substring in specific properties of the matching resource using a regular expression.
ContentUpgrade	doReplaceValuesOfMultiValueProperty(String name, String[] oldValues, String[] newValues) Replaces values in a multivalue property.
ContentUpgrade	doSetProperty(String name, Object value) Sets a property value.
ContentUpgrade	doSetTagsForContainingPage(String... tags) Sets tags for the containing page of the matching resource.
ContentUpgrade	doTreeActivateContainingPage() Activates the page tree where the resource is located.
ContentUpgrade	doTreeActivateContainingPage(boolean skipDeactivated) Activates the page tree where the resource is located.
void	dryRun() Performs a dry-run.
ContentUpgrade	filterByAnyPropertyRegex(String regex) Filters by checking if any property matches the given regular expression for the value.
ContentUpgrade	filterByHasProperty(String name) Filters by existence of a single property.
ContentUpgrade	filterByMultiValuePropContains(String name, Object[] conditionValues) Filters by multi-value with the given name containing the given conditionValues
ContentUpgrade	filterByNodeName(String nodeName) Filters by node name exact match.
ContentUpgrade	filterByNodeNameRegex(String regex) Filters by node name using regular expression.
ContentUpgrade	filterByPathRegex(String regex) Filters by node path using regular expression.
ContentUpgrade	filterByProperties(Map<String,Object> conditionProperties) Filters by properties.
ContentUpgrade	filterByProperty(String name, Object value) Filters by a single property.
ContentUpgrade	filterByPropertyRegex(String name, String regex) Filters by a single property using a regular expression for the value.
ContentUpgrade	filterWith(FilterBy filter) Filters by using the given filter.
ContentUpgrade	forChildResourcesOf(String path) Loops for all child resources of the given path.
ContentUpgrade	forDescendantResourcesOf(String path) Loops recursive for all child resources of the given path.
ContentUpgrade	forResources(String[] paths) Loops for given list of resources.
ContentUpgrade	forResourcesBySql2Query(String query) Loops over resources found by SQL2 query.
ContentUpgrade	forResourcesInSubtree(String path) Loops recursive over all resources contained in the subtree at the given path.
ContentUpgrade	printJson() Prints the properties json
ContentUpgrade	printPath() Print path
ContentUpgrade	printProperty(String property) Print property
void	run() Saves all changes to repository.
void	run(boolean dryRun) Executes a run or a dryRun depending on the dryRun parameter value.

Method Detail

forResources

ContentUpgrade forResources(String[] paths)

Loops for given list of resources.

Parameters:

paths - list of paths

Returns:

upgrade object

forChildResourcesOf

ContentUpgrade forChildResourcesOf(String path)

Loops for all child resources of the given path. The path itself is not included.

Parameters:

path - path

Returns:

upgrade object

forDescendantResourcesOf

ContentUpgrade forDescendantResourcesOf(String path)

Loops recursive for all child resources of the given path. The path itself is not included.

Parameters:

path - path

Returns:

upgrade object

forResourcesInSubtree

ContentUpgrade forResourcesInSubtree(String path)

Loops recursive over all resources contained in the subtree at the given path.

Parameters:

path - path

Returns:

upgrade object

forResourcesBySql2Query

ContentUpgrade forResourcesBySql2Query(String query)

Loops over resources found by SQL2 query.

Parameters:

query - query string

Returns:

upgrade object

filterByHasProperty

ContentUpgrade filterByHasProperty(String name)

Filters by existence of a single property.

Parameters:

name - property name

Returns:

upgrade object

filterByProperty

ContentUpgrade filterByProperty(String name,
                                Object value)

Filters by a single property.

Parameters:

name - property name

value - property value

Returns:

upgrade object

filterByPropertyRegex

ContentUpgrade filterByPropertyRegex(String name,
                                     String regex)

Filters by a single property using a regular expression for the value. This is intended for single value properties.

Parameters:

name - property name

regex - regular expression to match value

Returns:

upgrade object

filterByAnyPropertyRegex

ContentUpgrade filterByAnyPropertyRegex(String regex)

Filters by checking if any property matches the given regular expression for the value. This is intended for single value properties.

Parameters:

regex - regular expression to match value

Returns:

upgrade object

filterByProperties

ContentUpgrade filterByProperties(Map<String,Object> conditionProperties)

Filters by properties. Can be used also for Multi-value properties.

Parameters:

conditionProperties - properties to filter

Returns:

upgrade object

filterByMultiValuePropContains

ContentUpgrade filterByMultiValuePropContains(String name,
                                              Object[] conditionValues)

Filters by multi-value with the given name containing the given conditionValues

Parameters:

name - name of the multi-value property

conditionValues - values to search for

Returns:

upgrade object

filterByNodeName

ContentUpgrade filterByNodeName(String nodeName)

Filters by node name exact match.

Parameters:

nodeName - node name

Returns:

upgrade object

filterByNodeNameRegex

ContentUpgrade filterByNodeNameRegex(String regex)

Filters by node name using regular expression.

Parameters:

regex - regular expression (Java standard pattern)

Returns:

upgrade object

filterByPathRegex

ContentUpgrade filterByPathRegex(String regex)

Filters by node path using regular expression.

Parameters:

regex - regular expression (Java standard pattern)

Returns:

upgrade object

filterWith

ContentUpgrade filterWith(FilterBy filter)

Filters by using the given filter.

Parameters:

filter - filter

Returns:

upgrade object

doSetProperty

ContentUpgrade doSetProperty(String name,
                             Object value)

Sets a property value.

Parameters:

name - property name

value - property value

Returns:

upgrade object

doDeleteProperty

ContentUpgrade doDeleteProperty(String name)

Deletes a property if existing.

Parameters:

name - property name

Returns:

upgrade object

doRenameProperty

ContentUpgrade doRenameProperty(String oldName,
                                String newName)

Renames a property if existing.

Parameters:

oldName - old property name

newName - new property name

Returns:

upgrade object

doCopyPropertyToRelativePath

ContentUpgrade doCopyPropertyToRelativePath(String name,
                                            String newName,
                                            String relativeResourcePath)

Copies a property to a relative path.

Parameters:

name - property name

newName - new property name

relativeResourcePath - relative path

Returns:

upgrade object

doMovePropertyToRelativePath

ContentUpgrade doMovePropertyToRelativePath(String name,
                                            String newName,
                                            String relativeResourcePath)

Moves a property to a relative path.

Parameters:

name - property name

newName - new property name

relativeResourcePath - relative path

Returns:

upgrade object

doAddValuesToMultiValueProperty

ContentUpgrade doAddValuesToMultiValueProperty(String name,
                                               String[] values)

Adds values to a multivalue property.

Parameters:

name - property name

values - values

Returns:

upgrade object

doRemoveValuesOfMultiValueProperty

ContentUpgrade doRemoveValuesOfMultiValueProperty(String name,
                                                  String[] values)

Removes values of a multivalue property.

Parameters:

name - property name

values - values to remove

Returns:

upgrade object

doReplaceValuesOfMultiValueProperty

ContentUpgrade doReplaceValuesOfMultiValueProperty(String name,
                                                   String[] oldValues,
                                                   String[] newValues)

Replaces values in a multivalue property.

Parameters:

name - property name

oldValues - values to remove

newValues - values to add

Returns:

upgrade object

doReplaceValueInAllProperties

ContentUpgrade doReplaceValueInAllProperties(String oldValue,
                                             String newValue)

Replaces a substring in all properties of the matching resource. Only applies to String properties.

Parameters:

oldValue - old value

newValue - new value

Returns:

upgrade object

doReplaceValueInProperties

ContentUpgrade doReplaceValueInProperties(String oldValue,
                                          String newValue,
                                          String[] propertyNames)

Replaces a substring in specific properties of the matching resource. Only applies to String properties.

Parameters:

oldValue - old value

newValue - new value

propertyNames - property names that should be checked

Returns:

upgrade object

doReplaceValueInAllPropertiesRegex

ContentUpgrade doReplaceValueInAllPropertiesRegex(String searchRegex,
                                                  String replacement)

Replaces a substring in all properties of the matching resource using a regular expression. Only applies to String properties.

Parameters:

searchRegex - regex to match old value

replacement - new value, may contain matcher groups (e.g. $1)

Returns:

upgrade object

doReplaceValueInPropertiesRegex

ContentUpgrade doReplaceValueInPropertiesRegex(String searchRegex,
                                               String replacement,
                                               String[] propertyNames)

Replaces a substring in specific properties of the matching resource using a regular expression. Only applies to String properties.

Parameters:

searchRegex - regex to match old value

replacement - new value, may contain matcher groups (e.g. $1)

propertyNames - property names that should be checked

Returns:

upgrade object

doRename

ContentUpgrade doRename(String newName)

Renames a resource to the given name.

Parameters:

newName - path

Returns:

newName new name

doCopyResourceToRelativePath

ContentUpgrade doCopyResourceToRelativePath(String relativePath)

Copies a resource to a relative path.

Parameters:

relativePath - path

Returns:

upgrade object

doMoveResourceToRelativePath

ContentUpgrade doMoveResourceToRelativePath(String relativePath)

Moves a resource to a relative path.

Parameters:

relativePath - path

Returns:

upgrade object

doMoveResourceToPathRegex

ContentUpgrade doMoveResourceToPathRegex(String matchPattern,
                                         String targetPathExpr)

Moves a resource if its path matches the pattern to the path obtained by applying the replacement expression

Parameters:

matchPattern - regular expression for matching the resource path

targetPathExpr - expression to calculate the target path, can contain matched group references $1, $2, ...

Returns:

upgrade object

doDeleteResource

ContentUpgrade doDeleteResource()

Deletes the resource.

Returns:

upgrade object

doActivateResource

ContentUpgrade doActivateResource()

Activates the resource.

Returns:

upgrade object

doDeactivateResource

ContentUpgrade doDeactivateResource()

Deactivates the resource.

Returns:

upgrade object

doCustomResourceBasedAction

ContentUpgrade doCustomResourceBasedAction(CustomResourceAction action)

Performs a custom action with providing a function.

Parameters:

action - action to perform on resource

Returns:

upgrade object

doActivateContainingPage

ContentUpgrade doActivateContainingPage()

Activates the page where the resource is located.

Returns:

upgrade object

doTreeActivateContainingPage

ContentUpgrade doTreeActivateContainingPage()

Activates the page tree where the resource is located.

Returns:

upgrade object

doTreeActivateContainingPage

ContentUpgrade doTreeActivateContainingPage(boolean skipDeactivated)

Activates the page tree where the resource is located.

Parameters:

skipDeactivated - skip pages that are deactivated

Returns:

upgrade object

doDeactivateContainingPage

ContentUpgrade doDeactivateContainingPage()

Deactivates the page where the resource is located.

Returns:

upgrade object

doDeleteContainingPage

ContentUpgrade doDeleteContainingPage()

Deletes the page where the resource is located. This will not work if called multiple times for the same page.

Returns:

upgrade object

doAddTagsToContainingPage

ContentUpgrade doAddTagsToContainingPage(String... tags)

Adds tags to the containing page of the matching resource.

Parameters:

tags - tag IDs or paths

Returns:

upgrade object

doSetTagsForContainingPage

ContentUpgrade doSetTagsForContainingPage(String... tags)

Sets tags for the containing page of the matching resource. All existing tags are overwritten.

Parameters:

tags - tag IDs or paths

Returns:

upgrade object

doRemoveTagsFromContainingPage

ContentUpgrade doRemoveTagsFromContainingPage(String... tags)

Removes tags from the containing page of the matching resource.

Parameters:

tags - tag IDs or paths

Returns:

upgrade object

doCheckPageRendering

ContentUpgrade doCheckPageRendering()

Checks if the containing page renders with status code 200.

Returns:

upgrade object

doCheckPageRendering

ContentUpgrade doCheckPageRendering(int code)

Checks if the containing page renders with given status code.

Parameters:

code - status code

Returns:

upgrade object

doCheckPageRendering

ContentUpgrade doCheckPageRendering(String textPresent)

Checks if the containing page renders with status code 200 and contains given text.

Parameters:

textPresent - page content must include this text

Returns:

upgrade object

doCheckPageRendering

ContentUpgrade doCheckPageRendering(String textPresent,
                                    String textNotPresent)

Checks if the containing page renders with status code 200 and (not) contains given text.

Parameters:

textPresent - page content must include this text (can be null)

textNotPresent - page content must not include this text (can be null)

Returns:

upgrade object

printPath

ContentUpgrade printPath()

Print path

Returns:

upgrade object

printProperty

ContentUpgrade printProperty(String property)

Print property

Parameters:

property - property name

Returns:

upgrade object

printJson

ContentUpgrade printJson()

Prints the properties json

Returns:

upgrade object

run

void run()
  throws org.apache.sling.api.resource.PersistenceException,
         AecuException

Saves all changes to repository.

Throws:

org.apache.sling.api.resource.PersistenceException - error during execution

AecuException - other error

dryRun

void dryRun()
     throws org.apache.sling.api.resource.PersistenceException,
            AecuException

Performs a dry-run. No changes are written to CRX.

Throws:

org.apache.sling.api.resource.PersistenceException - error doing dry-run

AecuException - other error

run

void run(boolean dryRun)
  throws org.apache.sling.api.resource.PersistenceException,
         AecuException

Executes a run or a dryRun depending on the dryRun parameter value.

Parameters:

dryRun - dryRun option

Throws:

org.apache.sling.api.resource.PersistenceException - error during execution

AecuException - other error