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:

org.apache.maven.enforcer.rule.api.EnforcerRule

public class RequirePluginVersions
extends AbstractNonCacheableEnforcerRule

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

Version:

$Id$

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	additionalPlugins Deprecated. the visibility will be reduced to private with the next major version
boolean	banLatest Deprecated. the visibility will be reduced to private with the next major version
boolean	banRelease Deprecated. the visibility will be reduced to private with the next major version
boolean	banSnapshots Deprecated. the visibility will be reduced to private with the next major version
boolean	banTimestamps Deprecated. the visibility will be reduced to private with the next major version
String	phases Deprecated. the visibility will be reduced to private with the next major version
String	unCheckedPluginList Deprecated. the visibility will be reduced to private with the next major version
List	unCheckedPlugins Deprecated. the visibility will be reduced to private with the next major version

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

message

Constructor Summary

Constructors

Constructor and Description
RequirePluginVersions()

Method Summary

Methods

Modifier and Type	Method and Description
Set<org.apache.maven.model.Plugin>	addAdditionalPlugins(Set<org.apache.maven.model.Plugin> existing, List<String> additional) Add the additional plugins if they don't exist yet.
Collection<String>	combineUncheckedPlugins(Collection<String> uncheckedPlugins, String uncheckedPluginsList) Combines the old Collection with the new comma separated list.
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
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.
List<String>	getAdditionalPlugins()
protected List<PluginWrapper>	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 Set<org.apache.maven.model.Plugin>	getBoundPlugins(org.apache.maven.lifecycle.LifecycleExecutor life, org.apache.maven.project.MavenProject project, String thePhases) Gets the plugins that are bound to the defined phases.
String	getPhases()
Map<String,org.apache.maven.lifecycle.Lifecycle>	getPhaseToLifecycleMap() Gets the phase to lifecycle map.
Set<org.apache.maven.model.Plugin>	getProfilePlugins(org.apache.maven.project.MavenProject project) Finds the plugins that are listed in active profiles.
List	getUnCheckedPlugins()
protected EnforcerRuleUtils	getUtils() Gets the utils.
protected boolean	hasValidVersionSpecified(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper, org.apache.maven.model.Plugin source, List<PluginWrapper> 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(String baseVersion) Checks if is snapshot.
protected org.apache.maven.model.Plugin	parsePluginString(String pluginString, String field) Helper method to parse and inject a Plugin.
Collection<org.apache.maven.model.Plugin>	removeUncheckedPlugins(Collection<String> uncheckedPlugins, Collection<org.apache.maven.model.Plugin> 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.
void	setAdditionalPlugins(List<String> additionalPlugins)
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.
void	setPhases(String phases)
void	setUnCheckedPlugins(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 org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

banLatest

public boolean banLatest

Deprecated. the visibility will be reduced to private with the next major version

Don't allow the LATEST identifier.

See Also:

#setBanLatest(boolean)}, #isBanLatest()}

banRelease

public boolean banRelease

Deprecated. the visibility will be reduced to private with the next major version

Don't allow the RELEASE identifier.

See Also:

#setBanRelease(boolean)}, #isBanRelease()}

banSnapshots

public boolean banSnapshots

Deprecated. the visibility will be reduced to private with the next major version

Don't allow snapshot plugins.

See Also:

#setBanSnapshots(boolean)}, #isBanSnapshots()}

banTimestamps

public boolean banTimestamps

Deprecated. the visibility will be reduced to private with the next major version

Don't allow timestamp snapshot plugins.

See Also:

#setBanTimestamps(boolean)}, #isBanTimestamps()}

phases

public String phases

Deprecated. the visibility will be reduced to private with the next major version

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

See Also:

#setPhases(String)}, #getPhases()}

additionalPlugins

public List<String> additionalPlugins

Deprecated. the visibility will be reduced to private with the next major version

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.

See Also:

#setAdditionalPlugins(List)}, #getAdditionalPlugins()}

unCheckedPlugins

public List unCheckedPlugins

Deprecated. the visibility will be reduced to private with the next major version

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

See Also:

#setUnCheckedPlugins(List)}, #getUnCheckedPlugins()}

unCheckedPluginList

public String unCheckedPluginList

Deprecated. the visibility will be reduced to private with the next major version

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

Since:

1.0-beta-1

See Also:

#setUnCheckedPlugins(List)}, #getUnCheckedPlugins()}

Constructor Detail

RequirePluginVersions

public RequirePluginVersions()

Method Detail

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException

removeUncheckedPlugins

public Collection<org.apache.maven.model.Plugin> removeUncheckedPlugins(Collection<String> uncheckedPlugins,
                                                               Collection<org.apache.maven.model.Plugin> 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 Collection<String> combineUncheckedPlugins(Collection<String> uncheckedPlugins,
                                         String uncheckedPluginsList)

Combines the old Collection with the new comma separated list.

Parameters:

uncheckedPlugins -

uncheckedPluginsList -

Returns:

addAdditionalPlugins

public Set<org.apache.maven.model.Plugin> addAdditionalPlugins(Set<org.apache.maven.model.Plugin> existing,
                                                      List<String> 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(String pluginString,
                                              String field)
                                                   throws org.apache.maven.plugin.MojoExecutionException

Helper method to parse and inject a Plugin.

Parameters:

pluginString -

field -

Returns:

the plugin

Throws:

org.apache.maven.plugin.MojoExecutionException

getProfilePlugins

public Set<org.apache.maven.model.Plugin> 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 Set<org.apache.maven.model.Plugin> getBoundPlugins(org.apache.maven.lifecycle.LifecycleExecutor life,
                                                 org.apache.maven.project.MavenProject project,
                                                 String thePhases)
                                                      throws org.apache.maven.plugin.PluginNotFoundException,
                                                             org.apache.maven.lifecycle.LifecycleExecutionException,
                                                             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

IllegalAccessException - the illegal access exception

hasValidVersionSpecified

protected boolean hasValidVersionSpecified(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper,
                               org.apache.maven.model.Plugin source,
                               List<PluginWrapper> pluginWrappers)

Checks for valid version specified.

Parameters:

helper - the helper

source - the source

pluginWrappers - the plugins

Returns:

true, if successful

isSnapshot

protected boolean isSnapshot(String baseVersion)

Checks if is snapshot.

Parameters:

baseVersion - the base version

Returns:

true, if is snapshot

getPhaseToLifecycleMap

public Map<String,org.apache.maven.lifecycle.Lifecycle> 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 List<PluginWrapper> getAllPluginEntries(org.apache.maven.project.MavenProject project)
                                           throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                                  org.apache.maven.artifact.resolver.ArtifactNotFoundException,
                                                  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

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

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 List getUnCheckedPlugins()

setUnCheckedPlugins

public void setUnCheckedPlugins(List unCheckedPlugins)

setPhases

public final void setPhases(String phases)

getPhases

public final String getPhases()

setAdditionalPlugins

public final void setAdditionalPlugins(List<String> additionalPlugins)

getAdditionalPlugins

public final List<String> getAdditionalPlugins()