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.3.6

Browse Source
This commit is contained in:
Jeremy Long
2016-04-10 07:17:05 -04:00
parent ec78765d20
commit 694c3988f1
1060 changed files with 9318 additions and 9071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
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_31) on Sat Mar 05 13:29:25 EST 2016 -->
<!-- Generated by javadoc (1.8.0_31) on Sat Apr 09 20:12:43 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.5 API)</title>
<meta name="date" content="2016-03-05">
<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.6 API)</title>
<meta name="date" content="2016-04-09">
<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.3.5 API)";
parent.document.title="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.6 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":6,"i23":10,"i24":10,"i25":10,"i26":10,"i27":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":6,"i24":10,"i25":10,"i26":10,"i27":10,"i28":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";
@@ -313,44 +313,50 @@ implements org.apache.maven.reporting.MavenReport</pre>
</td>
</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#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">
<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="i21" class="rowColor">
<tr id="i22" 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;<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="i22" class="altColor">
<tr id="i23" class="rowColor">
<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="i23" class="rowColor">
<tr id="i24" 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#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>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency list.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<tr id="i25" class="rowColor">
<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="i25" class="rowColor">
<tr id="i26" 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#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>
<div class="block">Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.</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#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,
@@ -358,7 +364,7 @@ implements org.apache.maven.reporting.MavenReport</pre>
<div class="block">Writes the scan data to disk.</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#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,
org.apache.maven.project.MavenProject&nbsp;p,
@@ -475,6 +481,20 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
</dl>
</li>
</ul>
<a name="isGeneratingSite--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGeneratingSite</h4>
<pre>protected&nbsp;boolean&nbsp;isGeneratingSite()</pre>
<div class="block">Returns true if the Maven site is being generated.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Maven site is being generated</dd>
</dl>
</li>
</ul>
<a name="generate-org.apache.maven.doxia.sink.Sink-java.util.Locale-">
<!-- -->
</a>