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

cleaned up site

Browse Source
This commit is contained in:
Jeremy Long
2015-05-12 07:59:22 -04:00
parent 9194a42c93
commit 1359cc70b6
1855 changed files with 0 additions and 435840 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
dependency-check-maven/xref/allclasses-frame.html
View File

@@ -1,35 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>All Classes</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
<h3>All Classes</h3>
<ul>
<li>
<a href="org/owasp/dependencycheck/maven/AggregateMojo.html" target="classFrame">AggregateMojo</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html" target="classFrame">BaseDependencyCheckMojo</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/CheckMojo.html" target="classFrame">CheckMojo</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/Engine.html" target="classFrame">Engine</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/HelpMojo.html" target="classFrame">HelpMojo</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/UpdateMojo.html" target="classFrame">UpdateMojo</a>
</li>
</ul>
</body>
</html>

25
dependency-check-maven/xref/index.html
View File

@@ -1,25 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xml:lang="en" lang="en">
<!-- this is a JXR report set -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.2.10 Reference</title>
</head>
<frameset cols="20%,80%">
<frameset rows="30%,70%">
<frame src="overview-frame.html" name="packageListFrame" />
<frame src="allclasses-frame.html" name="packageFrame" />
</frameset>
<frame src="overview-summary.html" name="classFrame" />
<noframes>
<body>
<h1>Frame Alert</h1>
<p>
You don't have frames. Go <a href="overview-summary.html">here</a>
</p>
</body>
</noframes>
</frameset>
</html>

277
dependency-check-maven/xref/org/owasp/dependencycheck/maven/AggregateMojo.html
View File

