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

documentation version 1.2.10

Browse Source
This commit is contained in:
Jeremy Long
2015-04-13 17:43:19 -04:00
parent 480a05c798
commit 9194a42c93
1126 changed files with 34228 additions and 29019 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/Engine.html
View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Fri Mar 06 06:10:22 EST 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Apr 12 08:16:27 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Engine (Dependency-Check Maven Plugin 1.2.9 API)</title>
<meta name="date" content="2015-03-06">
<title>Engine (Dependency-Check Maven Plugin 1.2.10 API)</title>
<meta name="date" content="2015-04-12">
<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="Engine (Dependency-Check Maven Plugin 1.2.9 API)";
parent.document.title="Engine (Dependency-Check Maven Plugin 1.2.10 API)";
}
//-->
</script>
@@ -103,10 +103,10 @@
<br>
<pre>public class <span class="strong">Engine</span>
extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true" title="class or interface in org.owasp.dependencycheck">Engine</a></pre>
<div class="block">A modified version of the core engine specifically designed to persist some
data between multiple executions of a multi-module Maven project.</div>
<div class="block">A modified version of the core engine specifically designed to persist some data between multiple executions of a multi-module
Maven project.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
<dd>Jeremy Long</dd></dl>
</li>
</ul>
</div>
@@ -128,8 +128,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<tr class="altColor">
<td class="colFirst"><code>static <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/Engine.html#UPDATE_EXECUTED_FLAG">UPDATE_EXECUTED_FLAG</a></strong></code>
<div class="block">Key used in the MavenProject context values to note whether or not an
update has been executed.</div>
<div class="block">Key used in the MavenProject context values to note whether or not an update has been executed.</div>
</td>
</tr>
</table>
@@ -176,8 +175,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#cleanup()">cleanup</a></strong>()</code>
<div class="block">Releases resources used by the analyzers by calling close() on each
analyzer.</div>
<div class="block">Releases resources used by the analyzers by calling close() on each analyzer.</div>
</td>
</tr>
<tr class="altColor">
@@ -195,8 +193,13 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#resetFileTypeAnalyzers()">resetFileTypeAnalyzers</a></strong>()</code>
<div class="block">Resets the file type analyzers so that they can be re-used to scan
additional directories.</div>
<div class="block">Resets the file type analyzers so that they can be re-used to scan additional directories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#update()">update</a></strong>()</code>
<div class="block">Runs the update steps of dependency-check.</div>
</td>
</tr>
</table>
@@ -205,7 +208,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.owasp.dependencycheck.<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true" title="class or interface in org.owasp.dependencycheck">Engine</a></h3>
<code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getAnalyzers()" title="class or interface in org.owasp.dependencycheck">getAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getAnalyzers(org.owasp.dependencycheck.analyzer.AnalysisPhase)" title="class or interface in org.owasp.dependencycheck">getAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getDependencies()" title="class or interface in org.owasp.dependencycheck">getDependencies</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getFileTypeAnalyzers()" title="class or interface in org.owasp.dependencycheck">getFileTypeAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#initializeEngine()" title="class or interface in org.owasp.dependencycheck">initializeEngine</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.io.File)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.io.File[])" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.util.List)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.util.Set)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.lang.String)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.lang.String[])" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scanDirectory(java.io.File)" title="class or interface in org.owasp.dependencycheck">scanDirectory</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scanFile(java.io.File)" title="class or interface in org.owasp.dependencycheck">scanFile</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#setDependencies(java.util.List)" title="class or interface in org.owasp.dependencycheck">setDependencies</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#supportsExtension(java.lang.String)" title="class or interface in org.owasp.dependencycheck">supportsExtension</a></code></li>
<code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#doUpdates()" title="class or interface in org.owasp.dependencycheck">doUpdates</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getAnalyzers()" title="class or interface in org.owasp.dependencycheck">getAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getAnalyzers(org.owasp.dependencycheck.analyzer.AnalysisPhase)" title="class or interface in org.owasp.dependencycheck">getAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getDependencies()" title="class or interface in org.owasp.dependencycheck">getDependencies</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#getFileTypeAnalyzers()" title="class or interface in org.owasp.dependencycheck">getFileTypeAnalyzers</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#initializeEngine()" title="class or interface in org.owasp.dependencycheck">initializeEngine</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.io.File)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.io.File[])" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.util.List)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.util.Set)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.lang.String)" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scan(java.lang.String[])" title="class or interface in org.owasp.dependencycheck">scan</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scanDirectory(java.io.File)" title="class or interface in org.owasp.dependencycheck">scanDirectory</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#scanFile(java.io.File)" title="class or interface in org.owasp.dependencycheck">scanFile</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#setDependencies(java.util.List)" title="class or interface in org.owasp.dependencycheck">setDependencies</a>, <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#supportsExtension(java.lang.String)" title="class or interface in org.owasp.dependencycheck">supportsExtension</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -235,8 +238,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<li class="blockList">
<h4>UPDATE_EXECUTED_FLAG</h4>
<pre>public static final&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> UPDATE_EXECUTED_FLAG</pre>
<div class="block">Key used in the MavenProject context values to note whether or not an
update has been executed.</div>
<div class="block">Key used in the MavenProject context values to note whether or not an update has been executed.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.owasp.dependencycheck.maven.Engine.UPDATE_EXECUTED_FLAG">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -258,11 +260,9 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<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;reactorProjects)
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">Creates a new Engine to perform anyalsis on dependencies.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the current Maven project</dd><dd><code>reactorProjects</code> - the reactor projects for the current Maven
execution</dd>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the current Maven project</dd><dd><code>reactorProjects</code> - the reactor projects for the current Maven execution</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 an issue connecting to the
database</dd></dl>
<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 an issue connecting to the database</dd></dl>
</li>
</ul>
</li>
@@ -287,6 +287,16 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
</dl>
</li>
</ul>
<a name="update()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update()</pre>
<div class="block">Runs the update steps of dependency-check.</div>
</li>
</ul>
<a name="initializeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">
<!-- -->
</a>
@@ -294,8 +304,8 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<li class="blockList">
<h4>initializeAnalyzer</h4>
<pre>protected&nbsp;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/analyzer/Analyzer.html?is-external=true" title="class or interface in org.owasp.dependencycheck.analyzer">Analyzer</a>&nbsp;initializeAnalyzer(<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/analyzer/Analyzer.html?is-external=true" title="class or interface in org.owasp.dependencycheck.analyzer">Analyzer</a>&nbsp;analyzer)</pre>
<div class="block">Initializes the given analyzer. This skips the initialization of the
CPEAnalyzer if it has been initialized by a previous execution.</div>
<div class="block">Initializes the given analyzer. This skips the initialization of the CPEAnalyzer if it has been initialized by a previous
execution.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#initializeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)" title="class or interface in org.owasp.dependencycheck">initializeAnalyzer</a></code>&nbsp;in class&nbsp;<code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true" title="class or interface in org.owasp.dependencycheck">Engine</a></code></dd>
@@ -310,8 +320,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<li class="blockList">
<h4>cleanup</h4>
<pre>public&nbsp;void&nbsp;cleanup()</pre>
<div class="block">Releases resources used by the analyzers by calling close() on each
analyzer.</div>
<div class="block">Releases resources used by the analyzers by calling close() on each analyzer.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true#cleanup()" title="class or interface in org.owasp.dependencycheck">cleanup</a></code>&nbsp;in class&nbsp;<code><a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/Engine.html?is-external=true" title="class or interface in org.owasp.dependencycheck">Engine</a></code></dd>
@@ -339,10 +348,8 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<li class="blockList">
<h4>resetFileTypeAnalyzers</h4>
<pre>public&nbsp;void&nbsp;resetFileTypeAnalyzers()</pre>
<div class="block">Resets the file type analyzers so that they can be re-used to scan
additional directories. Without the reset the analyzer might be disabled
because the first scan/analyze did not identify any files that could be
processed by the analyzer.</div>
<div class="block">Resets the file type analyzers so that they can be re-used to scan additional directories. Without the reset the analyzer
might be disabled because the first scan/analyze did not identify any files that could be processed by the analyzer.</div>
</li>
</ul>
</li>