org.apache.maven.plugins.enforcer
Class RequirePluginVersions

java.lang.Object
  org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
      org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
          org.apache.maven.plugins.enforcer.RequirePluginVersions

All Implemented Interfaces:

EnforcerRule

public class RequirePluginVersions
extends AbstractNonCacheableEnforcerRule

This rule will enforce that all plugins specified in the poms have a version declared.

Version:

$Id: RequirePluginVersions.java 1028144 2010-10-28 00:10:58Z brianf $

Author:

Brian Fox

Field Summary

java.util.List	additionalPlugins Additional plugins to enforce have versions.
boolean	banLatest Don't allow the LATEST identifier.
boolean	banRelease Don't allow the RELEASE identifier.
boolean	banSnapshots Don't allow snapshot plugins.
boolean	banTimestamps Don't allow timestamp snapshot plugins.
java.lang.String	phases The comma separated list of phases that should be used to find lifecycle plugin bindings.
java.lang.String	unCheckedPluginList Same as unCheckedPlugins but as a comma list to better support properties.
java.util.List	unCheckedPlugins Deprecated.

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

RequirePluginVersions()

Method Summary

java.util.Set	addAdditionalPlugins(java.util.Set existing, java.util.List additional) Add the additional plugins if they don't exist yet.
java.util.Collection	combineUncheckedPlugins(java.util.Collection uncheckedPlugins, java.lang.String uncheckedPluginsList) Combines the old Collection with the new comma separated list.
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.
protected org.apache.maven.model.Plugin	findCurrentPlugin(org.apache.maven.model.Plugin plugin, org.apache.maven.project.MavenProject project) Given a plugin, this will retrieve the matching plugin artifact from the model.
protected java.util.List	getAllPluginEntries(org.apache.maven.project.MavenProject project) Gets all plugin entries in build.plugins, build.pluginManagement.plugins, profile.build.plugins, reporting and profile.reporting in this project and all parents
protected java.util.Set	getBoundPlugins(org.apache.maven.lifecycle.LifecycleExecutor life, org.apache.maven.project.MavenProject project, java.lang.String thePhases) Gets the plugins that are bound to the defined phases.
protected java.lang.String	getMessage() Gets the message.
java.util.Map	getPhaseToLifecycleMap() Gets the phase to lifecycle map.
java.util.Set	getProfilePlugins(org.apache.maven.project.MavenProject project) Finds the plugins that are listed in active profiles.
java.util.List	getUnCheckedPlugins()
protected EnforcerRuleUtils	getUtils() Gets the utils.
protected boolean	hasValidVersionSpecified(EnforcerRuleHelper helper, org.apache.maven.model.Plugin source, java.util.List pluginWrappers) Checks for valid version specified.
protected boolean	isBanLatest() Checks if is ban latest.
protected boolean	isBanRelease() Checks if is ban release.
boolean	isBanSnapshots() Checks if is ban snapshots.
boolean	isBanTimestamps() Checks if is ban timestamps.
protected boolean	isSnapshot(java.lang.String baseVersion) Checks if is snapshot.
protected org.apache.maven.model.Plugin	parsePluginString(java.lang.String pluginString, java.lang.String field) Helper method to parse and inject a Plugin.
java.util.Collection	removeUncheckedPlugins(java.util.Collection uncheckedPlugins, java.util.Collection plugins) Remove the plugins that the user doesn't want to check.
protected org.apache.maven.model.Plugin	resolvePlugin(org.apache.maven.model.Plugin plugin, org.apache.maven.project.MavenProject project) Resolve plugin.
protected void	setBanLatest(boolean theBanLatest) Sets the ban latest.
protected void	setBanRelease(boolean theBanRelease) Sets the ban release.
void	setBanSnapshots(boolean theBanSnapshots) Sets the ban snapshots.
void	setBanTimestamps(boolean theBanTimestamps) Sets the ban timestamps.
protected void	setMessage(java.lang.String theMessage) Sets the message.
void	setUnCheckedPlugins(java.util.List unCheckedPlugins)
protected void	setUtils(EnforcerRuleUtils theUtils) Sets the utils.

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

