Package org.craftercms.deployer.impl.processors

Class ScriptProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.ScriptProcessor

All Implemented Interfaces:

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

public class ScriptProcessor
extends AbstractMainDeploymentProcessor
implements org.springframework.context.ApplicationContextAware

Implementation of DeploymentProcessor that delegates execution to a Groovy script Can be configured with the following YAML properties:

• scriptPath: The relative path of the script to execute

Since:

3.1.12

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
static final String	CONFIG_KEY_SCRIPT_PATH
protected final org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor	sandboxInterceptor
static final String	SCRIPT_VAR_APP_CTX
static final String	SCRIPT_VAR_DEPLOYMENT
static final String	SCRIPT_VAR_EXECUTION
static final String	SCRIPT_VAR_FILTERED_CHANGE_SET
static final String	SCRIPT_VAR_LOGGER
static final String	SCRIPT_VAR_ORIGINAL_CHANGE_SET
protected final groovy.util.GroovyScriptEngine	scriptEngine
protected String	scriptPath	The relative path of the script to execute

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
ScriptProcessor(groovy.util.GroovyScriptEngine scriptEngine, org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor sandboxInterceptor)

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
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

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

CONFIG_KEY_SCRIPT_PATH

public static final String CONFIG_KEY_SCRIPT_PATH

See Also:

• Constant Field Values

SCRIPT_VAR_LOGGER

public static final String SCRIPT_VAR_LOGGER

See Also:

• Constant Field Values

SCRIPT_VAR_APP_CTX

public static final String SCRIPT_VAR_APP_CTX

See Also:

• Constant Field Values

SCRIPT_VAR_DEPLOYMENT

public static final String SCRIPT_VAR_DEPLOYMENT

See Also:

• Constant Field Values

SCRIPT_VAR_EXECUTION

public static final String SCRIPT_VAR_EXECUTION

See Also:

• Constant Field Values

SCRIPT_VAR_FILTERED_CHANGE_SET

public static final String SCRIPT_VAR_FILTERED_CHANGE_SET

See Also:

• Constant Field Values

SCRIPT_VAR_ORIGINAL_CHANGE_SET

public static final String SCRIPT_VAR_ORIGINAL_CHANGE_SET

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

scriptEngine

protected final groovy.util.GroovyScriptEngine scriptEngine

sandboxInterceptor

protected final org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor sandboxInterceptor

scriptPath

protected String scriptPath

The relative path of the script to execute

Constructor Details

ScriptProcessor

@ConstructorProperties({"scriptEngine","sandboxInterceptor"})
public ScriptProcessor(groovy.util.GroovyScriptEngine scriptEngine,
 org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor sandboxInterceptor)

Method Details

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

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()

Description copied from class: AbstractDeploymentProcessor

Allows extending classes perform any custom cleanup

Specified by:

doDestroy in class AbstractDeploymentProcessor

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