org.cyclonedx.maven

Class CycloneDxPackageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.cyclonedx.maven.BaseCycloneDxMojo

org.cyclonedx.maven.CycloneDxPackageMojo

All Implemented Interfaces:

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

@Mojo(name="makePackageBom",
      defaultPhase=PACKAGE,
      threadSafe=true,
      aggregator=true,
      requiresOnline=true,
      requiresDependencyCollection=TEST,
      requiresDependencyResolution=TEST)
public class CycloneDxPackageMojo
extends BaseCycloneDxMojo

Creates a CycloneDX BOM for each Maven module with war or ear packaging.

Since:

2.4.0

Field Summary

Fields inherited from class org.cyclonedx.maven.BaseCycloneDxMojo

MESSAGE_CREATING_BOM, MESSAGE_RESOLVING_AGGREGATED_DEPS, MESSAGE_RESOLVING_DEPS, MESSAGE_VALIDATING_BOM, MESSAGE_VALIDATION_FAILURE, MESSAGE_WRITING_BOM

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CycloneDxPackageMojo()

Method Summary

Modifier and Type	Method and Description
protected String	analyze(Set<org.cyclonedx.model.Component> components, Set<org.cyclonedx.model.Dependency> dependencies) Analyze the project dependencies to fill the BOM components list and their dependencies.
protected boolean	shouldInclude(org.apache.maven.project.MavenProject mavenProject)

Methods inherited from class org.cyclonedx.maven.BaseCycloneDxMojo

buildDependencyGraph, convert, execute, generatePackageUrl, generateVersionlessPackageUrl, getProject, logAdditionalParameters, logParameters, schemaVersion

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

Constructor Detail

CycloneDxPackageMojo

public CycloneDxPackageMojo()

Method Detail

shouldInclude

protected boolean shouldInclude(org.apache.maven.project.MavenProject mavenProject)

analyze

protected String analyze(Set<org.cyclonedx.model.Component> components,
                         Set<org.cyclonedx.model.Dependency> dependencies)
                  throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: BaseCycloneDxMojo

Analyze the project dependencies to fill the BOM components list and their dependencies.

Specified by:

analyze in class BaseCycloneDxMojo

Parameters:

components - the components set to fill

dependencies - the dependencies set to fill

Returns:

the name of the analysis done to store as a BOM, or null to not save result.

Throws:

org.apache.maven.plugin.MojoExecutionException - something weird happened...