org.nuxeo.build.maven

Class AntBuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuxeo.build.maven.AntBuildMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

IntegrationTestMojo

@Mojo(name="build",
      threadSafe=true,
      defaultPhase=PACKAGE,
      requiresDependencyCollection=TEST,
      requiresDependencyResolution=TEST)
public class AntBuildMojo
extends org.apache.maven.plugin.AbstractMojo

Execute an Ant build manipulating Maven objects (artifacts, dependencies, properties, profiles, repositories, graph...). Typical usage is the build of a distribution. It is also commonly used to setup and teardown the integration test environment.

Field Summary

Fields

Modifier and Type	Field and Description
protected AntProfileManager	antProfileManager
protected org.apache.maven.artifact.handler.manager.ArtifactHandlerManager	artifactHandlerManager
protected File	buildFile Location of the build file, if unique
protected File[]	buildFiles Location of the build files.
protected String	encoding The character encoding scheme to be applied.
protected String	expand How many levels the graph must be expanded before running Ant.
protected boolean	exportAntProperties If true, Ant properties are propagated to Maven.
protected Set<String>	exportedAntProperties If set, only the listed properties will be set back to Maven from Ant.
protected boolean	failOnError If 'false', the Maven build will proceed even if the Ant build fails.
protected Graph	graph
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected String	propertyPrefix Prefix for property names.
protected List<org.eclipse.aether.repository.RemoteRepository>	remoteRepositories
protected org.eclipse.aether.RepositorySystemSession	repositorySystemSession
protected org.eclipse.aether.DefaultRepositorySystemSession	session
protected org.apache.maven.settings.Settings	settings
protected org.eclipse.aether.RepositorySystem	system
protected String	target Ant target to call on build file(s).
protected String[]	targets Ant targets to call on build file(s).

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AntBuildMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected void	expandGraph(Graph newGraph)
List<org.apache.maven.model.Profile>	getActiveProfiles()
AntProfileManager	getAntProfileManager()
org.apache.maven.artifact.handler.manager.ArtifactHandlerManager	getArtifactHandlerManager()
File[]	getBuildFiles()
String	getEncoding()
Graph	getGraph()
List<String>	getInjectedProfileIds()
static AntBuildMojo	getInstance()
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
org.apache.maven.project.MavenProject	getProject()
org.apache.maven.project.MavenProjectHelper	getProjectHelper()
List<org.eclipse.aether.repository.RemoteRepository>	getRemoteRepositories()
org.eclipse.aether.DefaultRepositorySystemSession	getSession()
org.eclipse.aether.RepositorySystem	getSystem()
Graph	newGraph()
Graph	newGraph(String key)
protected void	setAntPropertiesFromMaven(org.apache.tools.ant.Project antProject)
protected void	setAntReferencesFromMaven(org.apache.tools.ant.Project antProject)
protected void	setMavenPropertiesFromAnt(AntClient ant)

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

graph

protected Graph graph

antProfileManager

protected AntProfileManager antProfileManager

buildFile

@Parameter(property="buildFile")
protected File buildFile

Location of the build file, if unique

buildFiles

@Parameter(property="buildFiles")
protected File[] buildFiles

Location of the build files.

target

@Parameter(property="target")
protected String target

Ant target to call on build file(s).

targets

@Parameter(property="targets")
protected String[] targets

Ant targets to call on build file(s).

Since:

1.6

expand

@Parameter(defaultValue="0",
           property="expand")
protected String expand

How many levels the graph must be expanded before running Ant.

system

@Component
protected org.eclipse.aether.RepositorySystem system

repositorySystemSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true)
protected org.eclipse.aether.RepositorySystemSession repositorySystemSession

session

protected org.eclipse.aether.DefaultRepositorySystemSession session

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

artifactHandlerManager

@Component
protected org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager

propertyPrefix

@Parameter(defaultValue="maven.",
           property="aamp.propertyPrefix")
protected String propertyPrefix

Prefix for property names.

Since:

2.0

localRepository

@Parameter(defaultValue="${localRepository}")
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

exportAntProperties

@Parameter(defaultValue="false",
           property="aamp.exportAntProperties")
protected boolean exportAntProperties

If true, Ant properties are propagated to Maven.

Since:

2.0

exportedAntProperties

@Parameter(property="aamp.exportedAntProperties")
protected Set<String> exportedAntProperties

If set, only the listed properties will be set back to Maven from Ant.

Since:

2.0

remoteRepositories

@Parameter(defaultValue="${project.remoteProjectRepositories}")
protected List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories

encoding

@Parameter(defaultValue="${project.build.sourceEncoding}",
           property="aamp.encoding")
protected String encoding

The character encoding scheme to be applied.

settings

@Parameter(defaultValue="${settings}")
protected org.apache.maven.settings.Settings settings

failOnError

@Parameter(defaultValue="true",
           property="failOnError",
           alias="aamp.failOnError")
protected boolean failOnError

If 'false', the Maven build will proceed even if the Ant build fails. Default is 'true'.

Since:

2.0

Constructor Detail

AntBuildMojo

public AntBuildMojo()

Method Detail

getBuildFiles

public File[] getBuildFiles()
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getSystem

public org.eclipse.aether.RepositorySystem getSystem()

getSession

public org.eclipse.aether.DefaultRepositorySystemSession getSession()

getArtifactHandlerManager

public org.apache.maven.artifact.handler.manager.ArtifactHandlerManager getArtifactHandlerManager()

getRemoteRepositories

public List<org.eclipse.aether.repository.RemoteRepository> getRemoteRepositories()

getEncoding

public String getEncoding()

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

newGraph

public Graph newGraph()

Since:

1.10.2

newGraph

public Graph newGraph(String key)

Parameters:

key - artifact GAV

Returns:

a Graph which root is artifact resolved from key

Since:

2.0

expandGraph

protected void expandGraph(Graph newGraph)

setMavenPropertiesFromAnt

protected void setMavenPropertiesFromAnt(AntClient ant)

Since:

2.0

setAntReferencesFromMaven

protected void setAntReferencesFromMaven(org.apache.tools.ant.Project antProject)
                                  throws org.apache.tools.ant.BuildException,
                                         org.apache.maven.artifact.DependencyResolutionRequiredException

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException

org.apache.tools.ant.BuildException

Since:

2.0

setAntPropertiesFromMaven

protected void setAntPropertiesFromMaven(org.apache.tools.ant.Project antProject)

Since:

2.0

getActiveProfiles

public List<org.apache.maven.model.Profile> getActiveProfiles()

getInjectedProfileIds

public List<String> getInjectedProfileIds()

getProject

public org.apache.maven.project.MavenProject getProject()

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

getProjectHelper

public org.apache.maven.project.MavenProjectHelper getProjectHelper()

getGraph

public Graph getGraph()

getAntProfileManager

public AntProfileManager getAntProfileManager()

getInstance

public static AntBuildMojo getInstance()

Since:

2.0