@@ -1,277 +0,0 @@
<!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>AggregateMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/AggregateMojo.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) 2013 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.io.File;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<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.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<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"> * Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * vulnerabilities.</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</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> @Mojo(
<a class="jxr_linenumber" name="L49" href="#L49">49</a> name = <span class="jxr_string">"aggregate"</span>,
<a class="jxr_linenumber" name="L50" href="#L50">50</a> defaultPhase = LifecyclePhase.SITE,
<a class="jxr_linenumber" name="L51" href="#L51">51</a> aggregator = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L52" href="#L52">52</a> threadSafe = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L53" href="#L53">53</a> requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
<a class="jxr_linenumber" name="L54" href="#L54">54</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> )
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/AggregateMojo.html">AggregateMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Logger field reference.</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(AggregateMojo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<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"> * Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is ane exception running the mojo</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to fail the build</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> @Override
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine = generateDataFile();
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (getProject() == getReactorProjects().get(getReactorProjects().size() - 1)) {
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">//ensure that the .ser file was created for each.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">for</strong> (MavenProject current : getReactorProjects()) {
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">final</strong> File dataFile = getDataFile(current);
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (dataFile == <strong class="jxr_keyword">null</strong>) { <em class="jxr_comment">//dc was never run on this project. write the ser to the target.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> LOGGER.fine(String.format(<span class="jxr_string">"Executing dependency-check on %s"</span>, current.getName()));
<a class="jxr_linenumber" name="L80" href="#L80">80</a> generateDataFile(engine, current);
<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>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">for</strong> (MavenProject current : getReactorProjects()) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> List&lt;Dependency&gt; dependencies = readDataFile(current);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (dependencies == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> dependencies = <strong class="jxr_keyword">new</strong> ArrayList&lt;Dependency&gt;();
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; childProjects = getDescendants(current);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">for</strong> (MavenProject reportOn : childProjects) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; childDeps = readDataFile(reportOn);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">if</strong> (childDeps != <strong class="jxr_keyword">null</strong> &amp;&amp; !childDeps.isEmpty()) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> LOGGER.fine(String.format(<span class="jxr_string">"Adding %d dependencies from %s"</span>, childDeps.size(), reportOn.getName()));
<a class="jxr_linenumber" name="L94" href="#L94">94</a> dependencies.addAll(childDeps);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> LOGGER.fine(String.format(<span class="jxr_string">"No dependencies read for %s"</span>, reportOn.getName()));
<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> engine.getDependencies().clear();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> engine.getDependencies().addAll(dependencies);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">final</strong> DependencyBundlingAnalyzer bundler = <strong class="jxr_keyword">new</strong> DependencyBundlingAnalyzer();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> LOGGER.fine(String.format(<span class="jxr_string">"Dependency count pre-bundler: %s"</span>, engine.getDependencies().size()));
<a class="jxr_linenumber" name="L104" href="#L104">104</a> bundler.analyze(<strong class="jxr_keyword">null</strong>, engine);
<a class="jxr_linenumber" name="L105" href="#L105">105</a> LOGGER.fine(String.format(<span class="jxr_string">"Dependency count post-bundler: %s"</span>, engine.getDependencies().size()));
<a class="jxr_linenumber" name="L106" href="#L106">106</a> } <strong class="jxr_keyword">catch</strong> (AnalysisException ex) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> LOGGER.log(Level.WARNING, <span class="jxr_string">"An error occured grouping the dependencies; duplicate entries may exist in the report"</span>, ex);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Bundling Exception"</span>, ex);
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> File outputDir = getCorrectOutputDirectory(current);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> (outputDir == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_comment">//in some regards we shouldn't be writting this, but we are anyway.</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_comment">//we shouldn't write this because nothing is configured to generate this report.</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> outputDir = <strong class="jxr_keyword">new</strong> File(current.getBuild().getDirectory());
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> writeReports(engine, current, outputDir);
<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> engine.cleanup();
<a class="jxr_linenumber" name="L121" href="#L121">121</a> Settings.cleanup();
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
<a class="jxr_linenumber" name="L123" href="#L123">123</a>
<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"> * Returns a set containing all the descendant projects of the given project.</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @param project the project for which all descendants will be returned</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * @return the set of descendant projects</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">protected</strong> Set&lt;MavenProject&gt; getDescendants(MavenProject project) {
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (project == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> Collections.emptySet();
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; descendants = <strong class="jxr_keyword">new</strong> HashSet&lt;MavenProject&gt;();
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">int</strong> size = 0;
<a class="jxr_linenumber" name="L136" href="#L136">136</a> LOGGER.fine(String.format(<span class="jxr_string">"Collecting descendants of %s"</span>, project.getName()));
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">for</strong> (String m : project.getModules()) {
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">for</strong> (MavenProject mod : getReactorProjects()) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> File mpp = <strong class="jxr_keyword">new</strong> File(project.getBasedir(), m);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(mod.getBasedir()) == 0) {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (descendants.add(mod)) {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> LOGGER.fine(String.format(<span class="jxr_string">"Decendent module %s added"</span>, mod.getName()));
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
<a class="jxr_linenumber" name="L147" href="#L147">147</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
<a class="jxr_linenumber" name="L150" href="#L150">150</a> }
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> size = descendants.size();
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">for</strong> (MavenProject p : getReactorProjects()) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (project.equals(p.getParent()) || descendants.contains(p.getParent())) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> (descendants.add(p)) {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> LOGGER.fine(String.format(<span class="jxr_string">"Decendent %s added"</span>, p.getName()));
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">for</strong> (MavenProject modTest : getReactorProjects()) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (p.getModules() != <strong class="jxr_keyword">null</strong> &amp;&amp; p.getModules().contains(modTest.getName())) {
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> (descendants.add(modTest)) {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> LOGGER.fine(String.format(<span class="jxr_string">"Decendent %s added"</span>, modTest.getName()));
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
<a class="jxr_linenumber" name="L165" href="#L165">165</a> }
<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">for</strong> (MavenProject dec : descendants) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">for</strong> (String mod : dec.getModules()) {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> File mpp = <strong class="jxr_keyword">new</strong> File(dec.getBasedir(), mod);
<a class="jxr_linenumber" name="L171" href="#L171">171</a> mpp = mpp.getCanonicalFile();
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> (mpp.compareTo(p.getBasedir()) == 0) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (descendants.add(p)) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> LOGGER.fine(String.format(<span class="jxr_string">"Decendent module %s added"</span>, p.getName()));
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Unable to determine module path"</span>, ex);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
<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> } <strong class="jxr_keyword">while</strong> (size != 0 &amp;&amp; size != descendants.size());
<a class="jxr_linenumber" name="L184" href="#L184">184</a> LOGGER.fine(String.format(<span class="jxr_string">"%s has %d children"</span>, project, descendants.size()));
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">return</strong> descendants;
<a class="jxr_linenumber" name="L186" href="#L186">186</a> }
<a class="jxr_linenumber" name="L187" href="#L187">187</a>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * Test if the project has pom packaging</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @param mavenProject Project to test</em>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if it has a pom packaging; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMultiModule(MavenProject mavenProject) {
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pom"</span>.equals(mavenProject.getPackaging());
<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
<a class="jxr_linenumber" name="L197" href="#L197">197</a>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @return the Engine used to execute dependency-check</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception running the mojo</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.</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">protected</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> generateDataFile() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine;
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L208" href="#L208">208</a> engine = initializeEngine();
<a class="jxr_linenumber" name="L209" href="#L209">209</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Database connection error"</span>, ex);
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"An exception occured connecting to the local database. Please see the log file for more details."</span>, ex);
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> generateDataFile(engine, getProject());
<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"> * Runs dependency-check's Engine and writes the serialized dependencies to disk.</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 engine the Engine to use when scanning.</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @param project the project to scan and generate the data file for</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @return the Engine used to execute dependency-check</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception running the mojo</em>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.</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> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> generateDataFile(<a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine, MavenProject project) <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L226" href="#L226">226</a> LOGGER.fine(String.format(<span class="jxr_string">"Begin Scanning: %s"</span>, project.getName()));
<a class="jxr_linenumber" name="L227" href="#L227">227</a> engine.getDependencies().clear();
<a class="jxr_linenumber" name="L228" href="#L228">228</a> engine.resetFileTypeAnalyzers();
<a class="jxr_linenumber" name="L229" href="#L229">229</a> scanArtifacts(project, engine);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">final</strong> File target = <strong class="jxr_keyword">new</strong> File(project.getBuild().getDirectory());
<a class="jxr_linenumber" name="L232" href="#L232">232</a> writeDataFile(project, target, engine.getDependencies());
<a class="jxr_linenumber" name="L233" href="#L233">233</a> showSummary(project, engine.getDependencies());
<a class="jxr_linenumber" name="L234" href="#L234">234</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">return</strong> engine;
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> @Override
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; <em class="jxr_comment">//aggregate always returns true for now - we can look at a more complicated/acurate solution later</em>
<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"> * Returns the report name.</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 location</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @return the report name</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">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check:aggregate"</span>;
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates an aggregate report of all child Maven projects providing details on any "</span>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> + <span class="jxr_string">"published vulnerabilities within project dependencies. This report is a best "</span>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> + <span class="jxr_string">"effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

1051
dependency-check-maven/xref/org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html
View File

File diff suppressed because it is too large Load Diff

131
dependency-check-maven/xref/org/owasp/dependencycheck/maven/CheckMojo.html
View File

@@ -1,131 +0,0 @@
<!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>CheckMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/CheckMojo.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) 2013 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.Locale;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<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> <em class="jxr_javadoccomment"> * Maven Plugin that checks the project dependencies to see if they have any known published vulnerabilities.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> @Mojo(
<a class="jxr_linenumber" name="L38" href="#L38">38</a> name = <span class="jxr_string">"check"</span>,
<a class="jxr_linenumber" name="L39" href="#L39">39</a> defaultPhase = LifecyclePhase.COMPILE,
<a class="jxr_linenumber" name="L40" href="#L40">40</a> threadSafe = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L41" href="#L41">41</a> requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
<a class="jxr_linenumber" name="L42" href="#L42">42</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> )
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/CheckMojo.html">CheckMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<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> <em class="jxr_javadoccomment"> * Logger field reference.</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(CheckMojo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<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> <em class="jxr_javadoccomment"> * Returns whether or not a the report can be generated.</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> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if the report can be generated; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<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> @Override
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">boolean</strong> isCapable = false;
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">for</strong> (Artifact a : getProject().getArtifacts()) {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">if</strong> (!excludeFromScan(a)) {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> isCapable = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">break</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> <strong class="jxr_keyword">return</strong> isCapable;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<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"> * Executes the dependency-check engine on the project's dependencies and generates the report.</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> <em class="jxr_javadoccomment"> * @throws MojoExecutionException thrown if there is an exception executing the goal</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to fail the build</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> @Override
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> engine = initializeEngine();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Database connection error"</span>, ex);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"An exception occured connecting to the local database. Please see the log file for more details."</span>, ex);
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
<a class="jxr_linenumber" name="L83" href="#L83">83</a> scanArtifacts(getProject(), engine);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (engine.getDependencies().isEmpty()) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> LOGGER.info(<span class="jxr_string">"No dependencies were identified that could be analyzed by dependency-check"</span>);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> engine.analyzeDependencies();
<a class="jxr_linenumber" name="L88" href="#L88">88</a> writeReports(engine, getProject(), getCorrectOutputDirectory());
<a class="jxr_linenumber" name="L89" href="#L89">89</a> writeDataFile(getProject(), <strong class="jxr_keyword">null</strong>, engine.getDependencies());
<a class="jxr_linenumber" name="L90" href="#L90">90</a> showSummary(getProject(), engine.getDependencies());
<a class="jxr_linenumber" name="L91" href="#L91">91</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> engine.cleanup();
<a class="jxr_linenumber" name="L94" href="#L94">94</a> Settings.cleanup();
<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"> * Returns the report name.</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 locale the location</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @return the report name</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">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check"</span>;
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @return the description</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> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Generates a report providing details on any published vulnerabilities within project dependencies. "</span>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> + <span class="jxr_string">"This report is a best effort and may contain false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

963
dependency-check-maven/xref/org/owasp/dependencycheck/maven/DependencyCheckMojo.html
View File

@@ -1,963 +0,0 @@
<!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>DependencyCheckMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/DependencyCheckMojo.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) 2013 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.io.BufferedOutputStream;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.ObjectInputStream;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Proxy;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.exception.AnalysisException;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nexus.MavenArtifact;
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Confidence;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Identifier;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Vulnerability;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.LogUtils;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<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> <em class="jxr_javadoccomment"> * Maven Plugin that checks project dependencies to see if they have any known published vulnerabilities.</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @author Jeremy Long &lt;jeremy.long@owasp.org&gt;</em>
<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> @Mojo(
<a class="jxr_linenumber" name="L63" href="#L63">63</a> name = <span class="jxr_string">"check"</span>,
<a class="jxr_linenumber" name="L64" href="#L64">64</a> defaultPhase = LifecyclePhase.COMPILE,
<a class="jxr_linenumber" name="L65" href="#L65">65</a> threadSafe = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L66" href="#L66">66</a> requiresDependencyResolution = ResolutionScope.RUNTIME_PLUS_SYSTEM,
<a class="jxr_linenumber" name="L67" href="#L67">67</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> )
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/DependencyCheckMojo.html">DependencyCheckMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html">ReportAggregationMojo</a> {
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="Private fields"&gt;</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Logger field reference.</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(DependencyCheckMojo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * The properties file location.</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROPERTIES_FILE = <span class="jxr_string">"mojo.properties"</span>;
<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> <em class="jxr_javadoccomment"> * Name of the logging properties file.</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LOG_PROPERTIES_FILE = <span class="jxr_string">"log.properties"</span>;
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * System specific new line character.</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NEW_LINE = System.getProperty(<span class="jxr_string">"line.separator"</span>, <span class="jxr_string">"\n"</span>).intern();
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * The dependency-check engine used to scan the project.</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">// &lt;editor-fold defaultstate="collapsed" desc="Maven bound parameters and components"&gt;</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * The path to the verbose log.</em>
<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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L99" href="#L99">99</a> @Parameter(property = <span class="jxr_string">"logFile"</span>, defaultValue = <span class="jxr_string">""</span>)
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> String logFile = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * The output directory. This generally maps to "target".</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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">private</strong> File outputDirectory;
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * which means since the CVSS scores are 0-10, by default the build will never fail.</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L111" href="#L111">111</a> @Parameter(property = <span class="jxr_string">"failBuildOnCVSS"</span>, defaultValue = <span class="jxr_string">"11"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">float</strong> failBuildOnCVSS = 11;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * false. Default is true.</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L118" href="#L118">118</a> @Parameter(property = <span class="jxr_string">"autoupdate"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> autoUpdate = <strong class="jxr_keyword">true</strong>;
<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"> * The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * within the Site plug-in unless the externalReport is set to true. Default is HTML.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Parameter(property = <span class="jxr_string">"format"</span>, defaultValue = <span class="jxr_string">"HTML"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> String format = <span class="jxr_string">"HTML"</span>;
<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> <em class="jxr_javadoccomment"> * The Maven settings.</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> @Parameter(property = <span class="jxr_string">"mavenSettings"</span>, defaultValue = <span class="jxr_string">"${settings}"</span>, required = false)
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">private</strong> org.apache.maven.settings.Settings mavenSettings;
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * The maven settings proxy id.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Parameter(property = <span class="jxr_string">"mavenSettingsProxyId"</span>, required = false)
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">private</strong> String mavenSettingsProxyId;
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * The Connection Timeout.</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Parameter(property = <span class="jxr_string">"connectionTimeout"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> String connectionTimeout = <strong class="jxr_keyword">null</strong>;
<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"> * The path to the suppression file.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter(property = <span class="jxr_string">"suppressionFile"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> String suppressionFile = <strong class="jxr_keyword">null</strong>;
<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> <em class="jxr_javadoccomment"> * Flag indicating whether or not to show a summary in the output.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L156" href="#L156">156</a> @Parameter(property = <span class="jxr_string">"showSummary"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> showSummary = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L158" href="#L158">158</a>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * Whether or not the Jar Analyzer is enabled.</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L163" href="#L163">163</a> @Parameter(property = <span class="jxr_string">"jarAnalyzerEnabled"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> jarAnalyzerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L165" href="#L165">165</a>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * Whether or not the Archive Analyzer is enabled.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Parameter(property = <span class="jxr_string">"archiveAnalyzerEnabled"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> archiveAnalyzerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<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"> * Whether or not the .NET Assembly Analyzer is enabled.</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L177" href="#L177">177</a> @Parameter(property = <span class="jxr_string">"assemblyAnalyzerEnabled"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> assemblyAnalyzerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * Whether or not the .NET Nuspec Analyzer is enabled.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L184" href="#L184">184</a> @Parameter(property = <span class="jxr_string">"nuspecAnalyzerEnabled"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> nuspecAnalyzerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L186" href="#L186">186</a>
<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"> * Whether or not the Nexus Analyzer is enabled.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L191" href="#L191">191</a> @Parameter(property = <span class="jxr_string">"nexusAnalyzerEnabled"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> nexusAnalyzerEnabled = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * Whether or not the Nexus Analyzer is enabled.</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> @Parameter(property = <span class="jxr_string">"nexusUrl"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">private</strong> String nexusUrl;
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * Whether or not the configured proxy is used to connect to Nexus.</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> @Parameter(property = <span class="jxr_string">"nexusUsesProxy"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> nexusUsesProxy = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * The database connection string.</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> @Parameter(property = <span class="jxr_string">"connectionString"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">private</strong> String connectionString;
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * The database driver name. An example would be org.h2.Driver.</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> @Parameter(property = <span class="jxr_string">"databaseDriverName"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">private</strong> String databaseDriverName;
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * The path to the database driver if it is not on the class path.</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> @Parameter(property = <span class="jxr_string">"databaseDriverPath"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">private</strong> String databaseDriverPath;
<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"> * The database user name.</em>
<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> @Parameter(property = <span class="jxr_string">"databaseUser"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">private</strong> String databaseUser;
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * The password to use when connecting to the database.</em>
<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> @Parameter(property = <span class="jxr_string">"databasePassword"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">private</strong> String databasePassword;
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * A comma-separated list of file extensions to add to analysis next to jar, zip, ....</em>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> @Parameter(property = <span class="jxr_string">"zipExtensions"</span>, required = false)
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">private</strong> String zipExtensions;
<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"> * Skip Analysis for Test Scope Dependencies.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L237" href="#L237">237</a> @Parameter(property = <span class="jxr_string">"skipTestScope"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = false)
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipTestScope = <strong class="jxr_keyword">true</strong>;
<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"> * Skip Analysis for Runtime Scope Dependencies.</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L243" href="#L243">243</a> @Parameter(property = <span class="jxr_string">"skipRuntimeScope"</span>, defaultValue = <span class="jxr_string">"false"</span>, required = false)
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipRuntimeScope = false;
<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"> * Skip Analysis for Provided Scope Dependencies.</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L249" href="#L249">249</a> @Parameter(property = <span class="jxr_string">"skipProvidedScope"</span>, defaultValue = <span class="jxr_string">"false"</span>, required = false)
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipProvidedScope = false;
<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"> * The data directory, hold DC SQL DB.</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> @Parameter(property = <span class="jxr_string">"dataDirectory"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">private</strong> String dataDirectory;
<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"> * Data Mirror URL for CVE 1.2.</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> @Parameter(property = <span class="jxr_string">"cveUrl12Modified"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">private</strong> String cveUrl12Modified;
<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> <em class="jxr_javadoccomment"> * Data Mirror URL for CVE 2.0.</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> @Parameter(property = <span class="jxr_string">"cveUrl20Modified"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">private</strong> String cveUrl20Modified;
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Base Data Mirror URL for CVE 1.2.</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> @Parameter(property = <span class="jxr_string">"cveUrl12Base"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">private</strong> String cveUrl12Base;
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * Data Mirror URL for CVE 2.0.</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> @Parameter(property = <span class="jxr_string">"cveUrl20Base"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">private</strong> String cveUrl20Base;
<a class="jxr_linenumber" name="L276" href="#L276">276</a>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * The path to mono for .NET Assembly analysis on non-windows systems.</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> @Parameter(property = <span class="jxr_string">"pathToMono"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">private</strong> String pathToMono;
<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"> * The Proxy URL.</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"> * @deprecated Please use mavenSettings instead</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L289" href="#L289">289</a> @Parameter(property = <span class="jxr_string">"proxyUrl"</span>, defaultValue = <span class="jxr_string">""</span>, required = false)
<a class="jxr_linenumber" name="L290" href="#L290">290</a> @Deprecated
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">private</strong> String proxyUrl = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * Sets whether or not the external report format should be used.</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * @deprecated the internal report is no longer supported</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> @SuppressWarnings(<span class="jxr_string">"CanBeFinal"</span>)
<a class="jxr_linenumber" name="L298" href="#L298">298</a> @Parameter(property = <span class="jxr_string">"externalReport"</span>)
<a class="jxr_linenumber" name="L299" href="#L299">299</a> @Deprecated
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">private</strong> String externalReport = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L301" href="#L301">301</a>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_comment">// &lt;/editor-fold&gt;</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"> * Executes the Dependency-Check on the dependent libraries.</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> <em class="jxr_javadoccomment"> * @return the Engine used to scan the dependencies.</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an exception connecting to the database</em>
<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> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> executeDependencyCheck() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">return</strong> executeDependencyCheck(getProject());
<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
<a class="jxr_linenumber" name="L312" href="#L312">312</a>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * Executes the Dependency-Check on the dependent libraries.</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param project the project to run dependency-check on</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @return the Engine used to scan the dependencies.</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an exception connecting to the database</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> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> executeDependencyCheck(MavenProject project) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> localEngine;
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">if</strong> (engine == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L323" href="#L323">323</a> localEngine = initializeEngine(project);
<a class="jxr_linenumber" name="L324" href="#L324">324</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> localEngine = engine;
<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
<a class="jxr_linenumber" name="L327" href="#L327">327</a>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">final</strong> Set&lt;Artifact&gt; artifacts = project.getArtifacts();
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">for</strong> (Artifact a : artifacts) {
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">if</strong> (excludeFromScan(a)) {
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">continue</strong>;
<a class="jxr_linenumber" name="L332" href="#L332">332</a> }
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; deps = localEngine.scan(a.getFile().getAbsoluteFile());
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">if</strong> (deps != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">if</strong> (deps.size() == 1) {
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">final</strong> Dependency d = deps.get(0);
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">if</strong> (d != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">final</strong> MavenArtifact ma = <strong class="jxr_keyword">new</strong> MavenArtifact(a.getGroupId(), a.getArtifactId(), a.getVersion());
<a class="jxr_linenumber" name="L339" href="#L339">339</a> d.addAsEvidence(<span class="jxr_string">"pom"</span>, ma, Confidence.HIGHEST);
<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
<a class="jxr_linenumber" name="L341" href="#L341">341</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"More then 1 dependency was identified in first pass scan of '%s:%s:%s'"</span>,
<a class="jxr_linenumber" name="L343" href="#L343">343</a> a.getGroupId(), a.getArtifactId(), a.getVersion());
<a class="jxr_linenumber" name="L344" href="#L344">344</a> LOGGER.info(msg);
<a class="jxr_linenumber" name="L345" href="#L345">345</a> }
<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> localEngine.analyzeDependencies();
<a class="jxr_linenumber" name="L349" href="#L349">349</a>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">return</strong> localEngine;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * Initializes a new &lt;code&gt;Engine&lt;/code&gt; that can be used for scanning.</em>
<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"> * @param project the current MavenProject</em>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @return a newly instantiated &lt;code&gt;Engine&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is a database exception</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> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> initializeEngine(MavenProject project) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L361" href="#L361">361</a> populateSettings();
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> localEngine = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>(project);
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">return</strong> localEngine;
<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"> * Tests is the artifact should be included in the scan (i.e. is the dependency in a scope that is being scanned).</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 a the Artifact to test</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if the artifact is in an excluded scope; otherwise &lt;code&gt;false&lt;/code&gt;</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">boolean</strong> excludeFromScan(Artifact a) {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">if</strong> (skipTestScope &amp;&amp; Artifact.SCOPE_TEST.equals(a.getScope())) {
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L375" href="#L375">375</a> }
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">if</strong> (skipProvidedScope &amp;&amp; Artifact.SCOPE_PROVIDED.equals(a.getScope())) {
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L378" href="#L378">378</a> }
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">if</strong> (skipRuntimeScope &amp;&amp; !Artifact.SCOPE_RUNTIME.equals(a.getScope())) {
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
<a class="jxr_linenumber" name="L384" href="#L384">384</a>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="Methods to populate global settings"&gt;</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system</em>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * properties required to change the proxy url, port, and connection timeout.</em>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> populateSettings() {
<a class="jxr_linenumber" name="L391" href="#L391">391</a> Settings.initialize();
<a class="jxr_linenumber" name="L392" href="#L392">392</a> InputStream mojoProperties = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L394" href="#L394">394</a> mojoProperties = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
<a class="jxr_linenumber" name="L395" href="#L395">395</a> Settings.mergeProperties(mojoProperties);
<a class="jxr_linenumber" name="L396" href="#L396">396</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L397" href="#L397">397</a> LOGGER.log(Level.WARNING, <span class="jxr_string">"Unable to load the dependency-check ant task.properties file."</span>);
<a class="jxr_linenumber" name="L398" href="#L398">398</a> LOGGER.log(Level.FINE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="L399" href="#L399">399</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">if</strong> (mojoProperties != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L402" href="#L402">402</a> mojoProperties.close();
<a class="jxr_linenumber" name="L403" href="#L403">403</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L404" href="#L404">404</a> LOGGER.log(Level.FINEST, <strong class="jxr_keyword">null</strong>, ex);
<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> Settings.setBoolean(Settings.KEYS.AUTO_UPDATE, autoUpdate);
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">if</strong> (externalReport != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L411" href="#L411">411</a> LOGGER.warning(<span class="jxr_string">"The 'externalReport' option was set; this configuration option has been removed. "</span>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> + <span class="jxr_string">"Please update the dependency-check-maven plugin's configuration"</span>);
<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">if</strong> (proxyUrl != <strong class="jxr_keyword">null</strong> &amp;&amp; !proxyUrl.isEmpty()) {
<a class="jxr_linenumber" name="L416" href="#L416">416</a> LOGGER.warning(<span class="jxr_string">"Deprecated configuration detected, proxyUrl will be ignored; use the maven settings "</span> + <span class="jxr_string">"to configure the proxy instead"</span>);
<a class="jxr_linenumber" name="L417" href="#L417">417</a> }
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">final</strong> Proxy proxy = getMavenProxy();
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">if</strong> (proxy != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L420" href="#L420">420</a> Settings.setString(Settings.KEYS.PROXY_SERVER, proxy.getHost());
<a class="jxr_linenumber" name="L421" href="#L421">421</a> Settings.setString(Settings.KEYS.PROXY_PORT, Integer.toString(proxy.getPort()));
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">final</strong> String userName = proxy.getUsername();
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">final</strong> String password = proxy.getPassword();
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">if</strong> (userName != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L425" href="#L425">425</a> Settings.setString(Settings.KEYS.PROXY_USERNAME, userName);
<a class="jxr_linenumber" name="L426" href="#L426">426</a> }
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">if</strong> (password != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L428" href="#L428">428</a> Settings.setString(Settings.KEYS.PROXY_PASSWORD, password);
<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> }
<a class="jxr_linenumber" name="L432" href="#L432">432</a>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">if</strong> (connectionTimeout != <strong class="jxr_keyword">null</strong> &amp;&amp; !connectionTimeout.isEmpty()) {
<a class="jxr_linenumber" name="L434" href="#L434">434</a> Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
<a class="jxr_linenumber" name="L435" href="#L435">435</a> }
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong class="jxr_keyword">if</strong> (suppressionFile != <strong class="jxr_keyword">null</strong> &amp;&amp; !suppressionFile.isEmpty()) {
<a class="jxr_linenumber" name="L437" href="#L437">437</a> Settings.setString(Settings.KEYS.SUPPRESSION_FILE, suppressionFile);
<a class="jxr_linenumber" name="L438" href="#L438">438</a> }
<a class="jxr_linenumber" name="L439" href="#L439">439</a>
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_comment">//File Type Analyzer Settings</em>
<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_comment">//JAR ANALYZER</em>
<a class="jxr_linenumber" name="L442" href="#L442">442</a> Settings.setBoolean(Settings.KEYS.ANALYZER_JAR_ENABLED, jarAnalyzerEnabled);
<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_comment">//NUSPEC ANALYZER</em>
<a class="jxr_linenumber" name="L444" href="#L444">444</a> Settings.setBoolean(Settings.KEYS.ANALYZER_NUSPEC_ENABLED, nuspecAnalyzerEnabled);
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_comment">//NEXUS ANALYZER</em>
<a class="jxr_linenumber" name="L446" href="#L446">446</a> Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_ENABLED, nexusAnalyzerEnabled);
<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">if</strong> (nexusUrl != <strong class="jxr_keyword">null</strong> &amp;&amp; !nexusUrl.isEmpty()) {
<a class="jxr_linenumber" name="L448" href="#L448">448</a> Settings.setString(Settings.KEYS.ANALYZER_NEXUS_URL, nexusUrl);
<a class="jxr_linenumber" name="L449" href="#L449">449</a> }
<a class="jxr_linenumber" name="L450" href="#L450">450</a> Settings.setBoolean(Settings.KEYS.ANALYZER_NEXUS_PROXY, nexusUsesProxy);
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_comment">//ARCHIVE ANALYZER</em>
<a class="jxr_linenumber" name="L452" href="#L452">452</a> Settings.setBoolean(Settings.KEYS.ANALYZER_ARCHIVE_ENABLED, archiveAnalyzerEnabled);
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">if</strong> (zipExtensions != <strong class="jxr_keyword">null</strong> &amp;&amp; !zipExtensions.isEmpty()) {
<a class="jxr_linenumber" name="L454" href="#L454">454</a> Settings.setString(Settings.KEYS.ADDITIONAL_ZIP_EXTENSIONS, zipExtensions);
<a class="jxr_linenumber" name="L455" href="#L455">455</a> }
<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_comment">//ASSEMBLY ANALYZER</em>
<a class="jxr_linenumber" name="L457" href="#L457">457</a> Settings.setBoolean(Settings.KEYS.ANALYZER_ASSEMBLY_ENABLED, assemblyAnalyzerEnabled);
<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">if</strong> (pathToMono != <strong class="jxr_keyword">null</strong> &amp;&amp; !pathToMono.isEmpty()) {
<a class="jxr_linenumber" name="L459" href="#L459">459</a> Settings.setString(Settings.KEYS.ANALYZER_ASSEMBLY_MONO_PATH, pathToMono);
<a class="jxr_linenumber" name="L460" href="#L460">460</a> }
<a class="jxr_linenumber" name="L461" href="#L461">461</a>
<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_comment">//Database configuration</em>
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">if</strong> (databaseDriverName != <strong class="jxr_keyword">null</strong> &amp;&amp; !databaseDriverName.isEmpty()) {
<a class="jxr_linenumber" name="L464" href="#L464">464</a> Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
<a class="jxr_linenumber" name="L465" href="#L465">465</a> }
<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">if</strong> (databaseDriverPath != <strong class="jxr_keyword">null</strong> &amp;&amp; !databaseDriverPath.isEmpty()) {
<a class="jxr_linenumber" name="L467" href="#L467">467</a> Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
<a class="jxr_linenumber" name="L468" href="#L468">468</a> }
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">if</strong> (connectionString != <strong class="jxr_keyword">null</strong> &amp;&amp; !connectionString.isEmpty()) {
<a class="jxr_linenumber" name="L470" href="#L470">470</a> Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
<a class="jxr_linenumber" name="L471" href="#L471">471</a> }
<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">if</strong> (databaseUser != <strong class="jxr_keyword">null</strong> &amp;&amp; !databaseUser.isEmpty()) {
<a class="jxr_linenumber" name="L473" href="#L473">473</a> Settings.setString(Settings.KEYS.DB_USER, databaseUser);
<a class="jxr_linenumber" name="L474" href="#L474">474</a> }
<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">if</strong> (databasePassword != <strong class="jxr_keyword">null</strong> &amp;&amp; !databasePassword.isEmpty()) {
<a class="jxr_linenumber" name="L476" href="#L476">476</a> Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
<a class="jxr_linenumber" name="L477" href="#L477">477</a> }
<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_comment">// Data Directory</em>
<a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">if</strong> (dataDirectory != <strong class="jxr_keyword">null</strong> &amp;&amp; !dataDirectory.isEmpty()) {
<a class="jxr_linenumber" name="L480" href="#L480">480</a> Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
<a class="jxr_linenumber" name="L481" href="#L481">481</a> }
<a class="jxr_linenumber" name="L482" href="#L482">482</a>
<a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_comment">// Scope Exclusion</em>
<a class="jxr_linenumber" name="L484" href="#L484">484</a> Settings.setBoolean(Settings.KEYS.SKIP_TEST_SCOPE, skipTestScope);
<a class="jxr_linenumber" name="L485" href="#L485">485</a> Settings.setBoolean(Settings.KEYS.SKIP_RUNTIME_SCOPE, skipRuntimeScope);
<a class="jxr_linenumber" name="L486" href="#L486">486</a> Settings.setBoolean(Settings.KEYS.SKIP_PROVIDED_SCOPE, skipProvidedScope);
<a class="jxr_linenumber" name="L487" href="#L487">487</a>
<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_comment">// CVE Data Mirroring</em>
<a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">if</strong> (cveUrl12Modified != <strong class="jxr_keyword">null</strong> &amp;&amp; !cveUrl12Modified.isEmpty()) {
<a class="jxr_linenumber" name="L490" href="#L490">490</a> Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
<a class="jxr_linenumber" name="L491" href="#L491">491</a> }
<a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong class="jxr_keyword">if</strong> (cveUrl20Modified != <strong class="jxr_keyword">null</strong> &amp;&amp; !cveUrl20Modified.isEmpty()) {
<a class="jxr_linenumber" name="L493" href="#L493">493</a> Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
<a class="jxr_linenumber" name="L494" href="#L494">494</a> }
<a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">if</strong> (cveUrl12Base != <strong class="jxr_keyword">null</strong> &amp;&amp; !cveUrl12Base.isEmpty()) {
<a class="jxr_linenumber" name="L496" href="#L496">496</a> Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
<a class="jxr_linenumber" name="L497" href="#L497">497</a> }
<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">if</strong> (cveUrl20Base != <strong class="jxr_keyword">null</strong> &amp;&amp; !cveUrl20Base.isEmpty()) {
<a class="jxr_linenumber" name="L499" href="#L499">499</a> Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
<a class="jxr_linenumber" name="L500" href="#L500">500</a> }
<a class="jxr_linenumber" name="L501" href="#L501">501</a> }
<a class="jxr_linenumber" name="L502" href="#L502">502</a>
<a class="jxr_linenumber" name="L503" href="#L503">503</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment"> * Returns the maven proxy.</em>
<a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L506" href="#L506">506</a> <em class="jxr_javadoccomment"> * @return the maven proxy</em>
<a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L508" href="#L508">508</a> <strong class="jxr_keyword">private</strong> Proxy getMavenProxy() {
<a class="jxr_linenumber" name="L509" href="#L509">509</a> <strong class="jxr_keyword">if</strong> (mavenSettings != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">final</strong> List&lt;Proxy&gt; proxies = mavenSettings.getProxies();
<a class="jxr_linenumber" name="L511" href="#L511">511</a> <strong class="jxr_keyword">if</strong> (proxies != <strong class="jxr_keyword">null</strong> &amp;&amp; proxies.size() &gt; 0) {
<a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong class="jxr_keyword">if</strong> (mavenSettingsProxyId != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L513" href="#L513">513</a> <strong class="jxr_keyword">for</strong> (Proxy proxy : proxies) {
<a class="jxr_linenumber" name="L514" href="#L514">514</a> <strong class="jxr_keyword">if</strong> (mavenSettingsProxyId.equalsIgnoreCase(proxy.getId())) {
<a class="jxr_linenumber" name="L515" href="#L515">515</a> <strong class="jxr_keyword">return</strong> proxy;
<a class="jxr_linenumber" name="L516" href="#L516">516</a> }
<a class="jxr_linenumber" name="L517" href="#L517">517</a> }
<a class="jxr_linenumber" name="L518" href="#L518">518</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (proxies.size() == 1) {
<a class="jxr_linenumber" name="L519" href="#L519">519</a> <strong class="jxr_keyword">return</strong> proxies.get(0);
<a class="jxr_linenumber" name="L520" href="#L520">520</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L521" href="#L521">521</a> LOGGER.warning(<span class="jxr_string">"Multiple proxy defentiions exist in the Maven settings. In the dependency-check "</span>
<a class="jxr_linenumber" name="L522" href="#L522">522</a> + <span class="jxr_string">"configuration set the maveSettingsProxyId so that the correct proxy will be used."</span>);
<a class="jxr_linenumber" name="L523" href="#L523">523</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Ambiguous proxy definition"</span>);
<a class="jxr_linenumber" name="L524" href="#L524">524</a> }
<a class="jxr_linenumber" name="L525" href="#L525">525</a> }
<a class="jxr_linenumber" name="L526" href="#L526">526</a> }
<a class="jxr_linenumber" name="L527" href="#L527">527</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L528" href="#L528">528</a> }
<a class="jxr_linenumber" name="L529" href="#L529">529</a>
<a class="jxr_linenumber" name="L530" href="#L530">530</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="L531" href="#L531">531</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L532" href="#L532">532</a> <em class="jxr_javadoccomment"> * Initialize the mojo.</em>
<a class="jxr_linenumber" name="L533" href="#L533">533</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L534" href="#L534">534</a> @Override
<a class="jxr_linenumber" name="L535" href="#L535">535</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initialize() {
<a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">final</strong> InputStream in = DependencyCheckMojo.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream(LOG_PROPERTIES_FILE);
<a class="jxr_linenumber" name="L537" href="#L537">537</a> LogUtils.prepareLogger(in, logFile);
<a class="jxr_linenumber" name="L538" href="#L538">538</a> }
<a class="jxr_linenumber" name="L539" href="#L539">539</a>
<a class="jxr_linenumber" name="L540" href="#L540">540</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L541" href="#L541">541</a> <em class="jxr_javadoccomment"> * Executes the dependency-check and generates the report.</em>
<a class="jxr_linenumber" name="L542" href="#L542">542</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L543" href="#L543">543</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if a maven exception occurs</em>
<a class="jxr_linenumber" name="L544" href="#L544">544</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if a CVSS score is found that is higher then the configured level</em>
<a class="jxr_linenumber" name="L545" href="#L545">545</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L546" href="#L546">546</a> @Override
<a class="jxr_linenumber" name="L547" href="#L547">547</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> performExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L548" href="#L548">548</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L549" href="#L549">549</a> engine = executeDependencyCheck();
<a class="jxr_linenumber" name="L550" href="#L550">550</a> ReportingUtil.generateExternalReports(engine, outputDirectory, getProject().getName(), format);
<a class="jxr_linenumber" name="L551" href="#L551">551</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.showSummary) {
<a class="jxr_linenumber" name="L552" href="#L552">552</a> showSummary(engine.getDependencies());
<a class="jxr_linenumber" name="L553" href="#L553">553</a> }
<a class="jxr_linenumber" name="L554" href="#L554">554</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.failBuildOnCVSS &lt;= 10) {
<a class="jxr_linenumber" name="L555" href="#L555">555</a> checkForFailure(engine.getDependencies());
<a class="jxr_linenumber" name="L556" href="#L556">556</a> }
<a class="jxr_linenumber" name="L557" href="#L557">557</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L558" href="#L558">558</a> LOGGER.log(Level.SEVERE, <span class="jxr_string">"Unable to connect to the dependency-check database; analysis has stopped"</span>);
<a class="jxr_linenumber" name="L559" href="#L559">559</a> LOGGER.log(Level.FINE, <span class="jxr_string">""</span>, ex);
<a class="jxr_linenumber" name="L560" href="#L560">560</a> }
<a class="jxr_linenumber" name="L561" href="#L561">561</a> }
<a class="jxr_linenumber" name="L562" href="#L562">562</a>
<a class="jxr_linenumber" name="L563" href="#L563">563</a> @Override
<a class="jxr_linenumber" name="L564" href="#L564">564</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="L565" href="#L565">565</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L566" href="#L566">566</a> <strong class="jxr_keyword">super</strong>.postExecute();
<a class="jxr_linenumber" name="L567" href="#L567">567</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L568" href="#L568">568</a> cleanupEngine();
<a class="jxr_linenumber" name="L569" href="#L569">569</a> }
<a class="jxr_linenumber" name="L570" href="#L570">570</a> }
<a class="jxr_linenumber" name="L571" href="#L571">571</a>
<a class="jxr_linenumber" name="L572" href="#L572">572</a> @Override
<a class="jxr_linenumber" name="L573" href="#L573">573</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="L574" href="#L574">574</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L575" href="#L575">575</a> <strong class="jxr_keyword">super</strong>.postGenerate();
<a class="jxr_linenumber" name="L576" href="#L576">576</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L577" href="#L577">577</a> cleanupEngine();
<a class="jxr_linenumber" name="L578" href="#L578">578</a> }
<a class="jxr_linenumber" name="L579" href="#L579">579</a> }
<a class="jxr_linenumber" name="L580" href="#L580">580</a>
<a class="jxr_linenumber" name="L581" href="#L581">581</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L582" href="#L582">582</a> <em class="jxr_javadoccomment"> * Calls &lt;code&gt;engine.cleanup()&lt;/code&gt; to release resources.</em>
<a class="jxr_linenumber" name="L583" href="#L583">583</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L584" href="#L584">584</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> cleanupEngine() {
<a class="jxr_linenumber" name="L585" href="#L585">585</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L586" href="#L586">586</a> engine.cleanup();
<a class="jxr_linenumber" name="L587" href="#L587">587</a> engine = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L588" href="#L588">588</a> }
<a class="jxr_linenumber" name="L589" href="#L589">589</a> Settings.cleanup(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L590" href="#L590">590</a> }
<a class="jxr_linenumber" name="L591" href="#L591">591</a>
<a class="jxr_linenumber" name="L592" href="#L592">592</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L593" href="#L593">593</a> <em class="jxr_javadoccomment"> * Generates the Dependency-Check Site Report.</em>
<a class="jxr_linenumber" name="L594" href="#L594">594</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L595" href="#L595">595</a> <em class="jxr_javadoccomment"> * @param locale the locale to use when generating the report</em>
<a class="jxr_linenumber" name="L596" href="#L596">596</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if a maven report exception occurs</em>
<a class="jxr_linenumber" name="L597" href="#L597">597</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L598" href="#L598">598</a> @Override
<a class="jxr_linenumber" name="L599" href="#L599">599</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeNonAggregateReport(Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
<a class="jxr_linenumber" name="L600" href="#L600">600</a> <strong class="jxr_keyword">final</strong> List&lt;Dependency&gt; deps = readDataFile();
<a class="jxr_linenumber" name="L601" href="#L601">601</a> <strong class="jxr_keyword">if</strong> (deps != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L602" href="#L602">602</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L603" href="#L603">603</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L604" href="#L604">604</a> engine = initializeEngine(getProject());
<a class="jxr_linenumber" name="L605" href="#L605">605</a> }
<a class="jxr_linenumber" name="L606" href="#L606">606</a> engine.getDependencies().addAll(deps);
<a class="jxr_linenumber" name="L607" href="#L607">607</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L608" href="#L608">608</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"An unrecoverable exception with the dependency-check initialization occured while scanning %s"</span>,
<a class="jxr_linenumber" name="L609" href="#L609">609</a> getProject().getName());
<a class="jxr_linenumber" name="L610" href="#L610">610</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(msg, ex);
<a class="jxr_linenumber" name="L611" href="#L611">611</a> }
<a class="jxr_linenumber" name="L612" href="#L612">612</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L613" href="#L613">613</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L614" href="#L614">614</a> engine = executeDependencyCheck();
<a class="jxr_linenumber" name="L615" href="#L615">615</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L616" href="#L616">616</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"An unrecoverable exception with the dependency-check scan occured while scanning %s"</span>,
<a class="jxr_linenumber" name="L617" href="#L617">617</a> getProject().getName());
<a class="jxr_linenumber" name="L618" href="#L618">618</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(msg, ex);
<a class="jxr_linenumber" name="L619" href="#L619">619</a> }
<a class="jxr_linenumber" name="L620" href="#L620">620</a> }
<a class="jxr_linenumber" name="L621" href="#L621">621</a> ReportingUtil.generateExternalReports(engine, getReportOutputDirectory(), getProject().getName(), format);
<a class="jxr_linenumber" name="L622" href="#L622">622</a> }
<a class="jxr_linenumber" name="L623" href="#L623">623</a>
<a class="jxr_linenumber" name="L624" href="#L624">624</a> @Override
<a class="jxr_linenumber" name="L625" href="#L625">625</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeAggregateReport(MavenProject project, Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException {
<a class="jxr_linenumber" name="L626" href="#L626">626</a> List&lt;Dependency&gt; deps = readDataFile(project);
<a class="jxr_linenumber" name="L627" href="#L627">627</a> <strong class="jxr_keyword">if</strong> (deps != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L628" href="#L628">628</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L629" href="#L629">629</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L630" href="#L630">630</a> engine = initializeEngine(project);
<a class="jxr_linenumber" name="L631" href="#L631">631</a> }
<a class="jxr_linenumber" name="L632" href="#L632">632</a> engine.getDependencies().addAll(deps);
<a class="jxr_linenumber" name="L633" href="#L633">633</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L634" href="#L634">634</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"An unrecoverable exception with the dependency-check initialization occured while scanning %s"</span>,
<a class="jxr_linenumber" name="L635" href="#L635">635</a> project.getName());
<a class="jxr_linenumber" name="L636" href="#L636">636</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(msg, ex);
<a class="jxr_linenumber" name="L637" href="#L637">637</a> }
<a class="jxr_linenumber" name="L638" href="#L638">638</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L639" href="#L639">639</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L640" href="#L640">640</a> engine = executeDependencyCheck(project);
<a class="jxr_linenumber" name="L641" href="#L641">641</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L642" href="#L642">642</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"An unrecoverable exception with the dependency-check scan occured while scanning %s"</span>,
<a class="jxr_linenumber" name="L643" href="#L643">643</a> project.getName());
<a class="jxr_linenumber" name="L644" href="#L644">644</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(msg, ex);
<a class="jxr_linenumber" name="L645" href="#L645">645</a> }
<a class="jxr_linenumber" name="L646" href="#L646">646</a> }
<a class="jxr_linenumber" name="L647" href="#L647">647</a> <strong class="jxr_keyword">for</strong> (MavenProject child : getAllChildren(project)) {
<a class="jxr_linenumber" name="L648" href="#L648">648</a> deps = readDataFile(child);
<a class="jxr_linenumber" name="L649" href="#L649">649</a> <strong class="jxr_keyword">if</strong> (deps == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L650" href="#L650">650</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to include information on %s in the dependency-check aggregate report"</span>,
<a class="jxr_linenumber" name="L651" href="#L651">651</a> child.getName());
<a class="jxr_linenumber" name="L652" href="#L652">652</a> LOGGER.severe(msg);
<a class="jxr_linenumber" name="L653" href="#L653">653</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L654" href="#L654">654</a> engine.getDependencies().addAll(deps);
<a class="jxr_linenumber" name="L655" href="#L655">655</a> }
<a class="jxr_linenumber" name="L656" href="#L656">656</a> }
<a class="jxr_linenumber" name="L657" href="#L657">657</a> <strong class="jxr_keyword">final</strong> DependencyBundlingAnalyzer bundler = <strong class="jxr_keyword">new</strong> DependencyBundlingAnalyzer();
<a class="jxr_linenumber" name="L658" href="#L658">658</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L659" href="#L659">659</a> bundler.analyze(<strong class="jxr_keyword">null</strong>, engine);
<a class="jxr_linenumber" name="L660" href="#L660">660</a> } <strong class="jxr_keyword">catch</strong> (AnalysisException ex) {
<a class="jxr_linenumber" name="L661" href="#L661">661</a> LOGGER.log(Level.WARNING, <span class="jxr_string">"An error occured grouping the dependencies; duplicate entries may exist in the report"</span>, ex);
<a class="jxr_linenumber" name="L662" href="#L662">662</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Bundling Exception"</span>, ex);
<a class="jxr_linenumber" name="L663" href="#L663">663</a> }
<a class="jxr_linenumber" name="L664" href="#L664">664</a> <strong class="jxr_keyword">final</strong> File outputDir = getReportOutputDirectory(project);
<a class="jxr_linenumber" name="L665" href="#L665">665</a> <strong class="jxr_keyword">if</strong> (outputDir != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L666" href="#L666">666</a> ReportingUtil.generateExternalReports(engine, outputDir, project.getName(), format);
<a class="jxr_linenumber" name="L667" href="#L667">667</a> }
<a class="jxr_linenumber" name="L668" href="#L668">668</a> }
<a class="jxr_linenumber" name="L669" href="#L669">669</a>
<a class="jxr_linenumber" name="L670" href="#L670">670</a> <em class="jxr_comment">// &lt;editor-fold defaultstate="collapsed" desc="Mojo interface/abstract required setter/getter methods"&gt;</em>
<a class="jxr_linenumber" name="L671" href="#L671">671</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L672" href="#L672">672</a> <em class="jxr_javadoccomment"> * Returns the output name.</em>
<a class="jxr_linenumber" name="L673" href="#L673">673</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L674" href="#L674">674</a> <em class="jxr_javadoccomment"> * @return the output name</em>
<a class="jxr_linenumber" name="L675" href="#L675">675</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L676" href="#L676">676</a> <strong class="jxr_keyword">public</strong> String getOutputName() {
<a class="jxr_linenumber" name="L677" href="#L677">677</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"HTML"</span>.equalsIgnoreCase(<strong class="jxr_keyword">this</strong>.format) || <span class="jxr_string">"ALL"</span>.equalsIgnoreCase(<strong class="jxr_keyword">this</strong>.format)) {
<a class="jxr_linenumber" name="L678" href="#L678">678</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-report"</span>;
<a class="jxr_linenumber" name="L679" href="#L679">679</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"XML"</span>.equalsIgnoreCase(<strong class="jxr_keyword">this</strong>.format)) {
<a class="jxr_linenumber" name="L680" href="#L680">680</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-report.xml#"</span>;
<a class="jxr_linenumber" name="L681" href="#L681">681</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"VULN"</span>.equalsIgnoreCase(<strong class="jxr_keyword">this</strong>.format)) {
<a class="jxr_linenumber" name="L682" href="#L682">682</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-vulnerability"</span>;
<a class="jxr_linenumber" name="L683" href="#L683">683</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L684" href="#L684">684</a> LOGGER.log(Level.WARNING, <span class="jxr_string">"Unknown report format used during site generation."</span>);
<a class="jxr_linenumber" name="L685" href="#L685">685</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-report"</span>;
<a class="jxr_linenumber" name="L686" href="#L686">686</a> }
<a class="jxr_linenumber" name="L687" href="#L687">687</a> }
<a class="jxr_linenumber" name="L688" href="#L688">688</a>
<a class="jxr_linenumber" name="L689" href="#L689">689</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L690" href="#L690">690</a> <em class="jxr_javadoccomment"> * Returns the category name.</em>
<a class="jxr_linenumber" name="L691" href="#L691">691</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L692" href="#L692">692</a> <em class="jxr_javadoccomment"> * @return the category name</em>
<a class="jxr_linenumber" name="L693" href="#L693">693</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L694" href="#L694">694</a> <strong class="jxr_keyword">public</strong> String getCategoryName() {
<a class="jxr_linenumber" name="L695" href="#L695">695</a> <strong class="jxr_keyword">return</strong> MavenReport.CATEGORY_PROJECT_REPORTS;
<a class="jxr_linenumber" name="L696" href="#L696">696</a> }
<a class="jxr_linenumber" name="L697" href="#L697">697</a>
<a class="jxr_linenumber" name="L698" href="#L698">698</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L699" href="#L699">699</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L700" href="#L700">700</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L701" href="#L701">701</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L702" href="#L702">702</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L703" href="#L703">703</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L704" href="#L704">704</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L705" href="#L705">705</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check"</span>;
<a class="jxr_linenumber" name="L706" href="#L706">706</a> }
<a class="jxr_linenumber" name="L707" href="#L707">707</a>
<a class="jxr_linenumber" name="L708" href="#L708">708</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L709" href="#L709">709</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L710" href="#L710">710</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L711" href="#L711">711</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L712" href="#L712">712</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L713" href="#L713">713</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L714" href="#L714">714</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L715" href="#L715">715</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"A report providing details on any published "</span>
<a class="jxr_linenumber" name="L716" href="#L716">716</a> + <span class="jxr_string">"vulnerabilities within project dependencies. This report is a best effort but may contain "</span>
<a class="jxr_linenumber" name="L717" href="#L717">717</a> + <span class="jxr_string">"false positives and false negatives."</span>;
<a class="jxr_linenumber" name="L718" href="#L718">718</a> }
<a class="jxr_linenumber" name="L719" href="#L719">719</a>
<a class="jxr_linenumber" name="L720" href="#L720">720</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L721" href="#L721">721</a> <em class="jxr_javadoccomment"> * Returns whether or not a report can be generated.</em>
<a class="jxr_linenumber" name="L722" href="#L722">722</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L723" href="#L723">723</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if a report can be generated; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L724" href="#L724">724</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L725" href="#L725">725</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L726" href="#L726">726</a> <strong class="jxr_keyword">if</strong> (canGenerateAggregateReport() || (isAggregate() &amp;&amp; isMultiModule())) {
<a class="jxr_linenumber" name="L727" href="#L727">727</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L728" href="#L728">728</a> }
<a class="jxr_linenumber" name="L729" href="#L729">729</a> <strong class="jxr_keyword">if</strong> (canGenerateNonAggregateReport()) {
<a class="jxr_linenumber" name="L730" href="#L730">730</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L731" href="#L731">731</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L732" href="#L732">732</a> <strong class="jxr_keyword">final</strong> String msg;
<a class="jxr_linenumber" name="L733" href="#L733">733</a> <strong class="jxr_keyword">if</strong> (getProject().getArtifacts().size() &gt; 0) {
<a class="jxr_linenumber" name="L734" href="#L734">734</a> msg = <span class="jxr_string">"No project dependencies exist in the included scope - dependency-check:check is unable to generate a report."</span>;
<a class="jxr_linenumber" name="L735" href="#L735">735</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L736" href="#L736">736</a> msg = <span class="jxr_string">"No project dependencies exist - dependency-check:check is unable to generate a report."</span>;
<a class="jxr_linenumber" name="L737" href="#L737">737</a> }
<a class="jxr_linenumber" name="L738" href="#L738">738</a> LOGGER.warning(msg);
<a class="jxr_linenumber" name="L739" href="#L739">739</a> }
<a class="jxr_linenumber" name="L740" href="#L740">740</a>
<a class="jxr_linenumber" name="L741" href="#L741">741</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L742" href="#L742">742</a> }
<a class="jxr_linenumber" name="L743" href="#L743">743</a>
<a class="jxr_linenumber" name="L744" href="#L744">744</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L745" href="#L745">745</a> <em class="jxr_javadoccomment"> * Returns whether or not a non-aggregate report can be generated.</em>
<a class="jxr_linenumber" name="L746" href="#L746">746</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L747" href="#L747">747</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if a non-aggregate report can be generated; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L748" href="#L748">748</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L749" href="#L749">749</a> @Override
<a class="jxr_linenumber" name="L750" href="#L750">750</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> canGenerateNonAggregateReport() {
<a class="jxr_linenumber" name="L751" href="#L751">751</a> <strong class="jxr_keyword">boolean</strong> ability = false;
<a class="jxr_linenumber" name="L752" href="#L752">752</a> <strong class="jxr_keyword">for</strong> (Artifact a : getProject().getArtifacts()) {
<a class="jxr_linenumber" name="L753" href="#L753">753</a> <strong class="jxr_keyword">if</strong> (!excludeFromScan(a)) {
<a class="jxr_linenumber" name="L754" href="#L754">754</a> ability = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L755" href="#L755">755</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L756" href="#L756">756</a> }
<a class="jxr_linenumber" name="L757" href="#L757">757</a> }
<a class="jxr_linenumber" name="L758" href="#L758">758</a> <strong class="jxr_keyword">return</strong> ability;
<a class="jxr_linenumber" name="L759" href="#L759">759</a> }
<a class="jxr_linenumber" name="L760" href="#L760">760</a>
<a class="jxr_linenumber" name="L761" href="#L761">761</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L762" href="#L762">762</a> <em class="jxr_javadoccomment"> * Returns whether or not an aggregate report can be generated.</em>
<a class="jxr_linenumber" name="L763" href="#L763">763</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L764" href="#L764">764</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt; if an aggregate report can be generated; otherwise &lt;code&gt;false&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L765" href="#L765">765</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L766" href="#L766">766</a> @Override
<a class="jxr_linenumber" name="L767" href="#L767">767</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> canGenerateAggregateReport() {
<a class="jxr_linenumber" name="L768" href="#L768">768</a> <strong class="jxr_keyword">return</strong> isAggregate() &amp;&amp; isLastProject();
<a class="jxr_linenumber" name="L769" href="#L769">769</a> }
<a class="jxr_linenumber" name="L770" href="#L770">770</a>
<a class="jxr_linenumber" name="L771" href="#L771">771</a> <em class="jxr_comment">// &lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="L772" href="#L772">772</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="Methods to fail build or show summary"&gt;</em>
<a class="jxr_linenumber" name="L773" href="#L773">773</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L774" href="#L774">774</a> <em class="jxr_javadoccomment"> * Checks to see if a vulnerability has been identified with a CVSS score that is above the threshold set in the</em>
<a class="jxr_linenumber" name="L775" href="#L775">775</a> <em class="jxr_javadoccomment"> * configuration.</em>
<a class="jxr_linenumber" name="L776" href="#L776">776</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L777" href="#L777">777</a> <em class="jxr_javadoccomment"> * @param dependencies the list of dependency objects</em>
<a class="jxr_linenumber" name="L778" href="#L778">778</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if a CVSS score is found that is higher then the threshold set</em>
<a class="jxr_linenumber" name="L779" href="#L779">779</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L780" href="#L780">780</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkForFailure(List&lt;Dependency&gt; dependencies) <strong class="jxr_keyword">throws</strong> MojoFailureException {
<a class="jxr_linenumber" name="L781" href="#L781">781</a> <strong class="jxr_keyword">final</strong> StringBuilder ids = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L782" href="#L782">782</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
<a class="jxr_linenumber" name="L783" href="#L783">783</a> <strong class="jxr_keyword">boolean</strong> addName = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L784" href="#L784">784</a> <strong class="jxr_keyword">for</strong> (Vulnerability v : d.getVulnerabilities()) {
<a class="jxr_linenumber" name="L785" href="#L785">785</a> <strong class="jxr_keyword">if</strong> (v.getCvssScore() &gt;= failBuildOnCVSS) {
<a class="jxr_linenumber" name="L786" href="#L786">786</a> <strong class="jxr_keyword">if</strong> (addName) {
<a class="jxr_linenumber" name="L787" href="#L787">787</a> addName = false;
<a class="jxr_linenumber" name="L788" href="#L788">788</a> ids.append(NEW_LINE).append(d.getFileName()).append(<span class="jxr_string">": "</span>);
<a class="jxr_linenumber" name="L789" href="#L789">789</a> ids.append(v.getName());
<a class="jxr_linenumber" name="L790" href="#L790">790</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L791" href="#L791">791</a> ids.append(<span class="jxr_string">", "</span>).append(v.getName());
<a class="jxr_linenumber" name="L792" href="#L792">792</a> }
<a class="jxr_linenumber" name="L793" href="#L793">793</a> }
<a class="jxr_linenumber" name="L794" href="#L794">794</a> }
<a class="jxr_linenumber" name="L795" href="#L795">795</a> }
<a class="jxr_linenumber" name="L796" href="#L796">796</a> <strong class="jxr_keyword">if</strong> (ids.length() &gt; 0) {
<a class="jxr_linenumber" name="L797" href="#L797">797</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"%n%nDependency-Check Failure:%n"</span>
<a class="jxr_linenumber" name="L798" href="#L798">798</a> + <span class="jxr_string">"One or more dependencies were identified with vulnerabilities that have a CVSS score greater then '%.1f': %s%n"</span>
<a class="jxr_linenumber" name="L799" href="#L799">799</a> + <span class="jxr_string">"See the dependency-check report for more details.%n%n"</span>, failBuildOnCVSS, ids.toString());
<a class="jxr_linenumber" name="L800" href="#L800">800</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L801" href="#L801">801</a> }
<a class="jxr_linenumber" name="L802" href="#L802">802</a> }
<a class="jxr_linenumber" name="L803" href="#L803">803</a>
<a class="jxr_linenumber" name="L804" href="#L804">804</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L805" href="#L805">805</a> <em class="jxr_javadoccomment"> * Generates a warning message listing a summary of dependencies and their associated CPE and CVE entries.</em>
<a class="jxr_linenumber" name="L806" href="#L806">806</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L807" href="#L807">807</a> <em class="jxr_javadoccomment"> * @param dependencies a list of dependency objects</em>
<a class="jxr_linenumber" name="L808" href="#L808">808</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L809" href="#L809">809</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> showSummary(List&lt;Dependency&gt; dependencies) {
<a class="jxr_linenumber" name="L810" href="#L810">810</a> <strong class="jxr_keyword">final</strong> StringBuilder summary = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L811" href="#L811">811</a> <strong class="jxr_keyword">for</strong> (Dependency d : dependencies) {
<a class="jxr_linenumber" name="L812" href="#L812">812</a> <strong class="jxr_keyword">boolean</strong> firstEntry = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L813" href="#L813">813</a> <strong class="jxr_keyword">final</strong> StringBuilder ids = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L814" href="#L814">814</a> <strong class="jxr_keyword">for</strong> (Vulnerability v : d.getVulnerabilities()) {
<a class="jxr_linenumber" name="L815" href="#L815">815</a> <strong class="jxr_keyword">if</strong> (firstEntry) {
<a class="jxr_linenumber" name="L816" href="#L816">816</a> firstEntry = false;
<a class="jxr_linenumber" name="L817" href="#L817">817</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L818" href="#L818">818</a> ids.append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="L819" href="#L819">819</a> }
<a class="jxr_linenumber" name="L820" href="#L820">820</a> ids.append(v.getName());
<a class="jxr_linenumber" name="L821" href="#L821">821</a> }
<a class="jxr_linenumber" name="L822" href="#L822">822</a> <strong class="jxr_keyword">if</strong> (ids.length() &gt; 0) {
<a class="jxr_linenumber" name="L823" href="#L823">823</a> summary.append(d.getFileName()).append(<span class="jxr_string">" ("</span>);
<a class="jxr_linenumber" name="L824" href="#L824">824</a> firstEntry = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L825" href="#L825">825</a> <strong class="jxr_keyword">for</strong> (Identifier id : d.getIdentifiers()) {
<a class="jxr_linenumber" name="L826" href="#L826">826</a> <strong class="jxr_keyword">if</strong> (firstEntry) {
<a class="jxr_linenumber" name="L827" href="#L827">827</a> firstEntry = false;
<a class="jxr_linenumber" name="L828" href="#L828">828</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L829" href="#L829">829</a> summary.append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="L830" href="#L830">830</a> }
<a class="jxr_linenumber" name="L831" href="#L831">831</a> summary.append(id.getValue());
<a class="jxr_linenumber" name="L832" href="#L832">832</a> }
<a class="jxr_linenumber" name="L833" href="#L833">833</a> summary.append(<span class="jxr_string">") : "</span>).append(ids).append(NEW_LINE);
<a class="jxr_linenumber" name="L834" href="#L834">834</a> }
<a class="jxr_linenumber" name="L835" href="#L835">835</a> }
<a class="jxr_linenumber" name="L836" href="#L836">836</a> <strong class="jxr_keyword">if</strong> (summary.length() &gt; 0) {
<a class="jxr_linenumber" name="L837" href="#L837">837</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"%n%n"</span> + <span class="jxr_string">"One or more dependencies were identified with known vulnerabilities:%n%n%s"</span>
<a class="jxr_linenumber" name="L838" href="#L838">838</a> + <span class="jxr_string">"%n%nSee the dependency-check report for more details.%n%n"</span>, summary.toString());
<a class="jxr_linenumber" name="L839" href="#L839">839</a> LOGGER.log(Level.WARNING, msg);
<a class="jxr_linenumber" name="L840" href="#L840">840</a> }
<a class="jxr_linenumber" name="L841" href="#L841">841</a> }
<a class="jxr_linenumber" name="L842" href="#L842">842</a>
<a class="jxr_linenumber" name="L843" href="#L843">843</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="L844" href="#L844">844</a> <em class="jxr_comment">//&lt;editor-fold defaultstate="collapsed" desc="Methods to read/write the serialized data file"&gt;</em>
<a class="jxr_linenumber" name="L845" href="#L845">845</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L846" href="#L846">846</a> <em class="jxr_javadoccomment"> * Writes the scan data to disk. This is used to serialize the scan data between the "check" and "aggregate" phase.</em>
<a class="jxr_linenumber" name="L847" href="#L847">847</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L848" href="#L848">848</a> <em class="jxr_javadoccomment"> * @return the File object referencing the data file that was written</em>
<a class="jxr_linenumber" name="L849" href="#L849">849</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L850" href="#L850">850</a> @Override
<a class="jxr_linenumber" name="L851" href="#L851">851</a> <strong class="jxr_keyword">protected</strong> File writeDataFile() {
<a class="jxr_linenumber" name="L852" href="#L852">852</a> File file = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L853" href="#L853">853</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong> &amp;&amp; getProject().getContextValue(<strong class="jxr_keyword">this</strong>.getDataFileContextKey()) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L854" href="#L854">854</a> file = <strong class="jxr_keyword">new</strong> File(getProject().getBuild().getDirectory(), getDataFileName());
<a class="jxr_linenumber" name="L855" href="#L855">855</a> OutputStream os = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L856" href="#L856">856</a> OutputStream bos = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L857" href="#L857">857</a> ObjectOutputStream out = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L858" href="#L858">858</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L859" href="#L859">859</a> os = <strong class="jxr_keyword">new</strong> FileOutputStream(file);
<a class="jxr_linenumber" name="L860" href="#L860">860</a> bos = <strong class="jxr_keyword">new</strong> BufferedOutputStream(os);
<a class="jxr_linenumber" name="L861" href="#L861">861</a> out = <strong class="jxr_keyword">new</strong> ObjectOutputStream(bos);
<a class="jxr_linenumber" name="L862" href="#L862">862</a> out.writeObject(engine.getDependencies());
<a class="jxr_linenumber" name="L863" href="#L863">863</a> out.flush();
<a class="jxr_linenumber" name="L864" href="#L864">864</a>
<a class="jxr_linenumber" name="L865" href="#L865">865</a> <em class="jxr_comment">//call reset to prevent resource leaks per</em>
<a class="jxr_linenumber" name="L866" href="#L866">866</a> <em class="jxr_comment">//https://www.securecoding.cert.org/confluence/display/java/SER10-J.+Avoid+memory+and+resource+leaks+during+serialization</em>
<a class="jxr_linenumber" name="L867" href="#L867">867</a> out.reset();
<a class="jxr_linenumber" name="L868" href="#L868">868</a>
<a class="jxr_linenumber" name="L869" href="#L869">869</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L870" href="#L870">870</a> LOGGER.log(Level.WARNING, <span class="jxr_string">"Unable to create data file used for report aggregation; "</span>
<a class="jxr_linenumber" name="L871" href="#L871">871</a> + <span class="jxr_string">"if report aggregation is being used the results may be incomplete."</span>);
<a class="jxr_linenumber" name="L872" href="#L872">872</a> LOGGER.log(Level.FINE, ex.getMessage(), ex);
<a class="jxr_linenumber" name="L873" href="#L873">873</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L874" href="#L874">874</a> <strong class="jxr_keyword">if</strong> (out != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L875" href="#L875">875</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L876" href="#L876">876</a> out.close();
<a class="jxr_linenumber" name="L877" href="#L877">877</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L878" href="#L878">878</a> LOGGER.log(Level.FINEST, <span class="jxr_string">"ignore"</span>, ex);
<a class="jxr_linenumber" name="L879" href="#L879">879</a> }
<a class="jxr_linenumber" name="L880" href="#L880">880</a> }
<a class="jxr_linenumber" name="L881" href="#L881">881</a> <strong class="jxr_keyword">if</strong> (bos != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L882" href="#L882">882</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L883" href="#L883">883</a> bos.close();
<a class="jxr_linenumber" name="L884" href="#L884">884</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L885" href="#L885">885</a> LOGGER.log(Level.FINEST, <span class="jxr_string">"ignore"</span>, ex);
<a class="jxr_linenumber" name="L886" href="#L886">886</a> }
<a class="jxr_linenumber" name="L887" href="#L887">887</a> }
<a class="jxr_linenumber" name="L888" href="#L888">888</a> <strong class="jxr_keyword">if</strong> (os != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L889" href="#L889">889</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L890" href="#L890">890</a> os.close();
<a class="jxr_linenumber" name="L891" href="#L891">891</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L892" href="#L892">892</a> LOGGER.log(Level.FINEST, <span class="jxr_string">"ignore"</span>, ex);
<a class="jxr_linenumber" name="L893" href="#L893">893</a> }
<a class="jxr_linenumber" name="L894" href="#L894">894</a> }
<a class="jxr_linenumber" name="L895" href="#L895">895</a> }
<a class="jxr_linenumber" name="L896" href="#L896">896</a> }
<a class="jxr_linenumber" name="L897" href="#L897">897</a> <strong class="jxr_keyword">return</strong> file;
<a class="jxr_linenumber" name="L898" href="#L898">898</a> }
<a class="jxr_linenumber" name="L899" href="#L899">899</a>
<a class="jxr_linenumber" name="L900" href="#L900">900</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L901" href="#L901">901</a> <em class="jxr_javadoccomment"> * Reads the serialized scan data from disk. This is used to serialize the scan data between the "check" and</em>
<a class="jxr_linenumber" name="L902" href="#L902">902</a> <em class="jxr_javadoccomment"> * "aggregate" phase.</em>
<a class="jxr_linenumber" name="L903" href="#L903">903</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L904" href="#L904">904</a> <em class="jxr_javadoccomment"> * @return a &lt;code&gt;Engine&lt;/code&gt; object populated with dependencies if the serialized data file exists; otherwise</em>
<a class="jxr_linenumber" name="L905" href="#L905">905</a> <em class="jxr_javadoccomment"> * &lt;code&gt;null&lt;/code&gt; is returned</em>
<a class="jxr_linenumber" name="L906" href="#L906">906</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L907" href="#L907">907</a> <strong class="jxr_keyword">protected</strong> List&lt;Dependency&gt; readDataFile() {
<a class="jxr_linenumber" name="L908" href="#L908">908</a> <strong class="jxr_keyword">return</strong> readDataFile(getProject());
<a class="jxr_linenumber" name="L909" href="#L909">909</a> }
<a class="jxr_linenumber" name="L910" href="#L910">910</a>
<a class="jxr_linenumber" name="L911" href="#L911">911</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L912" href="#L912">912</a> <em class="jxr_javadoccomment"> * Reads the serialized scan data from disk. This is used to serialize the scan data between the "check" and</em>
<a class="jxr_linenumber" name="L913" href="#L913">913</a> <em class="jxr_javadoccomment"> * "aggregate" phase.</em>
<a class="jxr_linenumber" name="L914" href="#L914">914</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L915" href="#L915">915</a> <em class="jxr_javadoccomment"> * @param project the Maven project to read the data file from</em>
<a class="jxr_linenumber" name="L916" href="#L916">916</a> <em class="jxr_javadoccomment"> * @return a &lt;code&gt;Engine&lt;/code&gt; object populated with dependencies if the serialized data file exists; otherwise</em>
<a class="jxr_linenumber" name="L917" href="#L917">917</a> <em class="jxr_javadoccomment"> * &lt;code&gt;null&lt;/code&gt; is returned</em>
<a class="jxr_linenumber" name="L918" href="#L918">918</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L919" href="#L919">919</a> <strong class="jxr_keyword">protected</strong> List&lt;Dependency&gt; readDataFile(MavenProject project) {
<a class="jxr_linenumber" name="L920" href="#L920">920</a> <strong class="jxr_keyword">final</strong> Object oPath = project.getContextValue(<strong class="jxr_keyword">this</strong>.getDataFileContextKey());
<a class="jxr_linenumber" name="L921" href="#L921">921</a> <strong class="jxr_keyword">if</strong> (oPath == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L922" href="#L922">922</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L923" href="#L923">923</a> }
<a class="jxr_linenumber" name="L924" href="#L924">924</a> List&lt;Dependency&gt; ret = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L925" href="#L925">925</a> <strong class="jxr_keyword">final</strong> String path = (String) oPath;
<a class="jxr_linenumber" name="L926" href="#L926">926</a> ObjectInputStream ois = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L927" href="#L927">927</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L928" href="#L928">928</a> ois = <strong class="jxr_keyword">new</strong> ObjectInputStream(<strong class="jxr_keyword">new</strong> FileInputStream(path));
<a class="jxr_linenumber" name="L929" href="#L929">929</a> ret = (List&lt;Dependency&gt;) ois.readObject();
<a class="jxr_linenumber" name="L930" href="#L930">930</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
<a class="jxr_linenumber" name="L931" href="#L931">931</a> <em class="jxr_comment">//TODO fix logging</em>
<a class="jxr_linenumber" name="L932" href="#L932">932</a> LOGGER.log(Level.SEVERE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="L933" href="#L933">933</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L934" href="#L934">934</a> LOGGER.log(Level.SEVERE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="L935" href="#L935">935</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException ex) {
<a class="jxr_linenumber" name="L936" href="#L936">936</a> LOGGER.log(Level.SEVERE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="L937" href="#L937">937</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L938" href="#L938">938</a> <strong class="jxr_keyword">if</strong> (ois != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L939" href="#L939">939</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L940" href="#L940">940</a> ois.close();
<a class="jxr_linenumber" name="L941" href="#L941">941</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L942" href="#L942">942</a> LOGGER.log(Level.SEVERE, <strong class="jxr_keyword">null</strong>, ex);
<a class="jxr_linenumber" name="L943" href="#L943">943</a> }
<a class="jxr_linenumber" name="L944" href="#L944">944</a> }
<a class="jxr_linenumber" name="L945" href="#L945">945</a> }
<a class="jxr_linenumber" name="L946" href="#L946">946</a> <strong class="jxr_keyword">return</strong> ret;
<a class="jxr_linenumber" name="L947" href="#L947">947</a> }
<a class="jxr_linenumber" name="L948" href="#L948">948</a> <em class="jxr_comment">//&lt;/editor-fold&gt;</em>
<a class="jxr_linenumber" name="L949" href="#L949">949</a>
<a class="jxr_linenumber" name="L950" href="#L950">950</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

