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

Class CloudFrontInvalidationProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.aws.CloudFrontInvalidationProcessor

All Implemented Interfaces:

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

public class CloudFrontInvalidationProcessor
extends AbstractMainDeploymentProcessor

Implementation of DeploymentProcessor that invalidates the changed files in the given AWS Cloudfront distributions. Can be configured with the following YAML properties:

• distributions: List of distributions ids

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected AwsClientBuilderConfigurer	builderConfigurer	Helper class the configures credentials and other properties for a AmazonCloudFront client.
protected static final String	CONFIG_KEY_DISTRIBUTIONS
protected String[]	distributions	List of distribution ids

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

Method Summary

Modifier and Type	Method	Description
protected com.amazonaws.services.cloudfront.AmazonCloudFront	buildClient()	Builds the AmazonCloudFront client.
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

CONFIG_KEY_DISTRIBUTIONS

protected static final String CONFIG_KEY_DISTRIBUTIONS

See Also:

• Constant Field Values

builderConfigurer

protected AwsClientBuilderConfigurer builderConfigurer

Helper class the configures credentials and other properties for a AmazonCloudFront client.

distributions

protected String[] distributions

List of distribution ids

Constructor Details

CloudFrontInvalidationProcessor

public CloudFrontInvalidationProcessor()

Method Details

doInit

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

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

doMainProcess

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

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

buildClient

protected com.amazonaws.services.cloudfront.AmazonCloudFront buildClient()

Builds the AmazonCloudFront client.

doDestroy

protected void doDestroy()
                  throws DeployerException

Allows extending classes perform any custom cleanup

Specified by:

doDestroy in class AbstractDeploymentProcessor

Throws:

DeployerException - if an error occurs