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 that this project's maven session whether have banned repositories.
-
Field Summary
FieldsModifier and TypeFieldDescriptionSpecify explicitly allowed plugin repositories, then all others repositories would be banned.Specify explicitly allowed non-plugin repositories, then all others repositories would be banned.Specify explicitly banned plugin repositories.Specify explicitly banned non-plugin repositories.private final org.apache.maven.project.MavenProject
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate 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
private boolean
private String
populateErrorMessage
(List<org.apache.maven.artifact.repository.ArtifactRepository> resultBannedRepos, String errorMessagePrefix) protected void
setAllowedPluginRepositories
(List<String> allowedPluginRepositories) protected void
setAllowedRepositories
(List<String> allowedRepositories) protected void
setBannedRepositories
(List<String> bannedRepositories) 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
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
Field Details
-
bannedRepositories
Specify explicitly banned non-plugin repositories. This is a list of repository url patterns. Support wildcard "*". -
bannedPluginRepositories
Specify explicitly banned plugin repositories. This is a list of repository url patterns. Support wildcard "*". -
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
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
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 exception
-
setBannedRepositories
-
setAllowedRepositories
-
setAllowedPluginRepositories
-
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
-
match
-
populateErrorMessage
-
getRepositoryUrlString
-
toString
-