banLatest

public boolean banLatest

Don't allow the LATEST identifier.

banRelease

public boolean banRelease

Don't allow the RELEASE identifier.

banSnapshots

public boolean banSnapshots

Don't allow snapshot plugins.

banTimestamps

public boolean banTimestamps

Don't allow timestamp snapshot plugins.

phases

public java.lang.String phases

The comma separated list of phases that should be used to find lifecycle plugin bindings. The default value is "clean,deploy,site".

additionalPlugins

public java.util.List additionalPlugins

Additional plugins to enforce have versions. These are plugins that may not be in the poms but are used anyway, like help, eclipse etc.
The plugins should be specified in the form: group:artifactId.

unCheckedPlugins

public java.util.List unCheckedPlugins

Deprecated.

Plugins to skip for version enforcement. The plugins should be specified in the form: group:artifactId. NOTE: This is deprecated, use unCheckedPluginList instead.

unCheckedPluginList

public java.lang.String unCheckedPluginList

Same as unCheckedPlugins but as a comma list to better support properties. Sample form: group:artifactId,group2:artifactId2

Since:

1.0-beta-1

Constructor Detail

RequirePluginVersions

public RequirePluginVersions()

Method Detail

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

Description copied from interface: EnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag if it should stop or just log the message as a warning.

Parameters:

helper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.

Throws:

EnforcerRuleException - the enforcer rule exception

removeUncheckedPlugins

public java.util.Collection removeUncheckedPlugins(java.util.Collection uncheckedPlugins,
                                                   java.util.Collection plugins)
                                            throws org.apache.maven.plugin.MojoExecutionException

Remove the plugins that the user doesn't want to check.

Parameters:

uncheckedPlugins -

plugins -

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

combineUncheckedPlugins

public java.util.Collection combineUncheckedPlugins(java.util.Collection uncheckedPlugins,
                                                    java.lang.String uncheckedPluginsList)

Combines the old Collection with the new comma separated list.

Parameters:

uncheckedPlugins -

uncheckedPluginsList -

Returns:

addAdditionalPlugins

public java.util.Set addAdditionalPlugins(java.util.Set existing,
                                          java.util.List additional)
                                   throws org.apache.maven.plugin.MojoExecutionException

Add the additional plugins if they don't exist yet.

Parameters:

existing - the existing

additional - the additional

Returns:

the sets the

Throws:

org.apache.maven.plugin.MojoExecutionException - the mojo execution exception

parsePluginString

protected org.apache.maven.model.Plugin parsePluginString(java.lang.String pluginString,
                                                          java.lang.String field)
                                                   throws org.apache.maven.plugin.MojoExecutionException

Helper method to parse and inject a Plugin.

Parameters:

pluginString -

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

getProfilePlugins

public java.util.Set getProfilePlugins(org.apache.maven.project.MavenProject project)

Finds the plugins that are listed in active profiles.

Parameters:

project - the project

Returns:

the profile plugins

findCurrentPlugin

protected org.apache.maven.model.Plugin findCurrentPlugin(org.apache.maven.model.Plugin plugin,
                                                          org.apache.maven.project.MavenProject project)

Given a plugin, this will retrieve the matching plugin artifact from the model.

Parameters:

plugin - plugin to lookup

project - project to search

Returns:

matching plugin, null if not found.

resolvePlugin

protected org.apache.maven.model.Plugin resolvePlugin(org.apache.maven.model.Plugin plugin,
                                                      org.apache.maven.project.MavenProject project)

Resolve plugin.

Parameters:

plugin - the plugin

project - the project

Returns:

the plugin

getBoundPlugins

protected java.util.Set getBoundPlugins(org.apache.maven.lifecycle.LifecycleExecutor life,
                                        org.apache.maven.project.MavenProject project,
                                        java.lang.String thePhases)
                                 throws org.apache.maven.plugin.PluginNotFoundException,
                                        org.apache.maven.lifecycle.LifecycleExecutionException,
                                        java.lang.IllegalAccessException