239
dependency-check-maven/xref/org/owasp/dependencycheck/maven/Engine.html
View File

@@ -1,239 +0,0 @@
<!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.List;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.Analyzer;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.CPEAnalyzer;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * A modified version of the core engine specifically designed to persist some data between multiple executions of a multi-module</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Maven project.</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> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</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="L36" href="#L36">36</a>
<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> <em class="jxr_javadoccomment"> * The logger.</em>
<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> <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="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * A key used to persist an object in the MavenProject.</em>
<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> <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="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * The current MavenProject.</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">private</strong> MavenProject currentProject;
<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"> * The list of MavenProjects that are part of the current build.</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> List&lt;MavenProject&gt; reactorProjects;
<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> <em class="jxr_javadoccomment"> * Key used in the MavenProject context values to note whether or not an update has been executed.</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UPDATE_EXECUTED_FLAG = <span class="jxr_string">"dependency-check-update-executed"</span>;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * Creates a new Engine to perform anyalsis on dependencies.</em>
<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"> * @param project the current Maven project</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param reactorProjects the reactor projects for the current Maven execution</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>(MavenProject project, List&lt;MavenProject&gt; reactorProjects) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">this</strong>.currentProject = project;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">this</strong>.reactorProjects = reactorProjects;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> initializeEngine();
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Runs the analyzers against all of the dependencies.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> @Override
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> analyzeDependencies() {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> MavenProject root = getExecutionRoot();
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> LOGGER.fine(String.format(<span class="jxr_string">"Checking root project, %s, if updates have already been completed"</span>, root.getArtifactId()));
<a class="jxr_linenumber" name="L79" href="#L79">79</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> LOGGER.fine(<span class="jxr_string">"Checking root project, null, if updates have already been completed"</span>);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong> &amp;&amp; root.getContextValue(UPDATE_EXECUTED_FLAG) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">super</strong>.analyzeDependencies();
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> root.setContextValue(UPDATE_EXECUTED_FLAG, Boolean.TRUE);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Runs the update steps of dependency-check.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> update() {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> MavenProject root = getExecutionRoot();
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong> &amp;&amp; root.getContextValue(UPDATE_EXECUTED_FLAG) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">this</strong>.doUpdates();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<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> <em class="jxr_javadoccomment"> * This constructor should not be called. Use Engine(MavenProject) instead.</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</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="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"> * Initializes the given analyzer. This skips the initialization of the CPEAnalyzer if it has been initialized by a previous</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * execution.</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to initialize</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @return the initialized analyzer</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> @Override
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">protected</strong> Analyzer initializeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
<a class="jxr_linenumber" name="L124" href="#L124">124</a> cpe = (CPEAnalyzer) <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L125" href="#L125">125</a> storeCPEAnalyzer(cpe);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
<a class="jxr_linenumber" name="L129" href="#L129">129</a>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Releases resources used by the analyzers by calling close() on each analyzer.</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> @Override
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanup() {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">super</strong>.cleanup();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (currentProject == <strong class="jxr_keyword">null</strong> || reactorProjects == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.currentProject == reactorProjects.get(reactorProjects.size() - 1)) {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L142" href="#L142">142</a> cpe.close();
<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>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Closes the given analyzer. This skips closing the CPEAnalyzer.</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"> * @param analyzer the analyzer to close</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> @Override
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (getPreviouslyLoadedCPEAnalyzer() == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L158" href="#L158">158</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<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>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Gets the CPEAnalyzer from the root Maven Project.</em>
<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"> * @return an initialized CPEAnalyzer</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">private</strong> CPEAnalyzer getPreviouslyLoadedCPEAnalyzer() {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> CPEAnalyzer cpe = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">final</strong> MavenProject project = getExecutionRoot();
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">final</strong> Object obj = project.getContextValue(CPE_ANALYZER_KEY);
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (obj != <strong class="jxr_keyword">null</strong> &amp;&amp; obj instanceof CPEAnalyzer) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * Stores a CPEAnalyzer in the root Maven Project.</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"> * @param cpe the CPEAnalyzer to store</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">private</strong> <strong class="jxr_keyword">void</strong> storeCPEAnalyzer(CPEAnalyzer cpe) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> MavenProject p = getExecutionRoot();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> (p != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> p.setContextValue(CPE_ANALYZER_KEY, cpe);
<a class="jxr_linenumber" name="L189" href="#L189">189</a> }
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<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"> * Returns the root Maven Project.</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> <em class="jxr_javadoccomment"> * @return the root Maven Project</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">private</strong> MavenProject getExecutionRoot() {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (reactorProjects == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">for</strong> (MavenProject p : reactorProjects) {
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">if</strong> (p.isExecutionRoot()) {
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> p;
<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> <em class="jxr_comment">//the following should never run, but leaving it as a failsafe.</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</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="L208" href="#L208">208</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a> MavenProject p = <strong class="jxr_keyword">this</strong>.currentProject;
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">while</strong> (p.getParent() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L212" href="#L212">212</a> p = p.getParent();
<a class="jxr_linenumber" name="L213" href="#L213">213</a> }
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">return</strong> p;
<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"> * Resets the file type analyzers so that they can be re-used to scan additional directories. Without the reset the analyzer</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * might be disabled because the first scan/analyze did not identify any files that could be processed by the analyzer.</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> resetFileTypeAnalyzers() {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">for</strong> (FileTypeAnalyzer a : getFileTypeAnalyzers()) {
<a class="jxr_linenumber" name="L223" href="#L223">223</a> a.reset();
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

464
dependency-check-maven/xref/org/owasp/dependencycheck/maven/HelpMojo.html
View File

@@ -1,464 +0,0 @@
<!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>HelpMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/HelpMojo.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.maven;
<a class="jxr_linenumber" name="L3" href="#L3">3</a>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L8" href="#L8">8</a>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Node;
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="L14" href="#L14">14</a>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilder;
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilderFactory;
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.ParserConfigurationException;
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * Display help information on dependency-check-maven.&lt;br&gt;</em>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * Call &lt;code&gt;mvn dependency-check:help -Ddetail=true -Dgoal=&amp;lt;goal-name&amp;gt;&lt;/code&gt; to display parameter details.</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * @author maven-plugin-tools</em>
<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> @Mojo( name = <span class="jxr_string">"help"</span>, requiresProject = false, threadSafe = <strong class="jxr_keyword">true</strong> )
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/HelpMojo.html">HelpMojo</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
<a class="jxr_linenumber" name="L31" href="#L31">31</a> {
<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> <em class="jxr_javadoccomment"> * If &lt;code&gt;true&lt;/code&gt;, display all settable properties for each goal.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
<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> @Parameter( property = <span class="jxr_string">"detail"</span>, defaultValue = <span class="jxr_string">"false"</span> )
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> detail;
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<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"> * The name of the goal for which to show help. If unspecified, all goals will be displayed.</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> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> @Parameter( property = <span class="jxr_string">"goal"</span> )
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> java.lang.String goal;
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<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> <em class="jxr_javadoccomment"> * The maximum length of a display line, should be positive.</em>
<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"> */</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> @Parameter( property = <span class="jxr_string">"lineLength"</span>, defaultValue = <span class="jxr_string">"80"</span> )
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> lineLength;
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<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> <em class="jxr_javadoccomment"> * The number of spaces per indentation level, should be positive.</em>
<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"> */</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Parameter( property = <span class="jxr_string">"indentSize"</span>, defaultValue = <span class="jxr_string">"2"</span> )
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> indentSize;
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_comment">// groupId/artifactId/plugin-help.xml</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PLUGIN_HELP_PATH = <span class="jxr_string">"/META-INF/maven/org.owasp/dependency-check-maven/plugin-help.xml"</span>;
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> Document build()
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L65" href="#L65">65</a> {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> getLog().debug( <span class="jxr_string">"load plugin-help.xml: "</span> + PLUGIN_HELP_PATH );
<a class="jxr_linenumber" name="L67" href="#L67">67</a> InputStream is = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> is = getClass().getResourceAsStream( PLUGIN_HELP_PATH );
<a class="jxr_linenumber" name="L71" href="#L71">71</a> DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
<a class="jxr_linenumber" name="L72" href="#L72">72</a> DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">return</strong> dBuilder.parse( is );
<a class="jxr_linenumber" name="L74" href="#L74">74</a> }
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L76" href="#L76">76</a> {
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">catch</strong> ( ParserConfigurationException e )
<a class="jxr_linenumber" name="L80" href="#L80">80</a> {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">catch</strong> ( SAXException e )
<a class="jxr_linenumber" name="L84" href="#L84">84</a> {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">finally</strong>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> {
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> ( is != <strong class="jxr_keyword">null</strong> )
<a class="jxr_linenumber" name="L90" href="#L90">90</a> {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> is.close();
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
<a class="jxr_linenumber" name="L96" href="#L96">96</a> {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<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> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L108" href="#L108">108</a> {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> ( lineLength &lt;= 0 )
<a class="jxr_linenumber" name="L110" href="#L110">110</a> {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> getLog().warn( <span class="jxr_string">"The parameter 'lineLength' should be positive, using '80' as default."</span> );
<a class="jxr_linenumber" name="L112" href="#L112">112</a> lineLength = 80;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> ( indentSize &lt;= 0 )
<a class="jxr_linenumber" name="L115" href="#L115">115</a> {
<a class="jxr_linenumber" name="L116" href="#L116">116</a> getLog().warn( <span class="jxr_string">"The parameter 'indentSize' should be positive, using '2' as default."</span> );
<a class="jxr_linenumber" name="L117" href="#L117">117</a> indentSize = 2;
<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> Document doc = build();
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L123" href="#L123">123</a> Node plugin = getSingleChild( doc, <span class="jxr_string">"plugin"</span> );
<a class="jxr_linenumber" name="L124" href="#L124">124</a>
<a class="jxr_linenumber" name="L125" href="#L125">125</a>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> String name = getValue( plugin, <span class="jxr_string">"name"</span> );
<a class="jxr_linenumber" name="L127" href="#L127">127</a> String version = getValue( plugin, <span class="jxr_string">"version"</span> );
<a class="jxr_linenumber" name="L128" href="#L128">128</a> String id = getValue( plugin, <span class="jxr_string">"groupId"</span> ) + <span class="jxr_string">":"</span> + getValue( plugin, <span class="jxr_string">"artifactId"</span> ) + <span class="jxr_string">":"</span> + version;
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">if</strong> ( isNotEmpty( name ) &amp;&amp; !name.contains( id ) )
<a class="jxr_linenumber" name="L130" href="#L130">130</a> {
<a class="jxr_linenumber" name="L131" href="#L131">131</a> append( sb, name + <span class="jxr_string">" "</span> + version, 0 );
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">if</strong> ( isNotEmpty( name ) )
<a class="jxr_linenumber" name="L136" href="#L136">136</a> {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> append( sb, name, 0 );
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> {
<a class="jxr_linenumber" name="L141" href="#L141">141</a> append( sb, id, 0 );
<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
<a class="jxr_linenumber" name="L144" href="#L144">144</a> append( sb, getValue( plugin, <span class="jxr_string">"description"</span> ), 1 );
<a class="jxr_linenumber" name="L145" href="#L145">145</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">//&lt;goalPrefix&gt;plugin&lt;/goalPrefix&gt;</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> String goalPrefix = getValue( plugin, <span class="jxr_string">"goalPrefix"</span> );
<a class="jxr_linenumber" name="L149" href="#L149">149</a>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> Node mojos1 = getSingleChild( plugin, <span class="jxr_string">"mojos"</span> );
<a class="jxr_linenumber" name="L151" href="#L151">151</a>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> List&lt;Node&gt; mojos = findNamedChild( mojos1, <span class="jxr_string">"mojo"</span> );
<a class="jxr_linenumber" name="L153" href="#L153">153</a>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">if</strong> ( goal == <strong class="jxr_keyword">null</strong> || goal.length() &lt;= 0 )
<a class="jxr_linenumber" name="L155" href="#L155">155</a> {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> append( sb, <span class="jxr_string">"This plugin has "</span> + mojos.size() + ( mojos.size() &gt; 1 ? <span class="jxr_string">" goals:"</span> : <span class="jxr_string">" goal:"</span> ), 0 );
<a class="jxr_linenumber" name="L157" href="#L157">157</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">for</strong> ( Node mojo : mojos )
<a class="jxr_linenumber" name="L161" href="#L161">161</a> {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> writeGoal( sb, goalPrefix, (Element) mojo );
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() )
<a class="jxr_linenumber" name="L166" href="#L166">166</a> {
<a class="jxr_linenumber" name="L167" href="#L167">167</a> getLog().info( sb.toString() );
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a> }
<a class="jxr_linenumber" name="L170" href="#L170">170</a>
<a class="jxr_linenumber" name="L171" href="#L171">171</a>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isNotEmpty( String string )
<a class="jxr_linenumber" name="L173" href="#L173">173</a> {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">return</strong> string != <strong class="jxr_keyword">null</strong> &amp;&amp; string.length() &gt; 0;
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">private</strong> String getValue( Node node, String elementName )
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L179" href="#L179">179</a> {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">return</strong> getSingleChild( node, elementName ).getTextContent();
<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> <strong class="jxr_keyword">private</strong> Node getSingleChild( Node node, String elementName )
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L185" href="#L185">185</a> {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> List&lt;Node&gt; namedChild = findNamedChild( node, elementName );
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> ( namedChild.isEmpty() )
<a class="jxr_linenumber" name="L188" href="#L188">188</a> {
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Could not find "</span> + elementName + <span class="jxr_string">" in plugin-help.xml"</span> );
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> ( namedChild.size() &gt; 1 )
<a class="jxr_linenumber" name="L192" href="#L192">192</a> {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Multiple "</span> + elementName + <span class="jxr_string">" in plugin-help.xml"</span> );
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">return</strong> namedChild.get( 0 );
<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
<a class="jxr_linenumber" name="L197" href="#L197">197</a>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">private</strong> List&lt;Node&gt; findNamedChild( Node node, String elementName )
<a class="jxr_linenumber" name="L199" href="#L199">199</a> {
<a class="jxr_linenumber" name="L200" href="#L200">200</a> List&lt;Node&gt; result = <strong class="jxr_keyword">new</strong> ArrayList&lt;Node&gt;();
<a class="jxr_linenumber" name="L201" href="#L201">201</a> NodeList childNodes = node.getChildNodes();
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i &lt; childNodes.getLength(); i++ )
<a class="jxr_linenumber" name="L203" href="#L203">203</a> {
<a class="jxr_linenumber" name="L204" href="#L204">204</a> Node item = childNodes.item( i );
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">if</strong> ( elementName.equals( item.getNodeName() ) )
<a class="jxr_linenumber" name="L206" href="#L206">206</a> {
<a class="jxr_linenumber" name="L207" href="#L207">207</a> result.add( item );
<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">return</strong> result;
<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> <strong class="jxr_keyword">private</strong> Node findSingleChild( Node node, String elementName )
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L215" href="#L215">215</a> {
<a class="jxr_linenumber" name="L216" href="#L216">216</a> List&lt;Node&gt; elementsByTagName = findNamedChild( node, elementName );
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> ( elementsByTagName.isEmpty() )
<a class="jxr_linenumber" name="L218" href="#L218">218</a> {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> ( elementsByTagName.size() &gt; 1 )
<a class="jxr_linenumber" name="L222" href="#L222">222</a> {
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Multiple "</span> + elementName + <span class="jxr_string">"in plugin-help.xml"</span> );
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">return</strong> elementsByTagName.get( 0 );
<a class="jxr_linenumber" name="L226" href="#L226">226</a> }
<a class="jxr_linenumber" name="L227" href="#L227">227</a>
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeGoal( StringBuilder sb, String goalPrefix, Element mojo )
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L230" href="#L230">230</a> {
<a class="jxr_linenumber" name="L231" href="#L231">231</a> String mojoGoal = getValue( mojo, <span class="jxr_string">"goal"</span> );
<a class="jxr_linenumber" name="L232" href="#L232">232</a> Node configurationElement = findSingleChild( mojo, <span class="jxr_string">"configuration"</span> );
<a class="jxr_linenumber" name="L233" href="#L233">233</a> Node description = findSingleChild( mojo, <span class="jxr_string">"description"</span> );
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">if</strong> ( goal == <strong class="jxr_keyword">null</strong> || goal.length() &lt;= 0 || mojoGoal.equals( goal ) )
<a class="jxr_linenumber" name="L235" href="#L235">235</a> {
<a class="jxr_linenumber" name="L236" href="#L236">236</a> append( sb, goalPrefix + <span class="jxr_string">":"</span> + mojoGoal, 0 );
<a class="jxr_linenumber" name="L237" href="#L237">237</a> Node deprecated = findSingleChild( mojo, <span class="jxr_string">"deprecated"</span> );
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> ( ( deprecated != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( deprecated.getTextContent() ) )
<a class="jxr_linenumber" name="L239" href="#L239">239</a> {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> append( sb, <span class="jxr_string">"Deprecated. "</span> + deprecated.getTextContent(), 1 );
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> ( detail &amp;&amp; description != <strong class="jxr_keyword">null</strong> )
<a class="jxr_linenumber" name="L242" href="#L242">242</a> {
<a class="jxr_linenumber" name="L243" href="#L243">243</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L244" href="#L244">244</a> append( sb, description.getTextContent(), 1 );
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( description != <strong class="jxr_keyword">null</strong> )
<a class="jxr_linenumber" name="L248" href="#L248">248</a> {
<a class="jxr_linenumber" name="L249" href="#L249">249</a> append( sb, description.getTextContent(), 1 );
<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
<a class="jxr_linenumber" name="L251" href="#L251">251</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> ( detail )
<a class="jxr_linenumber" name="L254" href="#L254">254</a> {
<a class="jxr_linenumber" name="L255" href="#L255">255</a> Node parametersNode = getSingleChild( mojo, <span class="jxr_string">"parameters"</span> );
<a class="jxr_linenumber" name="L256" href="#L256">256</a> List&lt;Node&gt; parameters = findNamedChild( parametersNode, <span class="jxr_string">"parameter"</span> );
<a class="jxr_linenumber" name="L257" href="#L257">257</a> append( sb, <span class="jxr_string">"Available parameters:"</span>, 1 );
<a class="jxr_linenumber" name="L258" href="#L258">258</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L259" href="#L259">259</a>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">for</strong> ( Node parameter : parameters )
<a class="jxr_linenumber" name="L261" href="#L261">261</a> {
<a class="jxr_linenumber" name="L262" href="#L262">262</a> writeParameter( sb, parameter, configurationElement );
<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeParameter( StringBuilder sb, Node parameter, Node configurationElement )
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L270" href="#L270">270</a> {
<a class="jxr_linenumber" name="L271" href="#L271">271</a> String parameterName = getValue( parameter, <span class="jxr_string">"name"</span> );
<a class="jxr_linenumber" name="L272" href="#L272">272</a> String parameterDescription = getValue( parameter, <span class="jxr_string">"description"</span> );
<a class="jxr_linenumber" name="L273" href="#L273">273</a>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> Element fieldConfigurationElement = (Element)findSingleChild( configurationElement, parameterName );
<a class="jxr_linenumber" name="L275" href="#L275">275</a>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> String parameterDefaultValue = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">if</strong> ( fieldConfigurationElement != <strong class="jxr_keyword">null</strong> &amp;&amp; fieldConfigurationElement.hasAttribute( <span class="jxr_string">"default-value"</span> ) )
<a class="jxr_linenumber" name="L278" href="#L278">278</a> {
<a class="jxr_linenumber" name="L279" href="#L279">279</a> parameterDefaultValue = <span class="jxr_string">" (Default: "</span> + fieldConfigurationElement.getAttribute( <span class="jxr_string">"default-value"</span> ) + <span class="jxr_string">")"</span>;
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
<a class="jxr_linenumber" name="L281" href="#L281">281</a> append( sb, parameterName + parameterDefaultValue, 2 );
<a class="jxr_linenumber" name="L282" href="#L282">282</a> Node deprecated = findSingleChild( parameter, <span class="jxr_string">"deprecated"</span> );
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">if</strong> ( ( deprecated != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( deprecated.getTextContent() ) )
<a class="jxr_linenumber" name="L284" href="#L284">284</a> {
<a class="jxr_linenumber" name="L285" href="#L285">285</a> append( sb, <span class="jxr_string">"Deprecated. "</span> + deprecated.getTextContent(), 3 );
<a class="jxr_linenumber" name="L286" href="#L286">286</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L287" href="#L287">287</a> }
<a class="jxr_linenumber" name="L288" href="#L288">288</a> append( sb, parameterDescription, 3 );
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"true"</span>.equals( getValue( parameter, <span class="jxr_string">"required"</span> ) ) )
<a class="jxr_linenumber" name="L290" href="#L290">290</a> {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> append( sb, <span class="jxr_string">"Required: Yes"</span>, 3 );
<a class="jxr_linenumber" name="L292" href="#L292">292</a> }
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">if</strong> ( ( fieldConfigurationElement != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( fieldConfigurationElement.getTextContent() ) )
<a class="jxr_linenumber" name="L294" href="#L294">294</a> {
<a class="jxr_linenumber" name="L295" href="#L295">295</a> String property = getPropertyFromExpression( fieldConfigurationElement.getTextContent() );
<a class="jxr_linenumber" name="L296" href="#L296">296</a> append( sb, <span class="jxr_string">"User property: "</span> + property, 3 );
<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> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L300" href="#L300">300</a> }
<a class="jxr_linenumber" name="L301" href="#L301">301</a>
<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"> * &lt;p&gt;Repeat a String &lt;code&gt;n&lt;/code&gt; times to form a new string.&lt;/p&gt;</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> <em class="jxr_javadoccomment"> * @param str String to repeat</em>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @param repeat number of times to repeat str</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * @return String with repeated String</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * @throws NegativeArraySizeException if &lt;code&gt;repeat &lt; 0&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * @throws NullPointerException if str is &lt;code&gt;null&lt;/code&gt;</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String repeat( String str, <strong class="jxr_keyword">int</strong> repeat )
<a class="jxr_linenumber" name="L312" href="#L312">312</a> {
<a class="jxr_linenumber" name="L313" href="#L313">313</a> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder( repeat * str.length() );
<a class="jxr_linenumber" name="L314" href="#L314">314</a>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i &lt; repeat; i++ )
<a class="jxr_linenumber" name="L316" href="#L316">316</a> {
<a class="jxr_linenumber" name="L317" href="#L317">317</a> buffer.append( str );
<a class="jxr_linenumber" name="L318" href="#L318">318</a> }
<a class="jxr_linenumber" name="L319" href="#L319">319</a>
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">return</strong> buffer.toString();
<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"> * Append a description to the buffer by respecting the indentSize and lineLength parameters.</em>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * &lt;b&gt;Note&lt;/b&gt;: The last character is always a new line.</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> <em class="jxr_javadoccomment"> * @param sb The buffer to append the description, not &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * @param description The description, not &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * @param indent The base indentation level of each line, must not be negative.</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> append( StringBuilder sb, String description, <strong class="jxr_keyword">int</strong> indent )
<a class="jxr_linenumber" name="L332" href="#L332">332</a> {
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">for</strong> ( String line : toLines( description, indent, indentSize, lineLength ) )
<a class="jxr_linenumber" name="L334" href="#L334">334</a> {
<a class="jxr_linenumber" name="L335" href="#L335">335</a> sb.append( line ).append( '\n' );
<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"> * Splits the specified text into lines of convenient display length.</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"> * @param text The text to split into lines, must not be &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * @param indent The base indentation level of each line, must not be negative.</em>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * @param indentSize The size of each indentation, must not be negative.</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * @param lineLength The length of the line, must not be negative.</em>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @return The sequence of display lines, never &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @throws NegativeArraySizeException if &lt;code&gt;indent &lt; 0&lt;/code&gt;</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> List&lt;String&gt; toLines( String text, <strong class="jxr_keyword">int</strong> indent, <strong class="jxr_keyword">int</strong> indentSize, <strong class="jxr_keyword">int</strong> lineLength )
<a class="jxr_linenumber" name="L350" href="#L350">350</a> {
<a class="jxr_linenumber" name="L351" href="#L351">351</a> List&lt;String&gt; lines = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
<a class="jxr_linenumber" name="L352" href="#L352">352</a>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> String ind = repeat( <span class="jxr_string">"\t"</span>, indent );
<a class="jxr_linenumber" name="L354" href="#L354">354</a>
<a class="jxr_linenumber" name="L355" href="#L355">355</a> String[] plainLines = text.split( <span class="jxr_string">"(\r\n)|(\r)|(\n)"</span> );
<a class="jxr_linenumber" name="L356" href="#L356">356</a>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">for</strong> ( String plainLine : plainLines )
<a class="jxr_linenumber" name="L358" href="#L358">358</a> {
<a class="jxr_linenumber" name="L359" href="#L359">359</a> toLines( lines, ind + plainLine, indentSize, lineLength );
<a class="jxr_linenumber" name="L360" href="#L360">360</a> }
<a class="jxr_linenumber" name="L361" href="#L361">361</a>
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">return</strong> lines;
<a class="jxr_linenumber" name="L363" href="#L363">363</a> }
<a class="jxr_linenumber" name="L364" href="#L364">364</a>
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * Adds the specified line to the output sequence, performing line wrapping if necessary.</em>
<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"> * @param lines The sequence of display lines, must not be &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @param line The line to add, must not be &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * @param indentSize The size of each indentation, must not be negative.</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * @param lineLength The length of the line, must not be negative.</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> toLines( List&lt;String&gt; lines, String line, <strong class="jxr_keyword">int</strong> indentSize, <strong class="jxr_keyword">int</strong> lineLength )
<a class="jxr_linenumber" name="L374" href="#L374">374</a> {
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">int</strong> lineIndent = getIndentLevel( line );
<a class="jxr_linenumber" name="L376" href="#L376">376</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder( 256 );
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> String[] tokens = line.split( <span class="jxr_string">" +"</span> );
<a class="jxr_linenumber" name="L379" href="#L379">379</a>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">for</strong> ( String token : tokens )
<a class="jxr_linenumber" name="L381" href="#L381">381</a> {
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">if</strong> ( buf.length() &gt; 0 )
<a class="jxr_linenumber" name="L383" href="#L383">383</a> {
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">if</strong> ( buf.length() + token.length() &gt;= lineLength )
<a class="jxr_linenumber" name="L385" href="#L385">385</a> {
<a class="jxr_linenumber" name="L386" href="#L386">386</a> lines.add( buf.toString() );
<a class="jxr_linenumber" name="L387" href="#L387">387</a> buf.setLength( 0 );
<a class="jxr_linenumber" name="L388" href="#L388">388</a> buf.append( repeat( <span class="jxr_string">" "</span>, lineIndent * indentSize ) );
<a class="jxr_linenumber" name="L389" href="#L389">389</a> }
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> {
<a class="jxr_linenumber" name="L392" href="#L392">392</a> buf.append( ' ' );
<a class="jxr_linenumber" name="L393" href="#L393">393</a> }
<a class="jxr_linenumber" name="L394" href="#L394">394</a> }
<a class="jxr_linenumber" name="L395" href="#L395">395</a>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> j = 0; j &lt; token.length(); j++ )
<a class="jxr_linenumber" name="L397" href="#L397">397</a> {
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">char</strong> c = token.charAt( j );
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">if</strong> ( c == '\t' )
<a class="jxr_linenumber" name="L400" href="#L400">400</a> {
<a class="jxr_linenumber" name="L401" href="#L401">401</a> buf.append( repeat( <span class="jxr_string">" "</span>, indentSize - buf.length() % indentSize ) );
<a class="jxr_linenumber" name="L402" href="#L402">402</a> }
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( c == '\u00A0' )
<a class="jxr_linenumber" name="L404" href="#L404">404</a> {
<a class="jxr_linenumber" name="L405" href="#L405">405</a> buf.append( ' ' );
<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> {
<a class="jxr_linenumber" name="L409" href="#L409">409</a> buf.append( c );
<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> }
<a class="jxr_linenumber" name="L413" href="#L413">413</a> lines.add( buf.toString() );
<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
<a class="jxr_linenumber" name="L415" href="#L415">415</a>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * Gets the indentation level of the specified line.</em>
<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"> * @param line The line whose indentation level should be retrieved, must not be &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * @return The indentation level of the line.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> getIndentLevel( String line )
<a class="jxr_linenumber" name="L423" href="#L423">423</a> {
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">int</strong> level = 0;
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i &lt; line.length() &amp;&amp; line.charAt( i ) == '\t'; i++ )
<a class="jxr_linenumber" name="L426" href="#L426">426</a> {
<a class="jxr_linenumber" name="L427" href="#L427">427</a> level++;
<a class="jxr_linenumber" name="L428" href="#L428">428</a> }
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = level + 1; i &lt;= level + 4 &amp;&amp; i &lt; line.length(); i++ )
<a class="jxr_linenumber" name="L430" href="#L430">430</a> {
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">if</strong> ( line.charAt( i ) == '\t' )
<a class="jxr_linenumber" name="L432" href="#L432">432</a> {
<a class="jxr_linenumber" name="L433" href="#L433">433</a> level++;
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">break</strong>;
<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> <strong class="jxr_keyword">return</strong> level;
<a class="jxr_linenumber" name="L438" href="#L438">438</a> }
<a class="jxr_linenumber" name="L439" href="#L439">439</a>
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">private</strong> String getPropertyFromExpression( String expression )
<a class="jxr_linenumber" name="L441" href="#L441">441</a> {
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">if</strong> ( expression != <strong class="jxr_keyword">null</strong> &amp;&amp; expression.startsWith( <span class="jxr_string">"${"</span> ) &amp;&amp; expression.endsWith( <span class="jxr_string">"}"</span> )
<a class="jxr_linenumber" name="L443" href="#L443">443</a> &amp;&amp; !expression.substring( 2 ).contains( <span class="jxr_string">"${"</span> ) )
<a class="jxr_linenumber" name="L444" href="#L444">444</a> {
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_comment">// expression="${xxx}" -&gt; property="xxx"</em>
<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">return</strong> expression.substring( 2, expression.length() - 1 );
<a class="jxr_linenumber" name="L447" href="#L447">447</a> }
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_comment">// no property can be extracted</em>
<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L450" href="#L450">450</a> }
<a class="jxr_linenumber" name="L451" href="#L451">451</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

481
dependency-check-maven/xref/org/owasp/dependencycheck/maven/ReportAggregationMojo.html
View File

@@ -1,481 +0,0 @@
<!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>ReportAggregationMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/ReportAggregationMojo.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.io.File;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<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.apache.maven.plugin.AbstractMojo;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * This is an abstract reporting mojo that enables report aggregation. Some of the code in the this class was copied</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * from the CoberturaReportMojo (<a href="http://mojo.codehaus.org/cobertura-maven-plugin/," target="alexandria_uri">http://mojo.codehaus.org/cobertura-maven-plugin/,</a> version 2.6). The authors of the</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * CoberturaReportMojo were &lt;a href="will.gwaltney@sas.com"&gt;Will Gwaltney&lt;/a&gt; and</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="mailto:joakim@erdfelt.com" target="alexandria_uri">mailto:joakim@erdfelt.com</a>"&gt;Joakim Erdfelt&lt;/a&gt;. There working example of how to do report aggregation was</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * invaluable.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * An important point about using this abstract class is that it is intended for one to write some form of serialized</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * data (via the {@link org.owasp.dependencycheck.maven.ReportAggregationMojo#writeDataFile() }; note that the</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &lt;code&gt;writeDataFile()&lt;/code&gt; function is called automatically after either {@link org.owasp.dependencycheck.maven.ReportAggregationMojo#executeNonAggregateReport(org.apache.maven.doxia.sink.Sink,</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * } or {@link org.owasp.dependencycheck.maven.ReportAggregationMojo#executeAggregateReport(org.apache.maven.doxia.sink.Sink,</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * org.apache.maven.doxia.sink.SinkFactory, java.util.Locale)</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * } are called. When &lt;code&gt;executeAggregateReport()&lt;/code&gt; is implemented, one can call {@link org.owasp.dependencycheck.maven.ReportAggregationMojo#getChildDataFiles()</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * } to obtain a list of the data files to aggregate.&lt;/p&gt;</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> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @author Jeremy Long &lt;jeremy.long@owasp.org&gt;</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/ReportAggregationMojo.html">ReportAggregationMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo <strong class="jxr_keyword">implements</strong> MavenReport {
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<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"> * The Maven Project Object.</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Component
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> MavenProject project;
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<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"> * Logger field reference.</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> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(ReportAggregationMojo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * List of Maven project of the current build</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter(readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>, property = <span class="jxr_string">"reactorProjects"</span>)
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> List&lt;MavenProject&gt; reactorProjects;
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Generate aggregate reports in multi-module projects.</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Parameter(property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span>)
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> aggregate;
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Sets whether or not the external report format should be used.</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Parameter(property = <span class="jxr_string">"metaFileName"</span>, defaultValue = <span class="jxr_string">"dependency-check.ser"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> String dataFileName;
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Specifies the destination directory for the generated Dependency-Check report. This generally maps to</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * "target/site".</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> @Parameter(property = <span class="jxr_string">"reportOutputDirectory"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> File reportOutputDirectory;
<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"> * Sets the Reporting output directory.</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 directory the output directory</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> @Override
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportOutputDirectory(File directory) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> reportOutputDirectory = directory;
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Returns the output directory.</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @return the output directory</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory() {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong> reportOutputDirectory;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Returns the output directory for the given project.</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @param project the Maven project to get the output directory for</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @return the output directory for the given 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> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory(MavenProject project) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">final</strong> Object o = project.getContextValue(getOutputDirectoryContextKey());
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">if</strong> (o != <strong class="jxr_keyword">null</strong> &amp;&amp; o instanceof File) {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong> (File) o;
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
<a class="jxr_linenumber" name="L130" href="#L130">130</a>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * Returns whether this is an external report. This method always returns true.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @return &lt;code&gt;true&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> @Override
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isExternalReport() {
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<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"> * 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">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"> * 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&lt;MavenProject, Set&lt;MavenProject&gt;&gt; projectChildren = <strong class="jxr_keyword">new</strong> HashMap&lt;MavenProject, Set&lt;MavenProject&gt;&gt;();
<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"> * &lt;/code&gt;super.preExecute()&lt;/code&gt;.</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 &lt;code&gt;writeDataFile()&lt;/code&gt;. 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 &lt;code&gt;super.postExecute()&lt;/code&gt; 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 &lt;code&gt;writeDataFile()&lt;/code&gt;. This key</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * is used in the &lt;code&gt;MavenProject.(set|get)ContextValue&lt;/code&gt;.</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"> * &lt;code&gt;executeAggregateReport()&lt;/code&gt; 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 &lt;code&gt;true&lt;/code&gt; if a non-aggregate report can be generated, otherwise &lt;code&gt;false&lt;/code&gt;</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 &lt;code&gt;true&lt;/code&gt; if an aggregate report can be generated, otherwise &lt;code&gt;false&lt;/code&gt;</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&lt;MavenProject&gt; 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&lt;MavenProject&gt;();
<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 &lt;code&gt;null&lt;/code&gt;.</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&lt;MavenProject&gt; 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 &lt;code&gt;null&lt;/code&gt;.</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&lt;MavenProject&gt; getAllChildren(MavenProject parentProject) {
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">final</strong> Set&lt;MavenProject&gt; 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&lt;MavenProject&gt; result = <strong class="jxr_keyword">new</strong> ArrayList&lt;MavenProject&gt;();
<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&lt;File&gt; getAllChildDataFiles(MavenProject project) {
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">final</strong> List&lt;MavenProject&gt; 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&lt;File&gt; getDataFiles(List&lt;MavenProject&gt; projects) {
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">final</strong> List&lt;File&gt; files = <strong class="jxr_keyword">new</strong> ArrayList&lt;File&gt;();
<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 &lt;code&gt;true&lt;/code&gt; if it has a pom packaging; otherwise &lt;code&gt;false&lt;/code&gt;</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 &lt;code&gt;true&lt;/code&gt; if it has a pom packaging; otherwise &lt;code&gt;false&lt;/code&gt;</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 &lt;code&gt;true&lt;/code&gt; 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"> * &lt;code&gt;false&lt;/code&gt;</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 &lt;code&gt;true&lt;/code&gt; if report aggregation is enabled; otherwise &lt;code&gt;false&lt;/code&gt;</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 &lt;code&gt;@Component MavenProject project;&lt;/code&gt;</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 &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

468
dependency-check-maven/xref/org/owasp/dependencycheck/maven/ReportingUtil.html
View File

@@ -1,468 +0,0 @@
<!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>ReportingUtil xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/ReportingUtil.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.io.File;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.text.DateFormat;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Date;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<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.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 &lt;jeremy.long@owasp.org&gt;</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&lt;Dependency&gt; 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">// &lt;editor-fold defaultstate="collapsed" desc="various writeXXXXX methods to generate the Site Report"&gt;</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> &amp;&amp; !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() &lt; 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() &gt;= 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> &amp;&amp; !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> &amp;&amp; !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> &amp;&amp; !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 &lt;a href=\&quot;javascript:toggleElement(this, 'vulnSoft"</span> + cnt + <span class="jxr_string">"')\&quot;&gt;[-]&lt;/a&gt;"</span>);
<a class="jxr_linenumber" name="L187" href="#L187">187</a> sink.rawText(<span class="jxr_string">"&lt;div id=\&quot;vulnSoft"</span> + cnt + <span class="jxr_string">"\&quot; style=\&quot;display:block\&quot;&gt;"</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">"&lt;/div&gt;"</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> &amp;&amp; !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> &amp;&amp; i.getUrl().length() &gt; 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> &amp;&amp; i.getDescription().length() &gt; 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> &amp;&amp; !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 &lt;a href=\&quot;javascript:toggleElement(this, 'related"</span> + cnt + <span class="jxr_string">"')\&quot;&gt;[+]&lt;/a&gt;"</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">"&lt;div id=\&quot;related"</span> + cnt + <span class="jxr_string">"\&quot; style=\&quot;display:none\&quot;&gt;"</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">"&lt;/div&gt;"</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&lt;Evidence&gt; 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> &amp;&amp; evidence.size() &gt; 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 &lt;a href=\&quot;javascript:toggleElement(this, 'evidence"</span> + cnt + <span class="jxr_string">"')\&quot;&gt;[+]&lt;/a&gt;"</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">"&lt;div id=\&quot;evidence"</span> + cnt + <span class="jxr_string">"\&quot; style=\&quot;display:none\&quot;&gt;"</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">"&lt;/div&gt;"</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> &amp;&amp; d.getDescription().length() &gt; 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> &amp;&amp; d.getLicense().length() &gt; 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>) &amp;&amp; !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&lt;Dependency&gt; 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">" &lt;font style=\&quot;color:red\&quot;&gt;•&lt;/font&gt;"</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">"&lt;script type=\&quot;text/javascript\&quot;&gt;"</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">"&lt;/script&gt;"</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">// &lt;/editor-fold&gt;</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 &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

114
dependency-check-maven/xref/org/owasp/dependencycheck/maven/UpdateMojo.html
View File

@@ -1,114 +0,0 @@
<!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>UpdateMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/maven/UpdateMojo.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) 2013 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.Locale;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<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> <em class="jxr_javadoccomment"> * Maven Plugin that checks the project dependencies to see if they have any known published vulnerabilities.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> @Mojo(
<a class="jxr_linenumber" name="L38" href="#L38">38</a> name = <span class="jxr_string">"update-only"</span>,
<a class="jxr_linenumber" name="L39" href="#L39">39</a> defaultPhase = LifecyclePhase.GENERATE_RESOURCES,
<a class="jxr_linenumber" name="L40" href="#L40">40</a> threadSafe = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L41" href="#L41">41</a> requiresDependencyResolution = ResolutionScope.NONE,
<a class="jxr_linenumber" name="L42" href="#L42">42</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> )
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/UpdateMojo.html">UpdateMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<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> <em class="jxr_javadoccomment"> * Logger field reference.</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = Logger.getLogger(UpdateMojo.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<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> <em class="jxr_javadoccomment"> * Returns false; this mojo cannot generate a report.</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> <em class="jxr_javadoccomment"> * @return &lt;code&gt;false&lt;/code&gt;</em>
<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> @Override
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> false;
<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"> * Executes the dependency-check engine on the project's dependencies and generates the report.</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"> * @throws MojoExecutionException thrown if there is an exception executing the goal</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to fail the build</em>
<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> @Override
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> engine;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> engine = initializeEngine();
<a class="jxr_linenumber" name="L72" href="#L72">72</a> engine.update();
<a class="jxr_linenumber" name="L73" href="#L73">73</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
<a class="jxr_linenumber" name="L74" href="#L74">74</a> LOGGER.log(Level.FINE, <span class="jxr_string">"Database connection error"</span>, ex);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"An exception occured connecting to the local database. Please see the log file for more details."</span>, ex);
<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
<a class="jxr_linenumber" name="L77" href="#L77">77</a> engine.cleanup();
<a class="jxr_linenumber" name="L78" href="#L78">78</a> Settings.cleanup();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-update"</span>;
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @return the description</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> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Updates the local cache of the NVD data from NIST."</span>;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

39
dependency-check-maven/xref/org/owasp/dependencycheck/maven/package-frame.html
View File

@@ -1,39 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.10 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
<h3>
<a href="package-summary.html" target="classFrame">org.owasp.dependencycheck.maven</a>
</h3>
<h3>Classes</h3>
<ul>
<li>
<a href="AggregateMojo.html" target="classFrame">AggregateMojo</a>
</li>
<li>
<a href="BaseDependencyCheckMojo.html" target="classFrame">BaseDependencyCheckMojo</a>
</li>
<li>
<a href="CheckMojo.html" target="classFrame">CheckMojo</a>
</li>
<li>
<a href="Engine.html" target="classFrame">Engine</a>
</li>
<li>
<a href="HelpMojo.html" target="classFrame">HelpMojo</a>
</li>
<li>
<a href="UpdateMojo.html" target="classFrame">UpdateMojo</a>
</li>
</ul>
</body>
</html>

94
dependency-check-maven/xref/org/owasp/dependencycheck/maven/package-summary.html
View File

@@ -1,94 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.10 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
<div class="overview">
<ul>
<li>
<a href="../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<h2>Package org.owasp.dependencycheck.maven</h2>
<table class="summary">
<thead>
<tr>
<th>Class Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="AggregateMojo.html" target="classFrame">AggregateMojo</a>
</td>
</tr>
<tr>
<td>
<a href="BaseDependencyCheckMojo.html" target="classFrame">BaseDependencyCheckMojo</a>
</td>
</tr>
<tr>
<td>
<a href="CheckMojo.html" target="classFrame">CheckMojo</a>
</td>
</tr>
<tr>
<td>
<a href="Engine.html" target="classFrame">Engine</a>
</td>
</tr>
<tr>
<td>
<a href="HelpMojo.html" target="classFrame">HelpMojo</a>
</td>
</tr>
<tr>
<td>
<a href="UpdateMojo.html" target="classFrame">UpdateMojo</a>
</td>
</tr>
</tbody>
</table>
<div class="overview">
<ul>
<li>
<a href="../../../../overview-summary.html">Overview</a>
</li>
<li class="selected">Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="../../../../index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="package-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<hr />
<div id="footer">
Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
</div>
</body>
</html>

25
dependency-check-maven/xref/overview-frame.html
View File

@@ -1,25 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.10 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
<h3>
<a href="allclasses-frame.html" target="packageFrame">All Classes</a>
</h3>
<h3>Packages</h3>
<ul>
<li>
<a href="org/owasp/dependencycheck/maven/package-frame.html" target="packageFrame">org.owasp.dependencycheck.maven</a>
</li>
</ul>
</body>
</html>

66
dependency-check-maven/xref/overview-summary.html
View File

@@ -1,66 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.10 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
<div class="overview">
<ul>
<li class="selected">Overview</li>
<li>Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="overview-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<h2>Dependency-Check Maven Plugin 1.2.10 Reference</h2>
<table class="summary">
<thead>
<tr>
<th>Packages</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="org/owasp/dependencycheck/maven/package-summary.html">org.owasp.dependencycheck.maven</a>
</td>
</tr>
</tbody>
</table>
<div class="overview">
<ul>
<li class="selected">Overview</li>
<li>Package</li>
</ul>
</div>
<div class="framenoframe">
<ul>
<li>
<a href="index.html" target="_top">FRAMES</a>
</li>
<li>
<a href="overview-summary.html" target="_top">NO FRAMES</a>
</li>
</ul>
</div>
<hr />
<div id="footer">
Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
</div>
</body>
</html>

114
dependency-check-maven/xref/stylesheet.css
View File

@@ -1,114 +0,0 @@
/* Javadoc style sheet */
/* Define colors, fonts and other style attributes here to override the defaults */
body {
background-color: #fff;
font-family: Arial, Helvetica, sans-serif;
}
a:link {
color: #00f;
}
a:visited {
color: #00a;
}
a:active, a:hover {
color: #f30 !important;
}
ul, li {
list-style-type:none;
margin:0;
padding:0;
}
table td {
padding: 3px;
border: 1px solid #000;
}
table {
width:100%;
border: 1px solid #000;
border-collapse: collapse;
}
div.overview {
background-color:#ddd;
padding: 4px 4px 4px 0;
}
div.overview li, div.framenoframe li {
display: inline;
}
div.framenoframe {
text-align: center;
font-size: x-small;
}
div.framenoframe li {
margin: 0 3px 0 3px;
}
div.overview li {
margin:3px 3px 0 3px;
padding: 4px;
}
li.selected {
background-color:#888;
color: #fff;
font-weight: bold;
}
table.summary {
margin-bottom: 20px;
}
table.summary td, table.summary th {
font-weight: bold;
text-align: left;
padding: 3px;
}
table.summary th {
background-color:#036;
color: #fff;
}
table.summary td {
background-color:#eee;
border: 1px solid black;
}
em {
color: #A00;
}
em.comment {
color: #390;
}
.string {
color: #009;
}
#overview {
padding:2px;
}
hr {
height: 1px;
color: #000;
}
/* JXR style sheet */
.jxr_comment
{
color: #390;
}
.jxr_javadoccomment
{
color: #A00;
}
.jxr_string
{
color: #009;
}
.jxr_keyword
{
color: #000;
}