version 1.2.4 of site documentation

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

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:41 EDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Index (Dependency-Check Utils 1.2.3 API)</title>
<meta name="date" content="2014-06-27">
<title>Index (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="Index (Dependency-Check Utils 1.2.3 API)";
parent.document.title="Index (Dependency-Check Utils 1.2.4 API)";
}
//-->
</script>
@@ -62,7 +62,7 @@
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#_A_">A</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;<a name="_A_">
<div class="contentContainer"><a href="#_A_">A</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;<a href="#_V_">V</a>&nbsp;<a name="_A_">
<!-- -->
</a>
<h2 class="title">A</h2>
@@ -117,6 +117,10 @@
</a>
<h2 class="title">C</h2>
<dl>
<dt><a href="./org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">Checksum</span></a> - Class in <a href="./org/owasp/dependencycheck/utils/package-summary.html">org.owasp.dependencycheck.utils</a></dt>
<dd>
<div class="block">Includes methods to generate the MD5 and SHA1 checksum.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#cleanup()">cleanup()</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<div class="block">Cleans up resources to prevent memory leaks.</div>
@@ -165,7 +169,7 @@
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#CVE_START_YEAR">CVE_START_YEAR</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The properties key for the telling us how many cvr.url.* URLs exists.</div>
<div class="block">The properties key for the telling us how many cve.url.* URLs exists.</div>
</dd>
</dl>
<a name="_D_">
@@ -189,6 +193,10 @@
<dd>
<div class="block">The database driver class name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#DB_FILE_NAME">DB_FILE_NAME</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The database file name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#DB_PASSWORD">DB_PASSWORD</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The password to authenticate to the database.</div>
@@ -197,6 +205,10 @@
<dd>
<div class="block">The username to use when connecting to the database.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#DB_VERSION">DB_VERSION</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The database schema version.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/FileUtils.html#delete(java.io.File)">delete(File)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/FileUtils.html" title="class in org.owasp.dependencycheck.utils">FileUtils</a></dt>
<dd>
<div class="block">Deletes a file.</div>
@@ -287,6 +299,15 @@
<dd>
<div class="block">Returns a boolean value from the properties file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Checksum.html#getChecksum(java.lang.String, java.io.File)">getChecksum(String, File)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils">Checksum</a></dt>
<dd>
<div class="block">
Creates the cryptographic checksum of a given file using the specified algorithm.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#getConnectionString(java.lang.String, java.lang.String, java.lang.String)">getConnectionString(String, String, String)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<div class="block">Returns a connection string from the configured properties.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/FileUtils.html#getDataDirectory(java.lang.String, java.lang.Class)">getDataDirectory(String, Class)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/FileUtils.html" title="class in org.owasp.dependencycheck.utils">FileUtils</a></dt>
<dd>
<div class="block"><span class="strong">Deprecated.</span>
@@ -294,6 +315,11 @@
how the data directory should be set.</i></div>
</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#getDataDirectory()">getDataDirectory()</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<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>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#getDataFile(java.lang.String)">getDataFile(String)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<div class="block">Returns a value from the properties file as a File object.</div>
@@ -306,6 +332,11 @@
<dd>
<div class="block">Returns the (lowercase) file extension for a specified file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Checksum.html#getHex(byte[])">getHex(byte[])</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils">Checksum</a></dt>
<dd>
<div class="block">
Converts a byte array into a hex string.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#getInstance()">getInstance()</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<div class="block">Gets the underlying instance of the Settings object.</div>
@@ -326,12 +357,20 @@
<dd>
<div class="block">Returns a long value from the properties file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Checksum.html#getMD5Checksum(java.io.File)">getMD5Checksum(File)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils">Checksum</a></dt>
<dd>
<div class="block">Calculates the MD5 checksum of a specified file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/FileUtils.html#getPathToJar(java.lang.Class)">getPathToJar(Class)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/FileUtils.html" title="class in org.owasp.dependencycheck.utils">FileUtils</a></dt>
<dd>
<div class="block"><span class="strong">Deprecated.</span>
<div class="block"><i>this should no longer be used.</i></div>
</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Checksum.html#getSHA1Checksum(java.io.File)">getSHA1Checksum(File)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Checksum.html" title="class in org.owasp.dependencycheck.utils">Checksum</a></dt>
<dd>
<div class="block">Calculates the SHA1 checksum of a specified file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.html#getString(java.lang.String, java.lang.String)">getString(String, String)</a></span> - Static method in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.html" title="class in org.owasp.dependencycheck.utils">Settings</a></dt>
<dd>
<div class="block">Returns a value from the properties file.</div>
@@ -568,7 +607,33 @@
<div class="block">Creates a new URLConnectionFailureException.</div>
</dd>
</dl>
<a href="#_A_">A</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;</div>
<a name="_V_">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#VFEED_CONNECTION_STRING">VFEED_CONNECTION_STRING</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The key to obtain the VFEED connection string.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#VFEED_DATA_FILE">VFEED_DATA_FILE</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The key to obtain the path to the VFEED data file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#VFEED_DOWNLOAD_FILE">VFEED_DOWNLOAD_FILE</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The key to obtain the download file name for the VFeed data.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#VFEED_DOWNLOAD_URL">VFEED_DOWNLOAD_URL</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The key to obtain the base download URL for the VFeed data file.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html#VFEED_UPDATE_STATUS">VFEED_UPDATE_STATUS</a></span> - Static variable in class org.owasp.dependencycheck.utils.<a href="./org/owasp/dependencycheck/utils/Settings.KEYS.html" title="class in org.owasp.dependencycheck.utils">Settings.KEYS</a></dt>
<dd>
<div class="block">The key to obtain the VFeed update status.</div>
</dd>
</dl>
<a href="#_A_">A</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;<a href="#_V_">V</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
@@ -613,6 +678,6 @@
<!-- -->
</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>