com.carrotgarden.maven.aws.CarrotMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carrot-maven-aws-plugin Show documentation

${project.organization.name} AWS Maven Plugin

There is a newer version: 1.2.6

Show newest version

/**
 * Copyright (C) 2010-2012 Andrei Pozolotin 
 *
 * All rights reserved. Licensed under the OSI BSD License.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package com.carrotgarden.maven.aws;

import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.project.MavenProject;
import org.apache.maven.settings.Settings;
import org.slf4j.Logger;
import org.slf4j.impl.MavenLoggerFactory;

/**
 * base plug-in mojo
 */
public abstract class CarrotMojo extends AbstractMojo {

	/**
	 * default amazon tag for resource names
	 * 
	 * @parameter default-value="Name"
	 */
	private String amazonTagName;

	protected String amazonTagName() {
		return amazonTagName;
	}

	/** do not use during class init */
	protected Logger getLogger(final Class klaz) {
		return MavenLoggerFactory.getLogger(klaz, getLog());
	}

	/**
	 * The Maven Session *
	 * 
	 * @required
	 * @readonly
	 * @parameter expression="${session}"
	 */
	private MavenSession session;

	protected MavenSession session() {
		return session;
	}

	/**
	 * @readonly
	 * @required
	 * @parameter expression="${project}"
	 */
	private MavenProject project;

	protected MavenProject project() {
		return project;
	}

	/**
	 * @readonly
	 * @required
	 * @parameter expression="${settings}"
	 */
	private Settings settings;

	protected Settings settings() {
		return settings;
	}

	/**
	 * AWS
	 * 
	 * region name, such as us-east-1,
	 * 
	 * which controls amazon region selection;
	 * 
	 * alternatively, see {@link #amazonRegionProperty}
	 * 
	 * @required
	 * @parameter default-value="us-east-1"
	 */
	private String amazonRegion;

	/**
	 * name of project.property which, if set dynamically, will be used instead
	 * of plugin property {@link #amazonRegion}
	 * 
	 * @parameter
	 */
	private String amazonRegionProperty;

	/** prefer project.properies over plug-in property */
	protected String amazonRegion() {
		return projectValue(amazonRegion, amazonRegionProperty);
	}

	/**
	 * @return value, if present; else substitute {@link #amazonRegion()} into
	 *         format expression
	 */
	protected String amazonEndpoint(final String value, final String format) {
		if (value == null) {
			return String.format(format, amazonRegion());
		} else {
			return value;
		}
	}

	protected String projectValue(final String propValue, final String propName) {
		if (propName == null) {
			return propValue;
		} else {
			return (String) project().getProperties().get(propName);
		}

	}

}