github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-04-30 04:04:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation v1.3.2

Browse Source
This commit is contained in:
Jeremy Long
2015-11-29 07:44:14 -05:00
parent 191c5fae56
commit a426de69cd
1220 changed files with 51071 additions and 40455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

348
xref/org/owasp/dependencycheck/data/cpe/CpeMemoryIndex.html
View File

@@ -157,185 +157,177 @@
<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 the CPE Analyzer.</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> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> Analyzer createIndexingAnalyzer() {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">final</strong> Map&lt;String, Analyzer&gt; fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Analyzer&gt;();
<a class="jxr_linenumber" name="L155" href="#L155">155</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Creates an Analyzer for searching the CPE Index.</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return the CPE Analyzer.</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">private</strong> Analyzer createSearchingAnalyzer() {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">final</strong> Map&lt;String, Analyzer&gt; fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Analyzer&gt;();
<a class="jxr_linenumber" name="L167" href="#L167">167</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="L168" href="#L168">168</a> productSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> vendorSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="L170" href="#L170">170</a> fieldAnalyzers.put(Fields.PRODUCT, productSearchFieldAnalyzer);
<a class="jxr_linenumber" name="L171" href="#L171">171</a> fieldAnalyzers.put(Fields.VENDOR, vendorSearchFieldAnalyzer);
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
<a class="jxr_linenumber" name="L175" href="#L175">175</a>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * Saves a CPE IndexEntry into the Lucene index.</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @param vendor the vendor to index</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @param product the product to index</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @param indexWriter the index writer to write the entry into</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @throws CorruptIndexException is thrown if the index is corrupt</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if an IOException occurs</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> saveEntry(String vendor, String product, IndexWriter indexWriter) <strong class="jxr_keyword">throws</strong> CorruptIndexException, IOException {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> Document doc = <strong class="jxr_keyword">new</strong> Document();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">final</strong> Field v = <strong class="jxr_keyword">new</strong> TextField(Fields.VENDOR, vendor, Field.Store.YES);
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> Field p = <strong class="jxr_keyword">new</strong> TextField(Fields.PRODUCT, product, Field.Store.YES);
<a class="jxr_linenumber" name="L189" href="#L189">189</a> doc.add(v);
<a class="jxr_linenumber" name="L190" href="#L190">190</a> doc.add(p);
<a class="jxr_linenumber" name="L191" href="#L191">191</a> indexWriter.addDocument(doc);
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * Closes the CPE Index.</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (searchingAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> searchingAnalyzer.close();
<a class="jxr_linenumber" name="L200" href="#L200">200</a> searchingAnalyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">if</strong> (indexReader != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L204" href="#L204">204</a> indexReader.close();
<a class="jxr_linenumber" name="L205" href="#L205">205</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> LOGGER.trace(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a> indexReader = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a> queryParser = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L211" href="#L211">211</a> indexSearcher = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (index != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> index.close();
<a class="jxr_linenumber" name="L214" href="#L214">214</a> index = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
<a class="jxr_linenumber" name="L216" href="#L216">216</a> openState = false;
<a class="jxr_linenumber" name="L217" href="#L217">217</a> }
<a class="jxr_linenumber" name="L218" href="#L218">218</a>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Builds the CPE Lucene Index based off of the data within the CveDB.</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @param cve the data base containing the CPE data</em>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @throws IndexException thrown if there is an issue creating the index</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> buildIndex(<a href="../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cve) <strong class="jxr_keyword">throws</strong> IndexException {
<a class="jxr_linenumber" name="L226" href="#L226">226</a> Analyzer analyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L227" href="#L227">227</a> IndexWriter indexWriter = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> analyzer = createIndexingAnalyzer();
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">final</strong> IndexWriterConfig conf = <strong class="jxr_keyword">new</strong> IndexWriterConfig(LuceneUtils.CURRENT_VERSION, analyzer);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> indexWriter = <strong class="jxr_keyword">new</strong> IndexWriter(index, conf);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">final</strong> Set&lt;Pair&lt;String, String&gt;&gt; data = cve.getVendorProductList();
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">for</strong> (Pair&lt;String, String&gt; pair : data) {
<a class="jxr_linenumber" name="L235" href="#L235">235</a> saveEntry(pair.getLeft(), pair.getRight(), indexWriter);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Error reading CPE data"</span>, ex);
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
<a class="jxr_linenumber" name="L241" href="#L241">241</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L243" href="#L243">243</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L245" href="#L245">245</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (indexWriter != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> indexWriter.commit();
<a class="jxr_linenumber" name="L250" href="#L250">250</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L251" href="#L251">251</a> indexWriter.close(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L255" href="#L255">255</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (analyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L259" href="#L259">259</a> analyzer.close();
<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
<a class="jxr_linenumber" name="L261" href="#L261">261</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">private</strong> Analyzer createIndexingAnalyzer() {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">final</strong> Map&lt;String, Analyzer&gt; fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Analyzer&gt;();
<a class="jxr_linenumber" name="L154" href="#L154">154</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
<a class="jxr_linenumber" name="L157" href="#L157">157</a>
<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"> * Creates an Analyzer for searching the CPE Index.</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> <em class="jxr_javadoccomment"> * @return the CPE Analyzer.</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">private</strong> Analyzer createSearchingAnalyzer() {
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">final</strong> Map&lt;String, Analyzer&gt; fieldAnalyzers = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Analyzer&gt;();
<a class="jxr_linenumber" name="L165" href="#L165">165</a> fieldAnalyzers.put(Fields.DOCUMENT_KEY, <strong class="jxr_keyword">new</strong> KeywordAnalyzer());
<a class="jxr_linenumber" name="L166" href="#L166">166</a> productSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="L167" href="#L167">167</a> vendorSearchFieldAnalyzer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/SearchFieldAnalyzer.html">SearchFieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION);
<a class="jxr_linenumber" name="L168" href="#L168">168</a> fieldAnalyzers.put(Fields.PRODUCT, productSearchFieldAnalyzer);
<a class="jxr_linenumber" name="L169" href="#L169">169</a> fieldAnalyzers.put(Fields.VENDOR, vendorSearchFieldAnalyzer);
<a class="jxr_linenumber" name="L170" href="#L170">170</a>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PerFieldAnalyzerWrapper(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/lucene/FieldAnalyzer.html">FieldAnalyzer</a>(LuceneUtils.CURRENT_VERSION), fieldAnalyzers);
<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * Closes the CPE Index.</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close() {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (searchingAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> searchingAnalyzer.close();
<a class="jxr_linenumber" name="L180" href="#L180">180</a> searchingAnalyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (indexReader != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L184" href="#L184">184</a> indexReader.close();
<a class="jxr_linenumber" name="L185" href="#L185">185</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> LOGGER.trace(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a> indexReader = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L189" href="#L189">189</a> }
<a class="jxr_linenumber" name="L190" href="#L190">190</a> queryParser = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L191" href="#L191">191</a> indexSearcher = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (index != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> index.close();
<a class="jxr_linenumber" name="L194" href="#L194">194</a> index = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a> openState = false;
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
<a class="jxr_linenumber" name="L198" href="#L198">198</a>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * Builds the CPE Lucene Index based off of the data within the CveDB.</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param cve the data base containing the CPE data</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @throws IndexException thrown if there is an issue creating the index</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">private</strong> <strong class="jxr_keyword">void</strong> buildIndex(<a href="../../../../../org/owasp/dependencycheck/data/nvdcve/CveDB.html">CveDB</a> cve) <strong class="jxr_keyword">throws</strong> IndexException {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> Analyzer analyzer = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L207" href="#L207">207</a> IndexWriter indexWriter = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L209" href="#L209">209</a> analyzer = createIndexingAnalyzer();
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">final</strong> IndexWriterConfig conf = <strong class="jxr_keyword">new</strong> IndexWriterConfig(LuceneUtils.CURRENT_VERSION, analyzer);
<a class="jxr_linenumber" name="L211" href="#L211">211</a> indexWriter = <strong class="jxr_keyword">new</strong> IndexWriter(index, conf);
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_comment">// Tip: reuse the Document and Fields for performance...</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_comment">// See "Re-use Document and Field instances" from</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_comment">// http://wiki.apache.org/lucene-java/ImproveIndexingSpeed</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">final</strong> Document doc = <strong class="jxr_keyword">new</strong> Document();
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">final</strong> Field v = <strong class="jxr_keyword">new</strong> TextField(Fields.VENDOR, Fields.VENDOR, Field.Store.YES);
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">final</strong> Field p = <strong class="jxr_keyword">new</strong> TextField(Fields.PRODUCT, Fields.PRODUCT, Field.Store.YES);
<a class="jxr_linenumber" name="L219" href="#L219">219</a> doc.add(v);
<a class="jxr_linenumber" name="L220" href="#L220">220</a> doc.add(p);
<a class="jxr_linenumber" name="L221" href="#L221">221</a>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">final</strong> Set&lt;Pair&lt;String, String&gt;&gt; data = cve.getVendorProductList();
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">for</strong> (Pair&lt;String, String&gt; pair : data) {
<a class="jxr_linenumber" name="L224" href="#L224">224</a> v.setStringValue(pair.getLeft());
<a class="jxr_linenumber" name="L225" href="#L225">225</a> p.setStringValue(pair.getRight());
<a class="jxr_linenumber" name="L226" href="#L226">226</a> indexWriter.addDocument(doc);
<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
<a class="jxr_linenumber" name="L228" href="#L228">228</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Error reading CPE data"</span>, ex);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
<a class="jxr_linenumber" name="L232" href="#L232">232</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L234" href="#L234">234</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> (indexWriter != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> indexWriter.commit();
<a class="jxr_linenumber" name="L241" href="#L241">241</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L242" href="#L242">242</a> indexWriter.close(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L243" href="#L243">243</a> }
<a class="jxr_linenumber" name="L244" href="#L244">244</a> } <strong class="jxr_keyword">catch</strong> (CorruptIndexException ex) {
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L246" href="#L246">246</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/owasp/dependencycheck/data/cpe/IndexException.html">IndexException</a>(<span class="jxr_string">"Unable to close an in-memory index"</span>, ex);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (analyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> analyzer.close();
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a> }
<a class="jxr_linenumber" name="L254" href="#L254">254</a> }
<a class="jxr_linenumber" name="L255" href="#L255">255</a>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * Resets the searching analyzers</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> resetSearchingAnalyzer() {
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> (productSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L261" href="#L261">261</a> productSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="L262" href="#L262">262</a> }
<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<a class="jxr_linenumber" name="L264" href="#L264">264</a>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * Resets the searching analyzers</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> resetSearchingAnalyzer() {
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> (productSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L270" href="#L270">270</a> productSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">if</strong> (vendorSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L273" href="#L273">273</a> vendorSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="L274" href="#L274">274</a> }
<a class="jxr_linenumber" name="L275" href="#L275">275</a> }
<a class="jxr_linenumber" name="L276" href="#L276">276</a>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * Searches the index using the given search string.</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * @param searchString the query text</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the maximum number of documents to return</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * @return the TopDocs found by the search</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * @throws ParseException thrown when the searchString is invalid</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if there is an issue with the underlying Index</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">public</strong> TopDocs search(String searchString, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> ParseException, IOException {
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">if</strong> (searchString == <strong class="jxr_keyword">null</strong> || searchString.trim().isEmpty()) {
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ParseException(<span class="jxr_string">"Query is null or empty"</span>);
<a class="jxr_linenumber" name="L289" href="#L289">289</a> }
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">final</strong> Query query = queryParser.parse(searchString);
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">return</strong> indexSearcher.search(query, maxQueryResults);
<a class="jxr_linenumber" name="L292" href="#L292">292</a> }
<a class="jxr_linenumber" name="L293" href="#L293">293</a>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * Searches the index using the given query.</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @param query the query used to search the index</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the max number of results to return</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @return the TopDocs found be the query</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * @throws CorruptIndexException thrown if the Index is corrupt</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">public</strong> TopDocs search(Query query, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> CorruptIndexException, IOException {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> resetSearchingAnalyzer();
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">return</strong> indexSearcher.search(query, maxQueryResults);
<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
<a class="jxr_linenumber" name="L307" href="#L307">307</a>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * Retrieves a document from the Index.</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * @param documentId the id of the document to retrieve</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * @return the Document</em>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">public</strong> Document getDocument(<strong class="jxr_keyword">int</strong> documentId) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">return</strong> indexSearcher.doc(documentId);
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
<a class="jxr_linenumber" name="L318" href="#L318">318</a>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * Returns the number of CPE entries stored in the index.</em>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * @return the number of CPE entries stored in the index</em>
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> numDocs() {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (indexReader == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">return</strong> indexReader.numDocs();
<a class="jxr_linenumber" name="L329" href="#L329">329</a> }
<a class="jxr_linenumber" name="L330" href="#L330">330</a> }
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">if</strong> (vendorSearchFieldAnalyzer != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L264" href="#L264">264</a> vendorSearchFieldAnalyzer.clear();
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Searches the index using the given search string.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param searchString the query text</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the maximum number of documents to return</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @return the TopDocs found by the search</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * @throws ParseException thrown when the searchString is invalid</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if there is an issue with the underlying Index</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">public</strong> TopDocs search(String searchString, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> ParseException, IOException {
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">if</strong> (searchString == <strong class="jxr_keyword">null</strong> || searchString.trim().isEmpty()) {
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ParseException(<span class="jxr_string">"Query is null or empty"</span>);
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
<a class="jxr_linenumber" name="L281" href="#L281">281</a> LOGGER.debug(searchString);
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">final</strong> Query query = queryParser.parse(searchString);
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">return</strong> search(query, maxQueryResults);
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * Searches the index using the given query.</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @param query the query used to search the index</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @param maxQueryResults the max number of results to return</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @return the TopDocs found be the query</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @throws CorruptIndexException thrown if the Index is corrupt</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">public</strong> TopDocs search(Query query, <strong class="jxr_keyword">int</strong> maxQueryResults) <strong class="jxr_keyword">throws</strong> CorruptIndexException, IOException {
<a class="jxr_linenumber" name="L296" href="#L296">296</a> resetSearchingAnalyzer();
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">return</strong> indexSearcher.search(query, maxQueryResults);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
<a class="jxr_linenumber" name="L299" href="#L299">299</a>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * Retrieves a document from the Index.</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @param documentId the id of the document to retrieve</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @return the Document</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * @throws IOException thrown if there is an IOException</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">public</strong> Document getDocument(<strong class="jxr_keyword">int</strong> documentId) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">return</strong> indexSearcher.doc(documentId);
<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
<a class="jxr_linenumber" name="L310" href="#L310">310</a>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * Returns the number of CPE entries stored in the index.</em>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * @return the number of CPE entries stored in the index</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> numDocs() {
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> (indexReader == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="L319" href="#L319">319</a> }
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">return</strong> indexReader.numDocs();
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

2
xref/org/owasp/dependencycheck/data/cpe/IndexEntry.html
View File

@@ -56,7 +56,7 @@
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> String getDocumentId() {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">if</strong> (documentId == <strong class="jxr_keyword">null</strong> &amp;&amp; vendor != <strong class="jxr_keyword">null</strong> &amp;&amp; product != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> documentId = vendor + <span class="jxr_string">":"</span> + product;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> documentId = vendor + ':' + product;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">return</strong> documentId;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }

2
xref/org/owasp/dependencycheck/data/cpe/package-frame.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check 1.3.1 Reference Package org.owasp.dependencycheck.data.cpe</title>
<title>Dependency-Check 1.3.2 Reference Package org.owasp.dependencycheck.data.cpe</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>

2
xref/org/owasp/dependencycheck/data/cpe/package-summary.html
View File

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check 1.3.1 Reference Package org.owasp.dependencycheck.data.cpe</title>
<title>Dependency-Check 1.3.2 Reference Package org.owasp.dependencycheck.data.cpe</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>