Class BannedRepositories

All Implemented Interfaces:
EnforcerRule, EnforcerRule2

public class BannedRepositories extends AbstractNonCacheableEnforcerRule
This rule checks that this project's maven session whether have banned repositories.
  • Field Details

    • bannedRepositories

      private List<String> bannedRepositories
      Specify explicitly banned non-plugin repositories. This is a list of repository url patterns. Support wildcard "*".
    • bannedPluginRepositories

      private List<String> bannedPluginRepositories
      Specify explicitly banned plugin repositories. This is a list of repository url patterns. Support wildcard "*".
    • allowedRepositories

      private List<String> allowedRepositories
      Specify explicitly allowed non-plugin repositories, then all others repositories would be banned. This is a list of repository url patterns. Support wildcard "*".
    • allowedPluginRepositories

      private List<String> allowedPluginRepositories
      Specify explicitly allowed plugin repositories, then all others repositories would be banned. This is a list of repository url patterns. Support wildcard "*".
  • Constructor Details

    • BannedRepositories

      public BannedRepositories()
  • 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
    • setBannedRepositories

      protected void setBannedRepositories(List<String> bannedRepositories)
    • setBannedPluginRepositories

      protected void setBannedPluginRepositories(List<String> bannedPluginRepositories)
    • setAllowedRepositories

      protected void setAllowedRepositories(List<String> allowedRepositories)
    • setAllowedPluginRepositories

      protected void setAllowedPluginRepositories(List<String> allowedPluginRepositories)
    • checkRepositories

      private List<org.apache.maven.artifact.repository.ArtifactRepository> checkRepositories(List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, List<String> includes, List<String> excludes)
      Check whether specified repositories have banned repositories.
      Parameters:
      repositories - : candidate repositories.
      includes - : 'include' patterns.
      excludes - : 'exclude' patterns.
      Returns:
      Banned repositories.
    • match

      private boolean match(String url, List<String> patterns)
    • match

      private boolean match(String text, String pattern)
    • populateErrorMessage

      private String populateErrorMessage(List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos, String errorMessagePrefix)
    • getRepositoryUrlString

      private String getRepositoryUrlString(List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos)