Package org.apache.maven.plugins.enforcer

Class AbstractBanDependencies

java.lang.Object
org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
org.apache.maven.plugins.enforcer.AbstractBanDependencies
All Implemented Interfaces:
EnforcerRule, EnforcerRule2
Direct Known Subclasses:
BannedDependencies, RequireReleaseDeps
public abstract class AbstractBanDependencies extends AbstractNonCacheableEnforcerRule
Abstract Rule for banning dependencies.

  • 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
      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.
      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

    • getErrorMessage

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

    • getDependenciesToCheck

      protected Set<org.apache.maven.artifact.Artifact> getDependenciesToCheck(org.apache.maven.project.ProjectBuildingRequest buildingRequest)

    • 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