org.apache.maven.plugin.ide

Class AbstractIdeSupportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.ide.AbstractIdeSupportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

EclipsePlugin

public abstract class AbstractIdeSupportMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.codehaus.plexus.logging.LogEnabled

Abstract base plugin which takes care of the common stuff usually needed by maven IDE plugins. A plugin extending AbstractIdeSupportMojo should implement the setup() and writeConfiguration() methods, plus the getters needed to get the various configuration flags and required components. The lifecycle:

       *** calls setup() where you can configure your specific stuff and stop the mojo from execute if appropriate ***
       - manually resolve project dependencies, NOT failing if a dependency is missing
       - compute project references (reactor projects) if the getUseProjectReferences() flag is set
       - download sources/javadocs if the getDownloadSources() flag is set
       *** calls writeConfiguration(), passing the list of resolved referenced dependencies ***
       - report the list of missing sources or just tell how to turn this feature on if the flag was disabled
 

Version:

$Id: AbstractIdeSupportMojo.java 1173952 2011-09-22 05:53:22Z baerrach $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.resolver.ArtifactCollector	artifactCollector Artifact collector, needed to resolve dependencies.
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory Artifact factory, needed to download source jars for inclusion in classpath.
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver Artifact resolver, needed to download source jars for inclusion in classpath.
protected boolean	downloadJavadocs Enables/disables the downloading of javadoc attachments.
protected boolean	downloadSources Enables/disables the downloading of source attachments.
protected org.apache.maven.project.MavenProject	executedProject The currently executed project (can be a reactor project).
protected boolean	forceRecheck Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments.
private IdeDependency[]	ideDeps Cached array of resolved dependencies.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local maven repository.
protected org.codehaus.plexus.logging.Logger	logger Plexus logger needed for debugging manual artifact resolution.
private java.util.List	missingJavadocDependencies Not a plugin parameter.
private java.util.List	missingSourceDependencies Not a plugin parameter.
protected java.lang.String	packaging The project packaging.
protected org.apache.maven.project.MavenProject	project The project whose project files to create.
protected java.util.List	reactorProjects If the executed project is a reactor project, this will contains the full list of projects in the reactor.
protected java.util.List	remoteArtifactRepositories Remote repositories which will be searched for source attachments.
private boolean	resolveDependencies Flag for mojo implementations to control whether normal maven dependencies should be resolved.
private org.apache.maven.execution.RuntimeInformation	runtimeInformation The runtime information for Maven, used to retrieve Maven's version number.
private boolean	skip Skip the operation when true.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractIdeSupportMojo()

Method Summary

