github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-04-05 08:27:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation version 1.4.2

Browse Source
This commit is contained in:
Jeremy Long
2016-07-31 08:10:07 -04:00
parent 6193968089
commit 44917ad0d3
1319 changed files with 93942 additions and 60498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
View File

@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 16 06:48:24 EDT 2016 -->
<!-- Generated by javadoc (1.8.0_92) on Sun Jul 31 07:45:59 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.0 API)</title>
<meta name="date" content="2016-06-16">
<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.2 API)</title>
<meta name="date" content="2016-07-31">
<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="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.0 API)";
parent.document.title="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":6,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":6,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -307,9 +307,9 @@ implements org.apache.maven.reporting.MavenReport</pre>
</td>
</tr>
<tr id="i18" 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="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/BaseDependencyCheckMojo.html#initializeEngine--">initializeEngine</a></span>()</code>
<div class="block">Initializes a new <code>Engine</code> that can be used for scanning.</div>
<div class="block">Initializes a new <code>MavenEngine</code> that can be used for scanning.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
@@ -320,43 +320,49 @@ implements org.apache.maven.reporting.MavenReport</pre>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isFailOnError--">isFailOnError</a></span>()</code>
<div class="block">Returns if the mojo should fail the build if an exception occurs.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#isGeneratingSite--">isGeneratingSite</a></span>()</code>
<div class="block">Returns true if the Maven site is being generated.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<tr id="i22" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings--">populateSettings</a></span>()</code>
<div class="block">Takes the properties supplied and updates the dependency-check settings.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<tr id="i23" 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><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile-org.apache.maven.project.MavenProject-">readDataFile</a></span>(org.apache.maven.project.MavenProject&nbsp;project)</code>
<div class="block">Reads the serialized scan data from disk.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<tr id="i24" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#runCheck--">runCheck</a></span>()</code>
<div class="block">Executes the dependency-check scan and generates the necassary report.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.Engine-">scanArtifacts</a></span>(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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">scanArtifacts</a></span>(org.apache.maven.project.MavenProject&nbsp;project,
<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</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 id="i25" class="rowColor">
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#setReportOutputDirectory-java.io.File-">setReportOutputDirectory</a></span>(<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 id="i26" class="altColor">
<tr id="i27" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#showSummary-org.apache.maven.project.MavenProject-java.util.List-">showSummary</a></span>(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>
@@ -364,7 +370,7 @@ implements org.apache.maven.reporting.MavenReport</pre>
associated CPE and CVE entries.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<tr id="i28" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeDataFile-org.apache.maven.project.MavenProject-java.io.File-java.util.List-">writeDataFile</a></span>(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,
@@ -372,9 +378,9 @@ implements org.apache.maven.reporting.MavenReport</pre>
<div class="block">Writes the scan data to disk.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<tr id="i29" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.Engine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</a></span>(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a>&nbsp;engine,
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#writeReports-org.owasp.dependencycheck.maven.MavenEngine-org.apache.maven.project.MavenProject-java.io.File-">writeReports</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;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>
@@ -433,6 +439,20 @@ implements org.apache.maven.reporting.MavenReport</pre>
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isFailOnError--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFailOnError</h4>
<pre>protected&nbsp;boolean&nbsp;isFailOnError()</pre>
<div class="block">Returns if the mojo should fail the build if an exception occurs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether or not the mojo should fail the build</dd>
</dl>
</li>
</ul>
<a name="getConnectionString--">
<!-- -->
</a>
@@ -578,14 +598,14 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
</dl>
</li>
</ul>
<a name="scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.Engine-">
<a name="scanArtifacts-org.apache.maven.project.MavenProject-org.owasp.dependencycheck.maven.MavenEngine-">
<!-- -->
</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>
<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine)</pre>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency
list.</div>
<dl>
@@ -715,12 +735,12 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
<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>
<pre>protected&nbsp;<a href="../../../../org/owasp/dependencycheck/maven/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</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>MavenEngine</code> that can be used for scanning.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a newly instantiated <code>Engine</code></dd>
<dd>a newly instantiated <code>MavenEngine</code></dd>
<dt><span class="throwsLabel">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>
@@ -803,21 +823,24 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
</dl>
</li>
</ul>
<a name="writeReports-org.owasp.dependencycheck.maven.Engine-org.apache.maven.project.MavenProject-java.io.File-">
<a name="writeReports-org.owasp.dependencycheck.maven.MavenEngine-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,
<pre>protected&nbsp;void&nbsp;writeReports(<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;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>
<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)
throws <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/exception/ReportException.html?is-external=true" title="class or interface in org.owasp.dependencycheck.exception">ReportException</a></pre>
<div class="block">Generates the reports for a given dependency-check engine.</div>
<dl>
<dt><span class="paramLabel">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>
<dd><code>p</code> - the Maven project</dd>
<dd><code>outputDir</code> - the directory path to write the report(s)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/exception/ReportException.html?is-external=true" title="class or interface in org.owasp.dependencycheck.exception">ReportException</a></code> - thrown if there is an error writing the report</dd>
</dl>
</li>
</ul>
@@ -921,8 +944,8 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>project</code> - the Maven project to read the data file from</dd>
<dt><span class="returnLabel">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>
<dd>a <code>MavenEngine</code> object populated with dependencies if
the serialized data file exists; otherwise <code>null</code> is returned</dd>
</dl>
</li>
</ul>