github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-23 17:41:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

version 1.1.0

Browse Source
This commit is contained in:
Jeremy Long
2014-01-26 11:51:55 -05:00
parent 034dd03d2d
commit 8c53925bd7
1007 changed files with 55095 additions and 53038 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
dependency-check-cli/apidocs/org/owasp/dependencycheck/cli/CliParser.html
View File

@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 16 07:29:46 EST 2014 -->
<!-- Generated by javadoc (version 1.7.0_45) on Sun Jan 26 11:13:14 EST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CliParser (Dependency-Check Command Line 1.0.8 API)</title>
<meta name="date" content="2014-01-16">
<title>CliParser (Dependency-Check Command Line 1.1.0 API)</title>
<meta name="date" content="2014-01-26">
<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.0.8 API)";
parent.document.title="CliParser (Dependency-Check Command Line 1.1.0 API)";
}
//-->
</script>
@@ -123,8 +123,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.ArgumentName.html" title="class in org.owasp.dependencycheck.cli">CliParser.ArgumentName</a></strong></code>
<div class="block">A collection of static final strings that represent the possible command
line arguments.</div>
<div class="block">A collection of static final strings that represent the possible command line arguments.</div>
</td>
</tr>
</table>
@@ -167,16 +166,52 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</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#getConnectionTimeout()">getConnectionTimeout</a></strong>()</code>
<div class="block">Returns the connection timeout.</div>
<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">
<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">
<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">
<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">
<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">
<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">
<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">
<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">
<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>
@@ -210,8 +245,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<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#getReportDirectory()">getReportDirectory</a></strong>()</code>
<div class="block">Returns the directory to write the reports to specified on the command
line.</div>
<div class="block">Returns the directory to write the reports to specified on the command line.</div>
</td>
</tr>
<tr class="rowColor">
@@ -223,8 +257,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<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#getScanFiles()">getScanFiles</a></strong>()</code>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan'
argument.</div>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan' argument.</div>
</td>
</tr>
<tr class="rowColor">
@@ -259,26 +292,33 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
</tr>
<tr class="altColor">
<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="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>
<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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/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="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/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="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/cli/CliParser.html#printVersionInfo()">printVersionInfo</a></strong>()</code>
<div class="block">Prints the manifest information to standard output.</div>
<div class="block">
Prints the manifest information to standard output.</div>
</td>
</tr>
</table>
@@ -332,8 +372,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<div class="block">Parses the arguments passed in and captures the results for later use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - the command line arguments</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when a 'file' argument does not
point to a file that exists.</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</a></code> - is thrown when a 'file' argument does not point to a file that exists.</dd>
<dd><code>org.apache.commons.cli.ParseException</code> - is thrown when a Parse Exception occurs.</dd></dl>
</li>
</ul>
@@ -370,6 +409,28 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<dl><dt><span class="strong">Returns:</span></dt><dd>whether or not the 'scan' command line argument was passed in</dd></dl>
</li>
</ul>
<a name="isNexusDisabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNexusDisabled</h4>
<pre>public&nbsp;boolean&nbsp;isNexusDisabled()</pre>
<div class="block">Returns true if the disableNexus command line argument was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the disableNexus command line argument was specified; otherwise false</dd></dl>
</li>
</ul>
<a name="getNexusUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNexusUrl</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;getNexusUrl()</pre>
<div class="block">Returns the url to the nexus server if one was specified.</div>
<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="printHelp()">
<!-- -->
</a>
@@ -387,8 +448,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getScanFiles</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;getScanFiles()</pre>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan'
argument.</div>
<div class="block">Retrieves the file command line parameter(s) specified for the 'scan' argument.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the file paths specified on the command line for scan</dd></dl>
</li>
</ul>
@@ -399,8 +459,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getReportDirectory</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;getReportDirectory()</pre>
<div class="block">Returns the directory to write the reports to specified on the command
line.</div>
<div class="block">Returns the directory to write the reports to specified on the command line.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the path to the reports directory.</dd></dl>
</li>
</ul>
@@ -411,8 +470,7 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>getReportFormat</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;getReportFormat()</pre>
<div class="block">Returns the output format specified on the command line. Defaults to HTML
if no format was specified.</div>
<div class="block">Returns the output format specified on the command line. Defaults to HTML if no format was specified.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the output format name.</dd></dl>
</li>
</ul>
@@ -533,7 +591,8 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<li class="blockList">
<h4>printVersionInfo</h4>
<pre>public&nbsp;void&nbsp;printVersionInfo()</pre>
<div class="block"><p>Prints the manifest information to standard output.</p>
<div class="block"><p>
Prints the manifest information to standard output.</p>
<ul><li>Implementation-Title: ${pom.name}</li>
<li>Implementation-Version: ${pom.version}</li></ul></div>
</li>
@@ -541,15 +600,70 @@ extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?
<a name="isAutoUpdate()">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>isAutoUpdate</h4>
<pre>public&nbsp;boolean&nbsp;isAutoUpdate()</pre>
<div class="block">Checks if the auto update feature has been disabled. If it has been
disabled via the command line this will return false.</div>
<div class="block">Checks if the auto update feature has been disabled. If it has been disabled via the command line this will
return false.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>if auto-update is allowed.</dd></dl>
</li>
</ul>
<a name="getDatabaseDriverName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseDriverName</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;getDatabaseDriverName()</pre>
<div class="block">Returns the database driver name if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database driver name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabaseDriverPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseDriverPath</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;getDatabaseDriverPath()</pre>
<div class="block">Returns the database driver path if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database driver name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getConnectionString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionString</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;getConnectionString()</pre>
<div class="block">Returns the database connection string if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database connection string if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabaseUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseUser</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;getDatabaseUser()</pre>
<div class="block">Returns the database database user name if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database database user name if specified; otherwise null is returned</dd></dl>
</li>
</ul>
<a name="getDatabasePassword()">
<!-- -->
</a>
<ul class="blockListLast">
<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>
<div class="block">Returns the database database password if specified; otherwise null is returned.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the database database password if specified; otherwise null is returned</dd></dl>
</li>
</ul>
</li>
</ul>
</li>