Package org.apache.maven.enforcer.rules

Class BanDependencyManagementScope

java.lang.Object

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

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.BanDependencyManagementScope

All Implemented Interfaces:

EnforcerRuleBase

@Named("banDependencyManagementScope")
public final class BanDependencyManagementScope
extends AbstractStandardEnforcerRule

This rule bans all scope values except for import from dependencies within the dependency management. There is a configuration option to ignore certain dependencies in this check.

Constructor Summary

Constructors

Constructor	Description
BanDependencyManagementScope(org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method	Description
void	execute()	This is the interface into the rule.
EnforcerLogger	getLog()	Provide an EnforcerLogger instance for Rule
protected List<org.apache.maven.model.Dependency>	getViolatingDependencies(org.apache.maven.model.DependencyManagement depMgmt)
void	setExcludes(List<String> theExcludes)
void	setLog(EnforcerLogger log)	Used by EnforcerMojo to inject logger instance
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 java.lang.Object

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

Constructor Details

BanDependencyManagementScope

@Inject
public BanDependencyManagementScope(org.apache.maven.project.MavenProject project)

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

EnforcerRuleError - in order to brake a build immediately

getViolatingDependencies

protected List<org.apache.maven.model.Dependency> getViolatingDependencies(org.apache.maven.model.DependencyManagement depMgmt)

setExcludes

public void setExcludes(List<String> theExcludes)

toString

public String toString()

Overrides:

toString in class Object

setLog

public void setLog(EnforcerLogger log)

Used by EnforcerMojo to inject logger instance

Specified by:

setLog in interface EnforcerRuleBase

Parameters:

log - an EnforcerLogger instance

getLog

public EnforcerLogger getLog()

Provide an EnforcerLogger instance for Rule

NOTICE A logger is not available in constructors.

Returns:

an EnforcerLogger instance