documentation v1.3.2

This commit is contained in:
Jeremy Long
2015-11-29 07:44:14 -05:00
parent 191c5fae56
commit a426de69cd
1220 changed files with 51071 additions and 40455 deletions

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Sun Sep 20 06:48:03 EDT 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Nov 29 07:27:31 EST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CliParser (Dependency-Check Command Line 1.3.1 API)</title>
<meta name="date" content="2015-09-20">
<title>CliParser (Dependency-Check Command Line 1.3.2 API)</title>
<meta name="date" content="2015-11-29">
<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="CliParser (Dependency-Check Command Line 1.3.1 API)";
parent.document.title="CliParser (Dependency-Check Command Line 1.3.2 API)";
}
//-->
</script>
@@ -188,59 +188,71 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#getCveValidForHours()">getCveValidForHours</a></strong>()</code>
<div class="block">Get the value of cveValidForHours.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getDatabaseDriverName()">getDatabaseDriverName</a></strong>()</code>
<div class="block">Returns the database driver name if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><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/CliParser.html#getDatabaseDriverPath()">getDatabaseDriverPath</a></strong>()</code>
<div class="block">Returns the database driver path if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getDatabasePassword()">getDatabasePassword</a></strong>()</code>
<div class="block">Returns the database database password if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><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/CliParser.html#getDatabaseUser()">getDatabaseUser</a></strong>()</code>
<div class="block">Returns the database database user name if specified; otherwise null is returned.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getDataDirectory()">getDataDirectory</a></strong>()</code>
<div class="block">Get the value of dataDirectory.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><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/CliParser.html#getExcludeList()">getExcludeList</a></strong>()</code>
<div class="block">Retrieves the list of excluded file patterns specified by the 'exclude' argument.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getModifiedCve12Url()">getModifiedCve12Url</a></strong>()</code>
<div class="block">Returns the URL for the modified CVE 1.2 XMl file.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><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/CliParser.html#getModifiedCve20Url()">getModifiedCve20Url</a></strong>()</code>
<div class="block">Returns the URL for the modified CVE 2.0 XMl file.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getNexusUrl()">getNexusUrl</a></strong>()</code>
<div class="block">Returns the url to the nexus server if one was specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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/CliParser.html#getPathToBundleAudit()">getPathToBundleAudit</a></strong>()</code>
<div class="block">Returns the path to bundle-audit for Ruby bundle analysis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/CliParser.html#getPathToMono()">getPathToMono</a></strong>()</code>
@@ -345,119 +357,125 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isBundleAuditDisabled()">isBundleAuditDisabled</a></strong>()</code>
<div class="block">Returns true if the disableBundleAudit command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isCentralDisabled()">isCentralDisabled</a></strong>()</code>
<div class="block">Returns true if the disableCentral command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isCmakeDisabled()">isCmakeDisabled</a></strong>()</code>
<div class="block">Returns true if the disableCmake command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isComposerDisabled()">isComposerDisabled</a></strong>()</code>
<div class="block">Returns true if the disableComposer command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isGetHelp()">isGetHelp</a></strong>()</code>
<div class="block">Determines if the 'help' command line argument was passed in.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isGetVersion()">isGetVersion</a></strong>()</code>
<div class="block">Determines if the 'version' command line argument was passed in.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isJarDisabled()">isJarDisabled</a></strong>()</code>
<div class="block">Returns true if the disableJar command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isNexusDisabled()">isNexusDisabled</a></strong>()</code>
<div class="block">Returns true if the disableNexus command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isNexusUsesProxy()">isNexusUsesProxy</a></strong>()</code>
<div class="block">Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is returned.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isNodeJsDisabled()">isNodeJsDisabled</a></strong>()</code>
<div class="block">Returns true if the disableNodeJS command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isNuspecDisabled()">isNuspecDisabled</a></strong>()</code>
<div class="block">Returns true if the disableNuspec command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isOpenSSLDisabled()">isOpenSSLDisabled</a></strong>()</code>
<div class="block">Returns true if the disableOpenSSL command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isPurge()">isPurge</a></strong>()</code>
<div class="block">Checks if the purge NVD flag has been set.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isPythonDistributionDisabled()">isPythonDistributionDisabled</a></strong>()</code>
<div class="block">Returns true if the disablePyDist command line argument was specified.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isPythonPackageDisabled()">isPythonPackageDisabled</a></strong>()</code>
<div class="block">Returns true if the disablePyPkg command line argument was specified.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isRubyGemspecDisabled()">isRubyGemspecDisabled</a></strong>()</code>
<div class="block">Returns whether the Ruby gemspec analyzer is disabled.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isRunScan()">isRunScan</a></strong>()</code>
<div class="block">Determines if the 'scan' command line argument was passed in.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#isUpdateOnly()">isUpdateOnly</a></strong>()</code>
<div class="block">Checks if the update only flag has been set.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#parse(java.lang.String[])">parse</a></strong>(<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;args)</code>
<div class="block">Parses the arguments passed in and captures the results for later use.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#printHelp()">printHelp</a></strong>()</code>
<div class="block">Displays the command line help message to the standard output.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/owasp/dependencycheck/CliParser.html#printVersionInfo()">printVersionInfo</a></strong>()</code>
<div class="block">
@@ -607,6 +625,17 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableAssembly command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isBundleAuditDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBundleAuditDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isBundleAuditDisabled()</pre>
<div class="block">Returns true if the disableBundleAudit command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableBundleAudit command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="isPythonDistributionDisabled()">
<!-- -->
</a>
@@ -793,6 +822,17 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to Mono</dd></dl>
</li>
</ul>
<a name="getPathToBundleAudit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathToBundleAudit</h4>
<pre>public&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>&nbsp;getPathToBundleAudit()</pre>
<div class="block">Returns the path to bundle-audit for Ruby bundle analysis.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to Mono</dd></dl>
</li>
</ul>
<a name="getReportFormat()">
<!-- -->
</a>
@@ -1062,7 +1102,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<a name="getAdditionalZipExtensions()">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalZipExtensions</h4>
<pre>public&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>&nbsp;getAdditionalZipExtensions()</pre>
@@ -1070,6 +1110,17 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dl><dt><span class="strong">Returns:</span></dt><dd>the additional Extensions; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getCveValidForHours()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCveValidForHours</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getCveValidForHours()</pre>
<div class="block">Get the value of cveValidForHours.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of cveValidForHours</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
@@ -1136,6 +1187,6 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright© 2012-15 Jeremy Long. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright? 2012-15 Jeremy Long. All Rights Reserved.</small></p>
</body>
</html>