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

version 1.2.9 of documentation

Browse Source
This commit is contained in:
Jeremy Long
2015-03-06 19:43:56 -05:00
parent 641235ed9a
commit bca392355f
1416 changed files with 49885 additions and 32066 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -12,19 +12,19 @@
<ul>
<li>
<a href="org/owasp/dependencycheck/maven/DependencyCheckMojo.html" target="classFrame">DependencyCheckMojo</a>
<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/ReportAggregationMojo.html" target="classFrame">ReportAggregationMojo</a>
</li>
<li>
<a href="org/owasp/dependencycheck/maven/ReportingUtil.html" target="classFrame">ReportingUtil</a>
</li>
</ul>

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

@@ -4,7 +4,7 @@
<!-- 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.7 Reference</title>
<title>Dependency-Check Maven Plugin 1.2.9 Reference</title>
</head>
<frameset cols="20%,80%">
<frameset rows="30%,70%">

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

@@ -0,0 +1,277 @@
<!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 &lt;jeremy.long@owasp.org&gt;</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 Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -0,0 +1,131 @@
<!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 &lt;jeremy.long@owasp.org&gt;</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>

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

@@ -25,150 +25,211 @@
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.maven;
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.Analyzer;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.CPEAnalyzer;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * A modified version of the core engine specifically designed to persist some data between multiple executions of a</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * multi-module Maven project.</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @author Jeremy Long &lt;jeremy.long@owasp.org&gt;</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a> <strong class="jxr_keyword">extends</strong> org.owasp.dependencycheck.Engine {
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">transient</strong> Logger LOGGER = Logger.getLogger(Engine.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * A key used to persist an object in the MavenProject.</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CPE_ANALYZER_KEY = <span class="jxr_string">"dependency-check-CPEAnalyzer"</span>;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The current MavenProject.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> MavenProject currentProject;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Creates a new Engine to perform anyalsis on dependencies.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param project the current Maven project</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>(MavenProject project) <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">this</strong>.currentProject = project;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">final</strong> MavenProject parent = getRootParent();
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (parent != <strong class="jxr_keyword">null</strong> &amp;&amp; parent.getContextValue(<span class="jxr_string">"dependency-check-data-was-updated"</span>) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
<a class="jxr_linenumber" name="L60" href="#L60">60</a> initializeEngine();
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (parent != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> parent.setContextValue(<span class="jxr_string">"dependency-check-data-was-updated"</span>, Boolean.valueOf(<strong class="jxr_keyword">true</strong>));
<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * This constructor should not be called. Use Engine(MavenProject) instead.</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the database</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/maven/Engine.html">Engine</a>() <strong class="jxr_keyword">throws</strong> DatabaseException {
<a class="jxr_linenumber" name="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</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * data between multiple executions of a multi-module 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 &lt;jeremy.long@owasp.org&gt;</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</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * update has been executed.</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">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="L58" href="#L58">58</a>
<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"> * Creates a new Engine to perform anyalsis on dependencies.</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> <em class="jxr_javadoccomment"> * @param project the current Maven project</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @param reactorProjects the reactor projects for the current Maven</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * execution</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * database</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">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="L69" href="#L69">69</a> <strong class="jxr_keyword">this</strong>.currentProject = project;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">this</strong>.reactorProjects = reactorProjects;
<a class="jxr_linenumber" name="L71" href="#L71">71</a> initializeEngine();
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Initializes the given analyzer. This skips the initialization of the CPEAnalyzer if it has been initialized by a</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * previous execution.</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to initialize</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @return the initialized analyzer</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Override
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> Analyzer initializeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> CPEAnalyzer cpe = getPreviouslyLoadedAnalyzer();
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a> cpe = (CPEAnalyzer) <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> storeCPEAnalyzer(cpe);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Runs the analyzers against all of the dependencies.</em>
<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> @Override
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> analyzeDependencies() {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">final</strong> MavenProject root = getExecutionRoot();
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L81" href="#L81">81</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="L82" href="#L82">82</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> LOGGER.fine(<span class="jxr_string">"Checking root project, null, if updates have already been completed"</span>);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</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="L86" href="#L86">86</a> System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">super</strong>.analyzeDependencies();
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (root != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> root.setContextValue(UPDATE_EXECUTED_FLAG, Boolean.TRUE);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Closes the given analyzer. This skips closing the CPEAnalyzer.</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * This constructor should not be called. Use Engine(MavenProject) instead.</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to close</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> @Override
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (getPreviouslyLoadedAnalyzer() == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * Closes the CPEAnalyzer if it has been created and persisted in the root parent MavenProject context.</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanupFinal() {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">final</strong> CPEAnalyzer cpe = getPreviouslyLoadedAnalyzer();
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L116" href="#L116">116</a> cpe.close();
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Gets the CPEAnalyzer from the root Maven Project.</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @return an initialized CPEAnalyzer</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">private</strong> CPEAnalyzer getPreviouslyLoadedAnalyzer() {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> CPEAnalyzer cpe = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">final</strong> MavenProject project = getRootParent();
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Stores a CPEAnalyzer in the root Maven Project.</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param cpe the CPEAnalyzer to store</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> storeCPEAnalyzer(CPEAnalyzer cpe) {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> MavenProject p = getRootParent();
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (p != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L142" href="#L142">142</a> p.setContextValue(CPE_ANALYZER_KEY, cpe);
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Returns the root Maven Project.</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @return the root Maven Project</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> MavenProject getRootParent() {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.currentProject == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws DatabaseException thrown if there is an issue connecting to the</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * database</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> <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="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"> * Initializes the given analyzer. This skips the initialization of the</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * CPEAnalyzer if it has been initialized by a previous execution.</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> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to initialize</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @return the initialized analyzer</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> @Override
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">protected</strong> Analyzer initializeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> cpe = (CPEAnalyzer) <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L118" href="#L118">118</a> storeCPEAnalyzer(cpe);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.initializeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a>
<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"> * Releases resources used by the analyzers by calling close() on each</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * analyzer.</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> @Override
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> cleanup() {
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">super</strong>.cleanup();
<a class="jxr_linenumber" name="L130" href="#L130">130</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="L131" href="#L131">131</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.currentProject == reactorProjects.get(reactorProjects.size() - 1)) {
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">if</strong> (cpe != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> cpe.close();
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
<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"> * Closes the given analyzer. This skips closing the CPEAnalyzer.</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> <em class="jxr_javadoccomment"> * @param analyzer the analyzer to close</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> @Override
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeAnalyzer(Analyzer analyzer) {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> ((analyzer instanceof CPEAnalyzer)) {
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (getPreviouslyLoadedCPEAnalyzer() == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">super</strong>.closeAnalyzer(analyzer);
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> MavenProject p = <strong class="jxr_keyword">this</strong>.currentProject;
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">while</strong> (p.getParent() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> p = p.getParent();
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong> p;
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
<a class="jxr_linenumber" name="L156" href="#L156">156</a>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Gets the CPEAnalyzer from the root Maven Project.</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @return an initialized CPEAnalyzer</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> <strong class="jxr_keyword">private</strong> CPEAnalyzer getPreviouslyLoadedCPEAnalyzer() {
<a class="jxr_linenumber" name="L163" href="#L163">163</a> CPEAnalyzer cpe = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">final</strong> MavenProject project = getExecutionRoot();
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">final</strong> Object obj = project.getContextValue(CPE_ANALYZER_KEY);
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> (obj != <strong class="jxr_keyword">null</strong> &amp;&amp; obj instanceof CPEAnalyzer) {
<a class="jxr_linenumber" name="L168" href="#L168">168</a> cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
<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> <strong class="jxr_keyword">return</strong> cpe;
<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * Stores a CPEAnalyzer in the root Maven Project.</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> <em class="jxr_javadoccomment"> * @param cpe the CPEAnalyzer to store</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> storeCPEAnalyzer(CPEAnalyzer cpe) {
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">final</strong> MavenProject p = getExecutionRoot();
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> (p != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L182" href="#L182">182</a> p.setContextValue(CPE_ANALYZER_KEY, cpe);
<a class="jxr_linenumber" name="L183" href="#L183">183</a> }
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Returns the root Maven Project.</em>
<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"> * @return the root Maven Project</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> <strong class="jxr_keyword">private</strong> MavenProject getExecutionRoot() {
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (reactorProjects == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">for</strong> (MavenProject p : reactorProjects) {
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">if</strong> (p.isExecutionRoot()) {
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong> p;
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
<a class="jxr_linenumber" name="L199" href="#L199">199</a> }
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_comment">//the following should never run, but leaving it as a failsafe.</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</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="L202" href="#L202">202</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
<a class="jxr_linenumber" name="L204" href="#L204">204</a> MavenProject p = <strong class="jxr_keyword">this</strong>.currentProject;
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">while</strong> (p.getParent() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> p = p.getParent();
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">return</strong> p;
<a class="jxr_linenumber" name="L209" href="#L209">209</a> }
<a class="jxr_linenumber" name="L210" href="#L210">210</a>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * Resets the file type analyzers so that they can be re-used to scan</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * additional directories. Without the reset the analyzer might be disabled</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * because the first scan/analyze did not identify any files that could be</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * processed by the analyzer.</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> resetFileTypeAnalyzers() {
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">for</strong> (FileTypeAnalyzer a : getFileTypeAnalyzers()) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> a.reset();
<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
<a class="jxr_linenumber" name="L221" href="#L221">221</a> }
<a class="jxr_linenumber" name="L222" href="#L222">222</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

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

@@ -6,76 +6,76 @@
</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> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.maven;
<a class="jxr_linenumber" name="L2" href="#L2">2</a>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L7" href="#L7">7</a>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document;
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Node;
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> org.xml.sax.SAXException;
<a class="jxr_linenumber" name="L13" href="#L13">13</a>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilder;
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.DocumentBuilderFactory;
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.ParserConfigurationException;
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<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="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</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @version</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> @Mojo( name = <span class="jxr_string">"help"</span>, requiresProject = false, threadSafe = <strong class="jxr_keyword">true</strong> )
<a class="jxr_linenumber" name="L30" href="#L30">30</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="L31" href="#L31">31</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
<a class="jxr_linenumber" name="L32" href="#L32">32</a> {
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</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="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> *</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> @Parameter( property = <span class="jxr_string">"detail"</span>, defaultValue = <span class="jxr_string">"false"</span> )
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> detail;
<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"> * The name of the goal for which to show help. If unspecified, all goals will be displayed.</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> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> @Parameter( property = <span class="jxr_string">"goal"</span> )
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> java.lang.String goal;
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<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> <em class="jxr_javadoccomment"> * The maximum length of a display line, should be positive.</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> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> @Parameter( property = <span class="jxr_string">"lineLength"</span>, defaultValue = <span class="jxr_string">"80"</span> )
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> lineLength;
<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"> * The number of spaces per indentation level, should be positive.</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> @Parameter( property = <span class="jxr_string">"indentSize"</span>, defaultValue = <span class="jxr_string">"2"</span> )
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> indentSize;
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_comment">// groupId/artifactId/plugin-help.xml</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</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="L63" href="#L63">63</a>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> Document build()
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L66" href="#L66">66</a> {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> getLog().debug( <span class="jxr_string">"load plugin-help.xml: "</span> + PLUGIN_HELP_PATH );
<a class="jxr_linenumber" name="L68" href="#L68">68</a> InputStream is = getClass().getResourceAsStream( PLUGIN_HELP_PATH );
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">try</strong>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> {
<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 );
@@ -92,360 +92,373 @@
<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> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L94" href="#L94">94</a> {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> ( lineLength &lt;= 0 )
<a class="jxr_linenumber" name="L96" href="#L96">96</a> {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> getLog().warn( <span class="jxr_string">"The parameter 'lineLength' should be positive, using '80' as default."</span> );
<a class="jxr_linenumber" name="L98" href="#L98">98</a> lineLength = 80;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> ( indentSize &lt;= 0 )
<a class="jxr_linenumber" name="L101" href="#L101">101</a> {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> getLog().warn( <span class="jxr_string">"The parameter 'indentSize' should be positive, using '2' as default."</span> );
<a class="jxr_linenumber" name="L103" href="#L103">103</a> indentSize = 2;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> Document doc = build();
<a class="jxr_linenumber" name="L107" href="#L107">107</a>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L109" href="#L109">109</a> Node plugin = getSingleChild( doc, <span class="jxr_string">"plugin"</span> );
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> String name = getValue( plugin, <span class="jxr_string">"name"</span> );
<a class="jxr_linenumber" name="L113" href="#L113">113</a> String version = getValue( plugin, <span class="jxr_string">"version"</span> );
<a class="jxr_linenumber" name="L114" href="#L114">114</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="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> ( isNotEmpty( name ) &amp;&amp; !name.contains( id ) )
<a class="jxr_linenumber" name="L116" href="#L116">116</a> {
<a class="jxr_linenumber" name="L117" href="#L117">117</a> append( sb, name + <span class="jxr_string">" "</span> + version, 0 );
<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> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> {
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">if</strong> ( isNotEmpty( name ) )
<a class="jxr_linenumber" name="L122" href="#L122">122</a> {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> append( sb, name, 0 );
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> {
<a class="jxr_linenumber" name="L127" href="#L127">127</a> append( sb, id, 0 );
<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> append( sb, getValue( plugin, <span class="jxr_string">"description"</span> ), 1 );
<a class="jxr_linenumber" name="L131" href="#L131">131</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L132" href="#L132">132</a>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">//&lt;goalPrefix&gt;plugin&lt;/goalPrefix&gt;</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> String goalPrefix = getValue( plugin, <span class="jxr_string">"goalPrefix"</span> );
<a class="jxr_linenumber" name="L135" href="#L135">135</a>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> Node mojos1 = getSingleChild( plugin, <span class="jxr_string">"mojos"</span> );
<a class="jxr_linenumber" name="L137" href="#L137">137</a>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> List&lt;Node&gt; mojos = findNamedChild( mojos1, <span class="jxr_string">"mojo"</span> );
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> ( goal == <strong class="jxr_keyword">null</strong> || goal.length() &lt;= 0 )
<a class="jxr_linenumber" name="L141" href="#L141">141</a> {
<a class="jxr_linenumber" name="L142" href="#L142">142</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="L143" href="#L143">143</a> append( sb, <span class="jxr_string">""</span>, 0 );
<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> <strong class="jxr_keyword">for</strong> ( Node mojo : mojos )
<a class="jxr_linenumber" name="L147" href="#L147">147</a> {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> writeGoal( sb, goalPrefix, (Element) mojo );
<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> <strong class="jxr_keyword">if</strong> ( getLog().isInfoEnabled() )
<a class="jxr_linenumber" name="L152" href="#L152">152</a> {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> getLog().info( sb.toString() );
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
<a class="jxr_linenumber" name="L156" href="#L156">156</a>
<a class="jxr_linenumber" name="L157" href="#L157">157</a>
<a class="jxr_linenumber" name="L158" href="#L158">158</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="L159" href="#L159">159</a> {
<a class="jxr_linenumber" name="L160" href="#L160">160</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="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> <strong class="jxr_keyword">private</strong> String getValue( Node node, String elementName )
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L165" href="#L165">165</a> {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">return</strong> getSingleChild( node, elementName ).getTextContent();
<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
<a class="jxr_linenumber" name="L168" href="#L168">168</a>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">private</strong> Node getSingleChild( Node node, String elementName )
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L171" href="#L171">171</a> {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> List&lt;Node&gt; namedChild = findNamedChild( node, elementName );
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> ( namedChild.isEmpty() )
<a class="jxr_linenumber" name="L174" href="#L174">174</a> {
<a class="jxr_linenumber" name="L175" href="#L175">175</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="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> ( namedChild.size() &gt; 1 )
<a class="jxr_linenumber" name="L178" href="#L178">178</a> {
<a class="jxr_linenumber" name="L179" href="#L179">179</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="L180" href="#L180">180</a> }
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">return</strong> namedChild.get( 0 );
<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> <strong class="jxr_keyword">private</strong> List&lt;Node&gt; findNamedChild( Node node, String elementName )
<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; result = <strong class="jxr_keyword">new</strong> ArrayList&lt;Node&gt;();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> NodeList childNodes = node.getChildNodes();
<a class="jxr_linenumber" name="L188" href="#L188">188</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="L189" href="#L189">189</a> {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> Node item = childNodes.item( i );
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> ( elementName.equals( item.getNodeName() ) )
<a class="jxr_linenumber" name="L192" href="#L192">192</a> {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> result.add( item );
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
<a class="jxr_linenumber" name="L198" href="#L198">198</a>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">private</strong> Node findSingleChild( Node node, String elementName )
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L201" href="#L201">201</a> {
<a class="jxr_linenumber" name="L202" href="#L202">202</a> List&lt;Node&gt; elementsByTagName = findNamedChild( node, elementName );
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">if</strong> ( elementsByTagName.isEmpty() )
<a class="jxr_linenumber" name="L204" href="#L204">204</a> {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> ( elementsByTagName.size() &gt; 1 )
<a class="jxr_linenumber" name="L208" href="#L208">208</a> {
<a class="jxr_linenumber" name="L209" href="#L209">209</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="L210" href="#L210">210</a> }
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">return</strong> elementsByTagName.get( 0 );
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeGoal( StringBuilder sb, String goalPrefix, Element mojo )
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L216" href="#L216">216</a> {
<a class="jxr_linenumber" name="L217" href="#L217">217</a> String mojoGoal = getValue( mojo, <span class="jxr_string">"goal"</span> );
<a class="jxr_linenumber" name="L218" href="#L218">218</a> Node configurationElement = findSingleChild( mojo, <span class="jxr_string">"configuration"</span> );
<a class="jxr_linenumber" name="L219" href="#L219">219</a> Node description = findSingleChild( mojo, <span class="jxr_string">"description"</span> );
<a class="jxr_linenumber" name="L220" href="#L220">220</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="L221" href="#L221">221</a> {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> append( sb, goalPrefix + <span class="jxr_string">":"</span> + mojoGoal, 0 );
<a class="jxr_linenumber" name="L223" href="#L223">223</a> Node deprecated = findSingleChild( mojo, <span class="jxr_string">"deprecated"</span> );
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> ( ( deprecated != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( deprecated.getNodeValue() ) )
<a class="jxr_linenumber" name="L225" href="#L225">225</a> {
<a class="jxr_linenumber" name="L226" href="#L226">226</a> append( sb, <span class="jxr_string">"Deprecated. "</span> + deprecated, 1 );
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> ( detail &amp;&amp; description != <strong class="jxr_keyword">null</strong> )
<a class="jxr_linenumber" name="L228" href="#L228">228</a> {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L230" href="#L230">230</a> append( sb, description.getTextContent(), 1 );
<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
<a class="jxr_linenumber" name="L233" href="#L233">233</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="L234" href="#L234">234</a> {
<a class="jxr_linenumber" name="L235" href="#L235">235</a> append( sb, description.getTextContent(), 1 );
<a class="jxr_linenumber" name="L236" href="#L236">236</a> }
<a class="jxr_linenumber" name="L237" href="#L237">237</a> append( sb, <span class="jxr_string">""</span>, 0 );
<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> ( detail )
<a class="jxr_linenumber" name="L240" href="#L240">240</a> {
<a class="jxr_linenumber" name="L241" href="#L241">241</a> Node parametersNode = getSingleChild( mojo, <span class="jxr_string">"parameters"</span> );
<a class="jxr_linenumber" name="L242" href="#L242">242</a> List&lt;Node&gt; parameters = findNamedChild( parametersNode, <span class="jxr_string">"parameter"</span> );
<a class="jxr_linenumber" name="L243" href="#L243">243</a> append( sb, <span class="jxr_string">"Available parameters:"</span>, 1 );
<a class="jxr_linenumber" name="L244" href="#L244">244</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L245" href="#L245">245</a>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">for</strong> ( Node parameter : parameters )
<a class="jxr_linenumber" name="L247" href="#L247">247</a> {
<a class="jxr_linenumber" name="L248" href="#L248">248</a> writeParameter( sb, parameter, configurationElement );
<a class="jxr_linenumber" name="L249" href="#L249">249</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> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeParameter( StringBuilder sb, Node parameter, Node configurationElement )
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
<a class="jxr_linenumber" name="L256" href="#L256">256</a> {
<a class="jxr_linenumber" name="L257" href="#L257">257</a> String parameterName = getValue( parameter, <span class="jxr_string">"name"</span> );
<a class="jxr_linenumber" name="L258" href="#L258">258</a> String parameterDescription = getValue( parameter, <span class="jxr_string">"description"</span> );
<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> Node fieldConfigurationElement = findSingleChild( configurationElement, parameterName );
<a class="jxr_linenumber" name="L261" href="#L261">261</a>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> String parameterDefaultValue = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">if</strong> ( fieldConfigurationElement != <strong class="jxr_keyword">null</strong> &amp;&amp; fieldConfigurationElement.getNodeValue() != <strong class="jxr_keyword">null</strong> )
<a class="jxr_linenumber" name="L264" href="#L264">264</a> {
<a class="jxr_linenumber" name="L265" href="#L265">265</a> parameterDefaultValue = <span class="jxr_string">" (Default: "</span> + ((Element)fieldConfigurationElement).getAttribute( <span class="jxr_string">"default-value"</span> ) + <span class="jxr_string">")"</span>;
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a> append( sb, parameterName + parameterDefaultValue, 2 );
<a class="jxr_linenumber" name="L268" href="#L268">268</a> Node deprecated = findSingleChild( parameter, <span class="jxr_string">"deprecated"</span> );
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> ( ( deprecated != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( deprecated.getNodeValue() ) )
<a class="jxr_linenumber" name="L270" href="#L270">270</a> {
<a class="jxr_linenumber" name="L271" href="#L271">271</a> append( sb, <span class="jxr_string">"Deprecated. "</span> + deprecated.getNodeValue(), 3 );
<a class="jxr_linenumber" name="L272" href="#L272">272</a> append( sb, <span class="jxr_string">""</span>, 0 );
<a class="jxr_linenumber" name="L273" href="#L273">273</a> }
<a class="jxr_linenumber" name="L274" href="#L274">274</a> append( sb, parameterDescription, 3 );
<a class="jxr_linenumber" name="L275" href="#L275">275</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="L276" href="#L276">276</a> {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> append( sb, <span class="jxr_string">"Required: Yes"</span>, 3 );
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
<a class="jxr_linenumber" name="L279" href="#L279">279</a> Node expression = findSingleChild( parameter, <span class="jxr_string">"expression"</span> );
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> ( ( expression != <strong class="jxr_keyword">null</strong> ) &amp;&amp; isNotEmpty( expression.getNodeValue() ) )
<a class="jxr_linenumber" name="L281" href="#L281">281</a> {
<a class="jxr_linenumber" name="L282" href="#L282">282</a> String property = getPropertyFromExpression( expression.getNodeValue() );
<a class="jxr_linenumber" name="L283" href="#L283">283</a> append( sb, <span class="jxr_string">"User property: "</span> + property, 3 );
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> 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>
<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> <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="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @param str String to repeat</em>
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param repeat number of times to repeat str</em>
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * @return String with repeated String</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * @throws NegativeArraySizeException if &lt;code&gt;repeat &lt; 0&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * @throws NullPointerException if str is &lt;code&gt;null&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</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="L299" href="#L299">299</a> {
<a class="jxr_linenumber" name="L300" href="#L300">300</a> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder( repeat * str.length() );
<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> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i &lt; repeat; i++ )
<a class="jxr_linenumber" name="L303" href="#L303">303</a> {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> buffer.append( str );
<a class="jxr_linenumber" name="L305" href="#L305">305</a> }
<a class="jxr_linenumber" name="L306" href="#L306">306</a>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">return</strong> buffer.toString();
<a class="jxr_linenumber" name="L308" href="#L308">308</a> }
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * Append a description to the buffer by respecting the indentSize and lineLength parameters.</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</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="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</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="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * @param description The description, not &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param indent The base indentation level of each line, must not be negative.</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <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="L319" href="#L319">319</a> {
<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">for</strong> ( String line : toLines( description, indent, indentSize, lineLength ) )
<a class="jxr_linenumber" name="L321" href="#L321">321</a> {
<a class="jxr_linenumber" name="L322" href="#L322">322</a> sb.append( line ).append( '\n' );
<a class="jxr_linenumber" name="L323" href="#L323">323</a> }
<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
<a class="jxr_linenumber" name="L325" href="#L325">325</a>
<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"> * Splits the specified text into lines of convenient display length.</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</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="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @param indent The base indentation level of each line, must not be negative.</em>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * @param indentSize The size of each indentation, must not be negative.</em>
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * @param lineLength The length of the line, must not be negative.</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</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="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @throws NegativeArraySizeException if &lt;code&gt;indent &lt; 0&lt;/code&gt;</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</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="L337" href="#L337">337</a> {
<a class="jxr_linenumber" name="L338" href="#L338">338</a> List&lt;String&gt; lines = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
<a class="jxr_linenumber" name="L339" href="#L339">339</a>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> String ind = repeat( <span class="jxr_string">"\t"</span>, indent );
<a class="jxr_linenumber" name="L341" href="#L341">341</a>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> String[] plainLines = text.split( <span class="jxr_string">"(\r\n)|(\r)|(\n)"</span> );
<a class="jxr_linenumber" name="L343" href="#L343">343</a>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">for</strong> ( String plainLine : plainLines )
<a class="jxr_linenumber" name="L345" href="#L345">345</a> {
<a class="jxr_linenumber" name="L346" href="#L346">346</a> toLines( lines, ind + plainLine, indentSize, lineLength );
<a class="jxr_linenumber" name="L347" href="#L347">347</a> }
<a class="jxr_linenumber" name="L348" href="#L348">348</a>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">return</strong> lines;
<a class="jxr_linenumber" name="L350" href="#L350">350</a> }
<a class="jxr_linenumber" name="L351" href="#L351">351</a>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * Adds the specified line to the output sequence, performing line wrapping if necessary.</em>
<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"> * @param lines The sequence of display lines, must not be &lt;code&gt;null&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L356" href="#L356">356</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="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @param indentSize The size of each indentation, must not be negative.</em>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @param lineLength The length of the line, must not be negative.</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> 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="L361" href="#L361">361</a> {
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">int</strong> lineIndent = getIndentLevel( line );
<a class="jxr_linenumber" name="L363" href="#L363">363</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder( 256 );
<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> String[] tokens = line.split( <span class="jxr_string">" +"</span> );
<a class="jxr_linenumber" name="L366" href="#L366">366</a>
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">for</strong> ( String token : tokens )
<a class="jxr_linenumber" name="L368" href="#L368">368</a> {
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">if</strong> ( buf.length() &gt; 0 )
<a class="jxr_linenumber" name="L370" href="#L370">370</a> {
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> ( buf.length() + token.length() &gt;= lineLength )
<a class="jxr_linenumber" name="L372" href="#L372">372</a> {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> lines.add( buf.toString() );
<a class="jxr_linenumber" name="L374" href="#L374">374</a> buf.setLength( 0 );
<a class="jxr_linenumber" name="L375" href="#L375">375</a> buf.append( repeat( <span class="jxr_string">" "</span>, lineIndent * indentSize ) );
<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> {
<a class="jxr_linenumber" name="L379" href="#L379">379</a> buf.append( ' ' );
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L382" href="#L382">382</a>
<a class="jxr_linenumber" name="L383" href="#L383">383</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="L384" href="#L384">384</a> {
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">char</strong> c = token.charAt( j );
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">if</strong> ( c == '\t' )
<a class="jxr_linenumber" name="L387" href="#L387">387</a> {
<a class="jxr_linenumber" name="L388" href="#L388">388</a> buf.append( repeat( <span class="jxr_string">" "</span>, indentSize - buf.length() % indentSize ) );
<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> <strong class="jxr_keyword">if</strong> ( c == '\u00A0' )
<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> <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> {
<a class="jxr_linenumber" name="L396" href="#L396">396</a> buf.append( c );
<a class="jxr_linenumber" name="L397" href="#L397">397</a> }
<a class="jxr_linenumber" name="L398" href="#L398">398</a> }
<a class="jxr_linenumber" name="L399" href="#L399">399</a> }
<a class="jxr_linenumber" name="L400" href="#L400">400</a> lines.add( buf.toString() );
<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
<a class="jxr_linenumber" name="L402" href="#L402">402</a>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * Gets the indentation level of the specified line.</em>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</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="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * @return The indentation level of the line.</em>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L409" href="#L409">409</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="L410" href="#L410">410</a> {
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">int</strong> level = 0;
<a class="jxr_linenumber" name="L412" href="#L412">412</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="L413" href="#L413">413</a> {
<a class="jxr_linenumber" name="L414" href="#L414">414</a> level++;
<a class="jxr_linenumber" name="L415" href="#L415">415</a> }
<a class="jxr_linenumber" name="L416" href="#L416">416</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="L417" href="#L417">417</a> {
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">if</strong> ( line.charAt( i ) == '\t' )
<a class="jxr_linenumber" name="L419" href="#L419">419</a> {
<a class="jxr_linenumber" name="L420" href="#L420">420</a> level++;
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
<a class="jxr_linenumber" name="L423" href="#L423">423</a> }
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">return</strong> level;
<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
<a class="jxr_linenumber" name="L426" href="#L426">426</a>
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">private</strong> String getPropertyFromExpression( String expression )
<a class="jxr_linenumber" name="L428" href="#L428">428</a> {
<a class="jxr_linenumber" name="L429" href="#L429">429</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="L430" href="#L430">430</a> &amp;&amp; !expression.substring( 2 ).contains( <span class="jxr_string">"${"</span> ) )
<a class="jxr_linenumber" name="L431" href="#L431">431</a> {
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_comment">// expression="${xxx}" -&gt; property="xxx"</em>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">return</strong> expression.substring( 2, expression.length() - 1 );
<a class="jxr_linenumber" name="L434" href="#L434">434</a> }
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_comment">// no property can be extracted</em>
<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L437" href="#L437">437</a> }
<a class="jxr_linenumber" name="L438" href="#L438">438</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;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
<div id="footer">Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>

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

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.2.7 Reference Package org.owasp.dependencycheck.maven</title>
<title>Dependency-Check Maven Plugin 1.2.9 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
@@ -16,19 +16,19 @@
<ul>
<li>
<a href="DependencyCheckMojo.html" target="classFrame">DependencyCheckMojo</a>
<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="ReportAggregationMojo.html" target="classFrame">ReportAggregationMojo</a>
</li>
<li>
<a href="ReportingUtil.html" target="classFrame">ReportingUtil</a>
</li>
</ul>

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

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.2.7 Reference Package org.owasp.dependencycheck.maven</title>
<title>Dependency-Check Maven Plugin 1.2.9 Reference Package org.owasp.dependencycheck.maven</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>
@@ -37,7 +37,17 @@
<tbody>
<tr>
<td>
<a href="DependencyCheckMojo.html" target="classFrame">DependencyCheckMojo</a>
<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>
@@ -49,16 +59,6 @@
<td>
<a href="HelpMojo.html" target="classFrame">HelpMojo</a>
</td>
</tr>
<tr>
<td>
<a href="ReportAggregationMojo.html" target="classFrame">ReportAggregationMojo</a>
</td>
</tr>
<tr>
<td>
<a href="ReportingUtil.html" target="classFrame">ReportingUtil</a>
</td>
</tr>
</tbody>
</table>
@@ -83,7 +83,7 @@
</div>
<hr />
<div id="footer">
Copyright &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
</div>
</body>
</html>

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

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.2.7 Reference</title>
<title>Dependency-Check Maven Plugin 1.2.9 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>

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

@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Dependency-Check Maven Plugin 1.2.7 Reference</title>
<title>Dependency-Check Maven Plugin 1.2.9 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
@@ -24,7 +24,7 @@
</ul>
</div>
<h2>Dependency-Check Maven Plugin 1.2.7 Reference</h2>
<h2>Dependency-Check Maven Plugin 1.2.9 Reference</h2>
<table class="summary">
<thead>
@@ -60,7 +60,7 @@
<hr />
<div id="footer">
Copyright &#169; 2013&#x2013;2014 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
Copyright &#169; 2013&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
</div>
</body>
</html>