Mojo Developer Cookbook
This page contains code snippets demonstrating commonly used tasks when writing Maven plug-ins. There are no guarantees that these are the 'right' way to do things, but they have worked at least once for the author(s).
Commonly used components
These components are commonly used, also in the following snippets.
You may want to add @required and @readonly, but I dropped them to keep it short.
Creating and resolving an artifact
To create an artifact, use an ArtifactFactory.
An artifact doesn't help you much until it's resolved (using an ArtifactResolver). This resolving process is not transitive!
Now you get the artifact file (in the local repository):
You need a MavenProject. If you don't have (the right) one, you can create it with just a groupId:artifactId:version:
Now you can use the ArtifactResolver to resolve transitively.
The filter is optional, and limits the resolving. Possible filters are:
- AndArtifactFilter (to combine them)
- or create your own, by implementing ArtifactFilter
Running external commands
Use CommandLine and CommandLineUtils from org.codehaus.plexus.util.cli
The input parameter is optional. For the output and error StreamConsumers, you can use CommandLineUtils.StringStreamConsumer which captures the output
in a String.
Installing and deploying artifacts
If you need want to install or deploy an artifact as part of a project build, you can add them to the MavenProject and they will be picked up in the install or deploy phase.
If you install/deploy in a standalone goal, or you need to install/deploy an artifact that is not part of the project being built, you can use the ArtifactInstaller or ArtifactDeployer.
Accessing the Plexus container
If you want access to the container, for doing your own component lookups, implement the org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable interface