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

Class BannedDependencies

java.lang.Object

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

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.dependency.BannedDependencies

All Implemented Interfaces:

EnforcerRuleBase

@Named("bannedDependencies")
public final class BannedDependencies
extends AbstractStandardEnforcerRule

This rule checks that lists of dependencies are not included.

Author:

Brian Fox

Method Summary

Modifier and Type	Method	Description
void	execute()
protected String	getErrorMessage()
List<String>	getExcludes()	Gets the excludes.
List<String>	getIncludes()	Gets the includes.
EnforcerLogger	getLog()
protected org.apache.maven.execution.MavenSession	getSession()
boolean	isSearchTransitive()
void	setExcludes(List<String> theExcludes)	Specify the banned dependencies.
void	setIncludes(List<String> theIncludes)	Specify the allowed dependencies.
void	setLog(EnforcerLogger arg0)
void	setSearchTransitive(boolean theSearchTransitive)	Sets the search transitive.
String	toString()
protected boolean	validate(org.apache.maven.artifact.Artifact artifact)	Validates a dependency artifact if it fulfills the enforcer rule
protected boolean	validate(org.eclipse.aether.graph.DependencyNode node, int level, StringBuilder messageBuilder)

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 java.lang.Object

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

Method Details

validate

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

Validates a dependency artifact if it fulfills the enforcer rule

Parameters:

artifact - dependency to be checked against the list of excludes

Returns:

true if the dependency passes the rule, false if the dependency triggers a validation error

getErrorMessage

protected String getErrorMessage()

toString

public String toString()

Overrides:

toString in class Object

getSession

protected org.apache.maven.execution.MavenSession getSession()

execute

public void execute()
             throws EnforcerRuleException

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException

validate

protected boolean validate(org.eclipse.aether.graph.DependencyNode node,
 int level,
 StringBuilder messageBuilder)

setSearchTransitive

public void setSearchTransitive(boolean theSearchTransitive)

Sets the search transitive.

Parameters:

theSearchTransitive - the searchTransitive to set

getExcludes

public List<String> getExcludes()

Gets the excludes.

Returns:

the excludes

setExcludes

public void setExcludes(List<String> theExcludes)

Specify the banned dependencies. This can be a list of artifacts in the format groupId[:artifactId][:version]. Any of the sections can be a wildcard by using '*' (ie group:*:1.0)
The rule will fail if any dependency matches any exclude, unless it also matches an include rule.

Parameters:

theExcludes - the excludes to set

See Also:

• getExcludes()

getIncludes

public List<String> getIncludes()

Gets the includes.

Returns:

the includes

setIncludes

public void setIncludes(List<String> theIncludes)

Specify the allowed dependencies. This can be a list of artifacts in the format groupId[:artifactId][:version]. Any of the sections can be a wildcard by using '*' (ie group:*:1.0)
Includes override the exclude rules. It is meant to allow wide exclusion rules with wildcards and still allow a smaller set of includes.
For example, to ban all xerces except xerces-api → exclude "xerces", include "xerces:xerces-api"

Parameters:

theIncludes - the includes to set

See Also:

• setIncludes(List)

isSearchTransitive

public boolean isSearchTransitive()

setLog

public void setLog(EnforcerLogger arg0)

Specified by:

setLog in interface EnforcerRuleBase

getLog

public EnforcerLogger getLog()