Package 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	Description
DefaultModelConverter()

Method Summary

Modifier and Type	Method	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 projectType, org.cyclonedx.CycloneDxSchema.Version schemaVersion, boolean includeLicenseText)	Converts a MavenProject into a Metadata object.
String	generateClassifierlessPackageUrl(org.eclipse.aether.artifact.Artifact artifact)
String	generatePackageUrl(org.apache.maven.artifact.Artifact artifact)
String	generatePackageUrl(org.eclipse.aether.artifact.Artifact artifact)
String	generateVersionlessPackageUrl(org.apache.maven.artifact.Artifact artifact)
String	generateVersionlessPackageUrl(org.eclipse.aether.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

generatePackageUrl

public String generatePackageUrl(org.eclipse.aether.artifact.Artifact artifact)

Specified by:

generatePackageUrl in interface ModelConverter

generateVersionlessPackageUrl

public String generateVersionlessPackageUrl(org.eclipse.aether.artifact.Artifact artifact)

Specified by:

generateVersionlessPackageUrl in interface ModelConverter

generateClassifierlessPackageUrl

public String generateClassifierlessPackageUrl(org.eclipse.aether.artifact.Artifact artifact)

Specified by:

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

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