Modifier and Type	Method and Description
private java.util.Map	createManagedVersionMap(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, java.lang.String projectId, org.apache.maven.model.DependencyManagement dependencyManagement)
protected IdeDependency[]	doDependencyResolution() Resolve project dependencies.
void	enableLogging(org.codehaus.plexus.logging.Logger logger)
void	execute()
org.apache.maven.artifact.factory.ArtifactFactory	getArtifactFactory() Getter for artifactFactory.
org.apache.maven.artifact.metadata.ArtifactMetadataSource	getArtifactMetadataSource() Getter for artifactMetadataSource.
org.apache.maven.artifact.resolver.ArtifactResolver	getArtifactResolver() Getter for artifactResolver.
boolean	getDownloadJavadocs() Getter for downloadJavadocs.
boolean	getDownloadSources() Getter for downloadSources.
abstract java.util.List	getExcludes()
org.apache.maven.project.MavenProject	getExecutedProject() Getter for executedProject.
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository() Getter for localRepository.
org.apache.maven.project.MavenProject	getProject() Getter for project.
private java.util.Set	getProjectArtifacts() Returns the list of project artifacts.
abstract java.lang.String	getProjectNameForArifact(org.apache.maven.artifact.Artifact artifact) Find the name of the project as used in eclipse.
protected org.apache.maven.project.MavenProject	getReactorProject(org.apache.maven.artifact.Artifact artifact) Checks the list of reactor projects to see if the artifact is included.
java.util.List	getReactorProjects() Getter for reactorProjects.
java.util.List	getRemoteArtifactRepositories() Getter for remoteArtifactRepositories.
protected abstract boolean	getUseProjectReferences() return false if projects available in a reactor build should be considered normal dependencies, true if referenced project will be linked and not need artifact resolution.
protected IdeDependency[]	getWorkspaceArtefacts()
private void	handleExclusions(org.apache.maven.artifact.Artifact artifact, org.apache.maven.model.Dependency dependency) Apply exclusion filters to direct AND transitive dependencies.
protected boolean	hasToResolveJar(org.apache.maven.artifact.Artifact art) Checks if jar has to be resolved for the given artifact
protected boolean	isAvailableAsAReactorProject(org.apache.maven.artifact.Artifact artifact) Utility method that locates a project producing the given artifact.
protected boolean	isMavenVersion(java.lang.String version) Checks whether the currently running Maven satisfies the specified version (range).
protected boolean	isResolveDependencies()
private void	reportMissingArtifacts() Output a message with the list of missing dependencies and info on how turn download on if it was disabled.
private java.util.List	resolveDependenciesWithClassifier(IdeDependency[] deps, java.lang.String inClassifier, boolean includeRemoteRepositories) Resolve the required artifacts for each of the dependency.
private void	resolveSourceAndJavadocArtifacts(IdeDependency[] deps) Resolve source artifacts and download them if downloadSources is true.
void	setArtifactFactory(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory) Setter for artifactFactory.
void	setArtifactMetadataSource(org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource) Setter for artifactMetadataSource.
void	setArtifactResolver(org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver) Setter for artifactResolver.
void	setDownloadJavadocs(boolean downloadJavadoc) Setter for downloadJavadocs.
void	setDownloadSources(boolean downloadSources) Setter for downloadSources.
void	setExecutedProject(org.apache.maven.project.MavenProject executedProject) Setter for executedProject.
void	setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository) Setter for localRepository.
void	setProject(org.apache.maven.project.MavenProject project) Setter for project.
void	setReactorProjects(java.util.List reactorProjects) Setter for reactorProjects.
void	setRemoteArtifactRepositories(java.util.List remoteArtifactRepositories) Setter for remoteArtifactRepositories.
protected void	setResolveDependencies(boolean resolveDependencies)
protected abstract boolean	setup() Hook for preparation steps before the actual plugin execution.
protected boolean	useProjectReference(org.apache.maven.artifact.Artifact art) Checks if a projects reference has to be used for the given artifact
protected abstract void	writeConfiguration(IdeDependency[] deps) Main plugin method where dependencies should be processed in order to generate IDE configuration files.

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

project

protected org.apache.maven.project.MavenProject project

The project whose project files to create.

executedProject

protected org.apache.maven.project.MavenProject executedProject

The currently executed project (can be a reactor project).

packaging

protected java.lang.String packaging

The project packaging.

artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

Artifact factory, needed to download source jars for inclusion in classpath.

artifactResolver

protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

Artifact resolver, needed to download source jars for inclusion in classpath.

artifactCollector

protected org.apache.maven.artifact.resolver.ArtifactCollector artifactCollector

Artifact collector, needed to resolve dependencies.

artifactMetadataSource

protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

runtimeInformation

private org.apache.maven.execution.RuntimeInformation runtimeInformation

The runtime information for Maven, used to retrieve Maven's version number.

remoteArtifactRepositories

protected java.util.List remoteArtifactRepositories

Remote repositories which will be searched for source attachments.

localRepository

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

Local maven repository.

reactorProjects

protected java.util.List reactorProjects

If the executed project is a reactor project, this will contains the full list of projects in the reactor.

skip

private boolean skip

Skip the operation when true.

downloadSources

protected boolean downloadSources

Enables/disables the downloading of source attachments. Defaults to false. When this flag is true remote repositories are checked for sources: in order to avoid repeated check for unavailable source archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.

downloadJavadocs

protected boolean downloadJavadocs

Enables/disables the downloading of javadoc attachments. Defaults to false. When this flag is true remote repositories are checked for javadocs: in order to avoid repeated check for unavailable javadoc archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.

forceRecheck

protected boolean forceRecheck

Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments. Defaults to false. When this flag is true and the source or javadoc attachment has a status cache to indicate that it is not available, then the remote repository will be rechecked for a source or javadoc attachment and the status cache updated to reflect the new state.

logger

protected org.codehaus.plexus.logging.Logger logger

Plexus logger needed for debugging manual artifact resolution.

missingSourceDependencies

private java.util.List missingSourceDependencies

Not a plugin parameter. Collect the list of dependencies with a missing source artifact for the final report.

missingJavadocDependencies

private java.util.List missingJavadocDependencies

Not a plugin parameter. Collect the list of dependencies with a missing javadoc artifact for the final report.

ideDeps

private IdeDependency[] ideDeps

Cached array of resolved dependencies.

