Class BanTransitiveDependencies
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.BanTransitiveDependencies
- All Implemented Interfaces:
EnforcerRuleBase
@Named("banTransitiveDependencies")
public final class BanTransitiveDependencies
extends AbstractStandardEnforcerRule
This rule bans all transitive dependencies. There is a configuration option to exclude certain artifacts from being
checked.
-
Field Summary
FieldsModifier and TypeFieldDescriptionSpecify the dependencies that will be ignored.Specify the dependencies that will be checked.private final ResolverUtil
private final org.apache.maven.execution.MavenSession
-
Constructor Summary
ConstructorsConstructorDescriptionBanTransitiveDependencies
(org.apache.maven.execution.MavenSession session, ResolverUtil resolverUtil) -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
This is the interface into the rule.private static boolean
searchTree
(org.eclipse.aether.graph.DependencyNode node, int level, ArtifactMatcher excludes, Set<org.eclipse.aether.graph.Dependency> directDependencies, StringBuilder message) Searches dependency tree recursively for transitive dependencies that are not excluded, while generating nice info message along the way.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
-
Field Details
-
excludes
Specify the dependencies that will be ignored. This can be a list of artifacts in the formatgroupId[:artifactId][:version][:type][:scope]
. Wildcard '*' can be used to in place of specific section (ie group:*:1.0 will match both 'group:artifact:1.0' and 'group:anotherArtifact:1.0')
You can override this patterns by using includes. Version is a string representing standard maven version range. Empty patterns will be ignored. -
includes
Specify the dependencies that will be checked. These are exceptions to excludes intended for more convenient and finer settings. This can be a list of artifacts in the formatgroupId[:artifactId][:version][:type][:scope]
. Wildcard '*' can be used to in place of specific section (ie group:*:1.0 will match both 'group:artifact:1.0' and 'group:anotherArtifact:1.0')
Version is a string representing standard maven version range. Empty patterns will be ignored. -
session
private final org.apache.maven.execution.MavenSession session -
resolverUtil
-
-
Constructor Details
-
BanTransitiveDependencies
@Inject public BanTransitiveDependencies(org.apache.maven.execution.MavenSession session, ResolverUtil resolverUtil)
-
-
Method Details
-
searchTree
private static boolean searchTree(org.eclipse.aether.graph.DependencyNode node, int level, ArtifactMatcher excludes, Set<org.eclipse.aether.graph.Dependency> directDependencies, StringBuilder message) Searches dependency tree recursively for transitive dependencies that are not excluded, while generating nice info message along the way. -
execute
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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exception
-
toString
-