org.cyclonedx.maven

Class CycloneDxAggregateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.cyclonedx.maven.BaseCycloneDxMojo

org.cyclonedx.maven.CycloneDxMojo

org.cyclonedx.maven.CycloneDxAggregateMojo

All Implemented Interfaces:

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

@Mojo(name="makeAggregateBom",
      defaultPhase=PACKAGE,
      threadSafe=true,
      aggregator=true,
      requiresOnline=true,
      requiresDependencyCollection=TEST,
      requiresDependencyResolution=TEST)
public class CycloneDxAggregateMojo
extends CycloneDxMojo

Creates a CycloneDX aggregate BOM at build root (with dependencies from the whole multi-modules build), and eventually a BOM for each module.

Since:

2.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	excludeArtifactId Excluded reactor project (aka module) ArtifactIds from aggregate BOM.
protected String[]	excludeGroupId Excluded reactor project (aka module) GroupIds from aggregate BOM.
protected Boolean	excludeTestProject Should reactor project (aka module) artifactId with the word "test" be excluded from aggregate BOM?

Fields inherited from class org.cyclonedx.maven.CycloneDxMojo

dependencyAnalyzer

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
CycloneDxAggregateMojo()

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 void	logAdditionalParameters()
protected boolean	shouldExclude(org.apache.maven.project.MavenProject mavenProject)

Methods inherited from class org.cyclonedx.maven.CycloneDxMojo

createProjectDependencyAnalyzer, getComponentScope

Methods inherited from class org.cyclonedx.maven.BaseCycloneDxMojo

buildDependencyGraph, convert, execute, generatePackageUrl, generateVersionlessPackageUrl, getProject, 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

Field Detail

excludeArtifactId

@Parameter(property="excludeArtifactId",
           required=false)
protected String[] excludeArtifactId

Excluded reactor project (aka module) ArtifactIds from aggregate BOM.

Since:

2.4.0

excludeGroupId

@Parameter(property="excludeGroupId",
           required=false)
protected String[] excludeGroupId

Excluded reactor project (aka module) GroupIds from aggregate BOM.

Since:

2.7.3

excludeTestProject

@Parameter(property="excludeTestProject",
           defaultValue="false",
           required=false)
protected Boolean excludeTestProject

Should reactor project (aka module) artifactId with the word "test" be excluded from aggregate BOM?

Since:

2.4.0

Constructor Detail

CycloneDxAggregateMojo

public CycloneDxAggregateMojo()

Method Detail

shouldExclude

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

logAdditionalParameters

protected void logAdditionalParameters()

Overrides:

logAdditionalParameters in class BaseCycloneDxMojo

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.

Overrides:

analyze in class CycloneDxMojo

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...