Package org.apache.maven.enforcer.rules.dependency

Class BanDynamicVersions

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.dependency.BanDynamicVersions

All Implemented Interfaces:

EnforcerRuleBase

@Named("banDynamicVersions")
public final class BanDynamicVersions
extends AbstractStandardEnforcerRule

This rule bans dependencies having a version which requires resolution (i.e. dynamic versions which might change with each build). Dynamic versions are either

• version ranges,
• the special placeholders LATEST or RELEASE or
• versions ending with -SNAPSHOT.

Since:

3.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	BanDynamicVersions.BannedDynamicVersionCollector
private static final class	BanDynamicVersions.ExcludeArtifactPatternsPredicate

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowLatest	true if versions using LATEST should be allowed
private boolean	allowRanges	true if version ranges should be allowed
private boolean	allowRangesWithIdenticalBounds	true if ranges having the same upper and lower bound like [1.0] should be allowed.
private boolean	allowRelease	true if versions using RELEASE should be allowed
private boolean	allowSnapshots	true if versions ending with -SNAPSHOT should be allowed
private List<String>	excludedScopes	the scopes of dependencies which should be excluded from this rule
private boolean	excludeOptionals	true if optional dependencies should not be checked
private List<String>	ignores	Specify the ignored dependencies.
private static final String	LATEST
private static final String	RELEASE
private final ResolverUtil	resolverUtil
private static final String	SNAPSHOT_SUFFIX

Constructor Summary

Constructors

Constructor	Description
BanDynamicVersions(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.execution.MavenSession mavenSession, ResolverUtil resolverUtil)

Method Summary

Modifier and Type	Method	Description
private List<String>	collectDependenciesWithBannedDynamicVersions(org.eclipse.aether.graph.DependencyNode rootDependency)
private static String	dumpIntermediatePath(Collection<org.eclipse.aether.graph.DependencyNode> path)
void	execute()	This is the interface into the rule.
String	toString()

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

getCacheId, getLevel

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class java.lang.Object

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

Field Details

RELEASE

private static final String RELEASE

See Also:

• Constant Field Values

LATEST

private static final String LATEST

See Also:

• Constant Field Values

SNAPSHOT_SUFFIX

private static final String SNAPSHOT_SUFFIX

See Also:

• Constant Field Values

allowSnapshots

private boolean allowSnapshots

true if versions ending with -SNAPSHOT should be allowed

allowLatest

private boolean allowLatest

true if versions using LATEST should be allowed

allowRelease

private boolean allowRelease

true if versions using RELEASE should be allowed

allowRanges

private boolean allowRanges

true if version ranges should be allowed

allowRangesWithIdenticalBounds

private boolean allowRangesWithIdenticalBounds

true if ranges having the same upper and lower bound like [1.0] should be allowed. Only applicable if allowRanges is not set to true.

excludeOptionals

private boolean excludeOptionals

true if optional dependencies should not be checked

excludedScopes

private List<String> excludedScopes

the scopes of dependencies which should be excluded from this rule

ignores

private List<String> ignores

Specify the ignored dependencies. This can be a list of artifacts in the format groupId[:artifactId[:version[:type[:scope:[classifier]]]]]. Any of the sections can be a wildcard by using '*' (e.g. group:*:1.0).
Any of the ignored dependencies may have dynamic versions.

resolverUtil

private final ResolverUtil resolverUtil

Constructor Details

BanDynamicVersions

@Inject
public BanDynamicVersions(org.apache.maven.project.MavenProject project,
 org.eclipse.aether.RepositorySystem repoSystem,
 org.apache.maven.execution.MavenSession mavenSession,
 ResolverUtil resolverUtil)

Method Details

execute

public void execute()
             throws EnforcerRuleException

Description copied from class: AbstractEnforcerRule

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 and rule level if it should stop or just log the message as a warning.

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

dumpIntermediatePath

private static String dumpIntermediatePath(Collection<org.eclipse.aether.graph.DependencyNode> path)

collectDependenciesWithBannedDynamicVersions

private List<String> collectDependenciesWithBannedDynamicVersions(org.eclipse.aether.graph.DependencyNode rootDependency)
                                                           throws org.eclipse.aether.collection.DependencyCollectionException

Throws:

org.eclipse.aether.collection.DependencyCollectionException

toString

public String toString()

Overrides:

toString in class Object