org.apache.maven.plugins.enforcer

Class RequireNoRepositories

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.RequireNoRepositories

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireNoRepositories
extends AbstractNonCacheableEnforcerRule

This rule checks that this pom or its parents don't define a repository.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	allowedPluginRepositories Specify explicitly allowed plugin repositories.
private java.util.List<java.lang.String>	allowedRepositories Specify explicitly allowed non-plugin repositories.
private boolean	allowSnapshotPluginRepositories Whether to allow plugin repositories which only resolve snapshots.
private boolean	allowSnapshotRepositories Whether to allow repositories which only resolve snapshots.
private boolean	banPluginRepositories Whether to ban plugin repositories.
private boolean	banRepositories Whether to ban non-plugin repositories.

Constructor Summary

Constructors

Constructor and Description
RequireNoRepositories()

Method Summary

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.
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)
void	setAllowedPluginRepositories(java.util.List<java.lang.String> allowedPluginRepositories)
void	setAllowedRepositories(java.util.List<java.lang.String> allowedRepositories)
void	setAllowSnapshotPluginRepositories(boolean allowSnapshotPluginRepositories)
void	setAllowSnapshotRepositories(boolean allowSnapshotRepositories)
void	setBanPluginRepositories(boolean banPluginRepositories)
void	setBanRepositories(boolean banRepositories)

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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)}

Constructor Detail

RequireNoRepositories

public RequireNoRepositories()

Method Detail

setBanRepositories

public final void setBanRepositories(boolean banRepositories)

setBanPluginRepositories

public final void setBanPluginRepositories(boolean banPluginRepositories)

setAllowedRepositories

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

setAllowedPluginRepositories

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

setAllowSnapshotRepositories

public final void setAllowSnapshotRepositories(boolean allowSnapshotRepositories)

setAllowSnapshotPluginRepositories

public final void setAllowSnapshotPluginRepositories(boolean allowSnapshotPluginRepositories)

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

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

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.