documentation v1.3.1

This commit is contained in:
Jeremy Long
2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions

View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_71) on Tue Aug 04 20:23:55 EDT 2015 -->
<!-- Generated by javadoc (version 1.7.0_71) on Sun Sep 20 06:48:04 EDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Index (Dependency-Check Command Line 1.3.0 API)</title>
<meta name="date" content="2015-08-04">
<title>Index (Dependency-Check Command Line 1.3.1 API)</title>
<meta name="date" content="2015-09-20">
<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="Index (Dependency-Check Command Line 1.3.0 API)";
parent.document.title="Index (Dependency-Check Command Line 1.3.1 API)";
}
//-->
</script>
@@ -83,11 +83,15 @@
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#APP_NAME">APP_NAME</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">The long CLI argument name specifying the name of the application to be scanned.</div>
<div class="block"><span class="strong">Deprecated.</span>
<div class="block"><i>project should be used instead</i></div>
</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#APP_NAME_SHORT">APP_NAME_SHORT</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">The short CLI argument name specifying the name of the application to be scanned.</div>
<div class="block"><span class="strong">Deprecated.</span>
<div class="block"><i>project should be used instead</i></div>
</div>
</dd>
</dl>
<a name="_C_">
@@ -193,6 +197,10 @@
<dd>
<div class="block">Disables the Cmake Analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#DISABLE_COMPOSER">DISABLE_COMPOSER</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">Disables the Python Package Analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#DISABLE_JAR">DISABLE_JAR</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">Disables the Jar Analyzer.</div>
@@ -201,6 +209,10 @@
<dd>
<div class="block">Disables the Nexus Analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#DISABLE_NODE_JS">DISABLE_NODE_JS</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">Disables the Node.js Package Analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#DISABLE_NUSPEC">DISABLE_NUSPEC</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">Disables the Nuspec Analyzer.</div>
@@ -217,6 +229,10 @@
<dd>
<div class="block">Disables the Python Package Analyzer.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#DISABLE_RUBYGEMS">DISABLE_RUBYGEMS</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">Disables the Ruby Gemspec Analyzer.</div>
</dd>
</dl>
<a name="_E_">
<!-- -->
@@ -225,7 +241,7 @@
<dl>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/App.html#ensureCanonicalPath(java.lang.String)">ensureCanonicalPath(String)</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/App.html" title="class in org.owasp.dependencycheck">App</a></dt>
<dd>
<div class="block">Takes a path and resolves it to be a canonical & absolute path.</div>
<div class="block">Takes a path and resolves it to be a canonical &amp; absolute path.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#EXCLUDE">EXCLUDE</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
@@ -241,10 +257,6 @@
<dd>
<div class="block">Returns the additional Extensions if specified; otherwise null is returned.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#getApplicationName()">getApplicationName()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns the application name specified on the command line.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#getBaseCve12Url()">getBaseCve12Url()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns the base URL for the CVE 1.2 XMl file.</div>
@@ -301,6 +313,10 @@
<dd>
<div class="block">Returns the path to Mono for .NET Assembly analysis on non-windows systems.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#getProjectName()">getProjectName()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns the application name specified on the command line.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#getPropertiesFile()">getPropertiesFile()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns the properties file specified on the command line.</div>
@@ -389,6 +405,10 @@
<dd>
<div class="block">Returns true if the disableCmake command line argument was specified.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isComposerDisabled()">isComposerDisabled()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns true if the disableComposer command line argument was specified.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isGetHelp()">isGetHelp()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Determines if the 'help' command line argument was passed in.</div>
@@ -409,6 +429,10 @@
<dd>
<div class="block">Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is returned.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isNodeJsDisabled()">isNodeJsDisabled()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns true if the disableNodeJS command line argument was specified.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isNuspecDisabled()">isNuspecDisabled()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns true if the disableNuspec command line argument was specified.</div>
@@ -417,6 +441,10 @@
<dd>
<div class="block">Returns true if the disableOpenSSL command line argument was specified.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isPurge()">isPurge()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Checks if the purge NVD flag has been set.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isPythonDistributionDisabled()">isPythonDistributionDisabled()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns true if the disablePyDist command line argument was specified.</div>
@@ -425,6 +453,10 @@
<dd>
<div class="block">Returns true if the disablePyPkg command line argument was specified.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isRubyGemspecDisabled()">isRubyGemspecDisabled()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Returns whether the Ruby gemspec analyzer is disabled.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.html#isRunScan()">isRunScan()</a></span> - Method in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.html" title="class in org.owasp.dependencycheck">CliParser</a></dt>
<dd>
<div class="block">Determines if the 'scan' command line argument was passed in.</div>
@@ -506,6 +538,10 @@
<div class="block">
Prints the manifest information to standard output.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#PROJECT">PROJECT</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">The long CLI argument name specifying the name of the project to be scanned.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#PROP">PROP</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">The CLI argument name for setting the location of an additional properties file.</div>
@@ -536,6 +572,10 @@
<dd>
<div class="block">The CLI argument name indicating the proxy username.</div>
</dd>
<dt><span class="strong"><a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html#PURGE_NVD">PURGE_NVD</a></span> - Static variable in class org.owasp.dependencycheck.<a href="./org/owasp/dependencycheck/CliParser.ARGUMENT.html" title="class in org.owasp.dependencycheck">CliParser.ARGUMENT</a></dt>
<dd>
<div class="block">The long CLI argument name specifying that only the update phase should be executed; no scan should be run.</div>
</dd>
</dl>
<a name="_R_">
<!-- -->
@@ -646,6 +686,6 @@
<!-- -->
</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>