github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-22 00:59:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation version 1.4.2

Browse Source
This commit is contained in:
Jeremy Long
2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
dependency-check-utils/apidocs/org/owasp/dependencycheck/utils/Settings.html
View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 16 06:44:12 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Sun Jul 31 07:37:31 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Settings (Dependency-Check Utils 1.4.0 API)</title>
<meta name="date" content="2016-06-16">
<title>Settings (Dependency-Check Utils 1.4.2 API)</title>
<meta name="date" content="2016-07-31">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -13,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Settings (Dependency-Check Utils 1.4.0 API)";
parent.document.title="Settings (Dependency-Check Utils 1.4.2 API)";
}
}
catch(err) {
@@ -190,8 +190,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/utils/Settings.html#getDataDirectory--">getDataDirectory</a></span>()</code>
<div class="block">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.</div>
<div class="block">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.</div>
</td>
</tr>
<tr id="i6" class="altColor">
@@ -370,8 +370,9 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>initialize</h4>
<pre>public static&nbsp;void&nbsp;initialize()</pre>
<div class="block">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.</div>
<div class="block">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.</div>
</li>
</ul>
<a name="initialize-java.lang.String-">
@@ -381,8 +382,9 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>initialize</h4>
<pre>public static&nbsp;void&nbsp;initialize(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propertiesFilePath)</pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propertiesFilePath</code> - the path to the base properties file to load</dd>
@@ -409,7 +411,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<div class="block">Cleans up resources to prevent memory leaks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deleteTemporary</code> - flag indicating whether any temporary directories generated should be removed</dd>
<dd><code>deleteTemporary</code> - flag indicating whether any temporary directories
generated should be removed</dd>
</dl>
</li>
</ul>
@@ -562,15 +565,18 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<pre>public static&nbsp;void&nbsp;mergeProperties(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;filePath)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Merges a new properties file into the current properties. This method allows for the loading of a user provided properties
file.<br><br>
<b>Note</b>: even if using this method - system properties will be loaded before properties loaded from files.</div>
<div class="block">Merges a new properties file into the current properties. This method
allows for the loading of a user provided properties file.<br><br>
<b>Note</b>: even if using this method - system properties will be loaded
before properties loaded from files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filePath</code> - the path to the properties file to merge.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when the filePath points to a non-existent file</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging the properties</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when the filePath points to a
non-existent file</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging
the properties</dd>
</dl>
</li>
</ul>
@@ -583,15 +589,18 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<pre>public static&nbsp;void&nbsp;mergeProperties(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filePath)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Merges a new properties file into the current properties. This method allows for the loading of a user provided properties
file.<br><br>
Note: even if using this method - system properties will be loaded before properties loaded from files.</div>
<div class="block">Merges a new properties file into the current properties. This method
allows for the loading of a user provided properties file.<br><br>
Note: even if using this method - system properties will be loaded before
properties loaded from files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filePath</code> - the path to the properties file to merge.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when the filePath points to a non-existent file</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging the properties</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when the filePath points to a
non-existent file</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging
the properties</dd>
</dl>
</li>
</ul>
@@ -603,14 +612,16 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>mergeProperties</h4>
<pre>public static&nbsp;void&nbsp;mergeProperties(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;stream)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Merges a new properties file into the current properties. This method allows for the loading of a user provided properties
file.<br><br>
<b>Note</b>: even if using this method - system properties will be loaded before properties loaded from files.</div>
<div class="block">Merges a new properties file into the current properties. This method
allows for the loading of a user provided properties file.<br><br>
<b>Note</b>: even if using this method - system properties will be loaded
before properties loaded from files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - an Input Stream pointing at a properties file to merge</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging the properties</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - is thrown when there is an exception loading/merging
the properties</dd>
</dl>
</li>
</ul>
@@ -621,9 +632,10 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getFile</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getFile(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
@@ -639,13 +651,15 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getDataFile</h4>
<pre>protected static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getDataFile(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">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.
<div class="block">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.</div>
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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
@@ -662,9 +676,10 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getString</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getString(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;defaultValue)</pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
@@ -687,7 +702,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the temporary directory</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if the temporary directory does not exist and cannot be created</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - thrown if the temporary directory does not
exist and cannot be created</dd>
</dl>
</li>
</ul>
@@ -698,9 +714,10 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getString</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getString(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
@@ -716,7 +733,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>removeProperty</h4>
<pre>public static&nbsp;void&nbsp;removeProperty(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">Removes a property from the local properties collection. This is mainly used in test cases.</div>
<div class="block">Removes a property from the local properties collection. This is mainly
used in test cases.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the property key to remove</dd>
@@ -731,16 +749,18 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getInt</h4>
<pre>public static&nbsp;int&nbsp;getInt(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)
throws <a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property from the properties file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving the setting</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving
the setting</dd>
</dl>
</li>
</ul>
@@ -752,16 +772,17 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getInt</h4>
<pre>public static&nbsp;int&nbsp;getInt(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
int&nbsp;defaultValue)</pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
<dd><code>defaultValue</code> - the default value to return</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property from the properties file or the defaultValue if the property does not exist or cannot be converted to
an integer</dd>
<dd>the property from the properties file or the defaultValue if the
property does not exist or cannot be converted to an integer</dd>
</dl>
</li>
</ul>
@@ -773,16 +794,18 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getLong</h4>
<pre>public static&nbsp;long&nbsp;getLong(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)
throws <a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property from the properties file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving the setting</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving
the setting</dd>
</dl>
</li>
</ul>
@@ -794,16 +817,19 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getBoolean</h4>
<pre>public static&nbsp;boolean&nbsp;getBoolean(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)
throws <a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></pre>
<div class="block">Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the
<code>-Dprop=value</code> argument this method will return the value from the system properties before the values in the
contained configuration file.</div>
<div class="block">Returns a boolean value from the properties file. If the value was
specified as a system property or passed in via the
<code>-Dprop=value</code> argument this method will return the value from
the system properties before the values in the contained configuration
file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property from the properties file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving the setting</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving
the setting</dd>
</dl>
</li>
</ul>
@@ -816,17 +842,21 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<pre>public static&nbsp;boolean&nbsp;getBoolean(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
boolean&nbsp;defaultValue)
throws <a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></pre>
<div class="block">Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the
<code>-Dprop=value</code> argument this method will return the value from the system properties before the values in the
contained configuration file.</div>
<div class="block">Returns a boolean value from the properties file. If the value was
specified as a system property or passed in via the
<code>-Dprop=value</code> argument this method will return the value from
the system properties before the values in the contained configuration
file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to lookup within the properties file</dd>
<dd><code>defaultValue</code> - the default value to return if the setting does not exist</dd>
<dd><code>defaultValue</code> - the default value to return if the setting does not
exist</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property from the properties file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving the setting</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - is thrown if there is an error retrieving
the setting</dd>
</dl>
</li>
</ul>
@@ -840,12 +870,14 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dbFileNameKey)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionStringKey</code> - the property file key for the connection string</dd>
<dd><code>connectionStringKey</code> - the property file key for the connection
string</dd>
<dd><code>dbFileNameKey</code> - the settings key for the db filename</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection string</dd>
@@ -863,8 +895,9 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<h4>getDataDirectory</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getDataDirectory()
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">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.</div>
<div class="block">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.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the data directory to store data files</dd>