Package org.spdx.spdx_to_osv

Class OsvApi

java.lang.Object

org.spdx.spdx_to_osv.OsvApi

public class OsvApi
extends Object

Singleton class for the OSV REST API

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	API_URL_STRING
protected URL	apiUrl

Method Summary

Modifier and Type	Method	Description
static OsvApi	getInstance()
List<OsvVulnerability>	queryVulnerabilities(OsvVulnerabilityRequest packageNameVersion)	Calls the QueryVulnerabilities API to obtain vulnerability information from OSV

Methods inherited from class java.lang.Object

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

Field Details

API_URL_STRING

protected static String API_URL_STRING

apiUrl

protected URL apiUrl

Method Details

getInstance

public static OsvApi getInstance()

queryVulnerabilities

public List<OsvVulnerability> queryVulnerabilities(OsvVulnerabilityRequest packageNameVersion) throws IOException, SpdxToOsvException

Calls the QueryVulnerabilities API to obtain vulnerability information from OSV

Parameters:

packageNameVersion - The package name and version object to pass to the OSV API

Returns:

collection of OSV Vulnerabilities returned by the API

Throws:

IOException

SpdxToOsvException