org.owasp.dependencycheck.utils

Class Settings

java.lang.Object

org.owasp.dependencycheck.utils.Settings

public final class Settings
extends Object

A simple settings container that wraps the dependencycheck.properties file.

Author:

Jeremy Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Settings.KEYS The collection of keys used within the properties file.

Method Summary

Methods

Modifier and Type	Method and Description
static void	cleanup() Cleans up resources to prevent memory leaks.
static void	cleanup(boolean deleteTemporary) Cleans up resources to prevent memory leaks.
static boolean	getBoolean(String key) Returns a boolean value from the properties file.
static boolean	getBoolean(String key, boolean defaultValue) Returns a boolean value from the properties file.
static String	getConnectionString(String connectionStringKey, String dbFileNameKey, String dbVersionKey) Returns a connection string from the configured properties.
static File	getDataDirectory() Retrieves the directory that the JAR file exists in so that we can ensure we always use a common data directory for the embedded H2 database.
protected static File	getDataFile(String key) Returns a value from the properties file as a File object.
static File	getFile(String key) Returns a value from the properties file as a File object.
static Settings	getInstance() Gets the underlying instance of the Settings object.
static int	getInt(String key) Returns an int value from the properties file.
static int	getInt(String key, int defaultValue) Returns an int value from the properties file.
static long	getLong(String key) Returns a long value from the properties file.
static String	getString(String key) Returns a value from the properties file.
static String	getString(String key, String defaultValue) Returns a value from the properties file.
static File	getTempDirectory() Returns the temporary directory.
static void	initialize() Initializes the thread local settings object.
static void	initialize(String propertiesFilePath) Initializes the thread local settings object.
static void	mergeProperties(File filePath) Merges a new properties file into the current properties.
static void	mergeProperties(InputStream stream) Merges a new properties file into the current properties.
static void	mergeProperties(String filePath) Merges a new properties file into the current properties.
static void	removeProperty(String key) Removes a property from the local properties collection.
static void	setBoolean(String key, boolean value) Sets a property value.
static void	setInstance(Settings instance) Sets the instance of the Settings object to use in this thread.
static void	setString(String key, String value) Sets a property value.

Methods inherited from class java.lang.Object

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

Method Detail

initialize

public static void initialize()

Initializes the thread local settings object. Note, to use the settings object you must call this method. However, you must also call Settings.cleanup() to properly release resources.

initialize

public static void initialize(String propertiesFilePath)

Initializes the thread local settings object. Note, to use the settings object you must call this method. However, you must also call Settings.cleanup() to properly release resources.

Parameters:

propertiesFilePath - the path to the base properties file to load

cleanup

public static void cleanup()

Cleans up resources to prevent memory leaks.

cleanup

public static void cleanup(boolean deleteTemporary)

Cleans up resources to prevent memory leaks.

Parameters:

deleteTemporary - flag indicating whether any temporary directories generated should be removed

getInstance

public static Settings getInstance()

Gets the underlying instance of the Settings object.

Returns:

the Settings object

setInstance

public static void setInstance(Settings instance)

Sets the instance of the Settings object to use in this thread.

Parameters:

instance - the instance of the settings object to use in this thread

setString

public static void setString(String key,
             String value)

Sets a property value.

Parameters:

key - the key for the property

value - the value for the property

setBoolean

public static void setBoolean(String key,
              boolean value)

Sets a property value.

Parameters:

key - the key for the property

value - the value for the property

mergeProperties

public static void mergeProperties(File filePath)
                            throws FileNotFoundException,
                                   IOException

Merges a new properties file into the current properties. This method allows for the loading of a user provided properties file.

Note: even if using this method - system properties will be loaded before properties loaded from files.

Parameters:

filePath - the path to the properties file to merge.

Throws:

FileNotFoundException - is thrown when the filePath points to a non-existent file

IOException - is thrown when there is an exception loading/merging the properties

mergeProperties

