org.alfresco.maven.plugin

Class AmpMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.alfresco.maven.plugin.AmpMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class AmpMojo
extends org.apache.maven.plugin.AbstractMojo

Builds an AMP archive of the current project's contents. The location of the AMP contents is ${project.build.directory}/${project.build.finalName}. Java resources (in src/main/java and src/main/resources) are packaged in a standard JAR file that is automatically bundled in the /lib folder of the AMP archive and it's treated as build artifact (i.e. distributed on Maven repositories during deploy). Maven transitive dependencies are by default added into the /lib folder of the AMP archive

Since:

1.0

Version:

$Id:$

Author:

Gabriele Columbro, Maurizio Pillitu

Field Summary

Fields

Modifier and Type	Field and Description
protected File	ampBuildDirectory Target folder used to aggregate content then packaged into the AMP
protected File	ampFinalDir Directory of the final generated AMP
protected String	ampFinalName Name of the generated AMP and JAR artifacts
protected org.apache.maven.archiver.MavenArchiveConfiguration	archive The archive configuration to use.
protected boolean	attachClasses Whether the JAR produced should be attached as a separate 'classes' artifact.
protected boolean	attachConfig Whether a config artifact should be produced should be attached as a separate 'config' artifact.
protected File	classesDirectory (Read Only) Directory containing the classes and resource files that should be packaged into the JAR.
protected String	classifier Classifier to add to the artifact generated.
protected boolean	includeDependencies Whether (runtime scoped) JAR dependencies (including transitive) should be added or not to the generated AMP /lib folder.
protected boolean	includeWebResources Whether the AMP /web folder should be added or not to the generated AMP file.
protected org.apache.maven.project.MavenProject	project (Read Only) The Maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected org.apache.maven.execution.MavenSession	session (Read Only) The Maven session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AmpMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected File	createArchive() Creates and returns the AMP archive, invoking the AmpArchiver
protected File	createConfigArchive() Creates and returns the config archive, invoking the MavenArchiver
protected File	createJarArchive() Creates and returns the JAR archive, invoking the MavenArchiver
void	execute()
protected void	gatherDependencies() Copies all runtime dependencies to AMP lib.
protected static File	getFile(File basedir, String finalName, String classifier, String extension) Builds a File object pointing to the target AMP package; the pointer to the File is created taking into account the (optional) artifact classifier defined

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

ampFinalName

protected String ampFinalName

Name of the generated AMP and JAR artifacts

ampBuildDirectory

protected File ampBuildDirectory

Target folder used to aggregate content then packaged into the AMP

classifier

protected String classifier

Classifier to add to the artifact generated. If given, the artifact will be attached. If this is not given,it will merely be written to the output directory according to the finalName.

includeDependencies

protected boolean includeDependencies

Whether (runtime scoped) JAR dependencies (including transitive) should be added or not to the generated AMP /lib folder. By default it's true so all direct and transitive (runtime) dependencies will be added

includeWebResources

protected boolean includeWebResources

Whether the AMP /web folder should be added or not to the generated AMP file. By default it's true so all web resources are package in the war. Can be disabled to enable quick loading of web resources from sources during development (e.g. in an IDE)

attachClasses

protected boolean attachClasses

Whether the JAR produced should be attached as a separate 'classes' artifact.

attachConfig

protected boolean attachConfig

Whether a config artifact should be produced should be attached as a separate 'config' artifact.

ampFinalDir

protected File ampFinalDir

Directory of the final generated AMP

classesDirectory

protected File classesDirectory

(Read Only) Directory containing the classes and resource files that should be packaged into the JAR.

project

protected org.apache.maven.project.MavenProject project

(Read Only) The Maven project.

session

protected org.apache.maven.execution.MavenSession session

(Read Only) The Maven session

archive

protected org.apache.maven.archiver.MavenArchiveConfiguration archive

The archive configuration to use. See Maven Archiver Reference.

projectHelper

protected org.apache.maven.project.MavenProjectHelper projectHelper

Constructor Detail

AmpMojo

public AmpMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

createJarArchive

protected File createJarArchive()
                         throws org.apache.maven.plugin.MojoExecutionException

Creates and returns the JAR archive, invoking the MavenArchiver

Returns:

a File pointing to the JAR, contained in ${project.build.outputDirectory}

Throws:

org.apache.maven.plugin.MojoExecutionException

createArchive

protected File createArchive()
                      throws org.apache.maven.plugin.MojoExecutionException

Creates and returns the AMP archive, invoking the AmpArchiver

Returns:

a File pointing to an existing AMP package, contained in ${project.build.outputDirectory}

Throws:

org.apache.maven.plugin.MojoExecutionException

createConfigArchive

protected File createConfigArchive()
                            throws org.apache.maven.plugin.MojoExecutionException

Creates and returns the config archive, invoking the MavenArchiver

Returns:

a File pointing to the JAR, contained in ${project.build.outputDirectory}

Throws:

org.apache.maven.plugin.MojoExecutionException

getFile

protected static File getFile(File basedir,
           String finalName,
           String classifier,
           String extension)

Builds a File object pointing to the target AMP package; the pointer to the File is created taking into account the (optional) artifact classifier defined

Parameters:

basedir - the Base Directory of the currently built project

finalName - the Final Name of the artifact being built

classifier - the optional classifier of the artifact being built

Returns:

a File object pointing to the target AMP package

gatherDependencies

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

Copies all runtime dependencies to AMP lib. By default transitive runtime dependencies are retrieved. This behavior can be configured via the transitive parameter

Throws:

org.apache.maven.plugin.MojoExecutionException