Package org.craftercms.deployer.impl.processors.aws

Class S3DeploymentEventsProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.aws.AbstractS3Processor

org.craftercms.deployer.impl.processors.aws.S3DeploymentEventsProcessor

All Implemented Interfaces:

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

public class S3DeploymentEventsProcessor
extends AbstractS3Processor

Implementation of AbstractS3Processor that uploads the deployment events to AWS S3. Can be configured with the following YAML properties:

• deploymentEventsFileUrl: URL of the deployment events file, relative to the local git repo

Since:

3.1.8

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIG_KEY_DEPLOYMENT_EVENTS_FILE_URL
protected static final String	DEFAULT_DEPLOYMENT_EVENTS_FILE_URL
protected String	deploymentEventsFileUrl	URL of the deployment events file, relative to the local git repo.
protected DeploymentEventsStore<?,Path>	store

Fields inherited from class org.craftercms.deployer.impl.processors.aws.AbstractS3Processor

builderConfigurer, CONFIG_KEY_URL, DELIMITER, logger, s3Url, threadPoolTaskExecutor

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
S3DeploymentEventsProcessor(org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor threadPoolTaskExecutor, DeploymentEventsStore<?,Path> store)

Method Summary

Modifier and Type	Method	Description
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.aws.AbstractS3Processor

buildAsyncClient, buildClient, buildTransferManager, doDestroy, getBucket, getS3BaseKey, getS3Key

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, getDeploymentParam, 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

DEFAULT_DEPLOYMENT_EVENTS_FILE_URL

protected static final String DEFAULT_DEPLOYMENT_EVENTS_FILE_URL

See Also:

• Constant Field Values

CONFIG_KEY_DEPLOYMENT_EVENTS_FILE_URL

protected static final String CONFIG_KEY_DEPLOYMENT_EVENTS_FILE_URL

See Also:

• Constant Field Values

store

protected DeploymentEventsStore<?,Path> store

deploymentEventsFileUrl

protected String deploymentEventsFileUrl

URL of the deployment events file, relative to the local git repo.

Constructor Details

S3DeploymentEventsProcessor

@ConstructorProperties({"threadPoolTaskExecutor","store"})
public S3DeploymentEventsProcessor(org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor threadPoolTaskExecutor,
 DeploymentEventsStore<?,Path> store)

Method Details

doInit

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

Description copied from class: AbstractS3Processor

Allows extending classes perform any custom initialization

Overrides:

doInit in class AbstractS3Processor

Parameters:

config - the bean's configuration

Throws:

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

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