Package org.craftercms.deployer.impl.processors.git

Class GitUpdateCommitIdProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.git.GitUpdateCommitIdProcessor

All Implemented Interfaces:

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

public class GitUpdateCommitIdProcessor
extends AbstractMainDeploymentProcessor

Implementation of AbstractMainDeploymentProcessor that updates the processed commit id.

Since:

3.1.8

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessedCommitsStore	processedCommitsStore

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
GitUpdateCommitIdProcessor(ProcessedCommitsStore processedCommitsStore)

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

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

processedCommitsStore

protected ProcessedCommitsStore processedCommitsStore

Constructor Details

GitUpdateCommitIdProcessor

@ConstructorProperties("processedCommitsStore")
public GitUpdateCommitIdProcessor(ProcessedCommitsStore processedCommitsStore)

Method Details

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

doInit

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

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

DeployerException - if there's a general exception on init

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