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

Class XsltFileUpgradeOperation

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.AbstractXsltFileUpgradeOperation

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

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 XsltFileUpgradeOperation
extends AbstractXsltFileUpgradeOperation

Implementation of UpgradeOperation that updates a single file using an XSLT template.

Supported YAML properties:

• path: (optional) the relative path to update in the repository
• target: (optional) the relative path in the repository to use as output

Since:

3.1.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_PATH
static final String	CONFIG_KEY_TARGET
protected String	path	Path of the file to use as input
protected String	target	Path of the file to use as output

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

CONFIG_KEY_TEMPLATE, template

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
XsltFileUpgradeOperation(StudioConfiguration studioConfiguration, DataSource dataSource)

Method Summary

Modifier and Type	Method	Description
void	doExecute(StudioUpgradeContext context)
void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)
void	setPath(String path)

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

executeTemplate, getURIResolver, setTemplate

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_PATH

public static final String CONFIG_KEY_PATH

See Also:

• Constant Field Values

CONFIG_KEY_TARGET

public static final String CONFIG_KEY_TARGET

See Also:

• Constant Field Values

path

protected String path

Path of the file to use as input

target

protected String target

Path of the file to use as output

Constructor Details

XsltFileUpgradeOperation

public XsltFileUpgradeOperation(StudioConfiguration studioConfiguration,
 DataSource dataSource)

Method Details

setPath

public void setPath(String path)

doInit

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

Overrides:

doInit in class AbstractXsltFileUpgradeOperation

doExecute

public void doExecute(StudioUpgradeContext context)
               throws Exception

Specified by:

doExecute in class AbstractUpgradeOperation

Throws:

Exception