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

version 1.2.4 of site documentation

Browse Source
This commit is contained in:
Jeremy Long
2014-08-05 18:48:58 -04:00
parent 15b03aed0c
commit c9a8bb3969
983 changed files with 29386 additions and 28743 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
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_45) on Fri Jun 27 06:34:11 EDT 2014 -->
<!-- Generated by javadoc (version 1.7.0_45) on Tue Aug 05 17:59:40 EDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Settings (Dependency-Check Utils 1.2.3 API)</title>
<meta name="date" content="2014-06-27">
<title>Settings (Dependency-Check Utils 1.2.4 API)</title>
<meta name="date" content="2014-08-05">
<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.3 API)";
parent.document.title="Settings (Dependency-Check Utils 1.2.4 API)";
}
//-->
</script>
@@ -166,7 +166,22 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/utils/Settings.html#getConnectionString(java.lang.String, java.lang.String, java.lang.String)">getConnectionString</a></strong>(<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;connectionStringKey,
<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,
<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)</code>
<div class="block">Returns a connection string from the configured properties.</div>
</td>
</tr>
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected 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#getDataFile(java.lang.String)">getDataFile</a></strong>(<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)</code>
<div class="block">Returns a value from the properties file as a File object.</div>
</td>
@@ -461,7 +476,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<ul class="blockList">
<li class="blockList">
<h4>getDataFile</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;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>
<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.
@@ -597,7 +612,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<a name="getBoolean(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<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,
@@ -612,6 +627,42 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<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>
<a name="getConnectionString(java.lang.String, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionString</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;getConnectionString(<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;connectionStringKey,
<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,
<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>
<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>
<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 the data directory cannot be created</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/utils/InvalidSettingException.html" title="class in org.owasp.dependencycheck.utils">InvalidSettingException</a></code> - thrown if there is an invalid setting</dd></dl>
</li>
</ul>
<a name="getDataDirectory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<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>
<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>
</li>
</ul>
</li>
</ul>
</li>
@@ -678,6 +729,6 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright© 2012-14 Jeremy Long. All Rights Reserved.</small></p>
</body>
</html>