org.cyclonedx.maven

Class CycloneDxMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.cyclonedx.maven.BaseCycloneDxMojo

org.cyclonedx.maven.CycloneDxMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CycloneDxAggregateMojo

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

Creates a CycloneDX BOM for each Maven module with its dependencies.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer	dependencyAnalyzer 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
CycloneDxMojo()

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 org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer	createProjectDependencyAnalyzer()
protected org.cyclonedx.model.Component.Scope	getComponentScope(org.cyclonedx.model.Component component, org.apache.maven.artifact.Artifact artifact, org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis dependencyAnalysis) Method to identify component scope based on dependency analysis

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

Field Detail

dependencyAnalyzer

protected org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer dependencyAnalyzer

DependencyAnalyzer

Constructor Detail

CycloneDxMojo

public CycloneDxMojo()

Method Detail

createProjectDependencyAnalyzer

protected org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalyzer createProjectDependencyAnalyzer()
                                                                                                         throws org.apache.maven.plugin.MojoExecutionException

Returns:

ProjectDependencyAnalyzer

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of an error.

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

getComponentScope

protected org.cyclonedx.model.Component.Scope getComponentScope(org.cyclonedx.model.Component component,
                                                                org.apache.maven.artifact.Artifact artifact,
                                                                org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis dependencyAnalysis)

Method to identify component scope based on dependency analysis

Parameters:

component - Component

artifact - Artifact from maven project

dependencyAnalysis - Dependency analysis data

Returns:

Component.Scope - Required: If the component is used. Optional: If it is unused