github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-04-25 17:59:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

version 1.4.3 documentation

Browse Source
This commit is contained in:
Jeremy Long
2016-09-06 08:48:40 -04:00
parent 44917ad0d3
commit e1a447f722
1225 changed files with 44138 additions and 39411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/AggregateMojo.html
View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Sun Jul 31 07:45:59 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Tue Sep 06 06:51:25 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AggregateMojo (Dependency-Check Maven Plugin 1.4.2 API)</title>
<meta name="date" content="2016-07-31">
<title>AggregateMojo (Dependency-Check Maven Plugin 1.4.3 API)</title>
<meta name="date" content="2016-09-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@@ -13,13 +13,13 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AggregateMojo (Dependency-Check Maven Plugin 1.4.2 API)";
parent.document.title="AggregateMojo (Dependency-Check Maven Plugin 1.4.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -126,6 +126,7 @@ var activeTableTab = "activeTableTab";
<br>
<pre>@Mojo(name="aggregate",
defaultPhase=VERIFY,
aggregator=true,
threadSafe=false,
requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
requiresOnline=true)
@@ -199,47 +200,38 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#canGenerateReport--">canGenerateReport</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#generateDataFile--">generateDataFile</a></span>()</code>
<div class="block">Initializes the engine, runs a scan, and writes the serialized
dependencies to disk.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#generateDataFile-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-">generateDataFile</a></span>(<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine,
org.apache.maven.project.MavenProject&nbsp;project)</code>
<div class="block">Runs dependency-check's MavenEngine and writes the serialized
dependencies to disk.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.apache.maven.project.MavenProject&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#getDescendants-org.apache.maven.project.MavenProject-">getDescendants</a></span>(org.apache.maven.project.MavenProject&nbsp;project)</code>
<div class="block">Returns a set containing all the descendant projects of the given
project.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<tr id="i2" 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><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#getDescription-java.util.Locale-">getDescription</a></span>(<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 id="i5" class="rowColor">
<tr id="i3" 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><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#getName-java.util.Locale-">getName</a></span>(<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 id="i6" class="altColor">
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#isMultiModule-org.apache.maven.project.MavenProject-">isMultiModule</a></span>(org.apache.maven.project.MavenProject&nbsp;mavenProject)</code>
<div class="block">Test if the project has pom packaging</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#loadEngine--">loadEngine</a></span>()</code>
<div class="block">Initializes the engine.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html#runCheck--">runCheck</a></span>()</code>
<div class="block">Executes the aggregate dependency-check goal.</div>
@@ -251,7 +243,7 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.owasp.dependencycheck.maven.<a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven">BaseDependencyCheckMojo</a></h3>
<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure-java.util.List-">checkForFailure</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-org.apache.maven.artifact.Artifact-">excludeFromScan</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute--">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.codehaus.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCategoryName--">getCategoryName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString--">getConnectionString</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory--">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory-org.apache.maven.project.MavenProject-">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFile-org.apache.maven.project.MavenProject-">getDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFileContextKey--">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat--">getFormat</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory--">getOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey--">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputName--">getOutputName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject--">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects--">getReactorProjects</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory--">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isFailOnError--">isFailOnError</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></code></li>
<code><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#checkForFailure-java.util.List-">checkForFailure</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-java.lang.String-">excludeFromScan</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#execute--">execute</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.codehaus.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">generate</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCategoryName--">getCategoryName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getConnectionString--">getConnectionString</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory--">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory-org.apache.maven.project.MavenProject-">getCorrectOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFile-org.apache.maven.project.MavenProject-">getDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getDataFileContextKey--">getDataFileContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getFormat--">getFormat</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectory--">getOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey--">getOutputDirectoryContextKey</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getOutputName--">getOutputName</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject--">getProject</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects--">getReactorProjects</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory--">getReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isExternalReport--">isExternalReport</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isFailOnError--">isFailOnError</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a>, <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
@@ -354,49 +346,22 @@ extends <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheck
</dl>
</li>
</ul>
<a name="generateDataFile--">
<a name="loadEngine--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateDataFile</h4>
<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;generateDataFile()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Initializes the engine, runs a scan, and writes the serialized
dependencies to disk.</div>
<h4>loadEngine</h4>
<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;loadEngine()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Initializes the engine.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MavenEngine used to execute dependency-check</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running
the mojo</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
fail the build if severe CVEs are identified.</dd>
</dl>
</li>
</ul>
<a name="generateDataFile-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateDataFile</h4>
<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;generateDataFile(<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine,
org.apache.maven.project.MavenProject&nbsp;project)
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException</pre>
<div class="block">Runs dependency-check's MavenEngine and writes the serialized
dependencies to disk.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>engine</code> - the MavenEngine to use when scanning.</dd>
<dd><code>project</code> - the project to scan and generate the data file for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MavenEngine used to execute dependency-check</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - thrown if there is an exception running
the mojo</dd>
the Mojo</dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code> - thrown if dependency-check is configured to
fail the build if severe CVEs are identified.</dd>
</dl>