br.com.ingenieux.mojo.aws

Class AbstractAWSMojo<S extends com.amazonaws.AmazonWebServiceClient>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

br.com.ingenieux.mojo.aws.AbstractAWSMojo<S>

All Implemented Interfaces:

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

public abstract class AbstractAWSMojo<S extends com.amazonaws.AmazonWebServiceClient>
extends org.apache.maven.plugin.AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Represents a Mojo which keeps AWS passwords

TODO: Refactor into tiny, delegated classes. Currently its a huge bloat, but it works, right?

NOTE: Settings in this class use properties based in "beanstalker", which is the project. The beanstalk module, though, prefixes then as "beanstalk" instead

Parts of this class come from maven-gae-plugin's source code.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.amazonaws.auth.AWSCredentialsProvider	awsCredentialsProvider AWS Credentials
protected AWSClientFactory	clientFactory
protected org.codehaus.plexus.context.Context	context
protected String	credentialId The credential id (on ~/.aws/credentials file) to use)
protected Charset	DEFAULT_CHARSET
protected boolean	ignoreExceptions Ignore Exceptions?
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected String	regionName Service region e.g.
protected com.amazonaws.regions.Region	regionObj
protected String	serverId The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
protected org.apache.maven.execution.MavenSession	session
protected org.apache.maven.settings.Settings	settings Maven Settings Reference
protected boolean	verbose Verbose Logging?
protected String	version

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSMojo()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Extension Point - Meant for others to declare and redefine variables as needed.
void	contextualize(org.codehaus.plexus.context.Context context)
protected <T extends com.amazonaws.AmazonWebServiceClient> T	createServiceFor(Class<T> serviceClass)
protected void	displayResults(Object result)
void	execute()
protected abstract Object	executeInternal()
protected Expose	exposeSettings(String serverId)
com.amazonaws.auth.AWSCredentialsProvider	getAWSCredentials()
protected com.amazonaws.ClientConfiguration	getClientConfiguration()
AWSClientFactory	getClientFactory()
protected Properties	getProperties()
com.amazonaws.regions.Region	getRegion()
S	getService()
protected String	getUserAgent()
void	handleException(Exception e)
boolean	isVerbose()
protected void	setupService()
protected void	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

Field Detail

DEFAULT_CHARSET

protected final Charset DEFAULT_CHARSET

session

@Parameter(defaultValue="${session}",
           required=true)
protected org.apache.maven.execution.MavenSession session

settings

@Parameter(property="settings",
           required=true,
           readonly=true)
protected org.apache.maven.settings.Settings settings

Maven Settings Reference

awsCredentialsProvider

protected com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider

AWS Credentials

serverId

@Parameter(property="beanstalker.serverId",
           defaultValue="aws.amazon.com")
protected String serverId

The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)

credentialId

@Parameter(property="beanstalker.credentialId",
           defaultValue="default")
protected String credentialId

The credential id (on ~/.aws/credentials file) to use)

verbose

@Parameter(property="beanstalker.verbose",
           defaultValue="false")
protected boolean verbose

Verbose Logging?

ignoreExceptions

@Parameter(property="beanstalker.ignoreExceptions",
           defaultValue="false")
protected boolean ignoreExceptions

Ignore Exceptions?

version

protected String version

context

protected org.codehaus.plexus.context.Context context

regionName

@Parameter(property="beanstalker.region")
protected String regionName

Service region e.g. "us-east-1"

See this list for reference.

regionObj

protected com.amazonaws.regions.Region regionObj

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

clientFactory

protected AWSClientFactory clientFactory

Constructor Detail

AbstractAWSMojo

protected AbstractAWSMojo()

Method Detail

getRegion

public com.amazonaws.regions.Region getRegion()

getAWSCredentials

public com.amazonaws.auth.AWSCredentialsProvider getAWSCredentials()
                                                            throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getClientFactory

public AWSClientFactory getClientFactory()

exposeSettings

protected Expose exposeSettings(String serverId)
                         throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

getClientConfiguration

protected com.amazonaws.ClientConfiguration getClientConfiguration()

getUserAgent

protected final String getUserAgent()

setupVersion

protected void setupVersion()

setupService

protected void setupService()
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createServiceFor

protected <T extends com.amazonaws.AmazonWebServiceClient> T createServiceFor(Class<T> serviceClass)
                                                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getProperties

protected Properties getProperties()

getService

public S getService()

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

configure

protected void configure()

Extension Point - Meant for others to declare and redefine variables as needed.

handleException

public void handleException(Exception e)
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

displayResults

protected void displayResults(Object result)

executeInternal

protected abstract Object executeInternal()
                                   throws Exception

Throws:

Exception

isVerbose

public boolean isVerbose()