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

Class AddFileUpgradeOperation

java.lang.Object

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

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

All Implemented Interfaces:

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

public class AddFileUpgradeOperation
extends AbstractUpgradeOperation

Implementation of UpgradeOperation that adds a new file to a repository.

Supported YAML properties:

• path: (required) the relative path to write the file in the repository
• file: (required) the location of the file to copy

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_FILE
static String	CONFIG_KEY_PATH
protected org.springframework.core.io.Resource	file The file to copy from the classpath.
protected String	path The path to write the file.

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

applicationContext, commitDetails, CONFIG_KEY_COMMIT_DETAILS, contentRepository, currentVersion, dataSource, generalLockService, nextVersion, servletContext, studioConfiguration

Constructor Summary

Constructors

Constructor and Description
AddFileUpgradeOperation()

Method Summary

Modifier and Type	Method and Description
void	doInit(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
void	execute(String site) Performs a single upgrade operation.

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

commitAllChanges, getCommitMessage, getConnection, getContentRepository, getGeneralLockService, getProperty, getRepositoryPath, init, loadResource, setApplicationContext, setContentRepository, setDataSource, setGeneralLockService, setServletContext, setStudioConfiguration, writeToRepo

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_PATH

public static final String CONFIG_KEY_PATH

See Also:

Constant Field Values

CONFIG_KEY_FILE

public static final String CONFIG_KEY_FILE

See Also:

Constant Field Values

path

protected String path

The path to write the file.

file

protected org.springframework.core.io.Resource file

The file to copy from the classpath.

Constructor Detail

AddFileUpgradeOperation

public AddFileUpgradeOperation()

Method Detail

doInit

public void doInit(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)

Overrides:

doInit in class AbstractUpgradeOperation

execute

public void execute(String site)
             throws UpgradeException

Performs a single upgrade operation.

Parameters:

site - the name of the site

Throws:

UpgradeException - if there is any error performing the upgrade