Class BannedRepositories

All Implemented Interfaces:
EnforcerRuleBase

@Named("bannedRepositories") public final class BannedRepositories extends AbstractStandardEnforcerRule
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 "*".
    • project

      private final org.apache.maven.project.MavenProject project
  • Constructor Details

    • BannedRepositories

      @Inject public BannedRepositories(org.apache.maven.project.MavenProject project)
  • Method Details

    • execute

      public void execute() throws EnforcerRuleException
      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 class AbstractEnforcerRule
      Throws:
      EnforcerRuleException - the enforcer rule exception
    • setBannedRepositories

      protected void setBannedRepositories(List<String> bannedRepositories)
    • 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)
    • toString

      public String toString()
      Overrides:
      toString in class Object