github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-18 15:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
15e7c351e4d439b42862e029ef5d09d9e9406dc2
DependencyCheck/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
Jeremy Long 15e7c351e4 version 1.3.3 of the site documentation
2015-12-11 19:59:11 -05:00

851 lines
48 KiB
HTML
Raw Blame History

<!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_71) on Thu Dec 10 19:53:45 EST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.3 API)</title>
<meta name="date" content="2015-12-10">
<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="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.3 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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseDependencyCheckMojo.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><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.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/BaseDependencyCheckMojo.html" target="_top">Frames</a></li>
<li><a href="BaseDependencyCheckMojo.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 BaseDependencyCheckMojo" class="title">Class BaseDependencyCheckMojo</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>org.owasp.dependencycheck.maven.BaseDependencyCheckMojo</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven">AggregateMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html" title="class in org.owasp.dependencycheck.maven">CheckMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">BaseDependencyCheckMojo</span>
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport</pre>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long</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&nbsp;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&nbsp;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">&nbsp;</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/BaseDependencyCheckMojo.html#BaseDependencyCheckMojo()">BaseDependencyCheckMojo</a></strong>()</code>&nbsp;</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">&nbsp;</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 void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure(java.util.List)">checkForFailure</a></strong>(<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;dependencies)</code>
<div class="block">Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the
configuration.</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/BaseDependencyCheckMojo.html#excludeFromScan(org.apache.maven.artifact.Artifact)">excludeFromScan</a></strong>(org.apache.maven.artifact.Artifact&nbsp;a)</code>
<div class="block">Tests is the artifact should be included in the scan (i.e.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute()">execute</a></strong>()</code>
<div class="block">Executes dependency-check.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.codehaus.doxia.sink.Sink,%20java.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>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)"><code>generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</code></a> instead.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)">generate</a></strong>(org.apache.maven.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>
<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/BaseDependencyCheckMojo.html#getCategoryName()">getCategoryName</a></strong>()</code>
<div class="block">Returns the category name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getConnectionString()">getConnectionString</a></strong>()</code>
<div class="block">Returns the connection string.</div>
</td>
</tr>
<tr class="rowColor">
<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/BaseDependencyCheckMojo.html#getCorrectOutputDirectory()">getCorrectOutputDirectory</a></strong>()</code>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</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/BaseDependencyCheckMojo.html#getCorrectOutputDirectory(org.apache.maven.project.MavenProject)">getCorrectOutputDirectory</a></strong>(org.apache.maven.project.MavenProject&nbsp;current)</code>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
</td>
</tr>
<tr class="rowColor">
<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/BaseDependencyCheckMojo.html#getDataFile(org.apache.maven.project.MavenProject)">getDataFile</a></strong>(org.apache.maven.project.MavenProject&nbsp;current)</code>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getDataFileContextKey()">getDataFileContextKey</a></strong>()</code>
<div class="block">Returns the key used to store the path to the data file that is saved by <code>writeDataFile()</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getFormat()">getFormat</a></strong>()</code>
<div class="block">Returns the report format.</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/BaseDependencyCheckMojo.html#getOutputDirectory()">getOutputDirectory</a></strong>()</code>
<div class="block">Returns the output directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey()">getOutputDirectoryContextKey</a></strong>()</code>
<div class="block">Returns the key used to store the path to the output directory.</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/BaseDependencyCheckMojo.html#getOutputName()">getOutputName</a></strong>()</code>
<div class="block">Returns the output name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject()">getProject</a></strong>()</code>
<div class="block">Returns a reference to the current project.</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>&lt;org.apache.maven.project.MavenProject&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects()">getReactorProjects</a></strong>()</code>
<div class="block">Returns the list of Maven Projects in this build.</div>
</td>
</tr>
<tr class="rowColor">
<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/BaseDependencyCheckMojo.html#getReportOutputDirectory()">getReportOutputDirectory</a></strong>()</code>
<div class="block">Returns the report output directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine()">initializeEngine</a></strong>()</code>
<div class="block">Initializes a new <code>Engine</code> that can be used for scanning.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport()">isExternalReport</a></strong>()</code>
<div class="block">Returns whether this is an external 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/BaseDependencyCheckMojo.html#populateSettings()">populateSettings</a></strong>()</code>
<div class="block">Takes the properties supplied and updates the dependency-check settings.</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/BaseDependencyCheckMojo.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>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#runCheck()">runCheck</a></strong>()</code>
<div class="block">Executes the dependency-check scan and generates the necassary report.</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/BaseDependencyCheckMojo.html#scanArtifacts(org.apache.maven.project.MavenProject,%20org.owasp.dependencycheck.maven.Engine)">scanArtifacts</a></strong>(org.apache.maven.project.MavenProject&nbsp;project,
<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine)</code>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.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>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary(org.apache.maven.project.MavenProject,%20java.util.List)">showSummary</a></strong>(org.apache.maven.project.MavenProject&nbsp;mp,
<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;dependencies)</code>
<div class="block">Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.</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/BaseDependencyCheckMojo.html#writeDataFile(org.apache.maven.project.MavenProject,%20java.io.File,%20java.util.List)">writeDataFile</a></strong>(org.apache.maven.project.MavenProject&nbsp;mp,
<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;writeTo,
<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;dependencies)</code>
<div class="block">Writes the scan data to disk.</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/BaseDependencyCheckMojo.html#writeReports(org.owasp.dependencycheck.maven.Engine,%20org.apache.maven.project.MavenProject,%20java.io.File)">writeReports</a></strong>(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine,
org.apache.maven.project.MavenProject&nbsp;p,
<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;outputDir)</code>
<div class="block">Generates the reports for a given dependency-check engine.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;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,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.reporting.MavenReport">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.maven.reporting.MavenReport</h3>
<code>canGenerateReport, getDescription, getName</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="BaseDependencyCheckMojo()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseDependencyCheckMojo</h4>
<pre>public&nbsp;BaseDependencyCheckMojo()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConnectionString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionString</h4>
<pre>protected&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;getConnectionString()</pre>
<div class="block">Returns the connection string.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the connection string</dd></dl>
</li>
</ul>
<a name="execute()">
<!-- -->
</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>
<div class="block">Executes dependency-check.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>execute</code>&nbsp;in interface&nbsp;<code>org.apache.maven.plugin.Mojo</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception executing the mojo</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check failed the build</dd></dl>
</li>
</ul>
<a name="generate(org.codehaus.doxia.sink.Sink, java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generate</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public final&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"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)"><code>generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</code></a> instead.</i></div>
<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.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><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="generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generate</h4>
<pre>public&nbsp;void&nbsp;generate(org.apache.maven.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>
<dl><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><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="getCorrectOutputDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorrectOutputDirectory</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;getCorrectOutputDirectory()
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the directory to write the report(s)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an error loading the file path</dd></dl>
</li>
</ul>
<a name="getCorrectOutputDirectory(org.apache.maven.project.MavenProject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorrectOutputDirectory</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;getCorrectOutputDirectory(org.apache.maven.project.MavenProject&nbsp;current)</pre>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>current</code> - the Maven project to get the output directory from</dd>
<dt><span class="strong">Returns:</span></dt><dd>the directory to write the report(s)</dd></dl>
</li>
</ul>
<a name="getDataFile(org.apache.maven.project.MavenProject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataFile</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;getDataFile(org.apache.maven.project.MavenProject&nbsp;current)</pre>
<div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>current</code> - the Maven project to get the output directory from</dd>
<dt><span class="strong">Returns:</span></dt><dd>the directory to write the report(s)</dd></dl>
</li>
</ul>
<a name="scanArtifacts(org.apache.maven.project.MavenProject, org.owasp.dependencycheck.maven.Engine)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanArtifacts</h4>
<pre>protected&nbsp;void&nbsp;scanArtifacts(org.apache.maven.project.MavenProject&nbsp;project,
<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine)</pre>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the project to scan the dependencies of</dd><dd><code>engine</code> - the engine to use to scan the dependencies</dd></dl>
</li>
</ul>
<a name="runCheck()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runCheck</h4>
<pre>public abstract&nbsp;void&nbsp;runCheck()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Executes the dependency-check scan and generates the necassary report.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running the scan</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to fail the build</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 report 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 report output directory</dd></dl>
</li>
</ul>
<a name="getOutputDirectory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputDirectory</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;getOutputDirectory()</pre>
<div class="block">Returns the output directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the output directory</dd></dl>
</li>
</ul>
<a name="isExternalReport()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExternalReport</h4>
<pre>public final&nbsp;boolean&nbsp;isExternalReport()</pre>
<div class="block">Returns whether this is an external report. This method always returns true.</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><code>true</code></dd></dl>
</li>
</ul>
<a name="getOutputName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<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>
</li>
</ul>
<a name="getCategoryName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<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>
</li>
</ul>
<a name="initializeEngine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeEngine</h4>
<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;initializeEngine()
throws <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/data/nvdcve/DatabaseException.html?is-external=true" title="class or interface in org.owasp.dependencycheck.data.nvdcve">DatabaseException</a></pre>
<div class="block">Initializes a new <code>Engine</code> that can be used for scanning.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a newly instantiated <code>Engine</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/data/nvdcve/DatabaseException.html?is-external=true" title="class or interface in org.owasp.dependencycheck.data.nvdcve">DatabaseException</a></code> - thrown if there is a database exception</dd></dl>
</li>
</ul>
<a name="populateSettings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populateSettings</h4>
<pre>protected&nbsp;void&nbsp;populateSettings()</pre>
<div class="block">Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system properties
required to change the proxy url, port, and connection timeout.</div>
</li>
</ul>
<a name="excludeFromScan(org.apache.maven.artifact.Artifact)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeFromScan</h4>
<pre>protected&nbsp;boolean&nbsp;excludeFromScan(org.apache.maven.artifact.Artifact&nbsp;a)</pre>
<div class="block">Tests is the artifact should be included in the scan (i.e. is the dependency in a scope that is being scanned).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>a</code> - the Artifact to test</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the artifact is in an excluded scope; otherwise <code>false</code></dd></dl>
</li>
</ul>
<a name="getProject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProject</h4>
<pre>protected&nbsp;org.apache.maven.project.MavenProject&nbsp;getProject()</pre>
<div class="block">Returns a reference to the current project. This method is used instead of auto-binding the project via component
annotation in concrete implementations of this. If the child has a <code>@Component MavenProject project;</code> defined
then the abstract class (i.e. this class) will not have access to the current project (just the way Maven works with the
binding).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>returns a reference to the current project</dd></dl>
</li>
</ul>
<a name="getReactorProjects()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReactorProjects</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;org.apache.maven.project.MavenProject&gt;&nbsp;getReactorProjects()</pre>
<div class="block">Returns the list of Maven Projects in this build.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of Maven Projects in this build</dd></dl>
</li>
</ul>
<a name="getFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormat</h4>
<pre>protected&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;getFormat()</pre>
<div class="block">Returns the report format.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the report format</dd></dl>
</li>
</ul>
<a name="writeReports(org.owasp.dependencycheck.maven.Engine, org.apache.maven.project.MavenProject, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeReports</h4>
<pre>protected&nbsp;void&nbsp;writeReports(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine,
org.apache.maven.project.MavenProject&nbsp;p,
<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;outputDir)</pre>
<div class="block">Generates the reports for a given dependency-check engine.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>engine</code> - a dependency-check engine</dd><dd><code>p</code> - the maven project</dd><dd><code>outputDir</code> - the directory path to write the report(s).</dd></dl>
</li>
</ul>
<a name="checkForFailure(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkForFailure</h4>
<pre>protected&nbsp;void&nbsp;checkForFailure(<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;dependencies)
throws org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the
configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dependencies</code> - the list of dependency objects</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if a CVSS score is found that is higher then the threshold set</dd></dl>
</li>
</ul>
<a name="showSummary(org.apache.maven.project.MavenProject, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>showSummary</h4>
<pre>protected&nbsp;void&nbsp;showSummary(org.apache.maven.project.MavenProject&nbsp;mp,
<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;dependencies)</pre>
<div class="block">Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mp</code> - the Maven project for which the summary is shown</dd><dd><code>dependencies</code> - a list of dependency objects</dd></dl>
</li>
</ul>
<a name="getDataFileContextKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataFileContextKey</h4>
<pre>protected&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;getDataFileContextKey()</pre>
<div class="block">Returns the key used to store the path to the data file that is saved by <code>writeDataFile()</code>. This key is used in
the <code>MavenProject.(set|get)ContextValue</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the key used to store the path to the data file</dd></dl>
</li>
</ul>
<a name="getOutputDirectoryContextKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputDirectoryContextKey</h4>
<pre>protected&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;getOutputDirectoryContextKey()</pre>
<div class="block">Returns the key used to store the path to the output directory. When generating the report in the
<code>executeAggregateReport()</code> the output directory should be obtained by using this key.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the key used to store the path to the output directory</dd></dl>
</li>
</ul>
<a name="writeDataFile(org.apache.maven.project.MavenProject, java.io.File, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeDataFile</h4>
<pre>protected&nbsp;void&nbsp;writeDataFile(org.apache.maven.project.MavenProject&nbsp;mp,
<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;writeTo,
<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;dependencies)</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><span class="strong">Parameters:</span></dt><dd><code>mp</code> - the mMven project for which the data file was created</dd><dd><code>writeTo</code> - the directory to write the data file</dd><dd><code>dependencies</code> - the list of dependencies to serialize</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>
</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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseDependencyCheckMojo.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><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.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/BaseDependencyCheckMojo.html" target="_top">Frames</a></li>
<li><a href="BaseDependencyCheckMojo.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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-15 Jeremy Long. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink