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

documentation version 1.2.10

Browse Source
This commit is contained in:
Jeremy Long
2015-04-13 17:43:19 -04:00
parent 480a05c798
commit 9194a42c93
1126 changed files with 34228 additions and 29019 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Fri Mar 06 06:02:09 EST 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Apr 12 08:08:11 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Settings (Dependency-Check Utils 1.2.9 API)</title>
<meta name="date" content="2015-03-06">
<title>Settings (Dependency-Check Utils 1.2.10 API)</title>
<meta name="date" content="2015-04-12">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Settings (Dependency-Check Utils 1.2.9 API)";
parent.document.title="Settings (Dependency-Check Utils 1.2.10 API)";
}
//-->
</script>
@@ -101,7 +101,7 @@
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A simple settings container that wraps the dependencycheck.properties file.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
<dd>Jeremy Long</dd></dl>
</li>
</ul>
</div>
@@ -177,8 +177,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<tr 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><strong><a href="../../../../org/owasp/dependencycheck/utils/Settings.html#getDataDirectory()">getDataDirectory</a></strong>()</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 class="altColor">
@@ -322,8 +322,8 @@ 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)">
@@ -333,8 +333,8 @@ 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="strong">Parameters:</span></dt><dd><code>propertiesFilePath</code> - the path to the base properties file to load</dd></dl>
</li>
</ul>
@@ -414,8 +414,8 @@ 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/>
<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="strong">Parameters:</span></dt><dd><code>filePath</code> - the path to the properties file to merge.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -432,8 +432,8 @@ 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/>
<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="strong">Parameters:</span></dt><dd><code>filePath</code> - the path to the properties file to merge.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -449,8 +449,8 @@ 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/>
<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="strong">Parameters:</span></dt><dd><code>stream</code> - an Input Stream pointing at a properties file to merge</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -464,9 +464,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file converted to a File object</dd></dl>
</li>
@@ -478,13 +478,13 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file converted to a File object</dd></dl>
</li>
@@ -497,9 +497,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd><dd><code>defaultValue</code> - the default value for the requested property</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd></dl>
</li>
@@ -525,9 +525,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd></dl>
</li>
@@ -551,9 +551,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -568,12 +568,12 @@ 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="strong">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="strong">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></dl>
<dt><span class="strong">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></dl>
</li>
</ul>
<a name="getLong(java.lang.String)">
@@ -584,9 +584,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -601,9 +601,9 @@ 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="strong">Parameters:</span></dt><dd><code>key</code> - the key to lookup within the properties file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -619,9 +619,9 @@ 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="strong">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>
<dt><span class="strong">Returns:</span></dt><dd>the property from the properties file</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -639,9 +639,9 @@ 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;dbVersionKey)
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="strong">Parameters:</span></dt><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><dd><code>dbVersionKey</code> - the settings key for the dbVersion</dd>
<dt><span class="strong">Returns:</span></dt><dd>the connection string</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -657,8 +657,8 @@ 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="strong">Returns:</span></dt><dd>the data directory to store data files</dd>
<dt><span class="strong">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 if an IOException occurs of course...</dd></dl>