org.cyclonedx.maven

Class BaseCycloneDxMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.cyclonedx.maven.BaseCycloneDxMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CycloneDxMojo, CycloneDxPackageMojo

public abstract class BaseCycloneDxMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MESSAGE_CREATING_BOM
protected static String	MESSAGE_RESOLVING_AGGREGATED_DEPS
protected static String	MESSAGE_RESOLVING_DEPS Various messages sent to console.
protected static String	MESSAGE_VALIDATING_BOM
protected static String	MESSAGE_VALIDATION_FAILURE
protected static String	MESSAGE_WRITING_BOM

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

ROLE

Constructor Summary

Constructors

Constructor and Description
BaseCycloneDxMojo()

Method Summary

Modifier and Type	Method and Description
protected abstract 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 Set<org.cyclonedx.model.Dependency>	buildDependencyGraph(org.apache.maven.project.MavenProject mavenProject)
protected org.cyclonedx.model.Component	convert(org.apache.maven.artifact.Artifact artifact)
void	execute()
protected String	generatePackageUrl(org.apache.maven.artifact.Artifact artifact)
protected String	generateVersionlessPackageUrl(org.apache.maven.artifact.Artifact artifact)
protected org.apache.maven.project.MavenProject	getProject() Returns a reference to the current project.
protected void	logAdditionalParameters()
protected void	logParameters()
protected org.cyclonedx.CycloneDxSchema.Version	schemaVersion() Resolves the CycloneDX schema the mojo has been requested to use.

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

MESSAGE_RESOLVING_DEPS

protected static final String MESSAGE_RESOLVING_DEPS

Various messages sent to console.

See Also:

Constant Field Values

MESSAGE_RESOLVING_AGGREGATED_DEPS

protected static final String MESSAGE_RESOLVING_AGGREGATED_DEPS

See Also:

Constant Field Values

MESSAGE_CREATING_BOM

protected static final String MESSAGE_CREATING_BOM

See Also:

Constant Field Values

MESSAGE_WRITING_BOM

protected static final String MESSAGE_WRITING_BOM

See Also:

Constant Field Values

MESSAGE_VALIDATING_BOM

protected static final String MESSAGE_VALIDATING_BOM

See Also:

Constant Field Values

MESSAGE_VALIDATION_FAILURE

protected static final String MESSAGE_VALIDATION_FAILURE

See Also:

Constant Field Values

Constructor Detail

BaseCycloneDxMojo

public BaseCycloneDxMojo()

Method Detail

getProject

protected org.apache.maven.project.MavenProject getProject()

Returns a reference to the current project.

Returns:

returns a reference to the current project

generatePackageUrl

protected String generatePackageUrl(org.apache.maven.artifact.Artifact artifact)

generateVersionlessPackageUrl

protected String generateVersionlessPackageUrl(org.apache.maven.artifact.Artifact artifact)

convert

protected org.cyclonedx.model.Component convert(org.apache.maven.artifact.Artifact artifact)

analyze

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

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

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

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

schemaVersion

protected org.cyclonedx.CycloneDxSchema.Version schemaVersion()

Resolves the CycloneDX schema the mojo has been requested to use.

Returns:

the CycloneDX schema to use

buildDependencyGraph

protected Set<org.cyclonedx.model.Dependency> buildDependencyGraph(org.apache.maven.project.MavenProject mavenProject)
                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

logAdditionalParameters

protected void logAdditionalParameters()

logParameters

protected void logParameters()