Package org.apache.maven.plugins.enforcer

Class BannedRepositories

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.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 Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.String>	allowedPluginRepositories	Specify explicitly allowed plugin repositories, then all others repositories would be banned.
private java.util.List<java.lang.String>	allowedRepositories	Specify explicitly allowed non-plugin repositories, then all others repositories would be banned.
private java.util.List<java.lang.String>	bannedPluginRepositories	Specify explicitly banned plugin repositories.
private java.util.List<java.lang.String>	bannedRepositories	Specify explicitly banned non-plugin repositories.

Constructor Summary

Constructors

Constructor	Description
BannedRepositories()

Method Summary

Modifier and Type	Method	Description
private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository>	checkRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, java.util.List<java.lang.String> includes, java.util.List<java.lang.String> excludes)	Check whether specified repositories have banned repositories.
void	execute(EnforcerRuleHelper helper)	This is the interface into the rule.
private java.lang.String	getRepositoryUrlString(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos)
private boolean	match(java.lang.String text, java.lang.String pattern)
private boolean	match(java.lang.String url, java.util.List<java.lang.String> patterns)
private java.lang.String	populateErrorMessage(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos, java.lang.String errorMessagePrefix)
protected void	setAllowedPluginRepositories(java.util.List<java.lang.String> allowedPluginRepositories)
protected void	setAllowedRepositories(java.util.List<java.lang.String> allowedRepositories)
protected void	setBannedPluginRepositories(java.util.List<java.lang.String> bannedPluginRepositories)
protected void	setBannedRepositories(java.util.List<java.lang.String> bannedRepositories)

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

bannedRepositories

private java.util.List<java.lang.String> bannedRepositories

Specify explicitly banned non-plugin repositories. This is a list of repository url patterns. Support wildcard "*".

bannedPluginRepositories

private java.util.List<java.lang.String> bannedPluginRepositories

Specify explicitly banned plugin repositories. This is a list of repository url patterns. Support wildcard "*".

allowedRepositories

private java.util.List<java.lang.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 java.util.List<java.lang.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 Detail

BannedRepositories

public BannedRepositories()

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

setBannedRepositories

protected void setBannedRepositories(java.util.List<java.lang.String> bannedRepositories)

setBannedPluginRepositories

protected void setBannedPluginRepositories(java.util.List<java.lang.String> bannedPluginRepositories)

setAllowedRepositories

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

setAllowedPluginRepositories

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

checkRepositories

private java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> checkRepositories(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                                                                                  java.util.List<java.lang.String> includes,
                                                                                                  java.util.List<java.lang.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(java.lang.String url,
                      java.util.List<java.lang.String> patterns)

match

private boolean match(java.lang.String text,
                      java.lang.String pattern)

populateErrorMessage

private java.lang.String populateErrorMessage(java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos,
                                              java.lang.String errorMessagePrefix)

getRepositoryUrlString

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