mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-22 09:09:31 +01:00
613 lines
35 KiB
HTML
613 lines
35 KiB
HTML
<!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 (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.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.5 API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/DependencyCheckMojo.html">Use</a></li>
|
|
<li><a href="package-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 Class</li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/DependencyCheckMojo.html" target="_top">Frames</a></li>
|
|
<li><a href="DependencyCheckMojo.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.owasp.dependencycheck.maven</div>
|
|
<h2 title="Class DependencyCheckMojo" class="title">Class DependencyCheckMojo</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<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.MavenReport</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>@Mojo(name="check",
|
|
defaultPhase=COMPILE,
|
|
threadSafe=true,
|
|
requiresDependencyResolution=RUNTIME_PLUS_SYSTEM,
|
|
requiresOnline=true)
|
|
public class <span class="strong">DependencyCheckMojo</span>
|
|
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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.reporting.MavenReport">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface org.apache.maven.reporting.MavenReport</h3>
|
|
<code>CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugin.Mojo">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3>
|
|
<code>ROLE</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<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>
|
|
<div class="block">Constructs a new dependency-check-mojo.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<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 a report can be generated.</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#executeAggregateReport(org.apache.maven.project.MavenProject, java.util.Locale)">executeAggregateReport</a></strong>(org.apache.maven.project.MavenProject 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> locale)</code>
|
|
<div class="block">Generates the aggregate Site Report.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<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> locale)</code>
|
|
<div class="block">Generates the Dependency-Check Site Report.</div>
|
|
</td>
|
|
</tr>
|
|
<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#getCategoryName()">getCategoryName</a></strong>()</code>
|
|
<div class="block">Returns the category name.</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#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> 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="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> locale)</code>
|
|
<div class="block">Returns the report name.</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#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>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>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>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><<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>></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><<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>></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 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 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>
|
|
<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3>
|
|
<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="DependencyCheckMojo()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DependencyCheckMojo</h4>
|
|
<pre>public DependencyCheckMojo()</pre>
|
|
<div class="block">Constructs a new dependency-check-mojo.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="performExecute()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>performExecute</h4>
|
|
<pre>protected void 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><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#performExecute()">performExecute</a></code> in class <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="postExecute()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>postExecute</h4>
|
|
<pre>protected void postExecute()
|
|
throws org.apache.maven.plugin.MojoExecutionException,
|
|
org.apache.maven.plugin.MojoFailureException</pre>
|
|
<div class="block"><strong>Description copied from class: <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>Overrides:</strong></dt>
|
|
<dd><code><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#postExecute()">postExecute</a></code> in class <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> - 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="postGenerate()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>postGenerate</h4>
|
|
<pre>protected void postGenerate()
|
|
throws org.apache.maven.reporting.MavenReportException</pre>
|
|
<div class="block"><strong>Description copied from class: <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> in class <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 void 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> 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><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#executeNonAggregateReport(java.util.Locale)">executeNonAggregateReport</a></code> in class <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 void executeAggregateReport(org.apache.maven.project.MavenProject 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> locale)
|
|
throws org.apache.maven.reporting.MavenReportException</pre>
|
|
<div class="block"><strong>Description copied from class: <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> in class <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>
|
|
</ul>
|
|
<a name="getOutputName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOutputName</h4>
|
|
<pre>public <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> getOutputName()</pre>
|
|
<div class="block">Returns the output name.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the output name</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCategoryName()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCategoryName</h4>
|
|
<pre>public <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> getCategoryName()</pre>
|
|
<div class="block">Returns the category name.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the category name</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getName(java.util.Locale)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre>public <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> 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> locale)</pre>
|
|
<div class="block">Returns the report name.</div>
|
|
<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="getDescription(java.util.Locale)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDescription</h4>
|
|
<pre>public <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> 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> 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><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="canGenerateReport()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>canGenerateReport</h4>
|
|
<pre>public boolean canGenerateReport()</pre>
|
|
<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 boolean 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><a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html#canGenerateNonAggregateReport()">canGenerateNonAggregateReport</a></code> in class <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 boolean 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> in class <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 <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> 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> in class <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 <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><<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>> 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 <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><<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>> readDataFile(org.apache.maven.project.MavenProject 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>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/DependencyCheckMojo.html">Use</a></li>
|
|
<li><a href="package-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 Class</li>
|
|
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/DependencyCheckMojo.html" target="_top">Frames</a></li>
|
|
<li><a href="DependencyCheckMojo.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright© 2012-14 Jeremy Long. All Rights Reserved.</small></p>
|
|
</body>
|
|
</html>
|