github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-18 23:34:15 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
76eae185478d0434ebf8de7fd0c01604b788731a
DependencyCheck/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/Engine.html
Jeremy Long 76eae18547 version 1.2.7 of site documentation
2014-12-08 06:45:24 -05:00

325 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Sun Dec 07 07:11:20 EST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Engine (Dependency-Check Maven Plugin 1.2.7 API)</title>
<meta name="date" content="2014-12-07">
<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.7 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/owasp/dependencycheck/maven/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Engine.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/Engine.html" target="_top">Frames</a></li>
<li><a href="Engine.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.owasp.dependencycheck.maven</div>
<h2 title="Class Engine" class="title">Class Engine</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><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">org.owasp.dependencycheck.Engine</a></li>
<li>
<ul class="inheritance">
<li>org.owasp.dependencycheck.maven.Engine</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<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>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Jeremy Long <jeremy.long@owasp.org></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#Engine(org.apache.maven.project.MavenProject)">Engine</a></strong>(org.apache.maven.project.MavenProject&nbsp;project)</code>
<div class="block">Creates a new Engine to perform anyalsis on dependencies.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#cleanupFinal()">cleanupFinal</a></strong>()</code>
<div class="block">Closes the CPEAnalyzer if it has been created and persisted in the root parent MavenProject context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#closeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">closeAnalyzer</a></strong>(<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)</code>
<div class="block">Closes the given analyzer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#initializeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">initializeAnalyzer</a></strong>(<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)</code>
<div class="block">Initializes the given analyzer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.owasp.dependencycheck.Engine">
<!-- -->
</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#analyzeDependencies()" title="class or interface in org.owasp.dependencycheck">analyzeDependencies</a>, <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>, <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#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">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Engine(org.apache.maven.project.MavenProject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Engine</h4>
<pre>public&nbsp;Engine(org.apache.maven.project.MavenProject&nbsp;project)
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>
<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>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initializeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">
<!-- -->
</a>
<ul class="blockList">
<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>
<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>
<dt><span class="strong">Parameters:</span></dt><dd><code>analyzer</code> - the analyzer to initialize</dd>
<dt><span class="strong">Returns:</span></dt><dd>the initialized analyzer</dd></dl>
</li>
</ul>
<a name="closeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAnalyzer</h4>
<pre>protected&nbsp;void&nbsp;closeAnalyzer(<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">Closes the given analyzer. This skips closing the CPEAnalyzer.</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#closeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)" title="class or interface in org.owasp.dependencycheck">closeAnalyzer</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>
<dt><span class="strong">Parameters:</span></dt><dd><code>analyzer</code> - the analyzer to close</dd></dl>
</li>
</ul>
<a name="cleanupFinal()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cleanupFinal</h4>
<pre>public&nbsp;void&nbsp;cleanupFinal()</pre>
<div class="block">Closes the CPEAnalyzer if it has been created and persisted in the root parent MavenProject context.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../org/owasp/dependencycheck/maven/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Engine.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html" title="class in org.owasp.dependencycheck.maven"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/owasp/dependencycheck/maven/Engine.html" target="_top">Frames</a></li>
<li><a href="Engine.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright© 2012-14 Jeremy Long. All Rights Reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink