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

Class AbstractXsltFileUpgradeOperation

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BatchXsltFileUpgradeOperation, XsltFileUpgradeOperation

public abstract class AbstractXsltFileUpgradeOperation
extends AbstractUpgradeOperation

Base implementation of UpgradeOperation for all operations related to an XSLT template.

Supported YAML properties:

• template: (required) the path to the XSLT template to apply

Since:

3.1.1

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_TEMPLATE
protected org.springframework.core.io.Resource	template	Template file to be applied.

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
AbstractXsltFileUpgradeOperation(StudioConfiguration studioConfiguration)

Method Summary

Modifier and Type	Method	Description
protected void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)
protected void	executeTemplate(StudioUpgradeContext context, String path, OutputStream os)
protected URIResolver	getURIResolver(StudioUpgradeContext context)
void	setTemplate(org.springframework.core.io.Resource template)

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

commitAllChanges, doExecute, 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_TEMPLATE

public static final String CONFIG_KEY_TEMPLATE

See Also:

• Constant Field Values

template

protected org.springframework.core.io.Resource template

Template file to be applied.

Constructor Details

AbstractXsltFileUpgradeOperation

public AbstractXsltFileUpgradeOperation(StudioConfiguration studioConfiguration)

Method Details

setTemplate

public void setTemplate(org.springframework.core.io.Resource template)

doInit

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

Overrides:

doInit in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation<String>

executeTemplate

protected void executeTemplate(StudioUpgradeContext context,
 String path,
 OutputStream os)
                        throws org.craftercms.commons.upgrade.exception.UpgradeException

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException

getURIResolver

protected URIResolver getURIResolver(StudioUpgradeContext context)