Settings (Dependency-Check Utils 4.0.2 API)

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.

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

Constructor Summary

Constructors
Constructor and Description

Settings()
Initialize the settings object.

Settings(String propertiesFilePath)
Initialize the settings object using the given properties file.

Constructors
Constructor and Description
`Settings()` Initialize the settings object.
`Settings(String propertiesFilePath)` Initialize the settings object using the given properties file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` Cleans up resources to prevent memory leaks.
`void`	`cleanup(boolean deleteTemporary)` Cleans up resources to prevent memory leaks.
`String[]`	`getArray(String key)` Returns a list with the given key.
`boolean`	`getBoolean(String key)` Returns a boolean value from the properties file.
`boolean`	`getBoolean(String key, boolean defaultValue)` Returns a boolean value from the properties file.
`String`	`getConnectionString(String connectionStringKey, String dbFileNameKey)` Returns a connection string from the configured properties.
`File`	`getDataDirectory()` Retrieves the primary data directory that is used for caching web content.
`protected File`	`getDataFile(String key)` Returns a value from the properties file as a File object.
`File`	`getFile(String key)` Returns a value from the properties file as a File object.
`float`	`getFloat(String key, float defaultValue)` Returns a float value from the properties file.
`File`	`getH2DataDirectory()` Retrieves the H2 data directory - if the database has been moved to the temp directory this method will return the temp directory.
`int`	`getInt(String key)` Returns an int value from the properties file.
`int`	`getInt(String key, int defaultValue)` Returns an int value from the properties file.
`long`	`getLong(String key)` Returns a long value from the properties file.
`String`	`getString(String key)` Returns a value from the properties file.
`String`	`getString(String key, String defaultValue)` Returns a value from the properties file.
`File`	`getTempDirectory()` Returns the temporary directory.
`File`	`getTempFile(String prefix, String extension)` Generates a new temporary file name that is guaranteed to be unique.
`void`	`mergeProperties(File filePath)` Merges a new properties file into the current properties.
`void`	`mergeProperties(InputStream stream)` Merges a new properties file into the current properties.
`void`	`mergeProperties(String filePath)` Merges a new properties file into the current properties.
`void`	`removeProperty(String key)` Removes a property from the local properties collection.
`void`	`setArrayIfNotEmpty(String key, List<String> value)` Sets a property value only if the array value is not null and not empty.
`void`	`setArrayIfNotEmpty(String key, String[] value)` Sets a property value only if the array value is not null and not empty.
`void`	`setBoolean(String key, boolean value)` Sets a property value.
`void`	`setBooleanIfNotNull(String key, Boolean value)` Sets a property value only if the value is not null.
`void`	`setInt(String key, int value)` Sets a property value.
`void`	`setIntIfNotNull(String key, Integer value)` Sets a property value only if the value is not null.
`void`	`setString(String key, String value)` Sets a property value.
`void`	`setStringIfNotEmpty(String key, String value)` Sets a property value only if the value is not null and not empty.
`void`	`setStringIfNotNull(String key, String value)` Sets a property value only if the value is not null.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings()
```
    Initialize the settings object.
  - Settings
```
public Settings(String propertiesFilePath)
```
    Initialize the settings object using the given properties file.
    
    Parameters:
    
    propertiesFilePath - the path to the base properties file to load
- Method Detail
  - cleanup
```
public void cleanup()
```
    Cleans up resources to prevent memory leaks.
  - cleanup
```
public void cleanup(boolean deleteTemporary)
```
    Cleans up resources to prevent memory leaks.
    
    Parameters:
    
    deleteTemporary - flag indicating whether any temporary directories generated should be removed
  - setString
```
public void setString(String key,
                      String value)
```
    Sets a property value.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setStringIfNotNull
```
public void setStringIfNotNull(String key,
                               String value)
```
    Sets a property value only if the value is not null.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setStringIfNotEmpty
```
public void setStringIfNotEmpty(String key,
                                String value)
```
    Sets a property value only if the value is not null and not empty.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setArrayIfNotEmpty
```
public void setArrayIfNotEmpty(String key,
                               String[] value)
```
    Sets a property value only if the array value is not null and not empty.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setArrayIfNotEmpty
```
public void setArrayIfNotEmpty(String key,
                               List<String> value)
```
    Sets a property value only if the array value is not null and not empty.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setBoolean
```
public void setBoolean(String key,
                       boolean value)
```
    Sets a property value.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setBooleanIfNotNull
```
public void setBooleanIfNotNull(String key,
                                Boolean value)
```
    Sets a property value only if the value is not null.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setInt
```
public void setInt(String key,
                   int value)
```
    Sets a property value.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - setIntIfNotNull
```
public void setIntIfNotNull(String key,
                            Integer value)
```
    Sets a property value only if the value is not null.
    
    Parameters:
    
    key - the key for the property
    
    value - the value for the property
  - mergeProperties
```
public 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 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 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 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 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 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 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 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
  - getArray
```
public String[] getArray(String key)
```
    Returns a list with the given key. If the property is not set then null will be returned.
    
    Parameters:
    
    key - the key to get from this Settings.
    
    Returns:
    
    the list or null if the key wasn't present.
  - removeProperty
```
public 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 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 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 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 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 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
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Returns a float 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
  - getConnectionString
```
public String getConnectionString(String connectionStringKey,
                                  String dbFileNameKey)
                           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 exist it will be created.
    
    Parameters:
    
    connectionStringKey - the property file key for the connection string
    
    dbFileNameKey - the settings key for the db filename
    
    Returns:
    
    the connection string
    
    Throws:
    
    IOException - thrown the data directory cannot be created
    
    InvalidSettingException - thrown if there is an invalid setting
  - getDataDirectory
```
public File getDataDirectory()
                      throws IOException
```
    Retrieves the primary data directory that is used for caching web content.
    
    Returns:
    
    the data directory to store data files
    
    Throws:
    
    IOException - is thrown if an IOException occurs of course...
  - getH2DataDirectory
```
public File getH2DataDirectory()
                        throws IOException
```
    Retrieves the H2 data directory - if the database has been moved to the temp directory this method will return the temp directory.
    
    Returns:
    
    the data directory to store data files
    
    Throws:
    
    IOException - is thrown if an IOException occurs of course...
  - getTempFile
```
public File getTempFile(String prefix,
                        String extension)
                 throws IOException
```
    Generates a new temporary file name that is guaranteed to be unique.
    
    Parameters:
    
    prefix - the prefix for the file name to generate
    
    extension - the extension of the generated file name
    
    Returns:
    
    a temporary File
    
    Throws:
    
    IOException - thrown if the temporary folder could not be created

Class Settings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Settings

Method Detail

cleanup

cleanup

setString

setStringIfNotNull

setStringIfNotEmpty

setArrayIfNotEmpty

setArrayIfNotEmpty

setBoolean

setBooleanIfNotNull

setInt

setIntIfNotNull

mergeProperties

mergeProperties

mergeProperties

getFile

getDataFile

getString

getTempDirectory

getString

getArray

removeProperty

getInt

getInt

getLong

getBoolean

getBoolean

getFloat

getConnectionString

getDataDirectory

getH2DataDirectory

getTempFile