resolveDependencies

private boolean resolveDependencies

Flag for mojo implementations to control whether normal maven dependencies should be resolved. Default value is true.

Constructor Detail

AbstractIdeSupportMojo

public AbstractIdeSupportMojo()

Method Detail

getArtifactMetadataSource

public org.apache.maven.artifact.metadata.ArtifactMetadataSource getArtifactMetadataSource()

Getter for artifactMetadataSource.

Returns:

Returns the artifactMetadataSource.

setArtifactMetadataSource

public void setArtifactMetadataSource(org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource)

Setter for artifactMetadataSource.

Parameters:

artifactMetadataSource - The artifactMetadataSource to set.

getProject

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

Getter for project.

Returns:

Returns the project.

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Setter for project.

Parameters:

project - The project to set.

getReactorProjects

public java.util.List getReactorProjects()

Getter for reactorProjects.

Returns:

Returns the reactorProjects.

setReactorProjects

public void setReactorProjects(java.util.List reactorProjects)

Setter for reactorProjects.

Parameters:

reactorProjects - The reactorProjects to set.

getRemoteArtifactRepositories

public java.util.List getRemoteArtifactRepositories()

Getter for remoteArtifactRepositories.

Returns:

Returns the remoteArtifactRepositories.

setRemoteArtifactRepositories

public void setRemoteArtifactRepositories(java.util.List remoteArtifactRepositories)

Setter for remoteArtifactRepositories.

Parameters:

remoteArtifactRepositories - The remoteArtifactRepositories to set.

getArtifactFactory

public org.apache.maven.artifact.factory.ArtifactFactory getArtifactFactory()

Getter for artifactFactory.

Returns:

Returns the artifactFactory.

setArtifactFactory

public void setArtifactFactory(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory)

Setter for artifactFactory.

Parameters:

artifactFactory - The artifactFactory to set.

getArtifactResolver

public org.apache.maven.artifact.resolver.ArtifactResolver getArtifactResolver()

Getter for artifactResolver.

Returns:

Returns the artifactResolver.

setArtifactResolver

public void setArtifactResolver(org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver)

Setter for artifactResolver.

Parameters:

artifactResolver - The artifactResolver to set.

getExecutedProject

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

Getter for executedProject.

Returns:

Returns the executedProject.

setExecutedProject

public void setExecutedProject(org.apache.maven.project.MavenProject executedProject)

Setter for executedProject.

Parameters:

executedProject - The executedProject to set.

getLocalRepository

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

Getter for localRepository.

Returns:

Returns the localRepository.

setLocalRepository

public void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)

Setter for localRepository.

Parameters:

localRepository - The localRepository to set.

getDownloadJavadocs

public boolean getDownloadJavadocs()

Getter for downloadJavadocs.

Returns:

Returns the downloadJavadocs.

setDownloadJavadocs

public void setDownloadJavadocs(boolean downloadJavadoc)

Setter for downloadJavadocs.

Parameters:

downloadJavadoc - The downloadJavadocs to set.

getDownloadSources

public boolean getDownloadSources()

Getter for downloadSources.

Returns:

Returns the downloadSources.

setDownloadSources

public void setDownloadSources(boolean downloadSources)

Setter for downloadSources.

Parameters:

downloadSources - The downloadSources to set.

setResolveDependencies

protected void setResolveDependencies(boolean resolveDependencies)

isResolveDependencies

protected boolean isResolveDependencies()

getUseProjectReferences

protected abstract boolean getUseProjectReferences()

return false if projects available in a reactor build should be considered normal dependencies, true if referenced project will be linked and not need artifact resolution.

Returns:

true if referenced project will be linked and not need artifact resolution

setup

protected abstract boolean setup()
                          throws org.apache.maven.plugin.MojoExecutionException

Hook for preparation steps before the actual plugin execution.

Returns:

true if execution should continue or false if not.

Throws:

org.apache.maven.plugin.MojoExecutionException - generic mojo exception

writeConfiguration

protected abstract void writeConfiguration(IdeDependency[] deps)
                                    throws org.apache.maven.plugin.MojoExecutionException

Main plugin method where dependencies should be processed in order to generate IDE configuration files.

Parameters:

deps - list of IdeDependency objects, with artifacts, sources and javadocs already resolved

Throws:

org.apache.maven.plugin.MojoExecutionException - generic mojo exception

enableLogging

public void enableLogging(org.codehaus.plexus.logging.Logger logger)

Specified by:

