Package io.quarkus.sbom

Class SbomContribution

java.lang.Object

io.quarkus.sbom.SbomContribution

public final class SbomContribution
extends Object

Groups component descriptors and their dependency relationships for SBOM contribution.

An SbomContribution contains:

• A flat collection of ComponentDescriptor instances (one per software component)
• A collection of ComponentDependencies that describe the dependency graph between components, referencing them by bom-ref

The mainComponentBomRef() and runnerPath() properties are reserved for the Quarkus core contribution. Extensions should use of(Collection, Collection) or ofComponents(Collection) to create their contributions.

Instances are immutable and safe for use by multiple threads. The SbomContribution.Builder is not thread-safe and should not be shared between threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SbomContribution.Builder

Method Summary

Modifier and Type	Method	Description
static SbomContribution.Builder	builder()
Collection<ComponentDescriptor>	components()
Collection<ComponentDependencies>	dependencies()
String	mainComponentBomRef()
static SbomContribution	of(Collection<ComponentDescriptor> components, Collection<ComponentDependencies> dependencies)	Creates a contribution with both components and dependencies.
static SbomContribution	ofComponents(Collection<ComponentDescriptor> components)	Creates a contribution with components only (no dependency relationships).
Path	runnerPath()

Methods inherited from class java.lang.Object

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

Method Details

of

public static SbomContribution of(Collection<ComponentDescriptor> components,
 Collection<ComponentDependencies> dependencies)

Creates a contribution with both components and dependencies.

Parameters:

components - the component descriptors

dependencies - the dependency relationships

Returns:

a new contribution

ofComponents

public static SbomContribution ofComponents(Collection<ComponentDescriptor> components)

Creates a contribution with components only (no dependency relationships).

Parameters:

components - the component descriptors

Returns:

a new contribution

components

public Collection<ComponentDescriptor> components()

dependencies

public Collection<ComponentDependencies> dependencies()

mainComponentBomRef

public String mainComponentBomRef()

runnerPath

public Path runnerPath()

builder

public static SbomContribution.Builder builder()