org.sonatype.ossindex.maven.enforcer

Class BanVulnerableDependencies

java.lang.Object

org.sonatype.ossindex.maven.enforcer.EnforcerRuleSupport

org.sonatype.ossindex.maven.enforcer.BanVulnerableDependencies

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2

public class BanVulnerableDependencies
extends EnforcerRuleSupport

Enforcer rule to ban vulnerable dependencies.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
BanVulnerableDependencies()

Method Summary

Modifier and Type	Method and Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
void	setAuthId(String authId) Set client authentication from Maven settings server configuration.
void	setClientConfiguration(org.sonatype.ossindex.service.client.OssindexClientConfiguration clientConfiguration) Sonatype OSS Index client configuration.
void	setCvssScoreThreshold(float cvssScoreThreshold) CVSS-score threshold.
void	setExcludeCoordinates(Set<MavenCoordinates> excludeCoordinates) Set of coordinates to exclude from vulnerability matching.
void	setExcludeVulnerabilityIds(Set<String> excludeVulnerabilityIds) Set of Sonatype OSS Index vulnerability identifiers to exclude from matching.
void	setScope(String scope) Limit scope of dependency resolution.
void	setTransitive(boolean transitive) Include transitive dependencies.

Methods inherited from class org.sonatype.ossindex.maven.enforcer.EnforcerRuleSupport

getCacheId, getLevel, isCacheable, isResultValid, lookup, lookup, setLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

BanVulnerableDependencies

public BanVulnerableDependencies()

Method Detail

setClientConfiguration

public void setClientConfiguration(org.sonatype.ossindex.service.client.OssindexClientConfiguration clientConfiguration)

Sonatype OSS Index client configuration.

setAuthId

public void setAuthId(String authId)

Set client authentication from Maven settings server configuration.

setScope

public void setScope(String scope)

Limit scope of dependency resolution.

setTransitive

public void setTransitive(boolean transitive)

Include transitive dependencies.

setExcludeCoordinates

public void setExcludeCoordinates(Set<MavenCoordinates> excludeCoordinates)

Set of coordinates to exclude from vulnerability matching.

setCvssScoreThreshold

public void setCvssScoreThreshold(float cvssScoreThreshold)

CVSS-score threshold. Vulnerabilities with lower scores will be excluded.

setExcludeVulnerabilityIds

public void setExcludeVulnerabilityIds(Set<String> excludeVulnerabilityIds)

Set of Sonatype OSS Index vulnerability identifiers to exclude from matching.

execute

public void execute(@Nonnull
                    org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException