org.cyclonedx.maven

Class DefaultModelConverter

java.lang.Object

org.cyclonedx.maven.DefaultModelConverter

All Implemented Interfaces:

ModelConverter

@Singleton
 @Named
public class DefaultModelConverter
extends Object
implements ModelConverter

Constructor Summary

Constructors

Constructor and Description
DefaultModelConverter()

Method Summary

Modifier and Type	Method and Description
org.cyclonedx.model.Component	convert(org.apache.maven.artifact.Artifact artifact, org.cyclonedx.CycloneDxSchema.Version schemaVersion, boolean includeLicenseText) Converts a Maven artifact (dependency or transitive dependency) into a CycloneDX component.
org.cyclonedx.model.Metadata	convert(org.apache.maven.project.MavenProject project, String analysis, String projectType, org.cyclonedx.CycloneDxSchema.Version schemaVersion, boolean includeLicenseText) Converts a MavenProject into a Metadata object.
String	generatePackageUrl(org.apache.maven.artifact.Artifact artifact)
String	generateVersionlessPackageUrl(org.apache.maven.artifact.Artifact artifact)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModelConverter

public DefaultModelConverter()

Method Detail

generatePackageUrl

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

Specified by:

generatePackageUrl in interface ModelConverter

generateVersionlessPackageUrl

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

Specified by:

generateVersionlessPackageUrl in interface ModelConverter

convert

public org.cyclonedx.model.Component convert(org.apache.maven.artifact.Artifact artifact,
                                             org.cyclonedx.CycloneDxSchema.Version schemaVersion,
                                             boolean includeLicenseText)

Description copied from interface: ModelConverter

Converts a Maven artifact (dependency or transitive dependency) into a CycloneDX component.

Specified by:

convert in interface ModelConverter

Parameters:

artifact - the artifact to convert

schemaVersion - the target CycloneDX schema version

includeLicenseText - should license text be included in bom?

Returns:

a CycloneDX component

convert

public org.cyclonedx.model.Metadata convert(org.apache.maven.project.MavenProject project,
                                            String analysis,
                                            String projectType,
                                            org.cyclonedx.CycloneDxSchema.Version schemaVersion,
                                            boolean includeLicenseText)

Description copied from interface: ModelConverter

Converts a MavenProject into a Metadata object.

Specified by:

convert in interface ModelConverter

Parameters:

project - the MavenProject to convert

analysis - type of analysis

projectType - the target CycloneDX component type

schemaVersion - the target CycloneDX schema version

includeLicenseText - should license text be included in bom?

Returns:

a CycloneDX Metadata object