Package io.github.jeremylong.openvulnerability.client.nvd

Enum NvdCveClientBuilder.Filter

java.lang.Object

java.lang.Enum<NvdCveClientBuilder.Filter>

io.github.jeremylong.openvulnerability.client.nvd.NvdCveClientBuilder.Filter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NvdCveClientBuilder.Filter>

Enclosing class:

NvdCveClientBuilder

public static enum NvdCveClientBuilder.Filter
extends java.lang.Enum<NvdCveClientBuilder.Filter>

Parameters to the NVD CVE API used to filter the results.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CPE_NAME	Returns the vulnerabilities associated with a specific CPE.
CVE_ID	Returns a specific vulnerability.
CVSS_V2_METRICS	Returns vulnerabilities that match a specific CVSS V2 Metric; full or partial vector strings may be used.
CVSS_V3_METRICS	Returns vulnerabilities that match a specific CVSS V3 Metric; full or partial vector strings may be used.
CWE_ID	Returns vulnerabilities that have a specific CWE.
KEYWORD_EXACT_MATCH	Returns vulnerabilities that have an exact key word sequence in the description.
KEYWORD_SEARCH	Returns vulnerabilities where all the keywords are in the description.

Method Summary

Modifier and Type	Method	Description
java.lang.String	toParameterName()	Returns the API querystring parameter.
static NvdCveClientBuilder.Filter	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static NvdCveClientBuilder.Filter[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CPE_NAME

public static final NvdCveClientBuilder.Filter CPE_NAME

Returns the vulnerabilities associated with a specific CPE.

 cpeName=cpe:2.3:a:apache:log4j:2.0:*:*:*:*:*:*:*
 

See Also:

NVD CVE API

CVE_ID

public static final NvdCveClientBuilder.Filter CVE_ID

Returns a specific vulnerability.

 cveId = CVE - 2021 - 44228
 

See Also:

NVD CVE API

CVSS_V2_METRICS

public static final NvdCveClientBuilder.Filter CVSS_V2_METRICS

Returns vulnerabilities that match a specific CVSS V2 Metric; full or partial vector strings may be used.

 parameter: cvssV2Metrics=AV:L/AC:L/PR:L/UI:R/S:U/C:N/I:L/A:L
 

See Also:

NVD CVE API

CVSS_V3_METRICS

public static final NvdCveClientBuilder.Filter CVSS_V3_METRICS

Returns vulnerabilities that match a specific CVSS V3 Metric; full or partial vector strings may be used.

 cvssV3Metrics=AV:L/AC:L/PR:L/UI:R/S:U/C:N/I:L/A:L
 

See Also:

NVD CVE API

CWE_ID

public static final NvdCveClientBuilder.Filter CWE_ID

Returns vulnerabilities that have a specific CWE.

 cweId = CWE - 287
 

See Also:

NVD CVE API

KEYWORD_EXACT_MATCH

public static final NvdCveClientBuilder.Filter KEYWORD_EXACT_MATCH

Returns vulnerabilities that have an exact key word sequence in the description.

 keywordExactMatch=exact words
 

See Also:

NVD CVE API

KEYWORD_SEARCH

public static final NvdCveClientBuilder.Filter KEYWORD_SEARCH

Returns vulnerabilities where all the keywords are in the description.

 keywordSearch = words
 

See Also:

NVD CVE API

Method Detail

values

public static NvdCveClientBuilder.Filter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NvdCveClientBuilder.Filter c : NvdCveClientBuilder.Filter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NvdCveClientBuilder.Filter valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toParameterName

public java.lang.String toParameterName()

Returns the API querystring parameter.

Returns:

the API querystring parameter