github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-01-17 09:06:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
DependencyCheck/dependency-check-core/apidocs/overview-summary.html
Jeremy Long 615f6e3750 documentation version 1.4.5
2017-01-22 17:22:46 -05:00

285 lines
11 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Sun Jan 22 16:19:27 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (Dependency-Check Core 1.4.5 API)</title>
<meta name="date" content="2017-01-22">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (Dependency-Check Core 1.4.5 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Dependency-Check Core 1.4.5 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<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">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">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">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">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">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/composer/package-summary.html">org.owasp.dependencycheck.data.composer</a></td>
<td class="colLast">
<div class="block">Model elements for PHP Composer files</div>
</td>
</tr>
<tr class="altColor">
<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">Contains classes for working with the CPE Lucene Index.</div>
</td>
</tr>
<tr class="rowColor">
<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">Contains classes for working with the CWE Database.</div>
</td>
</tr>
<tr class="altColor">
<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">Contains classes used to work with the Lucene Indexes.</div>
</td>
</tr>
<tr class="rowColor">
<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">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="altColor">
<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">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="rowColor">
<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">Contains classes used to work with the NVD CVE data.</div>
</td>
</tr>
<tr class="altColor">
<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">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="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/data/update/cpe/package-summary.html">org.owasp.dependencycheck.data.update.cpe</a></td>
<td class="colLast">
<div class="block">Contains classes used to parse the CPE XML file from NIST.<br><br>
These classes are not used as they add no value over the existing CPE data contained within the CVE data from the NVD.</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">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/nvd/package-summary.html">org.owasp.dependencycheck.data.update.nvd</a></td>
<td class="colLast">
<div class="block">Contains classes used to download, parse, and load the NVD CVE data from NIST into the local database.<br><br></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/dependency/package-summary.html">org.owasp.dependencycheck.dependency</a></td>
<td class="colLast">
<div class="block">Contains the core Dependency implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/exception/package-summary.html">org.owasp.dependencycheck.exception</a></td>
<td class="colLast">
<div class="block">A collection of exception classes used within the application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/reporting/package-summary.html">org.owasp.dependencycheck.reporting</a></td>
<td class="colLast">
<div class="block">Contains classes used to generate reports.</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">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/hints/package-summary.html">org.owasp.dependencycheck.xml.hints</a></td>
<td class="colLast">
<div class="block">Contains classes used to parse the hints file to add evidence to dependencies.</div>
</td>
</tr>
<tr class="rowColor">
<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>
<tr class="altColor">
<td class="colFirst"><a href="org/owasp/dependencycheck/xml/suppression/package-summary.html">org.owasp.dependencycheck.xml.suppression</a></td>
<td class="colLast">
<div class="block">Contains classes used to suppress findings.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright? 2012-15 Jeremy Long. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink