Package io.quarkus.maven

Class DependencySbomMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.quarkus.maven.DependencySbomMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="dependency-sbom",
      defaultPhase=NONE,
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class DependencySbomMojo
extends org.apache.maven.plugin.AbstractMojo

Quarkus application SBOM generator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	format	CycloneDX BOM format.
(package private) boolean	includeLicenseText	Whether to include license text in the generated SBOM.
(package private) String	mode	Target launch mode corresponding to LaunchMode for which the SBOM should be built.
(package private) File	outputFile	File to store the SBOM in.
(package private) org.apache.maven.project.MavenProject	project
(package private) List<org.eclipse.aether.repository.RemoteRepository>	repos
protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver	resolver
(package private) boolean	runtimeOnly	Whether to limit application dependencies to only those that are included in the runtime
(package private) String	schemaVersion	CycloneDX BOM schema version
(package private) org.apache.maven.execution.MavenSession	session
(package private) boolean	skip	Whether to skip the execution of the goal
(package private) QuarkusWorkspaceProvider	workspaceProvider

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
DependencySbomMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver	getResolver()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Details

workspaceProvider

@Component
QuarkusWorkspaceProvider workspaceProvider

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true)
org.apache.maven.execution.MavenSession session

repos

@Parameter(defaultValue="${project.remoteProjectRepositories}",
           readonly=true,
           required=true)
List<org.eclipse.aether.repository.RemoteRepository> repos

skip

@Parameter(defaultValue="false",
           property="quarkus.dependency.sbom.skip")
boolean skip

Whether to skip the execution of the goal

mode

@Parameter(property="quarkus.dependency.sbom.mode",
           defaultValue="prod")
String mode

Target launch mode corresponding to LaunchMode for which the SBOM should be built. io.quarkus.runtime.LaunchMode.NORMAL is the default.

format

@Parameter(property="quarkus.dependency.sbom.format",
           defaultValue="json")
String format

CycloneDX BOM format. Allowed values are json and xml. The default is json.

outputFile

@Parameter(property="quarkus.dependency.sbom.output-file")
File outputFile

File to store the SBOM in. If not configured, the SBOM will be stored in the ${project.build.directory} directory.

includeLicenseText

@Parameter(property="quarkus.dependency.sbom.include-license-text",
           defaultValue="false")
boolean includeLicenseText

Whether to include license text in the generated SBOM. The default is false

schemaVersion

@Parameter(property="quarkus.dependency.sbom.schema-version")
String schemaVersion

CycloneDX BOM schema version

runtimeOnly

@Parameter(property="quarkus.dependency.sbom.runtime-only")
boolean runtimeOnly

Whether to limit application dependencies to only those that are included in the runtime

resolver

protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver resolver

Constructor Details

DependencySbomMojo

public DependencySbomMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getResolver

protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver getResolver()