documentation update v1.4.4

This commit is contained in:
Jeremy Long
2016-11-05 09:41:16 -04:00
parent e1a447f722
commit a1b5e3f7b0
1217 changed files with 79708 additions and 51391 deletions

View File

@@ -127,7 +127,7 @@
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an error opening the</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * database connection</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> open() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> open() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (!isOpen()) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> conn = ConnectionFactory.getConnection();
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
@@ -137,7 +137,7 @@
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Closes the DB4O database. Close should be called on this object when it</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * is done being used.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> conn.close();
@@ -157,7 +157,7 @@
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @return whether the database connection is open or closed</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isOpen() {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> isOpen() {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> conn != <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a>
@@ -166,7 +166,7 @@
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @throws SQLException thrown if a SQL Exception occurs</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> commit() <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> commit() <strong class="jxr_keyword">throws</strong> SQLException {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_comment">//temporary remove this as autocommit is on.</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_comment">//if (conn != null) {</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_comment">// conn.commit();</em>
@@ -210,7 +210,7 @@
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * analyzed</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @return a set of vulnerable software</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> Set&lt;VulnerableSoftware&gt; getCPEs(String vendor, String product) {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> Set&lt;VulnerableSoftware&gt; getCPEs(String vendor, String product) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">final</strong> Set&lt;VulnerableSoftware&gt; cpe = <strong class="jxr_keyword">new</strong> HashSet&lt;VulnerableSoftware&gt;();
<a class="jxr_linenumber" name="L207" href="#L207">207</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L208" href="#L208">208</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
@@ -242,7 +242,7 @@
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown when there is an error retrieving the</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * data from the DB</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">public</strong> Set&lt;Pair&lt;String, String&gt;&gt; getVendorProductList() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> Set&lt;Pair&lt;String, String&gt;&gt; getVendorProductList() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">final</strong> Set&lt;Pair&lt;String, String&gt;&gt; data = <strong class="jxr_keyword">new</strong> HashSet&lt;Pair&lt;String, String&gt;&gt;();
<a class="jxr_linenumber" name="L239" href="#L239">239</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L240" href="#L240">240</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
@@ -267,7 +267,7 @@
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @return the properties from the database</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> Properties getProperties() {
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">synchronized</strong> Properties getProperties() {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">final</strong> Properties prop = <strong class="jxr_keyword">new</strong> Properties();
<a class="jxr_linenumber" name="L264" href="#L264">264</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L265" href="#L265">265</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
@@ -293,7 +293,7 @@
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @param key the property key</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param value the property value</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">void</strong> saveProperty(String key, String value) {
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> saveProperty(String key, String value) {
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">final</strong> PreparedStatement mergeProperty = getConnection().prepareStatement(statementBundle.getString(<span class="jxr_string">"MERGE_PROPERTY"</span>));
@@ -336,7 +336,7 @@
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * @return a list of Vulnerabilities</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an exception retrieving data</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">public</strong> List&lt;Vulnerability&gt; getVulnerabilities(String cpeStr) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> List&lt;Vulnerability&gt; getVulnerabilities(String cpeStr) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/owasp/dependencycheck/dependency/VulnerableSoftware.html">VulnerableSoftware</a> cpe = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/dependency/VulnerableSoftware.html">VulnerableSoftware</a>();
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L334" href="#L334">334</a> cpe.parseName(cpeStr);
@@ -397,7 +397,7 @@
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * @return a vulnerability object</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * @throws DatabaseException if an exception occurs</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/owasp/dependencycheck/dependency/Vulnerability.html">Vulnerability</a> getVulnerability(String cve) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <a href="../../../../../org/owasp/dependencycheck/dependency/Vulnerability.html">Vulnerability</a> getVulnerability(String cve) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L393" href="#L393">393</a> PreparedStatement psV = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L394" href="#L394">394</a> PreparedStatement psR = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L395" href="#L395">395</a> PreparedStatement psS = <strong class="jxr_keyword">null</strong>;
@@ -470,7 +470,7 @@
<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * @param vuln the vulnerability to add to the database</em>
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * @throws DatabaseException is thrown if the database</em>
<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> updateVulnerability(<a href="../../../../../org/owasp/dependencycheck/dependency/Vulnerability.html">Vulnerability</a> vuln) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> updateVulnerability(<a href="../../../../../org/owasp/dependencycheck/dependency/Vulnerability.html">Vulnerability</a> vuln) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L466" href="#L466">466</a> PreparedStatement selectVulnerabilityId = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L467" href="#L467">467</a> PreparedStatement deleteVulnerability = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L468" href="#L468">468</a> PreparedStatement deleteReferences = <strong class="jxr_keyword">null</strong>;
@@ -646,7 +646,7 @@
<a class="jxr_linenumber" name="L638" href="#L638">638</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L639" href="#L639">639</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if data exists; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L640" href="#L640">640</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L641" href="#L641">641</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> dataExists() {
<a class="jxr_linenumber" name="L641" href="#L641">641</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> dataExists() {
<a class="jxr_linenumber" name="L642" href="#L642">642</a> Statement cs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L643" href="#L643">643</a> ResultSet rs = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L644" href="#L644">644</a> <strong class="jxr_keyword">try</strong> {
@@ -682,7 +682,7 @@
<a class="jxr_linenumber" name="L674" href="#L674">674</a> <em class="jxr_javadoccomment"> * updates. This should be called after all updates have been completed to</em>
<a class="jxr_linenumber" name="L675" href="#L675">675</a> <em class="jxr_javadoccomment"> * ensure orphan entries are removed.</em>
<a class="jxr_linenumber" name="L676" href="#L676">676</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L677" href="#L677">677</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanupDatabase() {
<a class="jxr_linenumber" name="L677" href="#L677">677</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> cleanupDatabase() {
<a class="jxr_linenumber" name="L678" href="#L678">678</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L679" href="#L679">679</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L680" href="#L680">680</a> ps = getConnection().prepareStatement(statementBundle.getString(<span class="jxr_string">"CLEANUP_ORPHANS"</span>));
@@ -820,7 +820,7 @@
<a class="jxr_linenumber" name="L812" href="#L812">812</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L813" href="#L813">813</a> <em class="jxr_javadoccomment"> * Deletes unused dictionary entries from the database.</em>
<a class="jxr_linenumber" name="L814" href="#L814">814</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L815" href="#L815">815</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> deleteUnusedCpe() {
<a class="jxr_linenumber" name="L815" href="#L815">815</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> deleteUnusedCpe() {
<a class="jxr_linenumber" name="L816" href="#L816">816</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L817" href="#L817">817</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L818" href="#L818">818</a> ps = getConnection().prepareStatement(statementBundle.getString(<span class="jxr_string">"DELETE_UNUSED_DICT_CPE"</span>));
@@ -842,7 +842,7 @@
<a class="jxr_linenumber" name="L834" href="#L834">834</a> <em class="jxr_javadoccomment"> * @param vendor the CPE vendor</em>
<a class="jxr_linenumber" name="L835" href="#L835">835</a> <em class="jxr_javadoccomment"> * @param product the CPE product</em>
<a class="jxr_linenumber" name="L836" href="#L836">836</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L837" href="#L837">837</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addCpe(String cpe, String vendor, String product) {
<a class="jxr_linenumber" name="L837" href="#L837">837</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> addCpe(String cpe, String vendor, String product) {
<a class="jxr_linenumber" name="L838" href="#L838">838</a> PreparedStatement ps = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L839" href="#L839">839</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L840" href="#L840">840</a> ps = getConnection().prepareStatement(statementBundle.getString(<span class="jxr_string">"ADD_DICT_CPE"</span>));