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

Class AbstractUpgradeOperation

java.lang.Object

org.craftercms.studio.impl.v2.upgrade.operations.AbstractUpgradeOperation

All Implemented Interfaces:

UpgradeOperation, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

AbstractContentUpgradeOperation, AbstractPluginDescriptorUpgradeOperation, AbstractXsltFileUpgradeOperation, AddFileUpgradeOperation, AddSiteUuidOperation, BlueprintsUpgradeOperation, DbEncryptionUpgradeOperation, DbScriptUpgradeOperation, DbVersionUpgradeOperation, DeleteUpgradeOperation, GlobalRepoUpgradeOperation, RenameUpgradeOperation

public abstract class AbstractUpgradeOperation
extends Object
implements UpgradeOperation, org.springframework.web.context.ServletContextAware, org.springframework.context.ApplicationContextAware

Provides access to system components for all upgrade operations.

Supported YAML properties:

• currentVersion: (required) the version number that will be upgraded
• nextVersion (required) the version number to use after the upgrade
• commitDetails(optional) any additional details to include in the commits if there are repository changes

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext The application context
protected String	commitDetails Additional details for the commit message (optional)
static String	CONFIG_KEY_COMMIT_DETAILS
protected ContentRepository	contentRepository The content repository.
protected String	currentVersion The current version.
protected DataSource	dataSource The database data source.
protected GeneralLockService	generalLockService
protected String	nextVersion The next version.
protected javax.servlet.ServletContext	servletContext The servlet context.
protected StudioConfiguration	studioConfiguration The Studio configuration.

Constructor Summary

Constructors

Constructor and Description
AbstractUpgradeOperation()

Method Summary

Modifier and Type	Method and Description
protected void	commitAllChanges(String site)
protected void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
protected String	getCommitMessage()
Connection	getConnection()
ContentRepository	getContentRepository()
GeneralLockService	getGeneralLockService()
String	getProperty(String key)
protected Path	getRepositoryPath(String site)
void	init(String sourceVersion, String targetVersion, org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config) Initializes the instance with the given configuration.
protected org.springframework.core.io.Resource	loadResource(String path)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContentRepository(ContentRepository contentRepository)
void	setDataSource(DataSource dataSource)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setServletContext(javax.servlet.ServletContext servletContext)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
protected void	writeToRepo(String site, String path, InputStream content)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.studio.api.v2.upgrade.UpgradeOperation

execute

Field Detail

CONFIG_KEY_COMMIT_DETAILS

public static final String CONFIG_KEY_COMMIT_DETAILS

See Also:

Constant Field Values

currentVersion

protected String currentVersion

The current version.

nextVersion

protected String nextVersion

The next version.

commitDetails

protected String commitDetails

Additional details for the commit message (optional)

studioConfiguration

protected StudioConfiguration studioConfiguration

The Studio configuration.

dataSource

protected DataSource dataSource

The database data source.

contentRepository

protected ContentRepository contentRepository

The content repository.

servletContext

protected javax.servlet.ServletContext servletContext

The servlet context.

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

The application context

generalLockService

protected GeneralLockService generalLockService

Constructor Detail

AbstractUpgradeOperation

public AbstractUpgradeOperation()

Method Detail

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setDataSource

public void setDataSource(DataSource dataSource)

getConnection

public Connection getConnection()
                         throws SQLException

Throws:

SQLException

getContentRepository

public ContentRepository getContentRepository()

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

getProperty

public String getProperty(String key)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

getGeneralLockService

public GeneralLockService getGeneralLockService()

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

init

public void init(String sourceVersion,
                 String targetVersion,
                 org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
          throws UpgradeException

Description copied from interface: UpgradeOperation

Initializes the instance with the given configuration.

Specified by:

init in interface UpgradeOperation

Parameters:

sourceVersion - the starting version

targetVersion - the target version

config - operation configuration

Throws:

UpgradeException

doInit

protected void doInit(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
               throws org.craftercms.commons.config.ConfigurationException

Throws:

org.craftercms.commons.config.ConfigurationException

writeToRepo

protected void writeToRepo(String site,
                           String path,
                           InputStream content)

commitAllChanges

protected void commitAllChanges(String site)
                         throws UpgradeException

Throws:

UpgradeException

getCommitMessage

protected String getCommitMessage()

getRepositoryPath

protected Path getRepositoryPath(String site)

loadResource

protected org.springframework.core.io.Resource loadResource(String path)