Package io.quarkus.cyclonedx.deployment

Interface CycloneDxConfig

@ConfigMapping(prefix="quarkus.cyclonedx") @ConfigRoot public interface CycloneDxConfig
CycloneDX SBOM generator configuration

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    format()
    SBOM file format.
    boolean
    includeLicenseText()
    Whether to include the license text into generated SBOMs.
    Optional<String>
    schemaVersion()
    CycloneDX specification version.
    boolean
    skip()
    Whether to skip SBOM generation

  • Method Details

    • skip

      @WithDefault("false") boolean skip()
      Whether to skip SBOM generation

    • format

      @WithDefault("json") String format()
      SBOM file format. Supported formats are {code json} and {code xml}. The default format is JSON. If both are desired then all could be used as the value of this option.
      Returns:
      SBOM file format

    • schemaVersion

      Optional<String> schemaVersion()
      CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library.
      Returns:
      CycloneDX specification version

    • includeLicenseText

      @WithDefault("false") boolean includeLicenseText()
      Whether to include the license text into generated SBOMs.
      Returns:
      whether to include the license text into generated SBOMs