Package org.cyclonedx.maven

Interface ModelConverter

  • All Known Implementing Classes:
    DefaultModelConverter
    public interface ModelConverter
    Model converter from Maven concepts (Artifact + MavenProject) to CycloneDX ones (resp. pURL and Component + Metadata).

    • Method Detail

      • generatePackageUrl

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

      • generateVersionlessPackageUrl

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

      • generatePackageUrl

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

      • generateVersionlessPackageUrl

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

      • generateClassifierlessPackageUrl

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

      • convert

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

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