version 1.1.2 of project documentation

2026-04-30 20:24:32 +02:00 · 2014-03-03 19:32:36 -05:00
parent 9f9ed6f1da
commit 9a00756d3f
982 changed files with 42586 additions and 30816 deletions
--- a/dependency-check-cli/apidocs/org/owasp/dependencycheck/cli/CliParser.html
+++ b/dependency-check-cli/apidocs/org/owasp/dependencycheck/cli/CliParser.html
@@ -2,16 +2,16 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 30 06:04:59 EST 2014 -->
+<!-- Generated by javadoc (version 1.7.0_45) on Mon Mar 03 07:45:55 EST 2014 -->
 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>CliParser (Dependency-Check Command Line 1.1.1 API)</title>
-<meta name="date" content="2014-01-30">
+<title>CliParser (Dependency-Check Command Line 1.1.2 API)</title>
+<meta name="date" content="2014-03-03">
 <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.1.1 API)";
+        parent.document.title="CliParser (Dependency-Check Command Line 1.1.2 API)";
    }
 //-->
 </script>
@@ -160,142 +160,155 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
 </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/cli/CliParser.html#getAdditionalZipExtensions()">getAdditionalZipExtensions</a></strong>()</code>
+<div class="block">Returns the additional Extensions if specified; otherwise null is returned.</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/cli/CliParser.html#getApplicationName()">getApplicationName</a></strong>()</code>
 <div class="block">Returns the application name specified on the command line.</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/cli/CliParser.html#getConnectionString()">getConnectionString</a></strong>()</code>
 <div class="block">Returns the database connection string 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/cli/CliParser.html#getConnectionTimeout()">getConnectionTimeout</a></strong>()</code>
 <div class="block">Returns the connection timeout.</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/cli/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/cli/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/cli/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/cli/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/cli/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/cli/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">
+<tr class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#getPropertiesFile()">getPropertiesFile</a></strong>()</code>
 <div class="block">Returns the properties file specified on the command line.</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/cli/CliParser.html#getProxyPassword()">getProxyPassword</a></strong>()</code>
 <div class="block">Returns the proxy password.</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/cli/CliParser.html#getProxyPort()">getProxyPort</a></strong>()</code>
 <div class="block">Returns the proxy port.</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/cli/CliParser.html#getProxyUrl()">getProxyUrl</a></strong>()</code>
 <div class="block">Returns the proxy url.</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/cli/CliParser.html#getProxyUsername()">getProxyUsername</a></strong>()</code>
 <div class="block">Returns the proxy username.</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/cli/CliParser.html#getReportDirectory()">getReportDirectory</a></strong>()</code>
 <div class="block">Returns the directory to write the reports to specified on the command line.</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/cli/CliParser.html#getReportFormat()">getReportFormat</a></strong>()</code>
 <div class="block">Returns the output format specified on the command line.</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/cli/CliParser.html#getScanFiles()">getScanFiles</a></strong>()</code>
 <div class="block">Retrieves the file command line parameter(s) specified for the 'scan' 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/cli/CliParser.html#getSuppressionFile()">getSuppressionFile</a></strong>()</code>
 <div class="block">Returns the path to the suppression 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/cli/CliParser.html#getVerboseLog()">getVerboseLog</a></strong>()</code>
 <div class="block">Returns the path to the verbose log file.</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/cli/CliParser.html#isAutoUpdate()">isAutoUpdate</a></strong>()</code>
 <div class="block">Checks if the auto update feature has been 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/cli/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/cli/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/cli/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">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/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">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#isRunScan()">isRunScan</a></strong>()</code>
@@ -431,6 +444,18 @@ 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 url to the nexus server; if none was specified this will return null;</dd></dl>
 </li>
 </ul>
+<a name="isNexusUsesProxy()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isNexusUsesProxy</h4>
+<pre>public&nbsp;boolean&nbsp;isNexusUsesProxy()</pre>
+<div class="block">Returns true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false is
+ returned.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the Nexus Analyzer should use the configured proxy to connect to Nexus; otherwise false</dd></dl>
+</li>
+</ul>
 <a name="printHelp()">
 <!--   -->
 </a>
@@ -656,7 +681,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
 <a name="getDatabasePassword()">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>getDatabasePassword</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;getDatabasePassword()</pre>
@@ -664,6 +689,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 database database password if specified; otherwise null is returned</dd></dl>
 </li>
 </ul>
+<a name="getAdditionalZipExtensions()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<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>
+<div class="block">Returns the additional Extensions if specified; otherwise null is returned.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the additional Extensions; otherwise null is returned</dd></dl>
+</li>
+</ul>
 </li>
 </ul>
 </li>