Package org.sonatype.gradle.plugins.scan.ossindex

Class CycloneDxResponseHandler

java.lang.Object
org.sonatype.gradle.plugins.scan.ossindex.CycloneDxResponseHandler
All Implemented Interfaces:
OssIndexResponseHandler
public class CycloneDxResponseHandler extends Object implements OssIndexResponseHandler
Response handler that produces a CycloneDX SBOM from OSS Index scan results.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FILE_NAME_OUTPUT
    Default output filename for the CycloneDX BOM JSON file.

    Fields inherited from interface org.sonatype.gradle.plugins.scan.ossindex.OssIndexResponseHandler

    log

  • Constructor Summary

    Constructors
    Constructor
    Description
    CycloneDxResponseHandler(OssIndexPluginExtension extension, org.gradle.api.Project project)
    Constructs a handler with the given extension configuration and Gradle project.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    handleOssIndexResponse(Set<org.gradle.api.artifacts.ResolvedDependency> dependencies, Map<org.gradle.api.artifacts.ResolvedDependency,org.sonatype.goodies.packageurl.PackageUrl> dependenciesMap, Map<org.sonatype.goodies.packageurl.PackageUrl,org.sonatype.ossindex.service.api.componentreport.ComponentReport> response)
    Processes the OSS Index response and reports vulnerabilities.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • FILE_NAME_OUTPUT

      public static final String FILE_NAME_OUTPUT
      Default output filename for the CycloneDX BOM JSON file.
      See Also:

  • Constructor Details

    • CycloneDxResponseHandler

      public CycloneDxResponseHandler(OssIndexPluginExtension extension, org.gradle.api.Project project)
      Constructs a handler with the given extension configuration and Gradle project.

  • Method Details

    • handleOssIndexResponse

      public boolean handleOssIndexResponse(Set<org.gradle.api.artifacts.ResolvedDependency> dependencies, Map<org.gradle.api.artifacts.ResolvedDependency,org.sonatype.goodies.packageurl.PackageUrl> dependenciesMap, Map<org.sonatype.goodies.packageurl.PackageUrl,org.sonatype.ossindex.service.api.componentreport.ComponentReport> response)
      Description copied from interface: OssIndexResponseHandler
      Processes the OSS Index response and reports vulnerabilities.
      Specified by:
      handleOssIndexResponse in interface OssIndexResponseHandler