org.apache.maven.plugins.enforcer

Class BanTransitiveDependencies

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.BanTransitiveDependencies

All Implemented Interfaces:

EnforcerRule

public class BanTransitiveDependencies
extends AbstractNonCacheableEnforcerRule
implements EnforcerRule

This rule bans all transitive dependencies. There is a configuration option to exclude certain artifacts from being checked.

Author:

Jakub Senko

Field Summary

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

message

Constructor Summary

Constructors

Constructor and Description
BanTransitiveDependencies()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.

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

Methods inherited from interface org.apache.maven.enforcer.rule.api.EnforcerRule

getCacheId, isCacheable, isResultValid

Constructor Detail

BanTransitiveDependencies

public BanTransitiveDependencies()

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.

Specified by:

execute in interface EnforcerRule

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