documentation version 1.4.5

This commit is contained in:
Jeremy Long
2017-01-22 17:22:46 -05:00
parent a1b5e3f7b0
commit 615f6e3750
1583 changed files with 55974 additions and 52631 deletions

View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Sat Nov 05 07:44:55 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Sun Jan 22 16:22:23 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (Dependency-Check Maven Plugin 1.4.4 API)</title>
<meta name="date" content="2016-11-05">
<title>Index (Dependency-Check Maven Plugin 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>
@@ -13,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Dependency-Check Maven Plugin 1.4.4 API)";
parent.document.title="Index (Dependency-Check Maven Plugin 1.4.5 API)";
}
}
catch(err) {
@@ -69,7 +69,7 @@
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:W">W</a>&nbsp;<a name="I:A">
<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:W">W</a>&nbsp;<a name="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
@@ -81,10 +81,6 @@
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/AggregateMojo.html#AggregateMojo--">AggregateMojo()</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven">AggregateMojo</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#analyzeDependencies--">analyzeDependencies()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Runs the analyzers against all of the dependencies.</div>
</dd>
</dl>
<a name="I:B">
<!-- -->
@@ -127,15 +123,6 @@
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/CheckMojo.html#CheckMojo--">CheckMojo()</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/CheckMojo.html" title="class in org.owasp.dependencycheck.maven">CheckMojo</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#cleanup--">cleanup()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Releases resources used by the analyzers by calling close() on each
analyzer.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#closeAnalyzer-org.owasp.dependencycheck.analyzer.Analyzer-">closeAnalyzer(Analyzer)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Closes the given analyzer.</div>
</dd>
</dl>
<a name="I:E">
<!-- -->
@@ -285,13 +272,9 @@
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#initializeAnalyzer-org.owasp.dependencycheck.analyzer.Analyzer-">initializeAnalyzer(Analyzer)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Initializes the given analyzer.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dd>
<div class="block">Initializes a new <code>MavenEngine</code> that can be used for scanning.</div>
<div class="block">Initializes a new <code>Engine</code> that can be used for scanning.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dd>
@@ -320,21 +303,6 @@
<div class="block">Initializes the engine.</div>
</dd>
</dl>
<a name="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">MavenEngine</span></a> - Class in <a href="org/owasp/dependencycheck/maven/package-summary.html">org.owasp.dependencycheck.maven</a></dt>
<dd>
<div class="block">A modified version of the core engine specifically designed to persist some
data between multiple executions of a multi-module Maven project.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#MavenEngine-org.apache.maven.project.MavenProject-java.util.List-">MavenEngine(MavenProject, List&lt;MavenProject&gt;)</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Creates a new Engine to perform analysis on dependencies.</div>
</dd>
</dl>
<a name="I:O">
<!-- -->
</a>
@@ -366,15 +334,6 @@
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile(MavenProject)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dd>
<div class="block">Reads the serialized scan data from disk.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#resetFileTypeAnalyzers--">resetFileTypeAnalyzers()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Resets the file type analyzers so that they can be re-used to scan
additional directories.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/AggregateMojo.html#runCheck--">runCheck()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven">AggregateMojo</a></dt>
<dd>
<div class="block">Executes the aggregate dependency-check goal.</div>
@@ -403,7 +362,7 @@
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts(MavenProject, MavenEngine)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.Engine-">scanArtifacts(MavenProject, Engine)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dd>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency
list.</div>
@@ -423,15 +382,6 @@
</a>
<h2 class="title">U</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#update--">update()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Runs the update steps of dependency-check.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/MavenEngine.html#UPDATE_EXECUTED_FLAG">UPDATE_EXECUTED_FLAG</a></span> - Static variable in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></dt>
<dd>
<div class="block">Key used in the MavenProject context values to note whether or not an
update has been executed.</div>
</dd>
<dt><a href="org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="typeNameLink">UpdateMojo</span></a> - Class in <a href="org/owasp/dependencycheck/maven/package-summary.html">org.owasp.dependencycheck.maven</a></dt>
<dd>
<div class="block">Maven Plugin that checks the project dependencies to see if they have any
@@ -449,12 +399,12 @@
<dd>
<div class="block">Writes the scan data to disk.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports(MavenEngine, MavenProject, File)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dt><span class="memberNameLink"><a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.Engine-org.apache.maven.project.MavenProject-java.io.File-">writeReports(Engine, MavenProject, File)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></dt>
<dd>
<div class="block">Generates the reports for a given dependency-check engine.</div>
</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:W">W</a>&nbsp;</div>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:W">W</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->