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

Interface ContentUpgrade

public interface ContentUpgrade

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

Author:

Roxana Muresan

Method Summary

Modifier and Type	Method and Description
ContentUpgrade	doActivateContainingPage() Activates the page where the resource is located.
ContentUpgrade	doAddValuesToMultiValueProperty(String name, String[] values) Adds values to a multivalue property.
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	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	doMoveResourceToRelativePath(String relativePath) Moves a resource to a relative path.
ContentUpgrade	doRemoveValuesOfMultiValueProperty(String name, String[] values) Removes values of a multivalue property.
ContentUpgrade	doRenameProperty(String oldName, String newName) Renames a property if existing.
ContentUpgrade	doReplaceValuesOfMultiValueProperty(String name, String[] oldValues, String[] newValues) Replaces values in a multivalue property.
ContentUpgrade	doSetProperty(String name, Object value) Sets a property value.
StringBuffer	dryRun() Performs a dry-run.
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	filterByProperties(Map<String,Object> conditionProperties) Filters by properties.
ContentUpgrade	filterByProperty(String name, Object value) Filters by a single property.
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	forResourcesInSubtree(String path) Loops recursive over all resources contained in the subtree at the given path.
ContentUpgrade	printPath() Print path
StringBuffer	run() Saves all changes to repository.
StringBuffer	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

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

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

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

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

doDeleteResource

ContentUpgrade doDeleteResource()

Deletes 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

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

printPath

ContentUpgrade printPath()

Print path

Returns:

upgrade object

run

StringBuffer run()
          throws org.apache.sling.api.resource.PersistenceException

Saves all changes to repository.

Returns:

output

Throws:

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

dryRun

StringBuffer dryRun()
             throws org.apache.sling.api.resource.PersistenceException

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

Returns:

output

Throws:

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

run

StringBuffer run(boolean dryRun)
          throws org.apache.sling.api.resource.PersistenceException

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

Parameters:

dryRun - dryRun option

Returns:

output

Throws:

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