Package org.craftercms.deployer.impl.processors

Class CommandLineProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.CommandLineProcessor

All Implemented Interfaces:

DeploymentProcessor, InitializableByConfigBean, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class CommandLineProcessor
extends AbstractMainDeploymentProcessor

Processor that runs a command line process. A processor instance can be configured with the following YAML properties:

• workingDir: The directory from which the process will run. (defaults to the deployer's folder)
• command: The full command that the process will run.
• processTimeoutSecs: The amount of seconds to wait for the process to finish. (defaults to 30)
• includeChanges: Additional parameters will be added to the command. (defaults to false)
  Example: script.sh SITE_NAME OPERATION (CREATE | UPDATE | DELETE) FILE (relative path of the file)

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COMMAND_CONFIG_KEY
protected static final long	DEFAULT_PROCESS_TIMEOUT_SECS
protected static final String	INCLUDE_CHANGES_CONFIG_KEY
static final String	OPERATION_CREATE
static final String	OPERATION_DELETE
static final String	OPERATION_UPDATE
protected static final String	PROCESS_TIMEOUT_SECS_CONFIG_KEY
protected static final String	WORKING_DIR_CONFIG_KEY

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

FAIL_DEPLOYMENT_CONFIG_KEY, failDeploymentOnFailure

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

alwaysRun, env, excludeFiles, includeFiles, JUMPING_TO_PARAM_NAME, jumpTo, label, name, siteName, targetId

Constructor Summary

Constructors

Constructor	Description
CommandLineProcessor()

Method Summary

Modifier and Type	Method	Description
protected void	doDestroy()	Allows extending classes perform any custom cleanup
protected void	doInit(org.apache.commons.configuration2.Configuration config)	Allows extending classes perform any custom initialization
protected ChangeSet	doMainProcess(Deployment deployment, ProcessorExecution execution, ChangeSet filteredChangeSet, ChangeSet originalChangeSet)	Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline
protected void	executeProcess(String site, String operation, String file)
protected void	processFiles(String site, String operation, List<String> files)

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

doExecute, failDeploymentOnProcessorFailure, init, shouldExecute

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

destroy, execute, getFilteredChangeSet, isJumpToActive, isPostDeployment, setBeanName, setEnv, setSiteName, setTargetId, shouldIncludeFile, startJumpTo, supportsMode

Methods inherited from class java.lang.Object

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

Field Details

OPERATION_CREATE

public static final String OPERATION_CREATE

See Also:

• Constant Field Values

OPERATION_UPDATE

public static final String OPERATION_UPDATE

See Also:

• Constant Field Values

OPERATION_DELETE

public static final String OPERATION_DELETE

See Also:

• Constant Field Values

WORKING_DIR_CONFIG_KEY

protected static final String WORKING_DIR_CONFIG_KEY

See Also:

• Constant Field Values

COMMAND_CONFIG_KEY

protected static final String COMMAND_CONFIG_KEY

See Also:

• Constant Field Values

PROCESS_TIMEOUT_SECS_CONFIG_KEY

protected static final String PROCESS_TIMEOUT_SECS_CONFIG_KEY

See Also:

• Constant Field Values

INCLUDE_CHANGES_CONFIG_KEY

protected static final String INCLUDE_CHANGES_CONFIG_KEY

See Also:

• Constant Field Values

DEFAULT_PROCESS_TIMEOUT_SECS

protected static final long DEFAULT_PROCESS_TIMEOUT_SECS

See Also:

• Constant Field Values

Constructor Details

CommandLineProcessor

public CommandLineProcessor()

Method Details

doInit

protected void doInit(org.apache.commons.configuration2.Configuration config)
               throws org.craftercms.commons.config.ConfigurationException

Description copied from class: AbstractDeploymentProcessor

Allows extending classes perform any custom initialization

Specified by:

doInit in class AbstractDeploymentProcessor

Parameters:

config - the bean's configuration

Throws:

org.craftercms.commons.config.ConfigurationException - if there's configuration related exception

doDestroy

protected void doDestroy()
                  throws DeployerException

Description copied from class: AbstractDeploymentProcessor

Allows extending classes perform any custom cleanup

Specified by:

doDestroy in class AbstractDeploymentProcessor

Throws:

DeployerException - if an error occurs

doMainProcess

protected ChangeSet doMainProcess(Deployment deployment,
 ProcessorExecution execution,
 ChangeSet filteredChangeSet,
 ChangeSet originalChangeSet)
                           throws DeployerException

Description copied from class: AbstractMainDeploymentProcessor

Performs the actual work of processing the files in the ChangeSet, it is also possible to return a new ChangeSet to be used for the following processors in the pipeline

Specified by:

doMainProcess in class AbstractMainDeploymentProcessor

Parameters:

deployment - the current deployment

execution - the current execution

filteredChangeSet - the filtered change set (as returned by AbstractDeploymentProcessor.getFilteredChangeSet(ChangeSet))

originalChangeSet - the original change set (as returned by the previous processors in the pipeline)

Returns:

a new ChangeSet or null

Throws:

DeployerException - if there is any error processing the ChangeSet

processFiles

protected void processFiles(String site,
 String operation,
 List<String> files)
                     throws DeployerException

Throws:

DeployerException

executeProcess

protected void executeProcess(String site,
 String operation,
 String file)
                       throws DeployerException

Throws:

DeployerException