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

Class AbstractPluginDescriptorUpgradeOperation

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.plugin.AbstractPluginDescriptorUpgradeOperation

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:

DescriptorV2UpgradeOperation

public abstract class AbstractPluginDescriptorUpgradeOperation
extends AbstractUpgradeOperation

Since:

3.1.1

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_DESCRIPTOR_PATH
static final String	CONFIG_KEY_DESCRIPTOR_VERSION
protected String	descriptorPath
protected org.craftercms.commons.plugin.PluginDescriptorReader	descriptorReader
protected String	descriptorVersion

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
AbstractPluginDescriptorUpgradeOperation(StudioConfiguration studioConfiguration, org.craftercms.commons.plugin.PluginDescriptorReader descriptorReader)

Method Summary

Modifier and Type	Method	Description
void	doExecute(StudioUpgradeContext context)
protected void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration config)
protected abstract void	doPluginDescriptorUpdates(org.craftercms.commons.plugin.model.PluginDescriptor descriptor)

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_DESCRIPTOR_PATH

public static final String CONFIG_KEY_DESCRIPTOR_PATH

See Also:

• Constant Field Values

CONFIG_KEY_DESCRIPTOR_VERSION

public static final String CONFIG_KEY_DESCRIPTOR_VERSION

See Also:

• Constant Field Values

descriptorReader

protected org.craftercms.commons.plugin.PluginDescriptorReader descriptorReader

descriptorPath

protected String descriptorPath

descriptorVersion

protected String descriptorVersion

Constructor Details

AbstractPluginDescriptorUpgradeOperation

public AbstractPluginDescriptorUpgradeOperation(StudioConfiguration studioConfiguration,
 org.craftercms.commons.plugin.PluginDescriptorReader descriptorReader)

Method Details

doInit

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

Overrides:

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

doExecute

public void doExecute(StudioUpgradeContext context)
               throws org.craftercms.commons.upgrade.exception.UpgradeException

Specified by:

doExecute in class AbstractUpgradeOperation

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException

doPluginDescriptorUpdates

protected abstract void doPluginDescriptorUpdates(org.craftercms.commons.plugin.model.PluginDescriptor descriptor)
                                           throws org.craftercms.commons.upgrade.exception.UpgradeException

Throws:

org.craftercms.commons.upgrade.exception.UpgradeException