documentation version 1.2.10

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

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Fri Mar 06 06:07:08 EST 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Apr 12 08:13:24 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Overview (Dependency-Check Core 1.2.9 API)</title>
<meta name="date" content="2015-03-06">
<title>Overview (Dependency-Check Core 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="Overview (Dependency-Check Core 1.2.9 API)";
parent.document.title="Overview (Dependency-Check Core 1.2.10 API)";
}
//-->
</script>
@@ -64,7 +64,7 @@
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Dependency-Check Core 1.2.9 API</h1>
<h1 class="title">Dependency-Check Core 1.2.10 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
@@ -77,230 +77,137 @@
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/package-summary.html">org.owasp.dependencycheck</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck</title>
</head>
<body>
Includes the main entry point (i.e.</div>
<div class="block">Includes the main entry point for dependency-check.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/agent/package-summary.html">org.owasp.dependencycheck.agent</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.agent</title>
</head>
<body>
The agent package holds an agent API that can be used by other applications that have information about dependencies;
but would rather implement something in their code directly rather then spawn a process to run the entire
dependency-check engine.</div>
<div class="block">The agent package holds an agent API that can be used by other applications that have information about dependencies; but would
rather implement something in their code directly rather then spawn a process to run the entire dependency-check engine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/analyzer/package-summary.html">org.owasp.dependencycheck.analyzer</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.analyzer</title>
</head>
<body>
Analyzers are used to inspect the identified dependencies, collect Evidence,
and process the dependencies.</div>
<div class="block">Analyzers are used to inspect the identified dependencies, collect Evidence, and process the dependencies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/analyzer/exception/package-summary.html">org.owasp.dependencycheck.analyzer.exception</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.analyzer.exception</title>
</head>
<body></div>
<div class="block">A collection of exception classes used within the analyzers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/central/package-summary.html">org.owasp.dependencycheck.data.central</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.central</title>
</head>
<body></div>
<div class="block">Contains classes related to searching Maven Central.<br/><br/>
These are used to abstract Maven Central searching away from OWASP Dependency Check so they can be reused elsewhere.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/cpe/package-summary.html">org.owasp.dependencycheck.data.cpe</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.cpe</title>
</head>
<body>
Contains classes for working with the CPE Lucene Index.</div>
<div class="block">Contains classes for working with the CPE Lucene Index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/cwe/package-summary.html">org.owasp.dependencycheck.data.cwe</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.cwe</title>
</head>
<body>
Contains classes for working with the CWE Database.</div>
<div class="block">Contains classes for working with the CWE Database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/lucene/package-summary.html">org.owasp.dependencycheck.data.lucene</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.lucene</title>
</head>
<body>
Contains classes used to work with the Lucene Indexes.</div>
<div class="block">Contains classes used to work with the Lucene Indexes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/nexus/package-summary.html">org.owasp.dependencycheck.data.nexus</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.nexus</title>
</head>
<body></div>
<div class="block">Contains classes related to searching a Nexus repository.<br/><br/>
These are used to abstract Nexus searching away from OWASP Dependency Check so they can be reused elsewhere.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/nuget/package-summary.html">org.owasp.dependencycheck.data.nuget</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.nuget</title>
</head>
<body></div>
<div class="block">Contains classes related to parsing Nuget related files<br/><br/>
These are used to abstract away Nuget-related handling from Dependency Check so they can be used elsewhere.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/nvdcve/package-summary.html">org.owasp.dependencycheck.data.nvdcve</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.nvdcve</title>
</head>
<body>
Contains classes used to work with the NVD CVE data.</div>
<div class="block">Contains classes used to work with the NVD CVE data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/update/package-summary.html">org.owasp.dependencycheck.data.update</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.update</title>
</head>
<body></div>
<div class="block">Contains classes used to update the data stores.<br/><br/>
The UpdateService will load, any correctly defined CachedWebDataSource(s) and call update() on them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/update/exception/package-summary.html">org.owasp.dependencycheck.data.update.exception</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.update.exception</title>
</head>
<body></div>
<div class="block">A collection of exception classes used within the application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/update/task/package-summary.html">org.owasp.dependencycheck.data.update.task</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.update.task</title>
</head>
<body></div>
<div class="block">A collection of callable/runnable tasks used to speed up the update process.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/update/xml/package-summary.html">org.owasp.dependencycheck.data.update.xml</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.data.nvdcve.xml</title>
</head>
<body></div>
<div class="block">Contains classes used to parse the NVD CVE XML file.<br/><br/>
The basic use is that the Importer is called to import an NVD CVE file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/dependency/package-summary.html">org.owasp.dependencycheck.dependency</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.dependency</title>
</head>
<body>
Contains the core Dependency implementation.</div>
<div class="block">Contains the core Dependency implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/exception/package-summary.html">org.owasp.dependencycheck.exception</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.exception</title>
</head>
<body></div>
<div class="block">A collection of exception classes used within the application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/jaxb/pom/package-summary.html">org.owasp.dependencycheck.jaxb.pom</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.analyzer.pom</title>
</head>
<body>
This package contains utility classes used to parse pom.xml files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/jaxb/pom/generated/package-summary.html">org.owasp.dependencycheck.jaxb.pom.generated</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/reporting/package-summary.html">org.owasp.dependencycheck.reporting</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.reporting</title>
</head>
<body>
Contains classes used to generate reports.</div>
<div class="block">Contains classes used to generate reports.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/suppression/package-summary.html">org.owasp.dependencycheck.suppression</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.suppression</title>
</head>
<body>
Contains classes used to suppress findings.</div>
<div class="block">Contains classes used to suppress findings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/utils/package-summary.html">org.owasp.dependencycheck.utils</a></td>
<td class="colLast">
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.utils</title>
</head>
<body>
Includes various utility classes such as a Settings wrapper, a Checksum utility, etc.</div>
<div class="block">Includes various utility classes such as a Settings wrapper, a Checksum utility, etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/xml/pom/package-summary.html">org.owasp.dependencycheck.xml.pom</a></td>
<td class="colLast">
<div class="block">This package contains classes used to parse pom.xml files.</div>
</td>
</tr>
</tbody>