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:10:22 EST 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Apr 12 08:16:27 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Index (Dependency-Check Maven Plugin 1.2.9 API)</title>
<meta name="date" content="2015-03-06">
<title>Index (Dependency-Check Maven Plugin 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="Index (Dependency-Check Maven Plugin 1.2.9 API)";
parent.document.title="Index (Dependency-Check Maven Plugin 1.2.10 API)";
}
//-->
</script>
@@ -100,6 +100,10 @@
<dd>
<div class="block">Returns whether or not a the report can be generated.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/UpdateMojo.html#canGenerateReport()">canGenerateReport()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dt>
<dd>
<div class="block">Returns false; this mojo cannot generate a report.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure(java.util.List)">checkForFailure(List&lt;Dependency&gt;)</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">Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the
@@ -113,8 +117,7 @@
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#cleanup()">cleanup()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
<div class="block">Releases resources used by the analyzers by calling close() on each
analyzer.</div>
<div class="block">Releases resources used by the analyzers by calling close() on each analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#closeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">closeAnalyzer(Analyzer)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
@@ -128,8 +131,8 @@
<dl>
<dt><a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Engine</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>
<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="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#Engine(org.apache.maven.project.MavenProject,%20java.util.List)">Engine(MavenProject, List&lt;MavenProject&gt;)</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
@@ -153,7 +156,7 @@
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.codehaus.doxia.sink.Sink,%20java.util.Locale)">generate(Sink, Locale)</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"><span class="strong">Deprecated.</span>
<div class="block"><i>use {@link #generate(org.apache.maven.doxia.sink.Sink, java.util.Locale) instead.</i></div>
<div class="block"><i>use <a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)"><code>BaseDependencyCheckMojo.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</code></a> instead.</i></div>
</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)">generate(Sink, Locale)</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>
@@ -200,6 +203,10 @@
<dd>
<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/UpdateMojo.html#getDescription(java.util.Locale)">getDescription(Locale)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dt>
<dd>
<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat()">getFormat()</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">Returns the report format.</div>
@@ -212,6 +219,10 @@
<dd>
<div class="block">Returns the report name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/UpdateMojo.html#getName(java.util.Locale)">getName(Locale)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dt>
<dd>
<div class="block">Returns the report name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory()">getOutputDirectory()</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">Returns the output directory.</div>
@@ -279,12 +290,7 @@
<dl>
<dt><a href="./org/owasp/dependencycheck/maven/package-summary.html">org.owasp.dependencycheck.maven</a> - package org.owasp.dependencycheck.maven</dt>
<dd>
<div class="block"><html>
<head>
<title>org.owasp.dependencycheck.maven</title>
</head>
<body>
This is the main package containing the Mojo Maven Plugin - dependency-check.</div>
<div class="block">This is the main package containing the Mojo Maven Plugin - dependency-check.</div>
</dd>
</dl>
<a name="_R_">
@@ -298,8 +304,7 @@
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#resetFileTypeAnalyzers()">resetFileTypeAnalyzers()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
<div class="block">Resets the file type analyzers so that they can be re-used to scan
additional directories.</div>
<div class="block">Resets the file type analyzers so that they can be re-used to scan additional directories.</div>
</dd>
<dt><span class="strong"><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>
@@ -313,6 +318,10 @@
<dd>
<div class="block">Executes the dependency-check engine on the project's dependencies and generates the report.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/UpdateMojo.html#runCheck()">runCheck()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dt>
<dd>
<div class="block">Executes the dependency-check engine on the project's dependencies and generates the report.</div>
</dd>
</dl>
<a name="_S_">
<!-- -->
@@ -337,11 +346,20 @@
</a>
<h2 class="title">U</h2>
<dl>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#update()">update()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
<div class="block">Runs the update steps of dependency-check.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/Engine.html#UPDATE_EXECUTED_FLAG">UPDATE_EXECUTED_FLAG</a></span> - Static variable in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></dt>
<dd>
<div class="block">Key used in the MavenProject context values to note whether or not an
update has been executed.</div>
<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="strong">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 known published vulnerabilities.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/UpdateMojo.html#UpdateMojo()">UpdateMojo()</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="_W_">
<!-- -->