info.magnolia.module.resources.setup

Class ResourceCleanUpTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.AbstractRepositoryTask

info.magnolia.module.resources.setup.ResourceCleanUpTask

All Implemented Interfaces:

info.magnolia.module.delta.Task

public class ResourceCleanUpTask
extends info.magnolia.module.delta.AbstractRepositoryTask

Cleanup process for previously installed JCR resources.

Since 5.4, a side effect of the new Resources API + app is that previously installed resources appear twice in the new app (one from the classpath with extension, one from JCR without extension).

Installing resources was traditionally how resources used to be accessed, over URI2ResourcesRepositoryMapping, at /resources. This is still working and supported, but not encouraged in favor of the new resource loading cascade.

• Resources had to be installed in order to be found by the URI2Repository mapping
• Those installed resources had to be bypassed in order to be served from the classpath instead.

Also, historically, dots were not allowed in JCR node names, hence why extension used to be stripped.

ResourceCleanUpTask tries to restore extension in JCR node names to resolve this problem.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BINARY_RESOURCES_TEMPLATE
protected static String	PROPERTY_EXTENSION
protected static String	PROPERTY_REFERENCE
protected static String	PROPERTY_TEMPLATE
protected static String	PROPERTY_TEXT
protected static String	REFERENCES_RESOURCES_TEMPLATE
protected static String	RESOURCE_PROCESSED
protected static String	RESOURCES_PREFIX

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
ResourceCleanUpTask(String name, String description, Pattern pathPattern, UpdateResourceReferencesTask onSuccess) Restores resource extension in JCR node names, for resources matching a given pattern.
ResourceCleanUpTask(String name, String description, Set<String> absPaths, UpdateResourceReferencesTask onSuccess) Restores resource extension in JCR node names, for a set of specific resources.
ResourceCleanUpTask(String name, String description, String parentPath, UpdateResourceReferencesTask onSuccess) Restores resource extension in JCR node names, by visiting a JCR sub-tree recursively, from the given parent path.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(info.magnolia.module.InstallContext installContext)
protected Iterator<javax.jcr.Node>	findResourceNodes()
protected Map<String,String>	getChangedPaths()

Methods inherited from class info.magnolia.module.delta.AbstractRepositoryTask

execute

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_TEMPLATE

protected static final String PROPERTY_TEMPLATE

See Also:

Constant Field Values

PROPERTY_EXTENSION

protected static final String PROPERTY_EXTENSION

See Also:

Constant Field Values

PROPERTY_TEXT

protected static final String PROPERTY_TEXT

See Also:

Constant Field Values

PROPERTY_REFERENCE

protected static final String PROPERTY_REFERENCE

See Also:

Constant Field Values

RESOURCES_PREFIX

protected static final String RESOURCES_PREFIX

See Also:

Constant Field Values

BINARY_RESOURCES_TEMPLATE

protected static final String BINARY_RESOURCES_TEMPLATE

See Also:

Constant Field Values

REFERENCES_RESOURCES_TEMPLATE

protected static final String REFERENCES_RESOURCES_TEMPLATE

See Also:

Constant Field Values

RESOURCE_PROCESSED

protected static final String RESOURCE_PROCESSED

See Also:

Constant Field Values

Constructor Detail

ResourceCleanUpTask

public ResourceCleanUpTask(String name,
                   String description,
                   String parentPath,
                   UpdateResourceReferencesTask onSuccess)

Restores resource extension in JCR node names, by visiting a JCR sub-tree recursively, from the given parent path.

• First the task resolves extension for resource nodes, by the extension property, binary node extension property, or resource template
• Then it tries to restore this extension if it's not in node-name already

If resources already exist *in JCR* with extension and same content, they are considered redundant and are removed.
If resources already exist on classpath or file-system with extension and same content, they are renamed to restore extension; mind that they are kept in JCR so that bypassed resources keep working via URI2RepositoryMapping.

Parameters:

parentPath - a path in JCR resources workspace, to start visiting from

onSuccess - an UpdateResourceReferencesTask might be needed to update resource references for renamed resources

ResourceCleanUpTask

public ResourceCleanUpTask(String name,
                   String description,
                   Pattern pathPattern,
                   UpdateResourceReferencesTask onSuccess)

Restores resource extension in JCR node names, for resources matching a given pattern.

• First the task looks up for resource files matching the pattern in module resources
• Then it tries to find corresponding nodes in JCR, with extension stripped and same content

If resources already exist *in JCR* with extension and same content, they are considered redundant and are removed.
If resources already exist on classpath or file-system with extension and same content, they are renamed to restore extension; mind that they are kept in JCR so that bypassed resources keep working via URI2RepositoryMapping.

Parameters:

pathPattern - a Pattern to match resource paths in module resources, including extension.

onSuccess - an UpdateResourceReferencesTask might be needed to update resource references for renamed resources

ResourceCleanUpTask

public ResourceCleanUpTask(String name,
                   String description,
                   Set<String> absPaths,
                   UpdateResourceReferencesTask onSuccess)

Restores resource extension in JCR node names, for a set of specific resources.

• First the task looks up for resource files in module resources
• Then it tries to find corresponding nodes in JCR, with extension stripped and same content

If resources already exist *in JCR* with extension and same content, they are considered redundant and are removed.
If resources already exist on classpath or file-system with extension and same content, they are renamed to restore extension; mind that they are kept in JCR so that bypassed resources keep working via URI2RepositoryMapping.

Parameters:

absPaths - a set of existing resource paths in module resources, including extension.

onSuccess - an UpdateResourceReferencesTask might be needed to update resource references for renamed resources

Method Detail

doExecute

protected void doExecute(info.magnolia.module.InstallContext installContext)
                  throws javax.jcr.RepositoryException,
                         info.magnolia.module.delta.TaskExecutionException

Specified by:

doExecute in class info.magnolia.module.delta.AbstractRepositoryTask

Throws:

javax.jcr.RepositoryException

info.magnolia.module.delta.TaskExecutionException

getChangedPaths

protected Map<String,String> getChangedPaths()

findResourceNodes

protected Iterator<javax.jcr.Node> findResourceNodes()
                                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException