Package org.openrewrite.java.dependencies

Class DependencyVulnerabilityCheckBase

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>

org.openrewrite.java.dependencies.DependencyVulnerabilityCheckBase

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DependencyVulnerabilityCheck

public abstract class DependencyVulnerabilityCheckBase
extends org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DependencyVulnerabilityCheckBase.Accumulator
static class	DependencyVulnerabilityCheckBase.Fix
static class	DependencyVulnerabilityCheckBase.MinimumDepthVulnerability
static enum	DependencyVulnerabilityCheckBase.UpgradeDelta
static class	DependencyVulnerabilityCheckBase.Vulnerabilities

Nested classes/interfaces inherited from class org.openrewrite.Recipe

org.openrewrite.Recipe.Builder, org.openrewrite.Recipe.DelegatingRecipe

Field Summary

Fields

Modifier and Type	Field	Description
protected DependencyGraph	dependencyGraph
protected DependencyOriginsReport	dependencyOriginsReport
protected org.openrewrite.maven.table.MavenMetadataFailures	metadataFailures
protected Comparator<org.openrewrite.java.dependencies.internal.Version>	staticVersionComparator
protected @Nullable org.openrewrite.semver.VersionComparator	versionComparator
protected org.openrewrite.java.dependencies.internal.VersionParser	versionParser
protected VulnerabilityReport	vulnerabilityReport

Fields inherited from class org.openrewrite.Recipe

contributors, examples, PANIC

Constructor Summary

Constructors

Constructor	Description
DependencyVulnerabilityCheckBase()

Method Summary

Modifier and Type	Method	Description
List<Vulnerability>	baselineVulnerabilities(org.openrewrite.ExecutionContext ctx)	The baseline vulnerabilities are those that are always included in the recipe by default.
Collection<org.openrewrite.SourceFile>	generate(DependencyVulnerabilityCheckBase.Accumulator acc, org.openrewrite.ExecutionContext ctx)
DependencyVulnerabilityCheckBase.Accumulator	getInitialValue(org.openrewrite.ExecutionContext ctx)
abstract @Nullable DependencyVulnerabilityCheckBase.UpgradeDelta	getMaximumUpgradeDelta()
protected abstract @Nullable Boolean	getOverrideTransitive()
org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>	getScanner(DependencyVulnerabilityCheckBase.Accumulator acc)
protected abstract @Nullable String	getScope()
org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>	getVisitor(DependencyVulnerabilityCheckBase.Accumulator acc)
abstract List<Vulnerability>	supplementalVulnerabilities(org.openrewrite.ExecutionContext ctx)	Supplemental vulnerabilities are those that are added to baseline vulnerabilities.
org.openrewrite.Validated<Object>	validate()

Methods inherited from class org.openrewrite.ScanningRecipe

generate, getAccumulator, getVisitor

Methods inherited from class org.openrewrite.Recipe

addDataTable, builder, buildRecipeList, causesAnotherCycle, clone, createRecipeDescriptor, equals, getContributors, getDataTableDescriptors, getDescription, getDescriptor, getDisplayName, getEstimatedEffortPerOccurrence, getExamples, getInstanceName, getInstanceNameSuffix, getJacksonPolymorphicTypeTag, getMaintainers, getName, getRecipeList, getTags, hashCode, maxCycles, noop, onComplete, run, run, run, setContributors, setExamples, validate, validateAll, validateAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

metadataFailures

protected transient org.openrewrite.maven.table.MavenMetadataFailures metadataFailures

versionParser

protected transient org.openrewrite.java.dependencies.internal.VersionParser versionParser

staticVersionComparator

protected transient Comparator<org.openrewrite.java.dependencies.internal.Version> staticVersionComparator

vulnerabilityReport

protected transient VulnerabilityReport vulnerabilityReport

dependencyOriginsReport

protected transient DependencyOriginsReport dependencyOriginsReport

dependencyGraph

protected transient DependencyGraph dependencyGraph

versionComparator

protected transient @Nullable org.openrewrite.semver.VersionComparator versionComparator

Constructor Details

DependencyVulnerabilityCheckBase

public DependencyVulnerabilityCheckBase()

Method Details

getScope

protected abstract @Nullable String getScope()

getOverrideTransitive

protected abstract @Nullable Boolean getOverrideTransitive()

getMaximumUpgradeDelta

public abstract @Nullable DependencyVulnerabilityCheckBase.UpgradeDelta getMaximumUpgradeDelta()

validate

public org.openrewrite.Validated<Object> validate()

Overrides:

validate in class org.openrewrite.Recipe

baselineVulnerabilities

public List<Vulnerability> baselineVulnerabilities(org.openrewrite.ExecutionContext ctx)

The baseline vulnerabilities are those that are always included in the recipe by default. They are loaded from a CSV resource file.

You can override this method to provide a different set of baseline vulnerabilities or add supplemental vulnerabilities via supplementalVulnerabilities(ExecutionContext).

Parameters:

ctx - the execution context

Returns:

a list of baseline vulnerabilities

supplementalVulnerabilities

public abstract List<Vulnerability> supplementalVulnerabilities(org.openrewrite.ExecutionContext ctx)

Supplemental vulnerabilities are those that are added to baseline vulnerabilities.

Parameters:

ctx - the execution context

Returns:

a list of baseline vulnerabilities

See Also:

• baselineVulnerabilities(ExecutionContext)

getInitialValue

public DependencyVulnerabilityCheckBase.Accumulator getInitialValue(org.openrewrite.ExecutionContext ctx)

Specified by:

getInitialValue in class org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>

getScanner

public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getScanner(DependencyVulnerabilityCheckBase.Accumulator acc)

Specified by:

getScanner in class org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>

generate

public Collection<org.openrewrite.SourceFile> generate(DependencyVulnerabilityCheckBase.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

Overrides:

generate in class org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>

getVisitor

public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getVisitor(DependencyVulnerabilityCheckBase.Accumulator acc)

Overrides:

getVisitor in class org.openrewrite.ScanningRecipe<DependencyVulnerabilityCheckBase.Accumulator>