Class AbstractBanDependencies

    • Field Detail

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

      • AbstractBanDependencies

        public AbstractBanDependencies()
    • 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.
        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 java.lang.CharSequence getErrorMessage​(org.apache.maven.artifact.Artifact artifact)
      • getDependenciesToCheck

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

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

        protected abstract java.util.Set<org.apache.maven.artifact.Artifact> checkDependencies​(java.util.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