documentation v1.3.1

This commit is contained in:
Jeremy Long
2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Tue Aug 04 20:26:09 EDT 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Sep 20 06:50:35 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Index (Dependency-Check Maven Plugin 1.3.0 API)</title>
<meta name="date" content="2015-08-04">
<title>Index (Dependency-Check Maven Plugin 1.3.1 API)</title>
<meta name="date" content="2015-09-20">
<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.3.0 API)";
parent.document.title="Index (Dependency-Check Maven Plugin 1.3.1 API)";
}
//-->
</script>
@@ -63,7 +63,7 @@
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</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="#_W_">W</a>&nbsp;<a name="_A_">
<div class="contentContainer"><a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</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="#_W_">W</a>&nbsp;<a name="_A_">
<!-- -->
</a>
<h2 class="title">A</h2>
@@ -101,6 +101,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/PurgeMojo.html#canGenerateReport()">canGenerateReport()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</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/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>
@@ -202,6 +206,10 @@
<dd>
<div class="block">Returns the category name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString()">getConnectionString()</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 connection string.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory()">getCorrectOutputDirectory()</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 correct output directory depending on if a site is being executed or not.</div>
@@ -230,6 +238,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/PurgeMojo.html#getDescription(java.util.Locale)">getDescription(Locale)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</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/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>
@@ -258,6 +270,10 @@
<dd>
<div class="block">Returns the report name.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/PurgeMojo.html#getName(java.util.Locale)">getName(Locale)</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</a></dt>
<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>
@@ -298,7 +314,7 @@
<dl>
<dt><a href="./org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">HelpMojo</span></a> - Class in <a href="./org/owasp/dependencycheck/maven/package-summary.html">org.owasp.dependencycheck.maven</a></dt>
<dd>
<div class="block">Display help information on dependency-check-maven.<br/>
<div class="block">Display help information on dependency-check-maven.<br>
Call <code>mvn dependency-check:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/HelpMojo.html#HelpMojo()">HelpMojo()</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven">HelpMojo</a></dt>
@@ -388,6 +404,22 @@
<div class="block">This package contains the static binder for the slf4j-maven logger.</div>
</dd>
</dl>
<a name="_P_">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings()">populateSettings()</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">Takes the properties supplied and updates the dependency-check settings.</div>
</dd>
<dt><a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">PurgeMojo</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 purges the local copy of the NVD data.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/maven/PurgeMojo.html#PurgeMojo()">PurgeMojo()</a></span> - Constructor for class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="_R_">
<!-- -->
</a>
@@ -417,6 +449,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/PurgeMojo.html#runCheck()">runCheck()</a></span> - Method in class org.owasp.dependencycheck.maven.<a href="./org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</a></dt>
<dd>
<div class="block">Purges the local copy of the NVD.</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>
@@ -509,7 +545,7 @@
<div class="block">Generates the reports for a given dependency-check engine.</div>
</dd>
</dl>
<a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_O_">O</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="#_W_">W</a>&nbsp;</div>
<a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</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="#_W_">W</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->