github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-31 06:03:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

version 1.2.5 of the documentation

Browse Source
This commit is contained in:
Jeremy Long
2014-09-17 05:43:14 -04:00
parent c9a8bb3969
commit b31c4d94c4
988 changed files with 22559 additions and 19785 deletions
Download Patch File Download Diff File Expand all files Collapse all files

326
dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/DependencyCheckMojo.html
View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Tue Aug 05 18:11:09 EDT 2014 -->
<!-- Generated by javadoc (version 1.7.0_45) on Tue Sep 16 05:45:54 EDT 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DependencyCheckMojo (Dependency-Check Maven Plugin 1.2.4 API)</title>
<meta name="date" content="2014-08-05">
<title>DependencyCheckMojo (Dependency-Check Maven Plugin 1.2.5 API)</title>
<meta name="date" content="2014-09-16">
<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="DependencyCheckMojo (Dependency-Check Maven Plugin 1.2.4 API)";
parent.document.title="DependencyCheckMojo (Dependency-Check Maven Plugin 1.2.5 API)";
}
//-->
</script>
@@ -90,18 +90,23 @@
<li>org.apache.maven.plugin.AbstractMojo</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">org.owasp.dependencycheck.maven.ReportAggregationMojo</a></li>
<li>
<ul class="inheritance">
<li>org.owasp.dependencycheck.maven.DependencyCheckMojo</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport</dd>
<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport</dd>
</dl>
<hr>
<br>
@@ -111,8 +116,7 @@
requiresDependencyResolution=RUNTIME_PLUS_SYSTEM,
requiresOnline=true)
public class <span class="strong">DependencyCheckMojo</span>
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenMultiPageReport</pre>
extends <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></pre>
<div class="block">Maven Plugin that checks project dependencies to see if they have any known published vulnerabilities.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
@@ -156,7 +160,9 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#DependencyCheckMojo()">DependencyCheckMojo</a></strong>()</code>&nbsp;</td>
<td class="colOne"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#DependencyCheckMojo()">DependencyCheckMojo</a></strong>()</code>
<div class="block">Constructs a new dependency-check-mojo.</div>
</td>
</tr>
</table>
</li>
@@ -174,76 +180,105 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#canGenerateAggregateReport()">canGenerateAggregateReport</a></strong>()</code>
<div class="block">Returns whether or not an aggregate report can be generated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#canGenerateNonAggregateReport()">canGenerateNonAggregateReport</a></strong>()</code>
<div class="block">Returns whether or not a non-aggregate report can be generated.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#canGenerateReport()">canGenerateReport</a></strong>()</code>
<div class="block">Returns whether or not the plugin can generate a report.</div>
<div class="block">Returns whether or not a report can be generated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#execute()">execute</a></strong>()</code>
<div class="block">Executes the dependency-check and generates the report.</div>
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#executeAggregateReport(org.apache.maven.project.MavenProject, java.util.Locale)">executeAggregateReport</a></strong>(org.apache.maven.project.MavenProject&nbsp;project,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Generates the aggregate Site Report.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)">generate</a></strong>(org.codehaus.doxia.sink.Sink&nbsp;sink,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#executeNonAggregateReport(java.util.Locale)">executeNonAggregateReport</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Generates the Dependency-Check Site Report.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)">generate</a></strong>(org.apache.maven.doxia.sink.Sink&nbsp;sink,
org.apache.maven.doxia.sink.SinkFactory&nbsp;sinkFactory,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Generates the Dependency-Check Site Report.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#getCategoryName()">getCategoryName</a></strong>()</code>
<div class="block">Returns the category name.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#getDescription(java.util.Locale)">getDescription</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#getName(java.util.Locale)">getName</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Returns the report name.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#getOutputName()">getOutputName</a></strong>()</code>
<div class="block">Returns the output name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#performExecute()">performExecute</a></strong>()</code>
<div class="block">Executes the dependency-check and generates the report.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#getReportOutputDirectory()">getReportOutputDirectory</a></strong>()</code>
<div class="block">Returns the output directory.</div>
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#postExecute()">postExecute</a></strong>()</code>
<div class="block">Runs after the mojo has executed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#isExternalReport()">isExternalReport</a></strong>()</code>
<div class="block">Returns whether this is an external report.</div>
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#postGenerate()">postGenerate</a></strong>()</code>
<div class="block">Executes after the site report has been generated.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#setReportOutputDirectory(java.io.File)">setReportOutputDirectory</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;directory)</code>
<div class="block">Sets the Reporting output directory.</div>
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/dependency/Dependency.html?is-external=true" title="class or interface in org.owasp.dependencycheck.dependency">Dependency</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#readDataFile()">readDataFile</a></strong>()</code>
<div class="block">Reads the serialized scan data from disk.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/dependency/Dependency.html?is-external=true" title="class or interface in org.owasp.dependencycheck.dependency">Dependency</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#readDataFile(org.apache.maven.project.MavenProject)">readDataFile</a></strong>(org.apache.maven.project.MavenProject&nbsp;project)</code>
<div class="block">Reads the serialized scan data from disk.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html#writeDataFile()">writeDataFile</a></strong>()</code>
<div class="block">Writes the scan data to disk.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.owasp.dependencycheck.maven.ReportAggregationMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.owasp.dependencycheck.maven.<a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></h3>
<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#execute()">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getAllChildDataFiles(org.apache.maven.project.MavenProject)">getAllChildDataFiles</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getAllChildren()">getAllChildren</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getAllChildren(org.apache.maven.project.MavenProject)">getAllChildren</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getDataFileContextKey()">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getDataFileName()">getDataFileName</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getDataFiles(java.util.List)">getDataFiles</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getOutputDirectoryContextKey()">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getProject()">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getReportOutputDirectory()">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#getReportOutputDirectory(org.apache.maven.project.MavenProject)">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#isAggregate()">isAggregate</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#isExternalReport()">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#isLastProject()">isLastProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#isMultiModule()">isMultiModule</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#isMultiModule(org.apache.maven.project.MavenProject)">isMultiModule</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#preExecute()">preExecute</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#preGenerate()">preGenerate</a>, <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#setReportOutputDirectory(java.io.File)">setReportOutputDirectory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo">
<!-- -->
</a>
@@ -278,6 +313,7 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<li class="blockList">
<h4>DependencyCheckMojo</h4>
<pre>public&nbsp;DependencyCheckMojo()</pre>
<div class="block">Constructs a new dependency-check-mojo.</div>
</li>
</ul>
</li>
@@ -288,57 +324,93 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute()">
<a name="performExecute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<h4>performExecute</h4>
<pre>protected&nbsp;void&nbsp;performExecute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Executes the dependency-check and generates the report.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>execute</code>&nbsp;in interface&nbsp;<code>org.apache.maven.plugin.Mojo</code></dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#performExecute()">performExecute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if a maven exception occurs</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if a CVSS score is found that is higher then the configured level</dd></dl>
</li>
</ul>
<a name="generate(org.codehaus.doxia.sink.Sink, java.util.Locale)">
<a name="postExecute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generate</h4>
<pre>public&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)
throws org.apache.maven.reporting.MavenReportException</pre>
<div class="block">Generates the Dependency-Check Site Report.</div>
<h4>postExecute</h4>
<pre>protected&nbsp;void&nbsp;postExecute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#postExecute()">ReportAggregationMojo</a></code></strong></div>
<div class="block">Runs after the mojo has executed. This implementation will call <code>writeDataFile()</code>. As such, it is
important that if this method is overriden that <code>super.postExecute()</code> is called.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>generate</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sink</code> - the sink to write the report to</dd><dd><code>locale</code> - the locale to use when generating the report</dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#postExecute()">postExecute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.reporting.MavenReportException</code> - if a Maven report exception occurs</dd></dl>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an issue executing the mojo</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if there is an issue executing the mojo</dd></dl>
</li>
</ul>
<a name="generate(org.apache.maven.doxia.sink.Sink, org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)">
<a name="postGenerate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generate</h4>
<pre>public&nbsp;void&nbsp;generate(org.apache.maven.doxia.sink.Sink&nbsp;sink,
org.apache.maven.doxia.sink.SinkFactory&nbsp;sinkFactory,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)
throws org.apache.maven.reporting.MavenReportException</pre>
<h4>postGenerate</h4>
<pre>protected&nbsp;void&nbsp;postGenerate()
throws org.apache.maven.reporting.MavenReportException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#postGenerate()">ReportAggregationMojo</a></code></strong></div>
<div class="block">Executes after the site report has been generated.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#postGenerate()">postGenerate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.reporting.MavenReportException</code> - if a maven report exception occurs</dd></dl>
</li>
</ul>
<a name="executeNonAggregateReport(java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeNonAggregateReport</h4>
<pre>protected&nbsp;void&nbsp;executeNonAggregateReport(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)
throws org.apache.maven.reporting.MavenReportException</pre>
<div class="block">Generates the Dependency-Check Site Report.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>generate</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenMultiPageReport</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sink</code> - the sink to write the report to</dd><dd><code>sinkFactory</code> - the sink factory</dd><dd><code>locale</code> - the locale to use when generating the report</dd>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#executeNonAggregateReport(java.util.Locale)">executeNonAggregateReport</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the locale to use when generating the report</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.reporting.MavenReportException</code> - if a maven report exception occurs</dd></dl>
</li>
</ul>
<a name="executeAggregateReport(org.apache.maven.project.MavenProject, java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAggregateReport</h4>
<pre>protected&nbsp;void&nbsp;executeAggregateReport(org.apache.maven.project.MavenProject&nbsp;project,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)
throws org.apache.maven.reporting.MavenReportException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#executeAggregateReport(org.apache.maven.project.MavenProject, java.util.Locale)">ReportAggregationMojo</a></code></strong></div>
<div class="block">Generates the aggregate Site Report.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#executeAggregateReport(org.apache.maven.project.MavenProject, java.util.Locale)">executeAggregateReport</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the maven project used to generate the aggregate report</dd><dd><code>locale</code> - the locale to use when generating the report</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.reporting.MavenReportException</code> - if a maven report exception occurs</dd></dl>
</li>
@@ -351,10 +423,7 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<h4>getOutputName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getOutputName()</pre>
<div class="block">Returns the output name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getOutputName</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the output name</dd></dl>
<dl><dt><span class="strong">Returns:</span></dt><dd>the output name</dd></dl>
</li>
</ul>
<a name="getCategoryName()">
@@ -365,10 +434,7 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<h4>getCategoryName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCategoryName()</pre>
<div class="block">Returns the category name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getCategoryName</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the category name</dd></dl>
<dl><dt><span class="strong">Returns:</span></dt><dd>the category name</dd></dl>
</li>
</ul>
<a name="getName(java.util.Locale)">
@@ -379,41 +445,10 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<h4>getName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">Returns the report name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getName</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the location</dd>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the location</dd>
<dt><span class="strong">Returns:</span></dt><dd>the report name</dd></dl>
</li>
</ul>
<a name="setReportOutputDirectory(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReportOutputDirectory</h4>
<pre>public&nbsp;void&nbsp;setReportOutputDirectory(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;directory)</pre>
<div class="block">Sets the Reporting output directory.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setReportOutputDirectory</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - the output directory</dd></dl>
</li>
</ul>
<a name="getReportOutputDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReportOutputDirectory</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;getReportOutputDirectory()</pre>
<div class="block">Returns the output directory.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getReportOutputDirectory</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the output directory</dd></dl>
</li>
</ul>
<a name="getDescription(java.util.Locale)">
<!-- -->
</a>
@@ -422,39 +457,88 @@ implements org.apache.maven.reporting.MavenMultiPageReport</pre>
<h4>getDescription</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getDescription</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - The Locale to get the description for</dd>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - The Locale to get the description for</dd>
<dt><span class="strong">Returns:</span></dt><dd>the description</dd></dl>
</li>
</ul>
<a name="isExternalReport()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExternalReport</h4>
<pre>public&nbsp;boolean&nbsp;isExternalReport()</pre>
<div class="block">Returns whether this is an external report.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>isExternalReport</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true or false;</dd></dl>
</li>
</ul>
<a name="canGenerateReport()">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>canGenerateReport</h4>
<pre>public&nbsp;boolean&nbsp;canGenerateReport()</pre>
<div class="block">Returns whether or not the plugin can generate a report.</div>
<div class="block">Returns whether or not a report can be generated.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a report can be generated; otherwise <code>false</code></dd></dl>
</li>
</ul>
<a name="canGenerateNonAggregateReport()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canGenerateNonAggregateReport</h4>
<pre>protected&nbsp;boolean&nbsp;canGenerateNonAggregateReport()</pre>
<div class="block">Returns whether or not a non-aggregate report can be generated.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>canGenerateReport</code>&nbsp;in interface&nbsp;<code>org.apache.maven.reporting.MavenReport</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true</dd></dl>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#canGenerateNonAggregateReport()">canGenerateNonAggregateReport</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a non-aggregate report can be generated; otherwise <code>false</code></dd></dl>
</li>
</ul>
<a name="canGenerateAggregateReport()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canGenerateAggregateReport</h4>
<pre>protected&nbsp;boolean&nbsp;canGenerateAggregateReport()</pre>
<div class="block">Returns whether or not an aggregate report can be generated.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#canGenerateAggregateReport()">canGenerateAggregateReport</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if an aggregate report can be generated; otherwise <code>false</code></dd></dl>
</li>
</ul>
<a name="writeDataFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeDataFile</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;writeDataFile()</pre>
<div class="block">Writes the scan data to disk. This is used to serialize the scan data between the "check" and "aggregate" phase.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#writeDataFile()">writeDataFile</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html" title="class in org.owasp.dependencycheck.maven">ReportAggregationMojo</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the File object referencing the data file that was written</dd></dl>
</li>
</ul>
<a name="readDataFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readDataFile</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/dependency/Dependency.html?is-external=true" title="class or interface in org.owasp.dependencycheck.dependency">Dependency</a>&gt;&nbsp;readDataFile()</pre>
<div class="block">Reads the serialized scan data from disk. This is used to serialize the scan data between the "check" and
"aggregate" phase.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>Engine</code> object populated with dependencies if the serialized data file exists; otherwise
<code>null</code> is returned</dd></dl>
</li>
</ul>
<a name="readDataFile(org.apache.maven.project.MavenProject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readDataFile</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/dependency/Dependency.html?is-external=true" title="class or interface in org.owasp.dependencycheck.dependency">Dependency</a>&gt;&nbsp;readDataFile(org.apache.maven.project.MavenProject&nbsp;project)</pre>
<div class="block">Reads the serialized scan data from disk. This is used to serialize the scan data between the "check" and
"aggregate" phase.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the Maven project to read the data file from</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>Engine</code> object populated with dependencies if the serialized data file exists; otherwise
<code>null</code> is returned</dd></dl>
</li>
</ul>
</li>