documentation v1.3.1

2026-03-30 05:42:10 +02:00 · 2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions
--- a/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
+++ b/dependency-check-maven/apidocs/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
@@ -2,16 +2,16 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_71) on Tue Aug 04 20:26:08 EDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_71) on Sun Sep 20 06:50:34 EDT 2015 -->
 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.0 API)</title>
-<meta name="date" content="2015-08-04">
+<title>BaseDependencyCheckMojo (Dependency-Check Maven Plugin 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="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.0 API)";
+        parent.document.title="BaseDependencyCheckMojo (Dependency-Check Maven Plugin 1.3.1 API)";
    }
 //-->
 </script>
@@ -106,7 +106,7 @@
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
-<dd><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven">AggregateMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html" title="class in org.owasp.dependencycheck.maven">CheckMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dd>
+<dd><a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html" title="class in org.owasp.dependencycheck.maven">AggregateMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html" title="class in org.owasp.dependencycheck.maven">CheckMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/PurgeMojo.html" title="class in org.owasp.dependencycheck.maven">PurgeMojo</a>, <a href="../../../../org/owasp/dependencycheck/maven/UpdateMojo.html" title="class in org.owasp.dependencycheck.maven">UpdateMojo</a></dd>
 </dl>
 <hr>
 <br>
@@ -214,83 +214,95 @@ implements org.apache.maven.reporting.MavenReport</pre>
 </td>
 </tr>
 <tr class="altColor">
+<td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getConnectionString()">getConnectionString</a></strong>()</code>
+<div class="block">Returns the connection string.</div>
+</td>
+</tr>
+<tr class="rowColor">
 <td class="colFirst"><code>protected <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/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory()">getCorrectOutputDirectory</a></strong>()</code>
 <div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected <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/maven/BaseDependencyCheckMojo.html#getCorrectOutputDirectory(org.apache.maven.project.MavenProject)">getCorrectOutputDirectory</a></strong>(org.apache.maven.project.MavenProject&nbsp;current)</code>
 <div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected <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/maven/BaseDependencyCheckMojo.html#getDataFile(org.apache.maven.project.MavenProject)">getDataFile</a></strong>(org.apache.maven.project.MavenProject&nbsp;current)</code>
 <div class="block">Returns the correct output directory depending on if a site is being executed or not.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getDataFileContextKey()">getDataFileContextKey</a></strong>()</code>
 <div class="block">Returns the key used to store the path to the data file that is saved by <code>writeDataFile()</code>.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getFormat()">getFormat</a></strong>()</code>
 <div class="block">Returns the report format.</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/maven/BaseDependencyCheckMojo.html#getOutputDirectory()">getOutputDirectory</a></strong>()</code>
 <div class="block">Returns the output directory.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected <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/BaseDependencyCheckMojo.html#getOutputDirectoryContextKey()">getOutputDirectoryContextKey</a></strong>()</code>
 <div class="block">Returns the key used to store the path to the output directory.</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/maven/BaseDependencyCheckMojo.html#getOutputName()">getOutputName</a></strong>()</code>
 <div class="block">Returns the output name.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected org.apache.maven.project.MavenProject</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getProject()">getProject</a></strong>()</code>
 <div class="block">Returns a reference to the current project.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected <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;</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#getReactorProjects()">getReactorProjects</a></strong>()</code>
 <div class="block">Returns the list of Maven Projects in this build.</div>
 </td>
 </tr>
-<tr class="altColor">
+<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/maven/BaseDependencyCheckMojo.html#getReportOutputDirectory()">getReportOutputDirectory</a></strong>()</code>
 <div class="block">Returns the report output directory.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected <a href="../../../../org/owasp/dependencycheck/maven/Engine.html" title="class in org.owasp.dependencycheck.maven">Engine</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#initializeEngine()">initializeEngine</a></strong>()</code>
 <div class="block">Initializes a new <code>Engine</code> that can be used for scanning.</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/maven/BaseDependencyCheckMojo.html#isExternalReport()">isExternalReport</a></strong>()</code>
 <div class="block">Returns whether this is an external report.</div>
 </td>
 </tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#populateSettings()">populateSettings</a></strong>()</code>
+<div class="block">Takes the properties supplied and updates the dependency-check settings.</div>
+</td>
+</tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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;<a href="https://github.com/jeremylong/DependencyCheck.git/dependency-check-core/apidocs/org/owasp/dependencycheck/dependency/Dependency.html?is-external=true" title="class or interface in org.owasp.dependencycheck.dependency">Dependency</a>&gt;</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html#readDataFile(org.apache.maven.project.MavenProject)">readDataFile</a></strong>(org.apache.maven.project.MavenProject&nbsp;project)</code>
@@ -392,6 +404,17 @@ implements org.apache.maven.reporting.MavenReport</pre>
 <!--   -->
 </a>
 <h3>Method Detail</h3>
+<a name="getConnectionString()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getConnectionString</h4>
+<pre>protected&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 connection string.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the connection string</dd></dl>
+</li>
+</ul>
 <a name="execute()">
 <!--   -->
 </a>
@@ -605,6 +628,17 @@ public final&nbsp;void&nbsp;generate(org.codehaus.doxia.sink.Sink&nbsp;sink,
 <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 a database exception</dd></dl>
 </li>
 </ul>
+<a name="populateSettings()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateSettings</h4>
+<pre>protected&nbsp;void&nbsp;populateSettings()</pre>
+<div class="block">Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system properties
+ required to change the proxy url, port, and connection timeout.</div>
+</li>
+</ul>
 <a name="excludeFromScan(org.apache.maven.artifact.Artifact)">
 <!--   -->
 </a>