Class BannedRepositories

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.BannedRepositories

All Implemented Interfaces:

EnforcerRuleBase

@Named("bannedRepositories")
public final class BannedRepositories
extends AbstractStandardEnforcerRule

This rule checks whether this project's maven session has banned repositories.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	allowedPluginRepositories	Specify explicitly allowed plugin repositories, then all others repositories would be banned.
private List<String>	allowedRepositories	Specify explicitly allowed non-plugin repositories, then all others repositories would be banned.
private List<String>	bannedPluginRepositories	Specify explicitly banned plugin repositories.
private List<String>	bannedRepositories	Specify explicitly banned non-plugin repositories.
private final org.apache.maven.project.MavenProject	project

Constructor Summary

Constructors

Constructor	Description
BannedRepositories(org.apache.maven.project.MavenProject project)

Method Summary

Modifier and Type	Method	Description
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.
void	execute()	This is the interface into the rule.
private String	getRepositoryUrlString(List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos)
private boolean	match(String text, String pattern)
private boolean	match(String url, List<String> patterns)
private String	populateErrorMessage(List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos, String errorMessagePrefix)
(package private) void	setAllowedPluginRepositories(List<String> allowedPluginRepositories)
(package private) void	setAllowedRepositories(List<String> allowedRepositories)
(package private) void	setBannedRepositories(List<String> bannedRepositories)
String	toString()

Methods inherited from class AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class AbstractEnforcerRule

getCacheId, getLevel, getRuleName

Methods inherited from class AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class Object

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

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

void setBannedRepositories(List<String> bannedRepositories)

setAllowedRepositories

void setAllowedRepositories(List<String> allowedRepositories)

setAllowedPluginRepositories

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