version 1.4.3 documentation

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

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>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.2 API)</title>
<meta name="date" content="2016-07-31">
<title>BaseDependencyCheckMojo (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,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.2 API)";
parent.document.title="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.4.3 API)";
}
}
catch(err) {
@@ -196,7 +196,7 @@ implements org.apache.maven.reporting.MavenReport</pre>
</tr>
<tr id="i1" 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#excludeFromScan-org.apache.maven.artifact.Artifact-">excludeFromScan</a></span>(org.apache.maven.artifact.Artifact&nbsp;a)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#excludeFromScan-java.lang.String-">excludeFromScan</a></span>(<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;scope)</code>
<div class="block">Tests is the artifact should be included in the scan (i.e.</div>
</td>
</tr>
@@ -349,7 +349,7 @@ implements org.apache.maven.reporting.MavenReport</pre>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colFirst"><code>protected <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/exception/ExceptionCollection.html?is-external=true" title="class or interface in org.owasp.dependencycheck.exception">ExceptionCollection</a></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.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
@@ -604,14 +604,17 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
<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/MavenEngine.html" title="class in org.owasp.dependencycheck.maven">MavenEngine</a>&nbsp;engine)</pre>
<pre>protected&nbsp;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/exception/ExceptionCollection.html?is-external=true" title="class or interface in org.owasp.dependencycheck.exception">ExceptionCollection</a>&nbsp;scanArtifacts(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)</pre>
<div class="block">Scans the project's artifacts and adds them to the engine's dependency
list.</div>
<dl>
<dt><span class="paramLabel">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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a collection of exceptions that may have occurred while resolving
and scanning the dependencies</dd>
</dl>
</li>
</ul>
@@ -758,18 +761,18 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
proxy url, port, and connection timeout.</div>
</li>
</ul>
<a name="excludeFromScan-org.apache.maven.artifact.Artifact-">
<a name="excludeFromScan-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeFromScan</h4>
<pre>protected&nbsp;boolean&nbsp;excludeFromScan(org.apache.maven.artifact.Artifact&nbsp;a)</pre>
<pre>protected&nbsp;boolean&nbsp;excludeFromScan(<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;scope)</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="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - the Artifact to test</dd>
<dd><code>scope</code> - the scope of the artifact to test</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the artifact is in an excluded scope;
otherwise <code>false</code></dd>