org.owasp.dependencycheck.data.nvdcve

Class DatabaseProperties

java.lang.Object

org.owasp.dependencycheck.data.nvdcve.DatabaseProperties

@ThreadSafe
public class DatabaseProperties
extends Object

This is a wrapper around a set of properties that are stored in the database. This class is safe to be accessed from multiple threads in parallel.

Author:

Jeremy Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAST_CHECKED The properties file key for the last checked field - used to store the last check time of the Modified NVD CVE xml file.
static String	LAST_CPE_UPDATE The key for the last time the CPE data was updated.
static String	LAST_UPDATED The properties file key for the last updated field - used to store the last updated time of the Modified NVD CVE xml file.
static String	LAST_UPDATED_BASE Stores the last updated time for each of the NVD CVE files.
static String	MODIFIED Modified key word, used as a key to store information about the modified file (i.e.
static String	VERSION The key for the database schema version.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getMetaData() Returns a map of the meta data from the database properties.
Properties	getProperties() Returns the collection of Database Properties as a properties collection.
String	getProperty(String key) Returns the property value for the given key.
String	getProperty(String key, String defaultValue) Returns the property value for the given key.
boolean	isEmpty() Returns whether or not any properties are set.
void	save(NvdCveInfo updatedValue) Saves the last updated information to the properties file.
void	save(String key, String value) Saves the key value pair to the properties store.

Methods inherited from class java.lang.Object

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

Field Detail

MODIFIED

public static final String MODIFIED

Modified key word, used as a key to store information about the modified file (i.e. the containing the last 8 days of updates)..

See Also:

Constant Field Values

LAST_CHECKED

public static final String LAST_CHECKED

The properties file key for the last checked field - used to store the last check time of the Modified NVD CVE xml file.

See Also:

Constant Field Values

LAST_UPDATED

public static final String LAST_UPDATED

The properties file key for the last updated field - used to store the last updated time of the Modified NVD CVE xml file.

See Also:

Constant Field Values

LAST_UPDATED_BASE

public static final String LAST_UPDATED_BASE

Stores the last updated time for each of the NVD CVE files. These timestamps should be updated if we process the modified file within 7 days of the last update.

See Also:

Constant Field Values

LAST_CPE_UPDATE

public static final String LAST_CPE_UPDATE

The key for the last time the CPE data was updated.

See Also:

Constant Field Values

VERSION

public static final String VERSION

The key for the database schema version.

See Also:

Constant Field Values

Method Detail

isEmpty

public boolean isEmpty()

Returns whether or not any properties are set.

Returns:

whether or not any properties are set

save

public void save(NvdCveInfo updatedValue)
          throws UpdateException

Saves the last updated information to the properties file.

Parameters:

updatedValue - the updated NVD CVE entry

Throws:

UpdateException - is thrown if there is an update exception

save

public void save(String key,
                 String value)
          throws UpdateException

Saves the key value pair to the properties store.

Parameters:

key - the property key

value - the property value

Throws:

UpdateException - is thrown if there is an update exception

getProperty

public String getProperty(String key)

Returns the property value for the given key. If the key is not contained in the underlying properties null is returned.

Parameters:

key - the property key

Returns:

the value of the property

getProperty

public String getProperty(String key,
                          String defaultValue)

Returns the property value for the given key. If the key is not contained in the underlying properties the default value is returned.

Parameters:

key - the property key

defaultValue - the default value

Returns:

the value of the property

getProperties

public Properties getProperties()

Returns the collection of Database Properties as a properties collection.

Returns:

the collection of Database Properties

getMetaData

public Map<String,String> getMetaData()

Returns a map of the meta data from the database properties. This primarily contains timestamps of when the NVD CVE information was last updated.

Returns:

a map of the database meta data