Class AbstractBanDependencies

All Implemented Interfaces:
EnforcerRule, EnforcerRule2
Direct Known Subclasses:
BannedDependencies, NoSnapshots, RequireReleaseDeps

public abstract class AbstractBanDependencies extends AbstractNonCacheableEnforcerRule
Abstract Rule for banning dependencies.
Version:
$Id: AbstractBanDependencies.java 1630934 2014-10-10 16:35:26Z khmarbaise $
  • Field Details

    • searchTransitive

      private boolean searchTransitive
      Specify if transitive dependencies should be searched (default) or only look at direct dependencies.
    • graphBuilder

      private transient org.apache.maven.shared.dependency.graph.DependencyGraphBuilder graphBuilder
  • Constructor Details

    • AbstractBanDependencies

      public AbstractBanDependencies()
  • Method Details

    • execute

      public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
      Execute the rule.
      Parameters:
      helper - the helper
      Throws:
      EnforcerRuleException - the enforcer rule exception
    • getErrorMessage

      protected CharSequence getErrorMessage(org.apache.maven.artifact.Artifact artifact)
    • getDependenciesToCheck

      protected Set<org.apache.maven.artifact.Artifact> getDependenciesToCheck(org.apache.maven.project.ProjectBuildingRequest projectBuildingRequest)
    • getAllDescendants

      private Set<org.apache.maven.artifact.Artifact> getAllDescendants(org.apache.maven.shared.dependency.graph.DependencyNode node)
    • checkDependencies

      protected abstract Set<org.apache.maven.artifact.Artifact> checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies, org.apache.maven.plugin.logging.Log log) throws EnforcerRuleException
      Checks the set of dependencies against the list of excludes.
      Parameters:
      dependencies - the dependencies
      log - the log
      Returns:
      the sets the
      Throws:
      EnforcerRuleException - the enforcer rule exception
    • isSearchTransitive

      public boolean isSearchTransitive()
      Checks if is search transitive.
      Returns:
      the searchTransitive
    • setSearchTransitive

      public void setSearchTransitive(boolean theSearchTransitive)
      Sets the search transitive.
      Parameters:
      theSearchTransitive - the searchTransitive to set