br.com.ingenieux.mojo.beanstalk.env

Class ReplaceEnvironmentMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

br.com.ingenieux.mojo.aws.AbstractAWSMojo<com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient>

br.com.ingenieux.mojo.beanstalk.AbstractBeanstalkMojo

br.com.ingenieux.mojo.beanstalk.AbstractNeedsEnvironmentMojo

br.com.ingenieux.mojo.beanstalk.env.CreateEnvironmentMojo

br.com.ingenieux.mojo.beanstalk.env.ReplaceEnvironmentMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

@Mojo(name="replace-environment")
public class ReplaceEnvironmentMojo
extends CreateEnvironmentMojo

Launches a new environment and, when done, replace with the existing, terminating when needed. It combines both create-environment, wait-for-environment, swap-environment-cnames, and terminate-environment

Since:

0.2.0

Nested Class Summary

Nested classes/interfaces inherited from class br.com.ingenieux.mojo.beanstalk.AbstractNeedsEnvironmentMojo

AbstractNeedsEnvironmentMojo.ConfigurableOptionSetting

Field Summary

Fields inherited from class br.com.ingenieux.mojo.beanstalk.env.CreateEnvironmentMojo

BEANSTALK_TAG_PREFIX, environmentName

Fields inherited from class br.com.ingenieux.mojo.beanstalk.AbstractNeedsEnvironmentMojo

applicationName, BEANSTALKX_PREFIX, COMMON_PARAMETERS, COS_COMPARATOR, curEnv, environmentRef, project

Fields inherited from class br.com.ingenieux.mojo.beanstalk.AbstractBeanstalkMojo

endpointUrl

Fields inherited from class br.com.ingenieux.mojo.aws.AbstractAWSMojo

awsCredentialsProvider, clientFactory, context, credentialId, DEFAULT_CHARSET, ignoreExceptions, objectMapper, regionName, regionObj, serverId, session, settings, verbose, version

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ReplaceEnvironmentMojo()

Method Summary

Modifier and Type	Method and Description
protected boolean	containsNamedEnvironment(String environmentName) Boolean predicate for named environment
protected Object	executeInternal()
protected String	formatAndTruncate(String mask, int maxLen, Object... args) Elastic Beanstalk Contains a Max EnvironmentName Limit.
protected String	getCNamePrefixToCreate() Creates a cname prefix if needed, or returns the desired one
protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription	getEnvironmentFor(String applicationName, String cnamePrefix) Returns the environment description matching applicationName and environmentRef
protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription	handleResults(Collection<com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription> environments)
protected boolean	hasEnvironmentFor(String applicationName, String cnamePrefix) Boolean predicate for environment existence
void	sleepInterval(int pollInterval)
protected void	swapEnvironmentCNames(String newEnvironmentId, String curEnvironmentId, String cnamePrefix, com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription newEnv) Swaps environment cnames
protected void	terminateEnvironment(String environmentId) Terminates and waits for an environment
protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription	waitForEnvironment(String environmentId) Waits for an environment to get ready.
protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription	waitForGreenEnvironment(String environmentId) TODO: What is Coffee anyway? Waits for an environment to become green.

Methods inherited from class br.com.ingenieux.mojo.beanstalk.env.CreateEnvironmentMojo

configure, createEnvironment, projectTags

Methods inherited from class br.com.ingenieux.mojo.beanstalk.AbstractNeedsEnvironmentMojo

getEnvironmentsFor, introspectOptionSettings, lookupVersionLabel, waitForNotUpdating

Methods inherited from class br.com.ingenieux.mojo.beanstalk.AbstractBeanstalkMojo

ensureSuffixStripped, getConfigurationTemplates, getOptionSettings, getOptionsToRemove, getService, handleNonSingle, harmfulOptionSettingP, lookupEnvironment, lookupSolutionStack, lookupTemplateName

Methods inherited from class br.com.ingenieux.mojo.aws.AbstractAWSMojo

contextualize, createServiceFor, displayResults, execute, exposeSettings, getAWSCredentials, getClientConfiguration, getClientFactory, getProperties, getRegion, getUserAgent, handleException, isVerbose, setupService, setupVersion

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplaceEnvironmentMojo

public ReplaceEnvironmentMojo()

Method Detail

handleResults

protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription handleResults(Collection<com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription> environments)
                                                                                      throws org.apache.maven.plugin.MojoExecutionException

Overrides:

handleResults in class AbstractBeanstalkMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

executeInternal

protected Object executeInternal()
                          throws Exception

Overrides:

executeInternal in class CreateEnvironmentMojo

Throws:

Exception

sleepInterval

public void sleepInterval(int pollInterval)

swapEnvironmentCNames

protected void swapEnvironmentCNames(String newEnvironmentId,
                                     String curEnvironmentId,
                                     String cnamePrefix,
                                     com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription newEnv)
                              throws org.apache.maven.plugin.AbstractMojoExecutionException

Swaps environment cnames

Parameters:

newEnvironmentId - environment id

curEnvironmentId - environment id

Throws:

org.apache.maven.plugin.AbstractMojoExecutionException

terminateEnvironment

protected void terminateEnvironment(String environmentId)
                             throws org.apache.maven.plugin.AbstractMojoExecutionException

Terminates and waits for an environment

Parameters:

environmentId - environment id to terminate

Throws:

org.apache.maven.plugin.AbstractMojoExecutionException

waitForEnvironment

protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription waitForEnvironment(String environmentId)
                                                                                           throws org.apache.maven.plugin.AbstractMojoExecutionException

Waits for an environment to get ready. Throws an exception either if this environment couldn't get into Ready state or there was a timeout

Parameters:

environmentId - environmentId to wait for

Returns:

EnvironmentDescription in Ready state

Throws:

org.apache.maven.plugin.AbstractMojoExecutionException

waitForGreenEnvironment

protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription waitForGreenEnvironment(String environmentId)
                                                                                                throws org.apache.maven.plugin.AbstractMojoExecutionException

TODO: What is Coffee anyway? Waits for an environment to become green. Throws an exception either if this environment couldn't get into a green state, or there was a timeout.

Parameters:

environmentId - environmentId to wait for

Returns:

EnvironmentDescription in Ready state

Throws:

org.apache.maven.plugin.AbstractMojoExecutionException

getCNamePrefixToCreate

protected String getCNamePrefixToCreate()

Creates a cname prefix if needed, or returns the desired one

Returns:

cname prefix to launch environment into

hasEnvironmentFor

protected boolean hasEnvironmentFor(String applicationName,
                                    String cnamePrefix)

Boolean predicate for environment existence

Parameters:

applicationName - application name

cnamePrefix - cname prefix

Returns:

true if the application name has this cname prefix

getEnvironmentFor

protected com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription getEnvironmentFor(String applicationName,
                                                                                                 String cnamePrefix)

Returns the environment description matching applicationName and environmentRef

Parameters:

applicationName - application name

cnamePrefix - cname prefix

Returns:

environment description

formatAndTruncate

protected String formatAndTruncate(String mask,
                                   int maxLen,
                                   Object... args)

Elastic Beanstalk Contains a Max EnvironmentName Limit. Lets truncate it, shall we?

Parameters:

mask - String.format Mask

maxLen - Maximum Length

args - String.format args

Returns:

formatted String, or maxLen rightmost characters

containsNamedEnvironment

protected boolean containsNamedEnvironment(String environmentName)

Boolean predicate for named environment

Parameters:

environmentName - environment name

Returns:

true if environment name exists