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

version 1.2.8 of the site documentation

Browse Source
This commit is contained in:
Jeremy Long
2014-12-28 20:19:06 -05:00
parent 641235ed9a
commit a13c3501f2
1153 changed files with 20261 additions and 12350 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
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_45) on Sun Dec 07 07:11:20 EST 2014 -->
<!-- Generated by javadoc (version 1.7.0_45) on Sun Dec 28 09:20:15 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">
<title>Engine (Dependency-Check Maven Plugin 1.2.8 API)</title>
<meta name="date" content="2014-12-28">
<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)";
parent.document.title="Engine (Dependency-Check Maven Plugin 1.2.8 API)";
}
//-->
</script>
@@ -36,7 +36,7 @@
</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/CheckMojo.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">
@@ -62,13 +62,13 @@
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
@@ -113,6 +113,27 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<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>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
@@ -125,7 +146,8 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<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>
<td class="colOne"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/Engine.html#Engine(org.apache.maven.project.MavenProject, java.util.List)">Engine</a></strong>(org.apache.maven.project.MavenProject&nbsp;project,
<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)</code>
<div class="block">Creates a new Engine to perform anyalsis on dependencies.</div>
</td>
</tr>
@@ -146,8 +168,8 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
</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 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>
</td>
</tr>
<tr class="rowColor">
@@ -162,13 +184,19 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<div class="block">Initializes the given analyzer.</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#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>
</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>
<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#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">
@@ -185,22 +213,42 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="UPDATE_EXECUTED_FLAG">
<!-- -->
</a>
<ul class="blockListLast">
<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>
<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>
</li>
</ul>
<!-- ========= 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 name="Engine(org.apache.maven.project.MavenProject, java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Engine</h4>
<pre>public&nbsp;Engine(org.apache.maven.project.MavenProject&nbsp;project)
<pre>public&nbsp;Engine(org.apache.maven.project.MavenProject&nbsp;project,
<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>
<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>
</li>
@@ -229,6 +277,20 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<dt><span class="strong">Returns:</span></dt><dd>the initialized analyzer</dd></dl>
</li>
</ul>
<a name="cleanup()">
<!-- -->
</a>
<ul class="blockList">
<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>
<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>
</dl>
</li>
</ul>
<a name="closeAnalyzer(org.owasp.dependencycheck.analyzer.Analyzer)">
<!-- -->
</a>
@@ -243,14 +305,16 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<dt><span class="strong">Parameters:</span></dt><dd><code>analyzer</code> - the analyzer to close</dd></dl>
</li>
</ul>
<a name="cleanupFinal()">
<a name="resetFileTypeAnalyzers()">
<!-- -->
</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>
<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>
</li>
</ul>
</li>
@@ -278,7 +342,7 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
</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/CheckMojo.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">
@@ -304,13 +368,13 @@ extends <a href="https://github.com/jeremylong/DependencyCheck.git/dependency-ch
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>