Package org.apache.maven.enforcer.rules

Class RequireNoRepositories

  • All Implemented Interfaces:
    EnforcerRuleBase
    @Named("requireNoRepositories")
public final class RequireNoRepositories
extends AbstractStandardEnforcerRule
    This rule checks that this pom or its parents don't define a repository.

    • Field Detail

      • banRepositories

        private boolean banRepositories
        Whether to ban non-plugin repositories. By default they are banned.
        See Also:
        setBanRepositories(boolean)

      • banPluginRepositories

        private boolean banPluginRepositories
        Whether to ban plugin repositories. By default they are banned.
        See Also:
        setBanPluginRepositories(boolean)

      • allowedRepositories

        private java.util.List<java.lang.String> allowedRepositories
        Specify explicitly allowed non-plugin repositories. This is a list of ids.
        See Also:
        setAllowedRepositories(List)

      • allowedPluginRepositories

        private java.util.List<java.lang.String> allowedPluginRepositories
        Specify explicitly allowed plugin repositories. This is a list of ids.
        See Also:
        setAllowedPluginRepositories(List)

      • allowSnapshotRepositories

        private boolean allowSnapshotRepositories
        Whether to allow repositories which only resolve snapshots. By default they are banned.
        See Also:
        setAllowSnapshotRepositories(boolean)

      • allowSnapshotPluginRepositories

        private boolean allowSnapshotPluginRepositories
        Whether to allow plugin repositories which only resolve snapshots. By default they are banned.
        See Also:
        setAllowSnapshotPluginRepositories(boolean)

      • session

        private final org.apache.maven.execution.MavenSession session

    • Constructor Detail

      • RequireNoRepositories

        @Inject
public RequireNoRepositories​(org.apache.maven.execution.MavenSession session)

    • Method Detail

      • setBanRepositories

        public void setBanRepositories​(boolean banRepositories)

      • setBanPluginRepositories

        public void setBanPluginRepositories​(boolean banPluginRepositories)

      • setAllowedRepositories

        public void setAllowedRepositories​(java.util.List<java.lang.String> allowedRepositories)

      • setAllowedPluginRepositories

        public void setAllowedPluginRepositories​(java.util.List<java.lang.String> allowedPluginRepositories)

      • setAllowSnapshotRepositories

        public void setAllowSnapshotRepositories​(boolean allowSnapshotRepositories)

      • setAllowSnapshotPluginRepositories

        public void setAllowSnapshotPluginRepositories​(boolean allowSnapshotPluginRepositories)

      • 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
        EnforcerRuleError - in order to brake a build immediately

      • getRepoIdsFromSettings

        private java.util.Collection<java.lang.String> getRepoIdsFromSettings​(java.util.function.Function<org.apache.maven.settings.Profile,​java.util.List<org.apache.maven.settings.Repository>> getRepositoriesFunc)

      • findBannedRepositories

        private static java.util.List<java.lang.String> findBannedRepositories​(java.util.List<org.apache.maven.model.Repository> repos,
                                                                       java.util.List<java.lang.String> allowedRepos,
                                                                       boolean allowSnapshots)
        Parameters:
        repos - all repositories, never null
        allowedRepos - allowed repositories, never null
        allowSnapshots -
        Returns:
        List of banned repositoreis.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object