Package org.apache.maven.enforcer.rules
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 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.private org.apache.maven.project.MavenProject
project
-
Constructor Summary
Constructors Constructor Description BannedRepositories(org.apache.maven.project.MavenProject project)
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
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)
(package private) void
setAllowedPluginRepositories(java.util.List<java.lang.String> allowedPluginRepositories)
(package private) void
setAllowedRepositories(java.util.List<java.lang.String> allowedRepositories)
(package private) void
setBannedRepositories(java.util.List<java.lang.String> bannedRepositories)
java.lang.String
toString()
-
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
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 "*".
-
project
private final org.apache.maven.project.MavenProject project
-
-
Method Detail
-
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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- in order to brake a build immediately
-
setBannedRepositories
void setBannedRepositories(java.util.List<java.lang.String> bannedRepositories)
-
setAllowedRepositories
void setAllowedRepositories(java.util.List<java.lang.String> allowedRepositories)
-
setAllowedPluginRepositories
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)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-