enableLogging in interface org.codehaus.plexus.logging.LogEnabled

See Also:

LogEnabled.enableLogging(org.codehaus.plexus.logging.Logger)

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

Mojo.execute()

doDependencyResolution

protected IdeDependency[] doDependencyResolution()
                                          throws org.apache.maven.plugin.MojoExecutionException

Resolve project dependencies. Manual resolution is needed in order to avoid resolution of multiproject artifacts (if projects will be linked each other an installed jar is not needed) and to avoid a failure when a jar is missing.

Returns:

resolved IDE dependencies, with attached jars for non-reactor dependencies

Throws:

org.apache.maven.plugin.MojoExecutionException - if dependencies can't be resolved

getProjectNameForArifact

public abstract java.lang.String getProjectNameForArifact(org.apache.maven.artifact.Artifact artifact)

Find the name of the project as used in eclipse.

Parameters:

artifact - The artifact to find the eclipse name for.

Returns:

The name os the eclipse project.

getProjectArtifacts

private java.util.Set getProjectArtifacts()
                                   throws org.apache.maven.plugin.MojoExecutionException

Returns the list of project artifacts. Also artifacts generated from referenced projects will be added, but with the resolved property set to true.

Returns:

list of projects artifacts

Throws:

org.apache.maven.plugin.MojoExecutionException - if unable to parse dependency versions

handleExclusions

private void handleExclusions(org.apache.maven.artifact.Artifact artifact,
                              org.apache.maven.model.Dependency dependency)

Apply exclusion filters to direct AND transitive dependencies.

Parameters:

artifact -

dependency -

isAvailableAsAReactorProject

protected boolean isAvailableAsAReactorProject(org.apache.maven.artifact.Artifact artifact)

Utility method that locates a project producing the given artifact.

Parameters:

artifact - the artifact a project should produce.

Returns:

true if the artifact is produced by a reactor projectart.

getReactorProject

protected org.apache.maven.project.MavenProject getReactorProject(org.apache.maven.artifact.Artifact artifact)

Checks the list of reactor projects to see if the artifact is included.

Parameters:

artifact - the artifact to check if it is in the reactor

Returns:

the reactor project or null if it is not in the reactor

getWorkspaceArtefacts

protected IdeDependency[] getWorkspaceArtefacts()

Returns:

an array with all dependencies available in the workspace, to be implemented by the subclasses.

createManagedVersionMap

private java.util.Map createManagedVersionMap(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                                              java.lang.String projectId,
                                              org.apache.maven.model.DependencyManagement dependencyManagement)
                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

resolveSourceAndJavadocArtifacts

private void resolveSourceAndJavadocArtifacts(IdeDependency[] deps)

Resolve source artifacts and download them if downloadSources is true. Source and javadocs artifacts will be attached to the IdeDependency Resolve source and javadoc artifacts. The resolved artifacts will be downloaded based on the downloadSources and downloadJavadocs attributes. Source and

Parameters:

deps - resolved dependencies

resolveDependenciesWithClassifier

private java.util.List resolveDependenciesWithClassifier(IdeDependency[] deps,
                                                         java.lang.String inClassifier,
                                                         boolean includeRemoteRepositories)

Resolve the required artifacts for each of the dependency. sources or javadoc artifacts (depending on the classifier) are attached to the dependency.

Parameters:

deps - resolved dependencies

inClassifier - the classifier we are looking for (either sources or javadoc)

includeRemoteRepositories - flag whether we should search remote repositories for the artifacts or not

Returns:

the list of dependencies for which the required artifact was not found

reportMissingArtifacts

private void reportMissingArtifacts()

Output a message with the list of missing dependencies and info on how turn download on if it was disabled.

getExcludes

public abstract java.util.List getExcludes()

Returns:

List of dependencies to exclude from eclipse classpath.

Since:

2.5

hasToResolveJar

protected boolean hasToResolveJar(org.apache.maven.artifact.Artifact art)

Checks if jar has to be resolved for the given artifact

Parameters:

art - the artifact to check

Returns:

true if resolution should happen

useProjectReference

protected boolean useProjectReference(org.apache.maven.artifact.Artifact art)

Checks if a projects reference has to be used for the given artifact

Parameters:

art - the artifact to check

Returns:

true if a project reference has to be used.

isMavenVersion

protected boolean isMavenVersion(java.lang.String version)

Checks whether the currently running Maven satisfies the specified version (range).

Parameters:

version - The version range to test for, must not be null.

Returns:

true if the current Maven version matches the specified version range, false otherwise.