public static void mergeProperties(String filePath)
                            throws FileNotFoundException,
                                   IOException

Merges a new properties file into the current properties. This method allows for the loading of a user provided properties file.

Note: even if using this method - system properties will be loaded before properties loaded from files.

Parameters:

filePath - the path to the properties file to merge.

Throws:

FileNotFoundException - is thrown when the filePath points to a non-existent file

IOException - is thrown when there is an exception loading/merging the properties

mergeProperties

public static void mergeProperties(InputStream stream)
                            throws IOException

Merges a new properties file into the current properties. This method allows for the loading of a user provided properties file.

Note: even if using this method - system properties will be loaded before properties loaded from files.

Parameters:

stream - an Input Stream pointing at a properties file to merge

Throws:

IOException - is thrown when there is an exception loading/merging the properties

getFile

public static File getFile(String key)

Returns a value from the properties file as a File object. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file converted to a File object

getDataFile

protected static File getDataFile(String key)

Returns a value from the properties file as a File object. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file. This method will check the configured base directory and will use this as the base of the file path. Additionally, if the base directory begins with a leading "[JAR]\" sequence with the path to the folder containing the JAR file containing this class.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file converted to a File object

getString

public static String getString(String key,
               String defaultValue)

Returns a value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

defaultValue - the default value for the requested property

Returns:

the property from the properties file

getTempDirectory

public static File getTempDirectory()
                             throws IOException

Returns the temporary directory.

Returns:

the temporary directory

Throws:

IOException - thrown if the temporary directory does not exist and cannot be created

getString

public static String getString(String key)

Returns a value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file

removeProperty

public static void removeProperty(String key)

Removes a property from the local properties collection. This is mainly used in test cases.

Parameters:

key - the property key to remove

getInt

public static int getInt(String key)
                  throws InvalidSettingException

Returns an int value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file

Throws:

InvalidSettingException - is thrown if there is an error retrieving the setting

getInt

public static int getInt(String key,
         int defaultValue)

Returns an int value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

defaultValue - the default value to return

Returns:

the property from the properties file or the defaultValue if the property does not exist or cannot be converted to an integer

getLong

public static long getLong(String key)
                    throws InvalidSettingException

Returns a long value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument - this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file

Throws:

InvalidSettingException - is thrown if there is an error retrieving the setting

getBoolean

public static boolean getBoolean(String key)
                          throws InvalidSettingException

Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

Returns:

the property from the properties file

Throws:

InvalidSettingException - is thrown if there is an error retrieving the setting

getBoolean

public static boolean getBoolean(String key,
                 boolean defaultValue)
                          throws InvalidSettingException

Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value argument this method will return the value from the system properties before the values in the contained configuration file.

Parameters:

key - the key to lookup within the properties file

defaultValue - the default value to return if the setting does not exist

Returns:

the property from the properties file

Throws:

InvalidSettingException - is thrown if there is an error retrieving the setting

getConnectionString

public static String getConnectionString(String connectionStringKey,
                         String dbFileNameKey,
                         String dbVersionKey)
                                  throws IOException,
                                         InvalidSettingException

Returns a connection string from the configured properties. If the connection string contains a %s, this method will determine the 'data' directory and replace the %s with the path to the data directory. If the data directory does not exists it will be created.

Parameters:

connectionStringKey - the property file key for the connection string

dbFileNameKey - the settings key for the db filename

dbVersionKey - the settings key for the dbVersion

Returns:

the connection string

Throws:

IOException - thrown the data directory cannot be created

InvalidSettingException - thrown if there is an invalid setting

getDataDirectory

public static File getDataDirectory()
                             throws IOException

Retrieves the directory that the JAR file exists in so that we can ensure we always use a common data directory for the embedded H2 database. This is public solely for some unit tests; otherwise this should be private.

Returns:

the data directory to store data files

Throws:

IOException - is thrown if an IOException occurs of course...