org.apache.maven.plugin.eclipse

Class InstallPluginsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.eclipse.InstallPluginsMojo

All Implemented Interfaces:

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

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

Install plugins resolved from the Maven repository system into an Eclipse instance.

Field Summary

Fields

Modifier and Type	Field and Description
private org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager Used to configure and retrieve an appropriate tool for extracting each resolved plugin dependency.
private java.util.Collection	artifacts The list of resolved dependencies from the current project.
private java.io.File	eclipseDir This is the installed base directory of the Eclipse instance you want to modify.
private org.codehaus.plexus.components.interactivity.InputHandler	inputHandler Input handler, needed for comand line handling.
private org.apache.maven.artifact.repository.ArtifactRepository	localRepository The location of the Maven local repository, from which to install resolved dependency plugins.
private org.apache.maven.shared.osgi.Maven2OsgiConverter	maven2OsgiConverter
private boolean	overwrite Determines whether this mojo leaves existing installed plugins as-is, or overwrites them.
private java.lang.String	pluginDependencyTypes Comma-delimited list of dependency <type/> values which will be installed in the eclipse instance's plugins directory.
private java.io.File	pluginsDir
private org.apache.maven.project.MavenProjectBuilder	projectBuilder Used to retrieve the project metadata (POM) associated with each plugin dependency, to help determine whether that plugin should be installed as a jar, or expanded into a directory.
static java.lang.String	PROP_UNPACK_PLUGIN Set this property in a plugin POM's <properties/> section to determine whether that plugin should be expanded during installation, or left as a jar file.

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
	InstallPluginsMojo()
protected	InstallPluginsMojo(java.io.File eclipseDir, boolean overwrite, java.util.List dependencyArtifacts, java.lang.String pluginDependencyTypes, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.project.MavenProjectBuilder projectBuilder, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, org.codehaus.plexus.components.interactivity.InputHandler inputHandler, org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method and Description
void	execute() Traverse the list of resolved dependency artifacts.
private java.lang.String	formatEclipsePluginName(org.apache.maven.artifact.Artifact artifact) Format the artifact information into an Eclipse-friendly plug-in name.
private void	install(org.apache.maven.artifact.Artifact artifact, org.apache.maven.project.MavenProject project) Install the plugin into the eclipse instance's /plugins directory
private void	performFileOperations(boolean installAsJar, org.apache.maven.artifact.Artifact artifact, java.io.File pluginFile, java.io.File pluginDir)

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

PROP_UNPACK_PLUGIN

public static final java.lang.String PROP_UNPACK_PLUGIN

Set this property in a plugin POM's <properties/> section to determine whether that plugin should be expanded during installation, or left as a jar file.

See Also:

Constant Field Values

eclipseDir

private java.io.File eclipseDir

This is the installed base directory of the Eclipse instance you want to modify.

overwrite

private boolean overwrite

Determines whether this mojo leaves existing installed plugins as-is, or overwrites them.

artifacts

private java.util.Collection artifacts

The list of resolved dependencies from the current project. Since we're not resolving the dependencies by hand here, the build will fail if some of these dependencies do not resolve.

pluginDependencyTypes

private java.lang.String pluginDependencyTypes

Comma-delimited list of dependency <type/> values which will be installed in the eclipse instance's plugins directory.

localRepository

private org.apache.maven.artifact.repository.ArtifactRepository localRepository

The location of the Maven local repository, from which to install resolved dependency plugins.

projectBuilder

private org.apache.maven.project.MavenProjectBuilder projectBuilder

Used to retrieve the project metadata (POM) associated with each plugin dependency, to help determine whether that plugin should be installed as a jar, or expanded into a directory.

archiverManager

private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

Used to configure and retrieve an appropriate tool for extracting each resolved plugin dependency. It is conceivable that some resolved dependencies could be zip files, jar files, or other types, so the manager approach is a convenient way to provide extensibility here.

inputHandler

private org.codehaus.plexus.components.interactivity.InputHandler inputHandler

Input handler, needed for comand line handling.

pluginsDir

private java.io.File pluginsDir

maven2OsgiConverter

private org.apache.maven.shared.osgi.Maven2OsgiConverter maven2OsgiConverter

Constructor Detail

InstallPluginsMojo

public InstallPluginsMojo()

InstallPluginsMojo

protected InstallPluginsMojo(java.io.File eclipseDir,
                             boolean overwrite,
                             java.util.List dependencyArtifacts,
                             java.lang.String pluginDependencyTypes,
                             org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                             org.apache.maven.project.MavenProjectBuilder projectBuilder,
                             org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
                             org.codehaus.plexus.components.interactivity.InputHandler inputHandler,
                             org.apache.maven.plugin.logging.Log log)

Method Detail

execute

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

Traverse the list of resolved dependency artifacts. For each one having a type that is listed in the pluginDependencyTypes parameter value, resolve the associated project metadata (POM), and perform install(..) on that artifact.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

install

private void install(org.apache.maven.artifact.Artifact artifact,
                     org.apache.maven.project.MavenProject project)
              throws org.apache.maven.plugin.MojoExecutionException,
                     org.apache.maven.plugin.MojoFailureException

Install the plugin into the eclipse instance's /plugins directory

1. Determine whether the plugin should be extracted into a directory or not
2. If the plugin's target location exists, or overwrite is set to true:
   1. if extract, ensure the plugin target location exists (mkdirs), and extract there.
   2. copy the plugin file from the local repository to the target location

   Warn whenever a plugin will overwrite an existing file or directory, and emit an INFO message whenever a plugin installation is skipped because of an existing file and overwrite == false.

Parameters:

artifact - The plugin dependency as it has been resolved.

project - The project metadata for the accompanying plugin-dependency artifact, used to determine whether to install as a jar or as a directory

Throws:

org.apache.maven.plugin.MojoExecutionException - In the event the plugin should be extracted but cannot, or the file copy fails (in the event it should not be extracted)

org.apache.maven.plugin.MojoFailureException - In the event that the plugins target directory (inside the Eclipse instance directory) does not exist, or is not a directory.

performFileOperations

private void performFileOperations(boolean installAsJar,
                                   org.apache.maven.artifact.Artifact artifact,
                                   java.io.File pluginFile,
                                   java.io.File pluginDir)
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

formatEclipsePluginName

private java.lang.String formatEclipsePluginName(org.apache.maven.artifact.Artifact artifact)

Format the artifact information into an Eclipse-friendly plug-in name. Delegates to maven2OsgiConverter to obtain bundle symbolic name and version.