mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-21 16:49:43 +01:00
version 1.2.7 of site documentation
This commit is contained in:
Jeremy Long
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,174 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
||||
<title>Engine xref</title>
|
||||
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/Engine.html">View Javadoc</a></div><pre>
|
||||
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
|
||||
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * This file is part of dependency-check-maven.</em>
|
||||
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> *</em>
|
||||
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
|
||||
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
|
||||
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
|
||||
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em>
|
||||
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
|
||||
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
|
||||
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
|
||||
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
|
||||
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
|
||||
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
|
||||
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
|
||||
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> *</em>
|
||||
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * Copyright (c) 2014 Jeremy Long. All Rights Reserved.</em>
|
||||
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
|
||||
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.maven;
|
||||
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
|
||||
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
|
||||
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
|
||||
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.Analyzer;
|
||||
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.CPEAnalyzer;
|
||||
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
|
||||
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
|
||||
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
|
||||
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * A modified version of the core engine specifically designed to persist some data between multiple executions of a</em>
|
||||
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * multi-module Maven project.</em>
|
||||
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @author Jeremy Long <jeremy.long@owasp.org></em>
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> <strong class="jxr_keyword">extends</strong> org.owasp.dependencycheck.Engine {
|
||||
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
|
||||
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * The logger.</em>
|
||||
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">transient</strong> Logger LOGGER = Logger.getLogger(Engine.<strong class="jxr_keyword">class</strong>.getName());
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * A key used to persist an object in the MavenProject.</em>
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CPE_ANALYZER_KEY = <span class="jxr_string">"dependency-check-CPEAnalyzer"</span>;
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The current MavenProject.</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> MavenProject currentProject;
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Creates a new Engine to perform anyalsis on dependencies.</em>
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param project the current Maven project</em>
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>(MavenProject project) <strong class="jxr_keyword">throws</strong> DatabaseException {
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">this</strong>.currentProject = project;
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">final</strong> MavenProject parent = getRootParent();
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (parent != <strong class="jxr_keyword">null</strong> && parent.getContextValue(<span class="jxr_string">"dependency-check-data-was-updated"</span>) != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</a> System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
|
||||
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a> initializeEngine();
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (parent != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> parent.setContextValue(<span class="jxr_string">"dependency-check-data-was-updated"</span>, Boolean.valueOf(<strong class="jxr_keyword">true</strong>));
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * This constructor should not be called. Use Engine(MavenProject) instead.</em>
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>() <strong class="jxr_keyword">throws</strong> DatabaseException {
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Initializes the given analyzer. This skips the initialization of the CPEAnalyzer if it has been initialized by a</em>
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * previous execution.</em>
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to initialize</em>
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @return the initialized analyzer</em>
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Override
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> Analyzer initializeAnalyzer(Analyzer analyzer) {
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> CPEAnalyzer cpe = getPreviouslyLoadedAnalyzer();
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> cpe;
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> cpe = (CPEAnalyzer) <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> storeCPEAnalyzer(cpe);
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Closes the given analyzer. This skips closing the CPEAnalyzer.</em>
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to close</em>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> @Override
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeAnalyzer(Analyzer analyzer) {
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (getPreviouslyLoadedAnalyzer() == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Closes the CPEAnalyzer if it has been created and persisted in the root parent MavenProject context.</em>
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanupFinal() {
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">final</strong> CPEAnalyzer cpe = getPreviouslyLoadedAnalyzer();
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> cpe.close();
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Gets the CPEAnalyzer from the root Maven Project.</em>
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @return an initialized CPEAnalyzer</em>
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">private</strong> CPEAnalyzer getPreviouslyLoadedAnalyzer() {
|
||||
<a class="jxr_linenumber" name="L126" href="#L126">126</a> CPEAnalyzer cpe = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">final</strong> MavenProject project = getRootParent();
|
||||
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L129" href="#L129">129</a> cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
|
||||
<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
|
||||
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">return</strong> cpe;
|
||||
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
|
||||
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
|
||||
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Stores a CPEAnalyzer in the root Maven Project.</em>
|
||||
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param cpe the CPEAnalyzer to store</em>
|
||||
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> storeCPEAnalyzer(CPEAnalyzer cpe) {
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> MavenProject p = getRootParent();
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (p != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> p.setContextValue(CPE_ANALYZER_KEY, cpe);
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Returns the root Maven Project.</em>
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @return the root Maven Project</em>
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> MavenProject getRootParent() {
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.currentProject == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> <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> MavenProject p = <strong class="jxr_keyword">this</strong>.currentProject;
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">while</strong> (p.getParent() != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L157" href="#L157">157</a> p = p.getParent();
|
||||
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
|
||||
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong> p;
|
||||
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2013–2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -147,327 +147,333 @@
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a> }
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a>
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * The collection of child projects.</em>
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Initializes the mojo.</em>
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<MavenProject, Set<MavenProject>> projectChildren = <strong class="jxr_keyword">new</strong> HashMap<MavenProject, Set<MavenProject>>();
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> initialize();
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Called before execute; allows for any setup that is needed. If this is overridden you must call</em>
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * </code>super.preExecute()</code>.</em>
|
||||
<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"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> preExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> buildAggregateInfo();
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a>
|
||||
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Called when the mojo is being executed.</em>
|
||||
<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"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</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">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> performExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException;
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Runs after the mojo has executed. This implementation will call <code>writeDataFile()</code>. As such, it is</em>
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * important that if this method is overriden that <code>super.postExecute()</code> is called.</em>
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> postExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> File written = writeDataFile();
|
||||
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (written != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L175" href="#L175">175</a> project.setContextValue(getDataFileContextKey(), written.getAbsolutePath());
|
||||
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
|
||||
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
|
||||
<a class="jxr_linenumber" name="L178" href="#L178">178</a>
|
||||
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * Returns the key used to store the path to the data file that is saved by <code>writeDataFile()</code>. This key</em>
|
||||
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * is used in the <code>MavenProject.(set|get)ContextValue</code>.</em>
|
||||
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @return the key used to store the path to the data file</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">protected</strong> String getDataFileContextKey() {
|
||||
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-path-"</span> + <strong class="jxr_keyword">this</strong>.getDataFileName();
|
||||
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
|
||||
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
|
||||
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * Returns the key used to store the path to the output directory. When generating the report in the</em>
|
||||
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <code>executeAggregateReport()</code> the output directory should be obtained by using this key.</em>
|
||||
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @return the key used to store the path to the output directory</em>
|
||||
<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> <strong class="jxr_keyword">protected</strong> String getOutputDirectoryContextKey() {
|
||||
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-output-dir-"</span> + <strong class="jxr_keyword">this</strong>.getDataFileName();
|
||||
<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"> * Is called by Maven to execute the mojo.</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"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</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> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L207" href="#L207">207</a> preExecute();
|
||||
<a class="jxr_linenumber" name="L208" href="#L208">208</a> performExecute();
|
||||
<a class="jxr_linenumber" name="L209" href="#L209">209</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L210" href="#L210">210</a> postExecute();
|
||||
<a class="jxr_linenumber" name="L211" href="#L211">211</a> }
|
||||
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
|
||||
<a class="jxr_linenumber" name="L213" href="#L213">213</a>
|
||||
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * Runs prior to the site report generation.</em>
|
||||
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> preGenerate() <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L220" href="#L220">220</a> buildAggregateInfo();
|
||||
<a class="jxr_linenumber" name="L221" href="#L221">221</a>
|
||||
<a class="jxr_linenumber" name="L222" href="#L222">222</a> project.setContextValue(getOutputDirectoryContextKey(), getReportOutputDirectory());
|
||||
<a class="jxr_linenumber" name="L223" href="#L223">223</a> }
|
||||
<a class="jxr_linenumber" name="L224" href="#L224">224</a>
|
||||
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Executes after the site report has been generated.</em>
|
||||
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> postGenerate() <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">final</strong> File written = writeDataFile();
|
||||
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (written != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L233" href="#L233">233</a> project.setContextValue(getDataFileContextKey(), written.getAbsolutePath());
|
||||
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
|
||||
<a class="jxr_linenumber" name="L235" href="#L235">235</a> }
|
||||
<a class="jxr_linenumber" name="L236" href="#L236">236</a>
|
||||
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Generates the non aggregate report.</em>
|
||||
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeNonAggregateReport(Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException;
|
||||
<a class="jxr_linenumber" name="L244" href="#L244">244</a>
|
||||
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * Generates the aggregate Site Report.</em>
|
||||
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @param project the maven project used to generate the aggregate report</em>
|
||||
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeAggregateReport(MavenProject project, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException;
|
||||
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
|
||||
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * Generates the Dependency-Check Site Report.</em>
|
||||
<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"> * @param sink the sink to write the report to</em>
|
||||
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(org.apache.maven.doxia.sink.Sink, java.util.Locale) instead.</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> @Deprecated
|
||||
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> generate(@SuppressWarnings(<span class="jxr_string">"deprecation"</span>) org.codehaus.doxia.sink.Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L264" href="#L264">264</a> generate((Sink) sink, locale);
|
||||
<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> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * Generates the Dependency-Check Site Report.</em>
|
||||
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the report to</em>
|
||||
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> generate(Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L276" href="#L276">276</a> preGenerate();
|
||||
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> (canGenerateNonAggregateReport()) {
|
||||
<a class="jxr_linenumber" name="L278" href="#L278">278</a> executeNonAggregateReport(locale);
|
||||
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
|
||||
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
|
||||
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">if</strong> (canGenerateAggregateReport()) {
|
||||
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : reactorProjects) {
|
||||
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> (!isMultiModule(proj)) {
|
||||
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">continue</strong>;
|
||||
<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
|
||||
<a class="jxr_linenumber" name="L286" href="#L286">286</a> executeAggregateReport(proj, locale);
|
||||
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
|
||||
<a class="jxr_linenumber" name="L288" href="#L288">288</a> }
|
||||
<a class="jxr_linenumber" name="L289" href="#L289">289</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L290" href="#L290">290</a> postGenerate();
|
||||
<a class="jxr_linenumber" name="L291" href="#L291">291</a> }
|
||||
<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"> * Returns whether or not the mojo can generate a non-aggregate report for this project.</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"> * @return <code>true</code> if a non-aggregate report can be generated, otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> canGenerateNonAggregateReport();
|
||||
<a class="jxr_linenumber" name="L300" href="#L300">300</a>
|
||||
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * Returns whether or not we can generate any aggregate reports at this time.</em>
|
||||
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if an aggregate report can be generated, otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> canGenerateAggregateReport();
|
||||
<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"> * Returns the name of the data file that contains the serialized data.</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"> * @return the name of the data file that contains the serialized data</em>
|
||||
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">protected</strong> String getDataFileName() {
|
||||
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">return</strong> dataFileName;
|
||||
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
|
||||
<a class="jxr_linenumber" name="L316" href="#L316">316</a>
|
||||
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * Writes the data file to disk in the target directory.</em>
|
||||
<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"> * @return the File object referencing the data file that was written</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> File writeDataFile();
|
||||
<a class="jxr_linenumber" name="L323" href="#L323">323</a>
|
||||
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * Collects the information needed for building aggregate reports.</em>
|
||||
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> buildAggregateInfo() {
|
||||
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_comment">// build parent-child map</em>
|
||||
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : reactorProjects) {
|
||||
<a class="jxr_linenumber" name="L330" href="#L330">330</a> Set<MavenProject> depList = projectChildren.get(proj.getParent());
|
||||
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> (depList == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L332" href="#L332">332</a> depList = <strong class="jxr_keyword">new</strong> HashSet<MavenProject>();
|
||||
<a class="jxr_linenumber" name="L333" href="#L333">333</a> projectChildren.put(proj.getParent(), depList);
|
||||
<a class="jxr_linenumber" name="L334" href="#L334">334</a> }
|
||||
<a class="jxr_linenumber" name="L335" href="#L335">335</a> depList.add(proj);
|
||||
<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
|
||||
<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
|
||||
<a class="jxr_linenumber" name="L338" href="#L338">338</a>
|
||||
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * Returns a list containing all the recursive, non-pom children of the given project, never <code>null</code>.</em>
|
||||
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * @return a list of child projects</em>
|
||||
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> getAllChildren() {
|
||||
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">return</strong> getAllChildren(project);
|
||||
<a class="jxr_linenumber" name="L346" href="#L346">346</a> }
|
||||
<a class="jxr_linenumber" name="L347" href="#L347">347</a>
|
||||
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * Returns a list containing all the recursive, non-pom children of the given project, never <code>null</code>.</em>
|
||||
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @param parentProject the parent project to collect the child project references</em>
|
||||
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * @return a list of child projects</em>
|
||||
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> getAllChildren(MavenProject parentProject) {
|
||||
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">final</strong> Set<MavenProject> children = projectChildren.get(parentProject);
|
||||
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">if</strong> (children == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">return</strong> Collections.emptyList();
|
||||
<a class="jxr_linenumber" name="L358" href="#L358">358</a> }
|
||||
<a class="jxr_linenumber" name="L359" href="#L359">359</a>
|
||||
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">final</strong> List<MavenProject> result = <strong class="jxr_keyword">new</strong> ArrayList<MavenProject>();
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">for</strong> (MavenProject child : children) {
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">if</strong> (isMultiModule(child)) {
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> result.addAll(getAllChildren(child));
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a> result.add(child);
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a> }
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</a> }
|
||||
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">return</strong> result;
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> }
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a>
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * Returns a list of data files that were produced by the direct children of the given MavenProject.</em>
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * @param project the Maven project to obtain the child data files from</em>
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * @return a list of the data files</em>
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">protected</strong> List<File> getAllChildDataFiles(MavenProject project) {
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">final</strong> List<MavenProject> children = getAllChildren(project);
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">return</strong> getDataFiles(children);
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
|
||||
<a class="jxr_linenumber" name="L381" href="#L381">381</a>
|
||||
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * Returns any existing output files from the given list of projects.</em>
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * @param projects the list of projects to obtain the output files from</em>
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * @return a list of output files</em>
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">protected</strong> List<File> getDataFiles(List<MavenProject> projects) {
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">final</strong> List<File> files = <strong class="jxr_keyword">new</strong> ArrayList<File>();
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : projects) {
|
||||
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">final</strong> Object path = project.getContextValue(getDataFileContextKey());
|
||||
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to aggregate data for '%s' - aggregate data file was not generated"</span>,
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> proj.getName());
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> LOGGER.warning(msg);
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">final</strong> File outputFile = <strong class="jxr_keyword">new</strong> File((String) path);
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">if</strong> (outputFile.exists()) {
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> files.add(outputFile);
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">if</strong> (!isMultiModule(project)) {
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to aggregate data for '%s' - missing data file '%s'"</span>,
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> proj.getName(), outputFile.getPath());
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> LOGGER.warning(msg);
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
|
||||
<a class="jxr_linenumber" name="L408" href="#L408">408</a> }
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">return</strong> files;
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> }
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a>
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * Test if the project has pom packaging</em>
|
||||
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * @param mavenProject Project to test</em>
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if it has a pom packaging; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule(MavenProject mavenProject) {
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pom"</span>.equals(mavenProject.getPackaging());
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> }
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a>
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * Test if the current project has pom packaging</em>
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if it has a pom packaging; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule() {
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">return</strong> isMultiModule(project);
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> }
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a>
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * Check whether the current project is the last project in a multi-module build. If the maven build is not a</em>
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * multi-module project then this will always return true.</em>
|
||||
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the current project is the last project in a multi-module build; otherwise</em>
|
||||
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLastProject() {
|
||||
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">return</strong> project.equals(reactorProjects.get(reactorProjects.size() - 1));
|
||||
<a class="jxr_linenumber" name="L440" href="#L440">440</a> }
|
||||
<a class="jxr_linenumber" name="L441" href="#L441">441</a>
|
||||
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * Returns whether or not the mojo is configured to perform report aggregation.</em>
|
||||
<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if report aggregation is enabled; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAggregate() {
|
||||
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">return</strong> aggregate;
|
||||
<a class="jxr_linenumber" name="L449" href="#L449">449</a> }
|
||||
<a class="jxr_linenumber" name="L450" href="#L450">450</a>
|
||||
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * Returns a reference to the current project. This method is used instead of auto-binding the project via component</em>
|
||||
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * annotation in concrete implementations of this. If the child has a <code>@Component MavenProject project;</code></em>
|
||||
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> * defined then the abstract class (i.e. this class) will not have access to the current project (just the way Maven</em>
|
||||
<a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * works with the binding).</em>
|
||||
<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment"> * @return returns a reference to the current project</em>
|
||||
<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() {
|
||||
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">return</strong> project;
|
||||
<a class="jxr_linenumber" name="L461" href="#L461">461</a> }
|
||||
<a class="jxr_linenumber" name="L462" href="#L462">462</a> }
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * The collection of child projects.</em>
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<MavenProject, Set<MavenProject>> projectChildren = <strong class="jxr_keyword">new</strong> HashMap<MavenProject, Set<MavenProject>>();
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Called before execute; allows for any setup that is needed. If this is overridden you must call</em>
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * </code>super.preExecute()</code>.</em>
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> preExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L159" href="#L159">159</a> buildAggregateInfo();
|
||||
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Called when the mojo is being executed.</em>
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> performExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException;
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a>
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Runs after the mojo has executed. This implementation will call <code>writeDataFile()</code>. As such, it is</em>
|
||||
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * important that if this method is overriden that <code>super.postExecute()</code> is called.</em>
|
||||
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</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">protected</strong> <strong class="jxr_keyword">void</strong> postExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">final</strong> File written = writeDataFile();
|
||||
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> (written != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L180" href="#L180">180</a> project.setContextValue(getDataFileContextKey(), written.getAbsolutePath());
|
||||
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
|
||||
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
|
||||
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Returns the key used to store the path to the data file that is saved by <code>writeDataFile()</code>. This key</em>
|
||||
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * is used in the <code>MavenProject.(set|get)ContextValue</code>.</em>
|
||||
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return the key used to store the path to the data file</em>
|
||||
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">protected</strong> String getDataFileContextKey() {
|
||||
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-path-"</span> + <strong class="jxr_keyword">this</strong>.getDataFileName();
|
||||
<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"> * Returns the key used to store the path to the output directory. When generating the report in the</em>
|
||||
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <code>executeAggregateReport()</code> the output directory should be obtained by using this key.</em>
|
||||
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @return the key used to store the path to the output directory</em>
|
||||
<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> <strong class="jxr_keyword">protected</strong> String getOutputDirectoryContextKey() {
|
||||
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-output-dir-"</span> + <strong class="jxr_keyword">this</strong>.getDataFileName();
|
||||
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
|
||||
<a class="jxr_linenumber" name="L203" href="#L203">203</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Is called by Maven to execute the mojo.</em>
|
||||
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if there is an issue executing the mojo</em>
|
||||
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
|
||||
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L212" href="#L212">212</a> initialize();
|
||||
<a class="jxr_linenumber" name="L213" href="#L213">213</a> preExecute();
|
||||
<a class="jxr_linenumber" name="L214" href="#L214">214</a> performExecute();
|
||||
<a class="jxr_linenumber" name="L215" href="#L215">215</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L216" href="#L216">216</a> postExecute();
|
||||
<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>
|
||||
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * Runs prior to the site report generation.</em>
|
||||
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</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">protected</strong> <strong class="jxr_keyword">void</strong> preGenerate() <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L226" href="#L226">226</a> buildAggregateInfo();
|
||||
<a class="jxr_linenumber" name="L227" href="#L227">227</a>
|
||||
<a class="jxr_linenumber" name="L228" href="#L228">228</a> project.setContextValue(getOutputDirectoryContextKey(), getReportOutputDirectory());
|
||||
<a class="jxr_linenumber" name="L229" href="#L229">229</a> }
|
||||
<a class="jxr_linenumber" name="L230" href="#L230">230</a>
|
||||
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * Executes after the site report has been generated.</em>
|
||||
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> postGenerate() <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">final</strong> File written = writeDataFile();
|
||||
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> (written != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L239" href="#L239">239</a> project.setContextValue(getDataFileContextKey(), written.getAbsolutePath());
|
||||
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
|
||||
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
|
||||
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
|
||||
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * Generates the non aggregate report.</em>
|
||||
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeNonAggregateReport(Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException;
|
||||
<a class="jxr_linenumber" name="L250" href="#L250">250</a>
|
||||
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * Generates the aggregate Site Report.</em>
|
||||
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * @param project the maven project used to generate the aggregate report</em>
|
||||
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeAggregateReport(MavenProject project, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException;
|
||||
<a class="jxr_linenumber" name="L259" href="#L259">259</a>
|
||||
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * Generates the Dependency-Check Site Report.</em>
|
||||
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the report to</em>
|
||||
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
|
||||
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(org.apache.maven.doxia.sink.Sink, java.util.Locale) instead.</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> @Deprecated
|
||||
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> generate(@SuppressWarnings(<span class="jxr_string">"deprecation"</span>) org.codehaus.doxia.sink.Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> generate((Sink) sink, locale);
|
||||
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
|
||||
<a class="jxr_linenumber" name="L272" href="#L272">272</a>
|
||||
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * Generates the Dependency-Check Site Report.</em>
|
||||
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the report to</em>
|
||||
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
|
||||
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> generate(Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
|
||||
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L282" href="#L282">282</a> initialize();
|
||||
<a class="jxr_linenumber" name="L283" href="#L283">283</a> preGenerate();
|
||||
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">if</strong> (canGenerateNonAggregateReport()) {
|
||||
<a class="jxr_linenumber" name="L285" href="#L285">285</a> executeNonAggregateReport(locale);
|
||||
<a class="jxr_linenumber" name="L286" href="#L286">286</a> }
|
||||
<a class="jxr_linenumber" name="L287" href="#L287">287</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L288" href="#L288">288</a> postGenerate();
|
||||
<a class="jxr_linenumber" name="L289" href="#L289">289</a> }
|
||||
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">if</strong> (canGenerateAggregateReport()) {
|
||||
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : reactorProjects) {
|
||||
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">if</strong> (!isMultiModule(proj)) {
|
||||
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">continue</strong>;
|
||||
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
|
||||
<a class="jxr_linenumber" name="L295" href="#L295">295</a> executeAggregateReport(proj, locale);
|
||||
<a class="jxr_linenumber" name="L296" href="#L296">296</a> }
|
||||
<a class="jxr_linenumber" name="L297" href="#L297">297</a> }
|
||||
<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"> * Returns whether or not the mojo can generate a non-aggregate report for this project.</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"> * @return <code>true</code> if a non-aggregate report can be generated, otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> canGenerateNonAggregateReport();
|
||||
<a class="jxr_linenumber" name="L306" href="#L306">306</a>
|
||||
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * Returns whether or not we can generate any aggregate reports at this time.</em>
|
||||
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if an aggregate report can be generated, otherwise <code>false</code></em>
|
||||
<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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> canGenerateAggregateReport();
|
||||
<a class="jxr_linenumber" name="L313" href="#L313">313</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Returns the name of the data file that contains the serialized data.</em>
|
||||
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @return the name of the data file that contains the serialized data</em>
|
||||
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">protected</strong> String getDataFileName() {
|
||||
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">return</strong> dataFileName;
|
||||
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
|
||||
<a class="jxr_linenumber" name="L322" href="#L322">322</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Writes the data file to disk in the target directory.</em>
|
||||
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * @return the File object referencing the data file that was written</em>
|
||||
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> File writeDataFile();
|
||||
<a class="jxr_linenumber" name="L329" href="#L329">329</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Collects the information needed for building aggregate reports.</em>
|
||||
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> buildAggregateInfo() {
|
||||
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// build parent-child map</em>
|
||||
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : reactorProjects) {
|
||||
<a class="jxr_linenumber" name="L336" href="#L336">336</a> Set<MavenProject> depList = projectChildren.get(proj.getParent());
|
||||
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">if</strong> (depList == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L338" href="#L338">338</a> depList = <strong class="jxr_keyword">new</strong> HashSet<MavenProject>();
|
||||
<a class="jxr_linenumber" name="L339" href="#L339">339</a> projectChildren.put(proj.getParent(), depList);
|
||||
<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
|
||||
<a class="jxr_linenumber" name="L341" href="#L341">341</a> depList.add(proj);
|
||||
<a class="jxr_linenumber" name="L342" href="#L342">342</a> }
|
||||
<a class="jxr_linenumber" name="L343" href="#L343">343</a> }
|
||||
<a class="jxr_linenumber" name="L344" href="#L344">344</a>
|
||||
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * Returns a list containing all the recursive, non-pom children of the given project, never <code>null</code>.</em>
|
||||
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * @return a list of child projects</em>
|
||||
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> getAllChildren() {
|
||||
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">return</strong> getAllChildren(project);
|
||||
<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
|
||||
<a class="jxr_linenumber" name="L353" href="#L353">353</a>
|
||||
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * Returns a list containing all the recursive, non-pom children of the given project, never <code>null</code>.</em>
|
||||
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @param parentProject the parent project to collect the child project references</em>
|
||||
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @return a list of child projects</em>
|
||||
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> getAllChildren(MavenProject parentProject) {
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">final</strong> Set<MavenProject> children = projectChildren.get(parentProject);
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">if</strong> (children == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">return</strong> Collections.emptyList();
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a>
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">final</strong> List<MavenProject> result = <strong class="jxr_keyword">new</strong> ArrayList<MavenProject>();
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">for</strong> (MavenProject child : children) {
|
||||
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">if</strong> (isMultiModule(child)) {
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> result.addAll(getAllChildren(child));
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> result.add(child);
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> }
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a> }
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">return</strong> result;
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> }
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a>
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * Returns a list of data files that were produced by the direct children of the given MavenProject.</em>
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * @param project the Maven project to obtain the child data files from</em>
|
||||
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * @return a list of the data files</em>
|
||||
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">protected</strong> List<File> getAllChildDataFiles(MavenProject project) {
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">final</strong> List<MavenProject> children = getAllChildren(project);
|
||||
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">return</strong> getDataFiles(children);
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> }
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a>
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * Returns any existing output files from the given list of projects.</em>
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @param projects the list of projects to obtain the output files from</em>
|
||||
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @return a list of output files</em>
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">protected</strong> List<File> getDataFiles(List<MavenProject> projects) {
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">final</strong> List<File> files = <strong class="jxr_keyword">new</strong> ArrayList<File>();
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">for</strong> (MavenProject proj : projects) {
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">final</strong> Object path = project.getContextValue(getDataFileContextKey());
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to aggregate data for '%s' - aggregate data file was not generated"</span>,
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> proj.getName());
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> LOGGER.warning(msg);
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">final</strong> File outputFile = <strong class="jxr_keyword">new</strong> File((String) path);
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">if</strong> (outputFile.exists()) {
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a> files.add(outputFile);
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">if</strong> (!isMultiModule(project)) {
|
||||
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to aggregate data for '%s' - missing data file '%s'"</span>,
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> proj.getName(), outputFile.getPath());
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> LOGGER.warning(msg);
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a> }
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> }
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
|
||||
<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">return</strong> files;
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a>
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * Test if the project has pom packaging</em>
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @param mavenProject Project to test</em>
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if it has a pom packaging; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule(MavenProject mavenProject) {
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pom"</span>.equals(mavenProject.getPackaging());
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> }
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a>
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * Test if the current project has pom packaging</em>
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if it has a pom packaging; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule() {
|
||||
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">return</strong> isMultiModule(project);
|
||||
<a class="jxr_linenumber" name="L435" href="#L435">435</a> }
|
||||
<a class="jxr_linenumber" name="L436" href="#L436">436</a>
|
||||
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * Check whether the current project is the last project in a multi-module build. If the maven build is not a</em>
|
||||
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * multi-module project then this will always return true.</em>
|
||||
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the current project is the last project in a multi-module build; otherwise</em>
|
||||
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLastProject() {
|
||||
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">return</strong> project.equals(reactorProjects.get(reactorProjects.size() - 1));
|
||||
<a class="jxr_linenumber" name="L446" href="#L446">446</a> }
|
||||
<a class="jxr_linenumber" name="L447" href="#L447">447</a>
|
||||
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> * Returns whether or not the mojo is configured to perform report aggregation.</em>
|
||||
<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if report aggregation is enabled; otherwise <code>false</code></em>
|
||||
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isAggregate() {
|
||||
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">return</strong> aggregate;
|
||||
<a class="jxr_linenumber" name="L455" href="#L455">455</a> }
|
||||
<a class="jxr_linenumber" name="L456" href="#L456">456</a>
|
||||
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L458" href="#L458">458</a> <em class="jxr_javadoccomment"> * Returns a reference to the current project. This method is used instead of auto-binding the project via component</em>
|
||||
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <em class="jxr_javadoccomment"> * annotation in concrete implementations of this. If the child has a <code>@Component MavenProject project;</code></em>
|
||||
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment"> * defined then the abstract class (i.e. this class) will not have access to the current project (just the way Maven</em>
|
||||
<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * works with the binding).</em>
|
||||
<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * @return returns a reference to the current project</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">protected</strong> MavenProject getProject() {
|
||||
<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">return</strong> project;
|
||||
<a class="jxr_linenumber" name="L467" href="#L467">467</a> }
|
||||
<a class="jxr_linenumber" name="L468" href="#L468">468</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2013–2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
|
||||
@@ -36,432 +36,431 @@
|
||||
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
|
||||
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
|
||||
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.Engine;
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.CveDB;
|
||||
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
|
||||
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
|
||||
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
|
||||
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Evidence;
|
||||
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Identifier;
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Reference;
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Vulnerability;
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.VulnerableSoftware;
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.reporting.ReportGenerator;
|
||||
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * A utility class that encapsulates the report generation for dependency-check-maven.</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @author Jeremy Long <jeremy.long@owasp.org></em>
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportingUtil.html">ReportingUtil</a> {
|
||||
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Logger field reference.</em>
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(ReportingUtil.<strong class="jxr_keyword">class</strong>.getName());
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Empty private constructor for this utility class.</em>
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportingUtil.html">ReportingUtil</a>() {
|
||||
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Generates the reports for a given dependency-check engine.</em>
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @param engine a dependency-check engine</em>
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param outDirectory the directory to write the reports to</em>
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project that a report is being generated for</em>
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @param format the format of the report to generate</em>
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> generateExternalReports(Engine engine, File outDirectory, String projectName, String format) {
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> DatabaseProperties prop = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> CveDB cve = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> cve = <strong class="jxr_keyword">new</strong> CveDB();
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> cve.open();
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> prop = cve.getDatabaseProperties();
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Unable to retrieve DB Properties"</span>, ex);
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">if</strong> (cve != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> cve.close();
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">final</strong> ReportGenerator r = <strong class="jxr_keyword">new</strong> ReportGenerator(projectName, engine.getDependencies(), engine.getAnalyzers(), prop);
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> r.generateReports(outDirectory.getCanonicalPath(), format);
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> LOGGER.log(Level.SEVERE,
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <span class="jxr_string">"Unexpected exception occurred during analysis; please see the verbose error log for more details."</span>);
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> LOGGER.log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> } <strong class="jxr_keyword">catch</strong> (Throwable ex) {
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> LOGGER.log(Level.SEVERE,
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <span class="jxr_string">"Unexpected exception occurred during analysis; please see the verbose error log for more details."</span>);
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> LOGGER.log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a>
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * Generates a dependency-check report using the Maven Site format.</em>
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param engine the engine used to scan the dependencies</em>
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project</em>
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> generateMavenSiteReport(<strong class="jxr_keyword">final</strong> Engine engine, Sink sink, String projectName) {
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> List<Dependency> dependencies = engine.getDependencies();
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> writeSiteReportHeader(sink, projectName);
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a> writeSiteReportTOC(sink, dependencies);
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">int</strong> cnt = 0;
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> writeSiteReportDependencyHeader(sink, d);
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> cnt = writeSiteReportDependencyEvidenceUsed(d, cnt, sink);
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a> cnt = writeSiteReportDependencyRelatedDependencies(d, cnt, sink);
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> writeSiteReportDependencyIdentifiers(d, sink);
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> writeSiteReportDependencyVulnerabilities(d, sink, cnt);
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> sink.body_();
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment">// <editor-fold defaultstate="collapsed" desc="various writeXXXXX methods to generate the Site Report"></em>
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Writes the vulnerabilities to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyVulnerabilities(Dependency d, Sink sink, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount) {
|
||||
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (d.getVulnerabilities() != <strong class="jxr_keyword">null</strong> && !d.getVulnerabilities().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">for</strong> (Vulnerability v : d.getVulnerabilities()) {
|
||||
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
|
||||
<a class="jxr_linenumber" name="L134" href="#L134">134</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L135" href="#L135">135</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L137" href="#L137">137</a> sink.link(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/detail?vulnId="</span> + URLEncoder.encode(v.getName(), <span class="jxr_string">"US-ASCII"</span>));
|
||||
<a class="jxr_linenumber" name="L138" href="#L138">138</a> sink.text(v.getName());
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) {
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> sink.text(v.getName());
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a> sink.text(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/detail?vulnId="</span> + v.getName());
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> sink.text(<span class="jxr_string">"Severity: "</span>);
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() < 4.0) {
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> sink.text(<span class="jxr_string">"Low"</span>);
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() >= 7.0) {
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> sink.text(<span class="jxr_string">"High"</span>);
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a> sink.text(<span class="jxr_string">"Medium"</span>);
|
||||
<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> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L160" href="#L160">160</a> sink.text(<span class="jxr_string">"CVSS Score: "</span> + v.getCvssScore());
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> (v.getCwe() != <strong class="jxr_keyword">null</strong> && !v.getCwe().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L162" href="#L162">162</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L163" href="#L163">163</a> sink.text(<span class="jxr_string">"CWE: "</span>);
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a> sink.text(v.getCwe());
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> }
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> sink.text(v.getDescription());
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">if</strong> (v.getReferences() != <strong class="jxr_keyword">null</strong> && !v.getReferences().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">for</strong> (Reference ref : v.getReferences()) {
|
||||
<a class="jxr_linenumber" name="L172" href="#L172">172</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L173" href="#L173">173</a> sink.text(ref.getSource());
|
||||
<a class="jxr_linenumber" name="L174" href="#L174">174</a> sink.text(<span class="jxr_string">" - "</span>);
|
||||
<a class="jxr_linenumber" name="L175" href="#L175">175</a> sink.link(ref.getUrl());
|
||||
<a class="jxr_linenumber" name="L176" href="#L176">176</a> sink.text(ref.getName());
|
||||
<a class="jxr_linenumber" name="L177" href="#L177">177</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L178" href="#L178">178</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
|
||||
<a class="jxr_linenumber" name="L180" href="#L180">180</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
|
||||
<a class="jxr_linenumber" name="L182" href="#L182">182</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (v.getVulnerableSoftware() != <strong class="jxr_keyword">null</strong> && !v.getVulnerableSoftware().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L184" href="#L184">184</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L185" href="#L185">185</a>
|
||||
<a class="jxr_linenumber" name="L186" href="#L186">186</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L187" href="#L187">187</a> sink.rawText(<span class="jxr_string">"Vulnerable Software <a href=\"javascript:toggleElement(this, 'vulnSoft"</span> + cnt + <span class="jxr_string">"')\">[-]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L188" href="#L188">188</a> sink.rawText(<span class="jxr_string">"<div id=\"vulnSoft"</span> + cnt + <span class="jxr_string">"\" style=\"display:block\">"</span>);
|
||||
<a class="jxr_linenumber" name="L189" href="#L189">189</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">for</strong> (VulnerableSoftware vs : v.getVulnerableSoftware()) {
|
||||
<a class="jxr_linenumber" name="L191" href="#L191">191</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L193" href="#L193">193</a> sink.link(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/search-results?cpe="</span> + URLEncoder.encode(vs.getName(), <span class="jxr_string">"US-ASCII"</span>));
|
||||
<a class="jxr_linenumber" name="L194" href="#L194">194</a> sink.text(vs.getName());
|
||||
<a class="jxr_linenumber" name="L195" href="#L195">195</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">if</strong> (vs.hasPreviousVersion()) {
|
||||
<a class="jxr_linenumber" name="L197" href="#L197">197</a> sink.text(<span class="jxr_string">" and all previous versions."</span>);
|
||||
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
|
||||
<a class="jxr_linenumber" name="L199" href="#L199">199</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) {
|
||||
<a class="jxr_linenumber" name="L200" href="#L200">200</a> sink.text(vs.getName());
|
||||
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">if</strong> (vs.hasPreviousVersion()) {
|
||||
<a class="jxr_linenumber" name="L202" href="#L202">202</a> sink.text(<span class="jxr_string">" and all previous versions."</span>);
|
||||
<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
|
||||
<a class="jxr_linenumber" name="L204" href="#L204">204</a> sink.text(<span class="jxr_string">" (http://web.nvd.nist.gov/view/vuln/search-results?cpe="</span> + vs.getName() + <span class="jxr_string">")"</span>);
|
||||
<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
|
||||
<a class="jxr_linenumber" name="L206" href="#L206">206</a>
|
||||
<a class="jxr_linenumber" name="L207" href="#L207">207</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
|
||||
<a class="jxr_linenumber" name="L209" href="#L209">209</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L210" href="#L210">210</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L211" href="#L211">211</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
|
||||
<a class="jxr_linenumber" name="L213" href="#L213">213</a> }
|
||||
<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
|
||||
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
|
||||
<a class="jxr_linenumber" name="L216" href="#L216">216</a>
|
||||
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * Writes the identifiers to the site report.</em>
|
||||
<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"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyIdentifiers(Dependency d, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> (d.getIdentifiers() != <strong class="jxr_keyword">null</strong> && !d.getIdentifiers().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L225" href="#L225">225</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L226" href="#L226">226</a> sink.text(<span class="jxr_string">"Identifiers"</span>);
|
||||
<a class="jxr_linenumber" name="L227" href="#L227">227</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L228" href="#L228">228</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">for</strong> (Identifier i : d.getIdentifiers()) {
|
||||
<a class="jxr_linenumber" name="L230" href="#L230">230</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L231" href="#L231">231</a> sink.text(i.getType());
|
||||
<a class="jxr_linenumber" name="L232" href="#L232">232</a> sink.text(<span class="jxr_string">": "</span>);
|
||||
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (i.getUrl() != <strong class="jxr_keyword">null</strong> && i.getUrl().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L234" href="#L234">234</a> sink.link(i.getUrl());
|
||||
<a class="jxr_linenumber" name="L235" href="#L235">235</a> sink.text(i.getValue());
|
||||
<a class="jxr_linenumber" name="L236" href="#L236">236</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L237" href="#L237">237</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L238" href="#L238">238</a> sink.text(i.getValue());
|
||||
<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
|
||||
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (i.getDescription() != <strong class="jxr_keyword">null</strong> && i.getDescription().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L241" href="#L241">241</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L242" href="#L242">242</a> sink.text(i.getDescription());
|
||||
<a class="jxr_linenumber" name="L243" href="#L243">243</a> }
|
||||
<a class="jxr_linenumber" name="L244" href="#L244">244</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
|
||||
<a class="jxr_linenumber" name="L246" href="#L246">246</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L247" href="#L247">247</a> }
|
||||
<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
|
||||
<a class="jxr_linenumber" name="L249" href="#L249">249</a>
|
||||
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * Writes the related dependencies to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @return the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> writeSiteReportDependencyRelatedDependencies(Dependency d, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> (d.getRelatedDependencies() != <strong class="jxr_keyword">null</strong> && !d.getRelatedDependencies().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L261" href="#L261">261</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L262" href="#L262">262</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L263" href="#L263">263</a> sink.rawText(<span class="jxr_string">"Related Dependencies <a href=\"javascript:toggleElement(this, 'related"</span> + cnt + <span class="jxr_string">"')\">[+]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L264" href="#L264">264</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L265" href="#L265">265</a> sink.rawText(<span class="jxr_string">"<div id=\"related"</span> + cnt + <span class="jxr_string">"\" style=\"display:none\">"</span>);
|
||||
<a class="jxr_linenumber" name="L266" href="#L266">266</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">for</strong> (Dependency r : d.getRelatedDependencies()) {
|
||||
<a class="jxr_linenumber" name="L268" href="#L268">268</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L269" href="#L269">269</a> sink.text(r.getFileName());
|
||||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L271" href="#L271">271</a> writeListItem(sink, <span class="jxr_string">"File Path: "</span> + r.getFilePath());
|
||||
<a class="jxr_linenumber" name="L272" href="#L272">272</a> writeListItem(sink, <span class="jxr_string">"SHA1: "</span> + r.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L273" href="#L273">273</a> writeListItem(sink, <span class="jxr_string">"MD5: "</span> + r.getMd5sum());
|
||||
<a class="jxr_linenumber" name="L274" href="#L274">274</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L275" href="#L275">275</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
|
||||
<a class="jxr_linenumber" name="L277" href="#L277">277</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L278" href="#L278">278</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
|
||||
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">return</strong> cnt;
|
||||
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
|
||||
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
|
||||
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Writes the evidence used to the site report.</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> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @return the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> writeSiteReportDependencyEvidenceUsed(Dependency d, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">final</strong> Set<Evidence> evidence = d.getEvidenceForDisplay();
|
||||
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">if</strong> (evidence != <strong class="jxr_keyword">null</strong> && evidence.size() > 0) {
|
||||
<a class="jxr_linenumber" name="L295" href="#L295">295</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L296" href="#L296">296</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L297" href="#L297">297</a> sink.rawText(<span class="jxr_string">"Evidence Collected <a href=\"javascript:toggleElement(this, 'evidence"</span> + cnt + <span class="jxr_string">"')\">[+]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L298" href="#L298">298</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L299" href="#L299">299</a> sink.rawText(<span class="jxr_string">"<div id=\"evidence"</span> + cnt + <span class="jxr_string">"\" style=\"display:none\">"</span>);
|
||||
<a class="jxr_linenumber" name="L300" href="#L300">300</a> sink.table();
|
||||
<a class="jxr_linenumber" name="L301" href="#L301">301</a> sink.tableRow();
|
||||
<a class="jxr_linenumber" name="L302" href="#L302">302</a> writeTableHeaderCell(sink, <span class="jxr_string">"Source"</span>);
|
||||
<a class="jxr_linenumber" name="L303" href="#L303">303</a> writeTableHeaderCell(sink, <span class="jxr_string">"Name"</span>);
|
||||
<a class="jxr_linenumber" name="L304" href="#L304">304</a> writeTableHeaderCell(sink, <span class="jxr_string">"Value"</span>);
|
||||
<a class="jxr_linenumber" name="L305" href="#L305">305</a> sink.tableRow_();
|
||||
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">for</strong> (Evidence e : evidence) {
|
||||
<a class="jxr_linenumber" name="L307" href="#L307">307</a> sink.tableRow();
|
||||
<a class="jxr_linenumber" name="L308" href="#L308">308</a> writeTableCell(sink, e.getSource());
|
||||
<a class="jxr_linenumber" name="L309" href="#L309">309</a> writeTableCell(sink, e.getName());
|
||||
<a class="jxr_linenumber" name="L310" href="#L310">310</a> writeTableCell(sink, e.getValue());
|
||||
<a class="jxr_linenumber" name="L311" href="#L311">311</a> sink.tableRow_();
|
||||
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
|
||||
<a class="jxr_linenumber" name="L313" href="#L313">313</a> sink.table_();
|
||||
<a class="jxr_linenumber" name="L314" href="#L314">314</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
|
||||
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">return</strong> cnt;
|
||||
<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"> * Writes the dependency header to the site report.</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"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyHeader(Sink sink, Dependency d) {
|
||||
<a class="jxr_linenumber" name="L326" href="#L326">326</a> sink.sectionTitle2();
|
||||
<a class="jxr_linenumber" name="L327" href="#L327">327</a> sink.anchor(<span class="jxr_string">"sha1"</span> + d.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L328" href="#L328">328</a> sink.text(d.getFileName());
|
||||
<a class="jxr_linenumber" name="L329" href="#L329">329</a> sink.anchor_();
|
||||
<a class="jxr_linenumber" name="L330" href="#L330">330</a> sink.sectionTitle2_();
|
||||
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> (d.getDescription() != <strong class="jxr_keyword">null</strong> && d.getDescription().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L332" href="#L332">332</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L333" href="#L333">333</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L334" href="#L334">334</a> sink.text(<span class="jxr_string">"Description: "</span>);
|
||||
<a class="jxr_linenumber" name="L335" href="#L335">335</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L336" href="#L336">336</a> sink.text(d.getDescription());
|
||||
<a class="jxr_linenumber" name="L337" href="#L337">337</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L338" href="#L338">338</a> }
|
||||
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">if</strong> (d.getLicense() != <strong class="jxr_keyword">null</strong> && d.getLicense().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L340" href="#L340">340</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L341" href="#L341">341</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L342" href="#L342">342</a> sink.text(<span class="jxr_string">"License: "</span>);
|
||||
<a class="jxr_linenumber" name="L343" href="#L343">343</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (d.getLicense().startsWith(<span class="jxr_string">"http://"</span>) && !d.getLicense().contains(<span class="jxr_string">" "</span>)) {
|
||||
<a class="jxr_linenumber" name="L345" href="#L345">345</a> sink.link(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L346" href="#L346">346</a> sink.text(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L347" href="#L347">347</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L348" href="#L348">348</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L349" href="#L349">349</a> sink.text(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L350" href="#L350">350</a> }
|
||||
<a class="jxr_linenumber" name="L351" href="#L351">351</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
|
||||
<a class="jxr_linenumber" name="L353" href="#L353">353</a> }
|
||||
<a class="jxr_linenumber" name="L354" href="#L354">354</a>
|
||||
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> * Adds a list item to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeListItem(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a> }
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a>
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * Adds a table cell to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeTableCell(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> sink.tableCell();
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a> sink.tableCell_();
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a>
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * Adds a table header cell to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeTableHeaderCell(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> sink.tableHeaderCell();
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> sink.tableHeaderCell_();
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a> }
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</a>
|
||||
<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> <em class="jxr_javadoccomment"> * Writes the TOC for the site report.</em>
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * @param dependencies the dependencies that are being reported on</em>
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportTOC(Sink sink, <strong class="jxr_keyword">final</strong> List<Dependency> dependencies) {
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> sink.link(<span class="jxr_string">"#sha1"</span> + d.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> sink.text(d.getFileName());
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">if</strong> (!d.getVulnerabilities().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a> sink.rawText(<span class="jxr_string">" <font style=\"color:red\">•</font>"</span>);
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">if</strong> (!d.getRelatedDependencies().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L408" href="#L408">408</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">for</strong> (Dependency r : d.getRelatedDependencies()) {
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> writeListItem(sink, r.getFileName());
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a> }
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
|
||||
<a class="jxr_linenumber" name="L414" href="#L414">414</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> }
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a> }
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a>
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * Writes the site report header.</em>
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project</em>
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportHeader(Sink sink, String projectName) {
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> sink.head();
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a> sink.title();
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> sink.text(<span class="jxr_string">"Dependency-Check Report: "</span> + projectName);
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> sink.title_();
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a> sink.head_();
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> sink.body();
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> sink.rawText(<span class="jxr_string">"<script type=\"text/javascript\">"</span>);
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> sink.rawText(<span class="jxr_string">"function toggleElement(el, targetId) {"</span>);
|
||||
<a class="jxr_linenumber" name="L434" href="#L434">434</a> sink.rawText(<span class="jxr_string">"if (el.innerText == '[+]') {"</span>);
|
||||
<a class="jxr_linenumber" name="L435" href="#L435">435</a> sink.rawText(<span class="jxr_string">" el.innerText = '[-]';"</span>);
|
||||
<a class="jxr_linenumber" name="L436" href="#L436">436</a> sink.rawText(<span class="jxr_string">" document.getElementById(targetId).style.display='block';"</span>);
|
||||
<a class="jxr_linenumber" name="L437" href="#L437">437</a> sink.rawText(<span class="jxr_string">"} else {"</span>);
|
||||
<a class="jxr_linenumber" name="L438" href="#L438">438</a> sink.rawText(<span class="jxr_string">" el.innerText = '[+]';"</span>);
|
||||
<a class="jxr_linenumber" name="L439" href="#L439">439</a> sink.rawText(<span class="jxr_string">" document.getElementById(targetId).style.display='none';"</span>);
|
||||
<a class="jxr_linenumber" name="L440" href="#L440">440</a> sink.rawText(<span class="jxr_string">"}"</span>);
|
||||
<a class="jxr_linenumber" name="L441" href="#L441">441</a>
|
||||
<a class="jxr_linenumber" name="L442" href="#L442">442</a> sink.rawText(<span class="jxr_string">"}"</span>);
|
||||
<a class="jxr_linenumber" name="L443" href="#L443">443</a> sink.rawText(<span class="jxr_string">"</script>"</span>);
|
||||
<a class="jxr_linenumber" name="L444" href="#L444">444</a> sink.section1();
|
||||
<a class="jxr_linenumber" name="L445" href="#L445">445</a> sink.sectionTitle1();
|
||||
<a class="jxr_linenumber" name="L446" href="#L446">446</a> sink.text(<span class="jxr_string">"Project: "</span> + projectName);
|
||||
<a class="jxr_linenumber" name="L447" href="#L447">447</a> sink.sectionTitle1_();
|
||||
<a class="jxr_linenumber" name="L448" href="#L448">448</a> sink.date();
|
||||
<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">final</strong> Date now = <strong class="jxr_keyword">new</strong> Date();
|
||||
<a class="jxr_linenumber" name="L450" href="#L450">450</a> sink.text(DateFormat.getDateTimeInstance().format(now));
|
||||
<a class="jxr_linenumber" name="L451" href="#L451">451</a> sink.date_();
|
||||
<a class="jxr_linenumber" name="L452" href="#L452">452</a> sink.section1_();
|
||||
<a class="jxr_linenumber" name="L453" href="#L453">453</a> }
|
||||
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_comment">// </editor-fold></em>
|
||||
<a class="jxr_linenumber" name="L455" href="#L455">455</a>
|
||||
<a class="jxr_linenumber" name="L456" href="#L456">456</a> }
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.CveDB;
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
|
||||
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
|
||||
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
|
||||
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Evidence;
|
||||
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Identifier;
|
||||
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Reference;
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Vulnerability;
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.VulnerableSoftware;
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.reporting.ReportGenerator;
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
|
||||
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * A utility class that encapsulates the report generation for dependency-check-maven.</em>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @author Jeremy Long <jeremy.long@owasp.org></em>
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportingUtil.html">ReportingUtil</a> {
|
||||
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
|
||||
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Logger field reference.</em>
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(ReportingUtil.<strong class="jxr_keyword">class</strong>.getName());
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Empty private constructor for this utility class.</em>
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportingUtil.html">ReportingUtil</a>() {
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
|
||||
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Generates the reports for a given dependency-check engine.</em>
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @param engine a dependency-check engine</em>
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @param outDirectory the directory to write the reports to</em>
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project that a report is being generated for</em>
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param format the format of the report to generate</em>
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> generateExternalReports(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine, File outDirectory, String projectName, String format) {
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> DatabaseProperties prop = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> CveDB cve = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> cve = <strong class="jxr_keyword">new</strong> CveDB();
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> cve.open();
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> prop = cve.getDatabaseProperties();
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Unable to retrieve DB Properties"</span>, ex);
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (cve != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> cve.close();
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">final</strong> ReportGenerator r = <strong class="jxr_keyword">new</strong> ReportGenerator(projectName, engine.getDependencies(), engine.getAnalyzers(), prop);
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> r.generateReports(outDirectory.getCanonicalPath(), format);
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> LOGGER.log(Level.SEVERE,
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <span class="jxr_string">"Unexpected exception occurred during analysis; please see the verbose error log for more details."</span>);
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> LOGGER.log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (Throwable ex) {
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> LOGGER.log(Level.SEVERE,
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <span class="jxr_string">"Unexpected exception occurred during analysis; please see the verbose error log for more details."</span>);
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> LOGGER.log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Generates a dependency-check report using the Maven Site format.</em>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param engine the engine used to scan the dependencies</em>
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project</em>
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> generateMavenSiteReport(<strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine, Sink sink, String projectName) {
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> List<Dependency> dependencies = engine.getDependencies();
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> writeSiteReportHeader(sink, projectName);
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> writeSiteReportTOC(sink, dependencies);
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">int</strong> cnt = 0;
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> writeSiteReportDependencyHeader(sink, d);
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> cnt = writeSiteReportDependencyEvidenceUsed(d, cnt, sink);
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> cnt = writeSiteReportDependencyRelatedDependencies(d, cnt, sink);
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a> writeSiteReportDependencyIdentifiers(d, sink);
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> writeSiteReportDependencyVulnerabilities(d, sink, cnt);
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> sink.body_();
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_comment">// <editor-fold defaultstate="collapsed" desc="various writeXXXXX methods to generate the Site Report"></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> <em class="jxr_javadoccomment"> * Writes the vulnerabilities to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyVulnerabilities(Dependency d, Sink sink, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount) {
|
||||
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">if</strong> (d.getVulnerabilities() != <strong class="jxr_keyword">null</strong> && !d.getVulnerabilities().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">for</strong> (Vulnerability v : d.getVulnerabilities()) {
|
||||
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
|
||||
<a class="jxr_linenumber" name="L133" href="#L133">133</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L134" href="#L134">134</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L136" href="#L136">136</a> sink.link(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/detail?vulnId="</span> + URLEncoder.encode(v.getName(), <span class="jxr_string">"US-ASCII"</span>));
|
||||
<a class="jxr_linenumber" name="L137" href="#L137">137</a> sink.text(v.getName());
|
||||
<a class="jxr_linenumber" name="L138" href="#L138">138</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) {
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> sink.text(v.getName());
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> sink.text(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/detail?vulnId="</span> + v.getName());
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> sink.text(<span class="jxr_string">"Severity: "</span>);
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() < 4.0) {
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a> sink.text(<span class="jxr_string">"Low"</span>);
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() >= 7.0) {
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> sink.text(<span class="jxr_string">"High"</span>);
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> sink.text(<span class="jxr_string">"Medium"</span>);
|
||||
<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> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L159" href="#L159">159</a> sink.text(<span class="jxr_string">"CVSS Score: "</span> + v.getCvssScore());
|
||||
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (v.getCwe() != <strong class="jxr_keyword">null</strong> && !v.getCwe().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L162" href="#L162">162</a> sink.text(<span class="jxr_string">"CWE: "</span>);
|
||||
<a class="jxr_linenumber" name="L163" href="#L163">163</a> sink.text(v.getCwe());
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> sink.text(v.getDescription());
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (v.getReferences() != <strong class="jxr_keyword">null</strong> && !v.getReferences().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">for</strong> (Reference ref : v.getReferences()) {
|
||||
<a class="jxr_linenumber" name="L171" href="#L171">171</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L172" href="#L172">172</a> sink.text(ref.getSource());
|
||||
<a class="jxr_linenumber" name="L173" href="#L173">173</a> sink.text(<span class="jxr_string">" - "</span>);
|
||||
<a class="jxr_linenumber" name="L174" href="#L174">174</a> sink.link(ref.getUrl());
|
||||
<a class="jxr_linenumber" name="L175" href="#L175">175</a> sink.text(ref.getName());
|
||||
<a class="jxr_linenumber" name="L176" href="#L176">176</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L177" href="#L177">177</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
|
||||
<a class="jxr_linenumber" name="L179" href="#L179">179</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
|
||||
<a class="jxr_linenumber" name="L181" href="#L181">181</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (v.getVulnerableSoftware() != <strong class="jxr_keyword">null</strong> && !v.getVulnerableSoftware().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L183" href="#L183">183</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L184" href="#L184">184</a>
|
||||
<a class="jxr_linenumber" name="L185" href="#L185">185</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L186" href="#L186">186</a> sink.rawText(<span class="jxr_string">"Vulnerable Software <a href=\"javascript:toggleElement(this, 'vulnSoft"</span> + cnt + <span class="jxr_string">"')\">[-]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L187" href="#L187">187</a> sink.rawText(<span class="jxr_string">"<div id=\"vulnSoft"</span> + cnt + <span class="jxr_string">"\" style=\"display:block\">"</span>);
|
||||
<a class="jxr_linenumber" name="L188" href="#L188">188</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">for</strong> (VulnerableSoftware vs : v.getVulnerableSoftware()) {
|
||||
<a class="jxr_linenumber" name="L190" href="#L190">190</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L192" href="#L192">192</a> sink.link(<span class="jxr_string">"http://web.nvd.nist.gov/view/vuln/search-results?cpe="</span> + URLEncoder.encode(vs.getName(), <span class="jxr_string">"US-ASCII"</span>));
|
||||
<a class="jxr_linenumber" name="L193" href="#L193">193</a> sink.text(vs.getName());
|
||||
<a class="jxr_linenumber" name="L194" href="#L194">194</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> (vs.hasPreviousVersion()) {
|
||||
<a class="jxr_linenumber" name="L196" href="#L196">196</a> sink.text(<span class="jxr_string">" and all previous versions."</span>);
|
||||
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
|
||||
<a class="jxr_linenumber" name="L198" href="#L198">198</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) {
|
||||
<a class="jxr_linenumber" name="L199" href="#L199">199</a> sink.text(vs.getName());
|
||||
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> (vs.hasPreviousVersion()) {
|
||||
<a class="jxr_linenumber" name="L201" href="#L201">201</a> sink.text(<span class="jxr_string">" and all previous versions."</span>);
|
||||
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
|
||||
<a class="jxr_linenumber" name="L203" href="#L203">203</a> sink.text(<span class="jxr_string">" (http://web.nvd.nist.gov/view/vuln/search-results?cpe="</span> + vs.getName() + <span class="jxr_string">")"</span>);
|
||||
<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
|
||||
<a class="jxr_linenumber" name="L205" href="#L205">205</a>
|
||||
<a class="jxr_linenumber" name="L206" href="#L206">206</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
|
||||
<a class="jxr_linenumber" name="L208" href="#L208">208</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L209" href="#L209">209</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L210" href="#L210">210</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L211" href="#L211">211</a> }
|
||||
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
|
||||
<a class="jxr_linenumber" name="L213" href="#L213">213</a> }
|
||||
<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
|
||||
<a class="jxr_linenumber" name="L215" href="#L215">215</a>
|
||||
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Writes the identifiers to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyIdentifiers(Dependency d, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">if</strong> (d.getIdentifiers() != <strong class="jxr_keyword">null</strong> && !d.getIdentifiers().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L224" href="#L224">224</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L225" href="#L225">225</a> sink.text(<span class="jxr_string">"Identifiers"</span>);
|
||||
<a class="jxr_linenumber" name="L226" href="#L226">226</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L227" href="#L227">227</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">for</strong> (Identifier i : d.getIdentifiers()) {
|
||||
<a class="jxr_linenumber" name="L229" href="#L229">229</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L230" href="#L230">230</a> sink.text(i.getType());
|
||||
<a class="jxr_linenumber" name="L231" href="#L231">231</a> sink.text(<span class="jxr_string">": "</span>);
|
||||
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (i.getUrl() != <strong class="jxr_keyword">null</strong> && i.getUrl().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L233" href="#L233">233</a> sink.link(i.getUrl());
|
||||
<a class="jxr_linenumber" name="L234" href="#L234">234</a> sink.text(i.getValue());
|
||||
<a class="jxr_linenumber" name="L235" href="#L235">235</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L237" href="#L237">237</a> sink.text(i.getValue());
|
||||
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
|
||||
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">if</strong> (i.getDescription() != <strong class="jxr_keyword">null</strong> && i.getDescription().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L240" href="#L240">240</a> sink.lineBreak();
|
||||
<a class="jxr_linenumber" name="L241" href="#L241">241</a> sink.text(i.getDescription());
|
||||
<a class="jxr_linenumber" name="L242" href="#L242">242</a> }
|
||||
<a class="jxr_linenumber" name="L243" href="#L243">243</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
|
||||
<a class="jxr_linenumber" name="L245" href="#L245">245</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
|
||||
<a class="jxr_linenumber" name="L247" href="#L247">247</a> }
|
||||
<a class="jxr_linenumber" name="L248" href="#L248">248</a>
|
||||
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * Writes the related dependencies to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @return the collapsible header count</em>
|
||||
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> writeSiteReportDependencyRelatedDependencies(Dependency d, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">if</strong> (d.getRelatedDependencies() != <strong class="jxr_keyword">null</strong> && !d.getRelatedDependencies().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L260" href="#L260">260</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L261" href="#L261">261</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L262" href="#L262">262</a> sink.rawText(<span class="jxr_string">"Related Dependencies <a href=\"javascript:toggleElement(this, 'related"</span> + cnt + <span class="jxr_string">"')\">[+]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L263" href="#L263">263</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L264" href="#L264">264</a> sink.rawText(<span class="jxr_string">"<div id=\"related"</span> + cnt + <span class="jxr_string">"\" style=\"display:none\">"</span>);
|
||||
<a class="jxr_linenumber" name="L265" href="#L265">265</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">for</strong> (Dependency r : d.getRelatedDependencies()) {
|
||||
<a class="jxr_linenumber" name="L267" href="#L267">267</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L268" href="#L268">268</a> sink.text(r.getFileName());
|
||||
<a class="jxr_linenumber" name="L269" href="#L269">269</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> writeListItem(sink, <span class="jxr_string">"File Path: "</span> + r.getFilePath());
|
||||
<a class="jxr_linenumber" name="L271" href="#L271">271</a> writeListItem(sink, <span class="jxr_string">"SHA1: "</span> + r.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L272" href="#L272">272</a> writeListItem(sink, <span class="jxr_string">"MD5: "</span> + r.getMd5sum());
|
||||
<a class="jxr_linenumber" name="L273" href="#L273">273</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L274" href="#L274">274</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L275" href="#L275">275</a> }
|
||||
<a class="jxr_linenumber" name="L276" href="#L276">276</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L277" href="#L277">277</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
|
||||
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">return</strong> cnt;
|
||||
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
|
||||
<a class="jxr_linenumber" name="L281" href="#L281">281</a>
|
||||
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * Writes the evidence used to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param collapsibleHeaderCount the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @return the collapsible header count</em>
|
||||
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> writeSiteReportDependencyEvidenceUsed(Dependency d, <strong class="jxr_keyword">int</strong> collapsibleHeaderCount, Sink sink) {
|
||||
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">int</strong> cnt = collapsibleHeaderCount;
|
||||
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">final</strong> Set<Evidence> evidence = d.getEvidenceForDisplay();
|
||||
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">if</strong> (evidence != <strong class="jxr_keyword">null</strong> && evidence.size() > 0) {
|
||||
<a class="jxr_linenumber" name="L294" href="#L294">294</a> cnt += 1;
|
||||
<a class="jxr_linenumber" name="L295" href="#L295">295</a> sink.sectionTitle4();
|
||||
<a class="jxr_linenumber" name="L296" href="#L296">296</a> sink.rawText(<span class="jxr_string">"Evidence Collected <a href=\"javascript:toggleElement(this, 'evidence"</span> + cnt + <span class="jxr_string">"')\">[+]</a>"</span>);
|
||||
<a class="jxr_linenumber" name="L297" href="#L297">297</a> sink.sectionTitle4_();
|
||||
<a class="jxr_linenumber" name="L298" href="#L298">298</a> sink.rawText(<span class="jxr_string">"<div id=\"evidence"</span> + cnt + <span class="jxr_string">"\" style=\"display:none\">"</span>);
|
||||
<a class="jxr_linenumber" name="L299" href="#L299">299</a> sink.table();
|
||||
<a class="jxr_linenumber" name="L300" href="#L300">300</a> sink.tableRow();
|
||||
<a class="jxr_linenumber" name="L301" href="#L301">301</a> writeTableHeaderCell(sink, <span class="jxr_string">"Source"</span>);
|
||||
<a class="jxr_linenumber" name="L302" href="#L302">302</a> writeTableHeaderCell(sink, <span class="jxr_string">"Name"</span>);
|
||||
<a class="jxr_linenumber" name="L303" href="#L303">303</a> writeTableHeaderCell(sink, <span class="jxr_string">"Value"</span>);
|
||||
<a class="jxr_linenumber" name="L304" href="#L304">304</a> sink.tableRow_();
|
||||
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">for</strong> (Evidence e : evidence) {
|
||||
<a class="jxr_linenumber" name="L306" href="#L306">306</a> sink.tableRow();
|
||||
<a class="jxr_linenumber" name="L307" href="#L307">307</a> writeTableCell(sink, e.getSource());
|
||||
<a class="jxr_linenumber" name="L308" href="#L308">308</a> writeTableCell(sink, e.getName());
|
||||
<a class="jxr_linenumber" name="L309" href="#L309">309</a> writeTableCell(sink, e.getValue());
|
||||
<a class="jxr_linenumber" name="L310" href="#L310">310</a> sink.tableRow_();
|
||||
<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
|
||||
<a class="jxr_linenumber" name="L312" href="#L312">312</a> sink.table_();
|
||||
<a class="jxr_linenumber" name="L313" href="#L313">313</a> sink.rawText(<span class="jxr_string">"</div>"</span>);
|
||||
<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
|
||||
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">return</strong> cnt;
|
||||
<a class="jxr_linenumber" name="L316" href="#L316">316</a> }
|
||||
<a class="jxr_linenumber" name="L317" href="#L317">317</a>
|
||||
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * Writes the dependency header to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * @param d the dependency</em>
|
||||
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</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">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportDependencyHeader(Sink sink, Dependency d) {
|
||||
<a class="jxr_linenumber" name="L325" href="#L325">325</a> sink.sectionTitle2();
|
||||
<a class="jxr_linenumber" name="L326" href="#L326">326</a> sink.anchor(<span class="jxr_string">"sha1"</span> + d.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L327" href="#L327">327</a> sink.text(d.getFileName());
|
||||
<a class="jxr_linenumber" name="L328" href="#L328">328</a> sink.anchor_();
|
||||
<a class="jxr_linenumber" name="L329" href="#L329">329</a> sink.sectionTitle2_();
|
||||
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">if</strong> (d.getDescription() != <strong class="jxr_keyword">null</strong> && d.getDescription().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L331" href="#L331">331</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L332" href="#L332">332</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L333" href="#L333">333</a> sink.text(<span class="jxr_string">"Description: "</span>);
|
||||
<a class="jxr_linenumber" name="L334" href="#L334">334</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L335" href="#L335">335</a> sink.text(d.getDescription());
|
||||
<a class="jxr_linenumber" name="L336" href="#L336">336</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
|
||||
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">if</strong> (d.getLicense() != <strong class="jxr_keyword">null</strong> && d.getLicense().length() > 0) {
|
||||
<a class="jxr_linenumber" name="L339" href="#L339">339</a> sink.paragraph();
|
||||
<a class="jxr_linenumber" name="L340" href="#L340">340</a> sink.bold();
|
||||
<a class="jxr_linenumber" name="L341" href="#L341">341</a> sink.text(<span class="jxr_string">"License: "</span>);
|
||||
<a class="jxr_linenumber" name="L342" href="#L342">342</a> sink.bold_();
|
||||
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">if</strong> (d.getLicense().startsWith(<span class="jxr_string">"http://"</span>) && !d.getLicense().contains(<span class="jxr_string">" "</span>)) {
|
||||
<a class="jxr_linenumber" name="L344" href="#L344">344</a> sink.link(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L345" href="#L345">345</a> sink.text(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L346" href="#L346">346</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L347" href="#L347">347</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L348" href="#L348">348</a> sink.text(d.getLicense());
|
||||
<a class="jxr_linenumber" name="L349" href="#L349">349</a> }
|
||||
<a class="jxr_linenumber" name="L350" href="#L350">350</a> sink.paragraph_();
|
||||
<a class="jxr_linenumber" name="L351" href="#L351">351</a> }
|
||||
<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
|
||||
<a class="jxr_linenumber" name="L353" href="#L353">353</a>
|
||||
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * Adds a list item to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeListItem(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a>
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * Adds a table cell to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeTableCell(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a> sink.tableCell();
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> sink.tableCell_();
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * Adds a table header cell to the site report.</em>
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @param text the text to write</em>
|
||||
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeTableHeaderCell(Sink sink, String text) {
|
||||
<a class="jxr_linenumber" name="L385" href="#L385">385</a> sink.tableHeaderCell();
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> sink.text(text);
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a> sink.tableHeaderCell_();
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> }
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a>
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * Writes the TOC for the site report.</em>
|
||||
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @param dependencies the dependencies that are being reported on</em>
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportTOC(Sink sink, <strong class="jxr_keyword">final</strong> List<Dependency> dependencies) {
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> sink.listItem();
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> sink.link(<span class="jxr_string">"#sha1"</span> + d.getSha1sum());
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> sink.text(d.getFileName());
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> sink.link_();
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">if</strong> (!d.getVulnerabilities().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> sink.rawText(<span class="jxr_string">" <font style=\"color:red\">•</font>"</span>);
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">if</strong> (!d.getRelatedDependencies().isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</a> sink.list();
|
||||
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">for</strong> (Dependency r : d.getRelatedDependencies()) {
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> writeListItem(sink, r.getFileName());
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> }
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> }
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</a> sink.listItem_();
|
||||
<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> sink.list_();
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a>
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * Writes the site report header.</em>
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @param sink the sink to write the data to</em>
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @param projectName the name of the project</em>
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeSiteReportHeader(Sink sink, String projectName) {
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> sink.head();
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> sink.title();
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a> sink.text(<span class="jxr_string">"Dependency-Check Report: "</span> + projectName);
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> sink.title_();
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> sink.head_();
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a> sink.body();
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> sink.rawText(<span class="jxr_string">"<script type=\"text/javascript\">"</span>);
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> sink.rawText(<span class="jxr_string">"function toggleElement(el, targetId) {"</span>);
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> sink.rawText(<span class="jxr_string">"if (el.innerText == '[+]') {"</span>);
|
||||
<a class="jxr_linenumber" name="L434" href="#L434">434</a> sink.rawText(<span class="jxr_string">" el.innerText = '[-]';"</span>);
|
||||
<a class="jxr_linenumber" name="L435" href="#L435">435</a> sink.rawText(<span class="jxr_string">" document.getElementById(targetId).style.display='block';"</span>);
|
||||
<a class="jxr_linenumber" name="L436" href="#L436">436</a> sink.rawText(<span class="jxr_string">"} else {"</span>);
|
||||
<a class="jxr_linenumber" name="L437" href="#L437">437</a> sink.rawText(<span class="jxr_string">" el.innerText = '[+]';"</span>);
|
||||
<a class="jxr_linenumber" name="L438" href="#L438">438</a> sink.rawText(<span class="jxr_string">" document.getElementById(targetId).style.display='none';"</span>);
|
||||
<a class="jxr_linenumber" name="L439" href="#L439">439</a> sink.rawText(<span class="jxr_string">"}"</span>);
|
||||
<a class="jxr_linenumber" name="L440" href="#L440">440</a>
|
||||
<a class="jxr_linenumber" name="L441" href="#L441">441</a> sink.rawText(<span class="jxr_string">"}"</span>);
|
||||
<a class="jxr_linenumber" name="L442" href="#L442">442</a> sink.rawText(<span class="jxr_string">"</script>"</span>);
|
||||
<a class="jxr_linenumber" name="L443" href="#L443">443</a> sink.section1();
|
||||
<a class="jxr_linenumber" name="L444" href="#L444">444</a> sink.sectionTitle1();
|
||||
<a class="jxr_linenumber" name="L445" href="#L445">445</a> sink.text(<span class="jxr_string">"Project: "</span> + projectName);
|
||||
<a class="jxr_linenumber" name="L446" href="#L446">446</a> sink.sectionTitle1_();
|
||||
<a class="jxr_linenumber" name="L447" href="#L447">447</a> sink.date();
|
||||
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">final</strong> Date now = <strong class="jxr_keyword">new</strong> Date();
|
||||
<a class="jxr_linenumber" name="L449" href="#L449">449</a> sink.text(DateFormat.getDateTimeInstance().format(now));
|
||||
<a class="jxr_linenumber" name="L450" href="#L450">450</a> sink.date_();
|
||||
<a class="jxr_linenumber" name="L451" href="#L451">451</a> sink.section1_();
|
||||
<a class="jxr_linenumber" name="L452" href="#L452">452</a> }
|
||||
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_comment">// </editor-fold></em>
|
||||
<a class="jxr_linenumber" name="L454" href="#L454">454</a>
|
||||
<a class="jxr_linenumber" name="L455" href="#L455">455</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2013–2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
|
||||
@@ -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 Maven Plugin 1.2.6 Reference Package org.owasp.dependencycheck.maven</title>
|
||||
<title>Dependency-Check Maven Plugin 1.2.7 Reference Package org.owasp.dependencycheck.maven</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
@@ -17,6 +17,9 @@
|
||||
<ul>
|
||||
<li>
|
||||
<a href="DependencyCheckMojo.html" target="classFrame">DependencyCheckMojo</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Engine.html" target="classFrame">Engine</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="HelpMojo.html" target="classFrame">HelpMojo</a>
|
||||
|
||||
@@ -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 Maven Plugin 1.2.6 Reference Package org.owasp.dependencycheck.maven</title>
|
||||
<title>Dependency-Check Maven Plugin 1.2.7 Reference Package org.owasp.dependencycheck.maven</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
@@ -39,6 +39,11 @@
|
||||
<td>
|
||||
<a href="DependencyCheckMojo.html" target="classFrame">DependencyCheckMojo</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="Engine.html" target="classFrame">Engine</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
Reference in New Issue
Block a user