Gets the plugins that are bound to the defined phases. This does not find plugins bound in the pom to a phase later than the plugin is executing.

Parameters:

life - the life

project - the project

thePhases - the the phases

Returns:

the bound plugins

Throws:

org.apache.maven.plugin.PluginNotFoundException - the plugin not found exception

org.apache.maven.lifecycle.LifecycleExecutionException - the lifecycle execution exception

java.lang.IllegalAccessException - the illegal access exception

hasValidVersionSpecified

protected boolean hasValidVersionSpecified(EnforcerRuleHelper helper,
                                           org.apache.maven.model.Plugin source,
                                           java.util.List pluginWrappers)

Checks for valid version specified.

Parameters:

helper - the helper

source - the source

pluginWrappers - the plugins

Returns:

true, if successful

isSnapshot

protected boolean isSnapshot(java.lang.String baseVersion)

Checks if is snapshot.

Parameters:

baseVersion - the base version

Returns:

true, if is snapshot

getPhaseToLifecycleMap

public java.util.Map getPhaseToLifecycleMap()
                                     throws org.apache.maven.lifecycle.LifecycleExecutionException

Gets the phase to lifecycle map.

Returns:

the phase to lifecycle map

Throws:

org.apache.maven.lifecycle.LifecycleExecutionException - the lifecycle execution exception

getAllPluginEntries

protected java.util.List getAllPluginEntries(org.apache.maven.project.MavenProject project)
                                      throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                             org.apache.maven.artifact.resolver.ArtifactNotFoundException,
                                             java.io.IOException,
                                             org.codehaus.plexus.util.xml.pull.XmlPullParserException

Gets all plugin entries in build.plugins, build.pluginManagement.plugins, profile.build.plugins, reporting and profile.reporting in this project and all parents

Parameters:

project - the project

Returns:

the all plugin entries wrapped in a PluginWrapper Object

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException - the artifact resolution exception

org.apache.maven.artifact.resolver.ArtifactNotFoundException - the artifact not found exception

java.io.IOException - Signals that an I/O exception has occurred.

org.codehaus.plexus.util.xml.pull.XmlPullParserException - the xml pull parser exception

isBanLatest

protected boolean isBanLatest()

Checks if is ban latest.

Returns:

the banLatest

setBanLatest

protected void setBanLatest(boolean theBanLatest)

Sets the ban latest.

Parameters:

theBanLatest - the banLatest to set

isBanRelease

protected boolean isBanRelease()

Checks if is ban release.

Returns:

the banRelease

setBanRelease

protected void setBanRelease(boolean theBanRelease)

Sets the ban release.

Parameters:

theBanRelease - the banRelease to set

getMessage

protected java.lang.String getMessage()

Gets the message.

Returns:

the message

setMessage

protected void setMessage(java.lang.String theMessage)

Sets the message.

Parameters:

theMessage - the message to set

getUtils

protected EnforcerRuleUtils getUtils()

Gets the utils.

Returns:

the utils

setUtils

protected void setUtils(EnforcerRuleUtils theUtils)

Sets the utils.

Parameters:

theUtils - the utils to set

isBanSnapshots

public boolean isBanSnapshots()

Checks if is ban snapshots.

Returns:

the banSnapshots

setBanSnapshots

public void setBanSnapshots(boolean theBanSnapshots)

Sets the ban snapshots.

Parameters:

theBanSnapshots - the banSnapshots to set

isBanTimestamps

public boolean isBanTimestamps()

Checks if is ban timestamps.

Returns:

the banTimestamps

setBanTimestamps

public void setBanTimestamps(boolean theBanTimestamps)

Sets the ban timestamps.

Parameters:

theBanTimestamps - the banTimestamps to set

getUnCheckedPlugins

public java.util.List getUnCheckedPlugins()

setUnCheckedPlugins

public void setUnCheckedPlugins(java.util.List unCheckedPlugins)