Modified: websites/production/maven/content/plugins-archives/maven-linkcheck-plugin-LATEST/xref/org/apache/maven/plugins/linkcheck/LinkcheckReport.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-linkcheck-plugin-LATEST/xref/org/apache/maven/plugins/linkcheck/LinkcheckReport.html (original) +++ websites/production/maven/content/plugins-archives/maven-linkcheck-plugin-LATEST/xref/org/apache/maven/plugins/linkcheck/LinkcheckReport.html Wed Oct 8 11:19:38 2014 @@ -1,587 +1,516 @@ <!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=ISO-8859-1" /> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <title>LinkcheckReport xref</title> <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> </head> <body> <div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/linkcheck/LinkcheckReport.html">View Javadoc</a></div><pre> - -<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.linkcheck; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> -<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> -<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em> -<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> -<a name="21" href="#21">21</a> -<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.net.URL; -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; -<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a name="30" href="#30">30</a> -<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository; -<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.HttpBean; -<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.LinkCheck; -<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.LinkCheckException; -<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.model.LinkcheckModel; -<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer; -<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport; -<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; -<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Proxy; -<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; -<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N; -<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; -<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; -<a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a name="47" href="#47">47</a> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Generates a <code>Linkcheck</code> report.</em> -<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> -<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Vincent Siveton</a></em> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @version $Id: LinkcheckReport.java 1021298 2010-10-11 10:18:19Z ltheussl $</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @since 1.0</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @goal linkcheck</em> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> -<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/linkcheck/LinkcheckReport.html">LinkcheckReport</a> -<a name="57" href="#57">57</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport -<a name="58" href="#58">58</a> { -<a name="59" href="#59">59</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="60" href="#60">60</a> <em class="jxr_comment">// Report Components</em> -<a name="61" href="#61">61</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="62" href="#62">62</a> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Internationalization.</em> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> -<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @component</em> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> -<a name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> I18N i18n; -<a name="69" href="#69">69</a> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Doxia Site Renderer.</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> *</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @component</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em> -<a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> Renderer siteRenderer; -<a name="76" href="#76">76</a> -<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em> -<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * LinkCheck component.</em> -<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @component</em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> -<a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> LinkCheck linkCheck; -<a name="83" href="#83">83</a> -<a name="84" href="#84">84</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="85" href="#85">85</a> <em class="jxr_comment">// Report Parameters</em> -<a name="86" href="#86">86</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="87" href="#87">87</a> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> -<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * The Maven Project.</em> -<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em> -<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @parameter expression="${project}"</em> -<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> */</em> -<a name="95" href="#95">95</a> <strong class="jxr_keyword">private</strong> MavenProject project; -<a name="96" href="#96">96</a> -<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em> -<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Local Repository.</em> -<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em> -<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @parameter expression="${localRepository}"</em> -<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em> -<a name="104" href="#104">104</a> <strong class="jxr_keyword">private</strong> ArtifactRepository localRepository; -<a name="105" href="#105">105</a> -<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">/**</em> -<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * Report output directory.</em> -<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em> -<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @parameter expression="${project.reporting.outputDirectory}"</em> -<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> */</em> -<a name="112" href="#112">112</a> <strong class="jxr_keyword">private</strong> File outputDirectory; -<a name="113" href="#113">113</a> -<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em> -<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * The Maven Settings.</em> -<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> *</em> -<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @parameter default-value="${settings}"</em> -<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> -<a name="121" href="#121">121</a> <strong class="jxr_keyword">private</strong> Settings settings; -<a name="122" href="#122">122</a> -<a name="123" href="#123">123</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="124" href="#124">124</a> <em class="jxr_comment">// Linkcheck parameters</em> -<a name="125" href="#125">125</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="126" href="#126">126</a> -<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> -<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Whether we are offline or not.</em> -<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> *</em> -<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @parameter default-value="${settings.offline}" expression="${linkcheck.offline}"</em> -<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em> -<a name="133" href="#133">133</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> offline; -<a name="134" href="#134">134</a> -<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em> -<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * If online, the HTTP method should automatically follow HTTP redirects,</em> -<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * <tt>false</tt> otherwise.</em> -<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em> -<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @parameter default-value="true"</em> -<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em> -<a name="141" href="#141">141</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> httpFollowRedirect; -<a name="142" href="#142">142</a> -<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> -<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * The location of the Linkcheck cache file.</em> -<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> *</em> -<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.build.directory}/linkcheck/linkcheck.cache"</em> -<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> */</em> -<a name="149" href="#149">149</a> <strong class="jxr_keyword">protected</strong> File linkcheckCache; -<a name="150" href="#150">150</a> -<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em> -<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * The location of the Linkcheck report file.</em> -<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> *</em> -<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.build.directory}/linkcheck/linkcheck.xml"</em> -<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> */</em> -<a name="157" href="#157">157</a> <strong class="jxr_keyword">protected</strong> File linkcheckOutput; -<a name="158" href="#158">158</a> -<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">/**</em> -<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * The HTTP method to use. Currently supported are "GET" and "HEAD".</em> -<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * <dl></em> -<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * <dt>HTTP GET</dt></em> -<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * <dd></em> -<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * The HTTP GET method is defined in section 9.3 of</em> -<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.ietf.org/rfc/rfc2616.txt"; target="alexandria_uri">http://www.ietf.org/rfc/rfc2616.txt</a>">RFC2616</a>:</em> -<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * The GET method means retrieve whatever information (in the form of an</em> -<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * entity) is identified by the Request-URI.</em> -<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * </dd></em> -<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * <dt>HTTP HEAD</dt></em> -<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * <dd></em> -<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * The HTTP HEAD method is defined in section 9.4 of</em> -<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.ietf.org/rfc/rfc2616.txt"; target="alexandria_uri">http://www.ietf.org/rfc/rfc2616.txt</a>">RFC2616</a>:</em> -<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * The HEAD method is identical to GET except that the server MUST NOT</em> -<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * return a message-body in the response.</em> -<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * </dd></em> -<a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * </dl></em> -<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> *</em> -<a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @parameter default-value="head"</em> -<a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @required</em> -<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> */</em> -<a name="181" href="#181">181</a> <strong class="jxr_keyword">private</strong> String httpMethod; -<a name="182" href="#182">182</a> -<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">/**</em> -<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * The list of HTTP errors to ignored, like <code>404</code>.</em> -<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> *</em> -<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @parameter</em> -<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.</em> -<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> */</em> -<a name="189" href="#189">189</a> <strong class="jxr_keyword">private</strong> Integer[] excludedHttpStatusErrors; -<a name="190" href="#190">190</a> -<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">/**</em> -<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * The list of HTTP warnings to ignored, like <code>301</code>.</em> -<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> *</em> -<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @parameter</em> -<a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.</em> -<a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> */</em> -<a name="197" href="#197">197</a> <strong class="jxr_keyword">private</strong> Integer[] excludedHttpStatusWarnings; -<a name="198" href="#198">198</a> -<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">/**</em> -<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * A list of pages to exclude.</em> -<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * <br/></em> -<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * <b>Note</b>:</em> -<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * <br/></em> -<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * <ul></em> -<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * <li>This report, i.e. <code>linkcheck.html</code>, is always excluded.</li></em> -<a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * <li>May contain Ant-style wildcards and double wildcards, e.g. <code>apidocs/**</code>, etc.</li></em> -<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * </ul></em> -<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> *</em> -<a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @parameter</em> -<a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> */</em> -<a name="211" href="#211">211</a> <strong class="jxr_keyword">private</strong> String[] excludedPages; -<a name="212" href="#212">212</a> -<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em> -<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * The list of links to exclude.</em> -<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * <br/></em> -<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Patterns like <code>&#42;&#42;/dummy/&#42;</code> are allowed for excludedLink.</em> -<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> *</em> -<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @parameter</em> -<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> */</em> -<a name="220" href="#220">220</a> <strong class="jxr_keyword">private</strong> String[] excludedLinks; -<a name="221" href="#221">221</a> -<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">/**</em> -<a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * The file encoding to use when Linkcheck reads the source files. If the property</em> -<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * <code>project.build.sourceEncoding</code> is not set, the platform default encoding is used.</em> -<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> *</em> -<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"</em> -<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em> -<a name="228" href="#228">228</a> <strong class="jxr_keyword">private</strong> String encoding; -<a name="229" href="#229">229</a> -<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">/**</em> -<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * The extra HttpClient parameters to be used when fetching links. For instance:</em> -<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * <pre></em> -<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * &lt;httpClientParameters&gt;</em> -<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * &nbsp;&lt;property&gt;</em> -<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * &nbsp;&nbsp;&lt;name&gt;http.protocol.max-redirects&lt;/name&gt;</em> -<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * &nbsp;&nbsp;&lt;value&gt;10&lt;/value&gt;</em> -<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * &nbsp;&lt;/property&gt;</em> -<a name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * &lt;/httpClientParameters&gt;</em> -<a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * </pre></em> -<a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * See <a href="<a href="http://hc.apache.org/httpclient-3.x/preference-api.html"; target="alexandria_uri">http://hc.apache.org/httpclient-3.x/preference-api.html</a>">HttpClient preference page</a></em> -<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> *</em> -<a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * @parameter expression="${httpClientParameters}"</em> -<a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> */</em> -<a name="244" href="#244">244</a> <strong class="jxr_keyword">private</strong> Properties httpClientParameters; -<a name="245" href="#245">245</a> -<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">/**</em> -<a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * Set the timeout to be used when fetching links. A value of zero means the timeout is not used.</em> -<a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> *</em> -<a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * @parameter expression="${timeout}" default-value="2000"</em> -<a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> */</em> -<a name="251" href="#251">251</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> timeout; -<a name="252" href="#252">252</a> -<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">/**</em> -<a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * <code>true</code> to skip the report execution, <code>false</code> otherwise.</em> -<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * The purpose is to prevent infinite call when {@link #forceSite} is enable.</em> -<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> *</em> -<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * @parameter expression="${linkcheck.skip}" default-value="false"</em> -<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> */</em> -<a name="259" href="#259">259</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a name="260" href="#260">260</a> -<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">/**</em> -<a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * <code>true</code> to force the site generation, <code>false</code> otherwise.</em> -<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Using this parameter ensures that all documents have been correctly generated.</em> -<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> *</em> -<a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @parameter expression="${linkcheck.forceSite}" default-value="true"</em> -<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> */</em> -<a name="267" href="#267">267</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceSite; -<a name="268" href="#268">268</a> -<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">/**</em> -<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * The base URL to use for absolute links (eg <code>/index.html</code>) in the site.</em> -<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> *</em> -<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @parameter expression="${linkcheck.baseURL}" default-value="${project.url}"</em> -<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> */</em> -<a name="274" href="#274">274</a> <strong class="jxr_keyword">private</strong> String baseURL; -<a name="275" href="#275">275</a> -<a name="276" href="#276">276</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="277" href="#277">277</a> <em class="jxr_comment">// Instance fields</em> -<a name="278" href="#278">278</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="279" href="#279">279</a> -<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Result of the linkcheck in {@link #execute()} */</em> -<a name="281" href="#281">281</a> <strong class="jxr_keyword">private</strong> LinkcheckModel result; -<a name="282" href="#282">282</a> -<a name="283" href="#283">283</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_SUCCESS = <span class="jxr_string">"images/icon_success_sml.gif"</span>; -<a name="284" href="#284">284</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_WARNING = <span class="jxr_string">"images/icon_warning_sml.gif"</span>; -<a name="285" href="#285">285</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_INFO = <span class="jxr_string">"images/icon_info_sml.gif"</span>; -<a name="286" href="#286">286</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_ERROR = <span class="jxr_string">"images/icon_error_sml.gif"</span>; -<a name="287" href="#287">287</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String pluginResourcesBase = <span class="jxr_string">"org/apache/maven/plugin/linkcheck"</span>; -<a name="288" href="#288">288</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String resourceNames[] = { ICON_SUCCESS, ICON_WARNING, ICON_INFO, ICON_ERROR }; -<a name="289" href="#289">289</a> -<a name="290" href="#290">290</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="291" href="#291">291</a> <em class="jxr_comment">// Public methods</em> -<a name="292" href="#292">292</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="293" href="#293">293</a> -<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="295" href="#295">295</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) -<a name="296" href="#296">296</a> { -<a name="297" href="#297">297</a> <strong class="jxr_keyword">return</strong> i18n.getString( <span class="jxr_string">"linkcheck-report"</span>, locale, <span class="jxr_string">"report.linkcheck.description"</span> ); -<a name="298" href="#298">298</a> } -<a name="299" href="#299">299</a> -<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="301" href="#301">301</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) -<a name="302" href="#302">302</a> { -<a name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong> i18n.getString( <span class="jxr_string">"linkcheck-report"</span>, locale, <span class="jxr_string">"report.linkcheck.name"</span> ); -<a name="304" href="#304">304</a> } -<a name="305" href="#305">305</a> -<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="307" href="#307">307</a> <strong class="jxr_keyword">public</strong> String getOutputName() -<a name="308" href="#308">308</a> { -<a name="309" href="#309">309</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"linkcheck"</span>; -<a name="310" href="#310">310</a> } -<a name="311" href="#311">311</a> -<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="313" href="#313">313</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() -<a name="314" href="#314">314</a> { -<a name="315" href="#315">315</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a name="316" href="#316">316</a> { -<a name="317" href="#317">317</a> <strong class="jxr_keyword">return</strong> false; -<a name="318" href="#318">318</a> } -<a name="319" href="#319">319</a> -<a name="320" href="#320">320</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a name="321" href="#321">321</a> } -<a name="322" href="#322">322</a> -<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="324" href="#324">324</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a name="325" href="#325">325</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a name="326" href="#326">326</a> { -<a name="327" href="#327">327</a> <strong class="jxr_keyword">if</strong> ( !canGenerateReport() ) -<a name="328" href="#328">328</a> { -<a name="329" href="#329">329</a> <strong class="jxr_keyword">return</strong>; -<a name="330" href="#330">330</a> } -<a name="331" href="#331">331</a> -<a name="332" href="#332">332</a> checkEncoding(); -<a name="333" href="#333">333</a> -<a name="334" href="#334">334</a> <strong class="jxr_keyword">try</strong> -<a name="335" href="#335">335</a> { -<a name="336" href="#336">336</a> result = executeLinkCheck( getBasedir() ); -<a name="337" href="#337">337</a> } -<a name="338" href="#338">338</a> <strong class="jxr_keyword">catch</strong> ( LinkCheckException e ) -<a name="339" href="#339">339</a> { -<a name="340" href="#340">340</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"LinkCheckException: "</span> + e.getMessage(), e ); -<a name="341" href="#341">341</a> } -<a name="342" href="#342">342</a> } -<a name="343" href="#343">343</a> -<a name="344" href="#344">344</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="345" href="#345">345</a> <em class="jxr_comment">// Protected methods</em> -<a name="346" href="#346">346</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="347" href="#347">347</a> -<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="349" href="#349">349</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory() -<a name="350" href="#350">350</a> { -<a name="351" href="#351">351</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath(); -<a name="352" href="#352">352</a> } -<a name="353" href="#353">353</a> -<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="355" href="#355">355</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() -<a name="356" href="#356">356</a> { -<a name="357" href="#357">357</a> <strong class="jxr_keyword">return</strong> project; -<a name="358" href="#358">358</a> } -<a name="359" href="#359">359</a> -<a name="360" href="#360">360</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="361" href="#361">361</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() -<a name="362" href="#362">362</a> { -<a name="363" href="#363">363</a> <strong class="jxr_keyword">return</strong> siteRenderer; -<a name="364" href="#364">364</a> } -<a name="365" href="#365">365</a> -<a name="366" href="#366">366</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> -<a name="367" href="#367">367</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) -<a name="368" href="#368">368</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a name="369" href="#369">369</a> { -<a name="370" href="#370">370</a> <strong class="jxr_keyword">if</strong> ( result == <strong class="jxr_keyword">null</strong> ) -<a name="371" href="#371">371</a> { -<a name="372" href="#372">372</a> getLog().debug( <span class="jxr_string">"Calling execute()"</span> ); -<a name="373" href="#373">373</a> -<a name="374" href="#374">374</a> <strong class="jxr_keyword">try</strong> -<a name="375" href="#375">375</a> { -<a name="376" href="#376">376</a> <strong class="jxr_keyword">this</strong>.execute(); -<a name="377" href="#377">377</a> } -<a name="378" href="#378">378</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) -<a name="379" href="#379">379</a> { -<a name="380" href="#380">380</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"MojoExecutionException: "</span> + e.getMessage(), e ); -<a name="381" href="#381">381</a> } -<a name="382" href="#382">382</a> } -<a name="383" href="#383">383</a> -<a name="384" href="#384">384</a> <strong class="jxr_keyword">if</strong> ( result != <strong class="jxr_keyword">null</strong> ) -<a name="385" href="#385">385</a> { -<a name="386" href="#386">386</a> generateReport( locale, result ); -<a name="387" href="#387">387</a> <em class="jxr_comment">// free memory</em> -<a name="388" href="#388">388</a> result = <strong class="jxr_keyword">null</strong>; -<a name="389" href="#389">389</a> } -<a name="390" href="#390">390</a> } -<a name="391" href="#391">391</a> -<a name="392" href="#392">392</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="393" href="#393">393</a> <em class="jxr_comment">// Private methods</em> -<a name="394" href="#394">394</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="395" href="#395">395</a> -<a name="396" href="#396">396</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkEncoding() -<a name="397" href="#397">397</a> { -<a name="398" href="#398">398</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( encoding ) ) -<a name="399" href="#399">399</a> { -<a name="400" href="#400">400</a> <strong class="jxr_keyword">if</strong> ( getLog().isWarnEnabled() ) -<a name="401" href="#401">401</a> { -<a name="402" href="#402">402</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> -<a name="403" href="#403">403</a> + ReaderFactory.FILE_ENCODING + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); -<a name="404" href="#404">404</a> } -<a name="405" href="#405">405</a> -<a name="406" href="#406">406</a> encoding = ReaderFactory.FILE_ENCODING; -<a name="407" href="#407">407</a> } -<a name="408" href="#408">408</a> } -<a name="409" href="#409">409</a> -<a name="410" href="#410">410</a> <strong class="jxr_keyword">private</strong> File getBasedir() -<a name="411" href="#411">411</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a name="412" href="#412">412</a> { -<a name="413" href="#413">413</a> File basedir; -<a name="414" href="#414">414</a> -<a name="415" href="#415">415</a> <strong class="jxr_keyword">if</strong> ( forceSite ) -<a name="416" href="#416">416</a> { -<a name="417" href="#417">417</a> basedir = <strong class="jxr_keyword">new</strong> File( linkcheckOutput.getParentFile(), <span class="jxr_string">"tmpsite"</span> ); -<a name="418" href="#418">418</a> basedir.mkdirs(); -<a name="419" href="#419">419</a> -<a name="420" href="#420">420</a> List documents = <strong class="jxr_keyword">null</strong>; -<a name="421" href="#421">421</a> <strong class="jxr_keyword">try</strong> -<a name="422" href="#422">422</a> { -<a name="423" href="#423">423</a> documents = FileUtils.getFiles( basedir, <span class="jxr_string">"**/*.html"</span>, <strong class="jxr_keyword">null</strong> ); -<a name="424" href="#424">424</a> } -<a name="425" href="#425">425</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="426" href="#426">426</a> { -<a name="427" href="#427">427</a> getLog().error( <span class="jxr_string">"IOException: "</span> + e.getMessage() ); -<a name="428" href="#428">428</a> getLog().debug( e ); -<a name="429" href="#429">429</a> } -<a name="430" href="#430">430</a> -<a name="431" href="#431">431</a> <em class="jxr_comment">// if the site was not already generated, invoke it</em> -<a name="432" href="#432">432</a> <strong class="jxr_keyword">if</strong> ( documents == <strong class="jxr_keyword">null</strong> || ( documents != <strong class="jxr_keyword">null</strong> && documents.size() == 0 ) ) -<a name="433" href="#433">433</a> { -<a name="434" href="#434">434</a> getLog().info( <span class="jxr_string">"Invoking the maven-site-plugin to ensure that all files are generated..."</span> ); -<a name="435" href="#435">435</a> -<a name="436" href="#436">436</a> <strong class="jxr_keyword">try</strong> -<a name="437" href="#437">437</a> { -<a name="438" href="#438">438</a> <a href="../../../../../org/apache/maven/plugins/linkcheck/SiteInvoker.html">SiteInvoker</a> invoker = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/linkcheck/SiteInvoker.html">SiteInvoker</a>( localRepository, getLog() ); -<a name="439" href="#439">439</a> invoker.invokeSite( project, basedir ); -<a name="440" href="#440">440</a> } -<a name="441" href="#441">441</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="442" href="#442">442</a> { -<a name="443" href="#443">443</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"IOException: "</span> + e.getMessage(), e ); -<a name="444" href="#444">444</a> } -<a name="445" href="#445">445</a> } -<a name="446" href="#446">446</a> } -<a name="447" href="#447">447</a> <strong class="jxr_keyword">else</strong> -<a name="448" href="#448">448</a> { -<a name="449" href="#449">449</a> getLog().warn( <span class="jxr_string">"The number of documents analyzed by Linkcheck could differ from the actual "</span> -<a name="450" href="#450">450</a> + <span class="jxr_string">"number of documents!"</span> ); -<a name="451" href="#451">451</a> -<a name="452" href="#452">452</a> basedir = outputDirectory; -<a name="453" href="#453">453</a> basedir.mkdirs(); -<a name="454" href="#454">454</a> } -<a name="455" href="#455">455</a> -<a name="456" href="#456">456</a> <strong class="jxr_keyword">return</strong> basedir; -<a name="457" href="#457">457</a> } -<a name="458" href="#458">458</a> -<a name="459" href="#459">459</a> <em class="jxr_javadoccomment">/**</em> -<a name="460" href="#460">460</a> <em class="jxr_javadoccomment"> * Execute the <code>Linkcheck</code> tool.</em> -<a name="461" href="#461">461</a> <em class="jxr_javadoccomment"> *</em> -<a name="462" href="#462">462</a> <em class="jxr_javadoccomment"> * @param basedir not null</em> -<a name="463" href="#463">463</a> <em class="jxr_javadoccomment"> * @throws LinkCheckException if any</em> -<a name="464" href="#464">464</a> <em class="jxr_javadoccomment"> */</em> -<a name="465" href="#465">465</a> <strong class="jxr_keyword">private</strong> LinkcheckModel executeLinkCheck( File basedir ) -<a name="466" href="#466">466</a> <strong class="jxr_keyword">throws</strong> LinkCheckException -<a name="467" href="#467">467</a> { -<a name="468" href="#468">468</a> <em class="jxr_comment">// Wrap linkcheck</em> -<a name="469" href="#469">469</a> linkCheck.setOnline( !offline ); -<a name="470" href="#470">470</a> linkCheck.setBasedir( basedir ); -<a name="471" href="#471">471</a> linkCheck.setBaseURL( baseURL ); -<a name="472" href="#472">472</a> linkCheck.setReportOutput( linkcheckOutput ); -<a name="473" href="#473">473</a> linkCheck.setLinkCheckCache( linkcheckCache ); -<a name="474" href="#474">474</a> linkCheck.setExcludedLinks( excludedLinks ); -<a name="475" href="#475">475</a> linkCheck.setExcludedPages( getExcludedPages() ); -<a name="476" href="#476">476</a> linkCheck.setExcludedHttpStatusErrors( asIntArray( excludedHttpStatusErrors ) ); -<a name="477" href="#477">477</a> linkCheck.setExcludedHttpStatusWarnings( asIntArray( excludedHttpStatusWarnings ) ); -<a name="478" href="#478">478</a> linkCheck.setEncoding( ( StringUtils.isNotEmpty( encoding ) ? encoding : ReaderFactory.UTF_8 ) ); -<a name="479" href="#479">479</a> -<a name="480" href="#480">480</a> HttpBean bean = <strong class="jxr_keyword">new</strong> HttpBean(); -<a name="481" href="#481">481</a> bean.setMethod( httpMethod ); -<a name="482" href="#482">482</a> bean.setFollowRedirects( httpFollowRedirect ); -<a name="483" href="#483">483</a> bean.setTimeout( timeout ); -<a name="484" href="#484">484</a> <strong class="jxr_keyword">if</strong> ( httpClientParameters != <strong class="jxr_keyword">null</strong> ) -<a name="485" href="#485">485</a> { -<a name="486" href="#486">486</a> bean.setHttpClientParameters( httpClientParameters ); -<a name="487" href="#487">487</a> } -<a name="488" href="#488">488</a> -<a name="489" href="#489">489</a> Proxy proxy = settings.getActiveProxy(); -<a name="490" href="#490">490</a> <strong class="jxr_keyword">if</strong> ( proxy != <strong class="jxr_keyword">null</strong> ) -<a name="491" href="#491">491</a> { -<a name="492" href="#492">492</a> bean.setProxyHost( proxy.getHost() ); -<a name="493" href="#493">493</a> bean.setProxyPort( proxy.getPort() ); -<a name="494" href="#494">494</a> bean.setProxyUser( proxy.getUsername() ); -<a name="495" href="#495">495</a> bean.setProxyPassword( proxy.getPassword() ); -<a name="496" href="#496">496</a> } -<a name="497" href="#497">497</a> linkCheck.setHttp( bean ); -<a name="498" href="#498">498</a> -<a name="499" href="#499">499</a> <strong class="jxr_keyword">return</strong> linkCheck.execute(); -<a name="500" href="#500">500</a> } -<a name="501" href="#501">501</a> -<a name="502" href="#502">502</a> <em class="jxr_javadoccomment">/**</em> -<a name="503" href="#503">503</a> <em class="jxr_javadoccomment"> * @return the excludedPages defined by the user and also this report.</em> -<a name="504" href="#504">504</a> <em class="jxr_javadoccomment"> */</em> -<a name="505" href="#505">505</a> <strong class="jxr_keyword">private</strong> String[] getExcludedPages() -<a name="506" href="#506">506</a> { -<a name="507" href="#507">507</a> List pagesToExclude = -<a name="508" href="#508">508</a> ( excludedPages != <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">new</strong> ArrayList( Arrays.asList( excludedPages ) ) : <strong class="jxr_keyword">new</strong> ArrayList() ); -<a name="509" href="#509">509</a> -<a name="510" href="#510">510</a> <em class="jxr_comment">// Exclude this report</em> -<a name="511" href="#511">511</a> pagesToExclude.add( getOutputName() + <span class="jxr_string">".html"</span> ); -<a name="512" href="#512">512</a> -<a name="513" href="#513">513</a> <strong class="jxr_keyword">return</strong> (String[]) pagesToExclude.toArray( <strong class="jxr_keyword">new</strong> String[0] ); -<a name="514" href="#514">514</a> } -<a name="515" href="#515">515</a> -<a name="516" href="#516">516</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="517" href="#517">517</a> <em class="jxr_comment">// Linkcheck report</em> -<a name="518" href="#518">518</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> -<a name="519" href="#519">519</a> -<a name="520" href="#520">520</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateReport( Locale locale, LinkcheckModel linkcheckModel ) -<a name="521" href="#521">521</a> { -<a name="522" href="#522">522</a> <a href="../../../../../org/apache/maven/plugins/linkcheck/LinkcheckReportGenerator.html">LinkcheckReportGenerator</a> reportGenerator = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/linkcheck/LinkcheckReportGenerator.html">LinkcheckReportGenerator</a>( i18n ); -<a name="523" href="#523">523</a> -<a name="524" href="#524">524</a> reportGenerator.setExcludedHttpStatusErrors( excludedHttpStatusErrors ); -<a name="525" href="#525">525</a> reportGenerator.setExcludedHttpStatusWarnings( excludedHttpStatusWarnings ); -<a name="526" href="#526">526</a> reportGenerator.setExcludedLinks( excludedLinks ); -<a name="527" href="#527">527</a> reportGenerator.setExcludedPages( excludedPages ); -<a name="528" href="#528">528</a> reportGenerator.setHttpFollowRedirect( httpFollowRedirect ); -<a name="529" href="#529">529</a> reportGenerator.setHttpMethod( httpMethod ); -<a name="530" href="#530">530</a> reportGenerator.setOffline( offline ); -<a name="531" href="#531">531</a> -<a name="532" href="#532">532</a> reportGenerator.generateReport( locale, linkcheckModel, getSink() ); -<a name="533" href="#533">533</a> closeReport(); -<a name="534" href="#534">534</a> -<a name="535" href="#535">535</a> <em class="jxr_comment">// Copy the images</em> -<a name="536" href="#536">536</a> copyStaticResources(); -<a name="537" href="#537">537</a> } -<a name="538" href="#538">538</a> -<a name="539" href="#539">539</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> copyStaticResources() -<a name="540" href="#540">540</a> { -<a name="541" href="#541">541</a> <strong class="jxr_keyword">try</strong> -<a name="542" href="#542">542</a> { -<a name="543" href="#543">543</a> getLog().debug( <span class="jxr_string">"Copying static linkcheck resources."</span> ); -<a name="544" href="#544">544</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < resourceNames.length; i++ ) -<a name="545" href="#545">545</a> { -<a name="546" href="#546">546</a> URL url = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResource( pluginResourcesBase + <span class="jxr_string">"/"</span> + resourceNames[i] ); -<a name="547" href="#547">547</a> FileUtils.copyURLToFile( url, <strong class="jxr_keyword">new</strong> File( getReportOutputDirectory(), resourceNames[i] ) ); -<a name="548" href="#548">548</a> } -<a name="549" href="#549">549</a> } -<a name="550" href="#550">550</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a name="551" href="#551">551</a> { -<a name="552" href="#552">552</a> getLog().error( <span class="jxr_string">"Unable to copy icons for linkcheck report."</span> ); -<a name="553" href="#553">553</a> getLog().debug( e ); -<a name="554" href="#554">554</a> } -<a name="555" href="#555">555</a> } -<a name="556" href="#556">556</a> -<a name="557" href="#557">557</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong>[] asIntArray( Integer[] array ) -<a name="558" href="#558">558</a> { -<a name="559" href="#559">559</a> <strong class="jxr_keyword">if</strong> ( array == <strong class="jxr_keyword">null</strong> ) -<a name="560" href="#560">560</a> { -<a name="561" href="#561">561</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<a name="562" href="#562">562</a> } -<a name="563" href="#563">563</a> -<a name="564" href="#564">564</a> <strong class="jxr_keyword">int</strong>[] newArray = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">int</strong>[array.length]; -<a name="565" href="#565">565</a> -<a name="566" href="#566">566</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < array.length; i++ ) -<a name="567" href="#567">567</a> { -<a name="568" href="#568">568</a> newArray[i] = array[i].intValue(); -<a name="569" href="#569">569</a> } -<a name="570" href="#570">570</a> -<a name="571" href="#571">571</a> <strong class="jxr_keyword">return</strong> newArray; -<a name="572" href="#572">572</a> } -<a name="573" href="#573">573</a> } +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.linkcheck; +<a class="jxr_linenumber" name="L2" href="#L2">2</a> +<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 to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</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="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.HttpBean; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.LinkCheck; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.LinkCheckException; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.linkcheck.model.LinkcheckModel; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Proxy; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.net.URL; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Generates a <code>Linkcheck</code> report.</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> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @version $Id: LinkcheckReport.java 1628568 2014-09-30 22:19:10Z hboutemy $</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @since 1.0</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> @Mojo( name = <span class="jxr_string">"linkcheck"</span> ) +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/linkcheck/LinkcheckReport.html">LinkcheckReport</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport +<a class="jxr_linenumber" name="L59" href="#L59">59</a> { +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_comment">// Report Components</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Internationalization.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Component +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> I18N i18n; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<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"> * LinkCheck component.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Component +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> LinkCheck linkCheck; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// Report Parameters</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Local Repository.</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> @Parameter( defaultValue = <span class="jxr_string">"${localRepository}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> ArtifactRepository localRepository; +<a class="jxr_linenumber" name="L85" href="#L85">85</a> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * The Maven Settings.</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> @Parameter( defaultValue = <span class="jxr_string">"${settings}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> Settings settings; +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">// Linkcheck parameters</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Whether we are offline or not.</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> @Parameter( property = <span class="jxr_string">"linkcheck.offline"</span>, defaultValue = <span class="jxr_string">"${settings.offline}"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> offline; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * If online, the HTTP method should automatically follow HTTP redirects,</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <tt>false</tt> otherwise.</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> <em class="jxr_javadoccomment"> * @parameter default-value="true"</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> httpFollowRedirect; +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * The location of the Linkcheck cache file.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/linkcheck/linkcheck.cache"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> File linkcheckCache; +<a class="jxr_linenumber" name="L116" href="#L116">116</a> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * The location of the Linkcheck report file.</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/linkcheck/linkcheck.xml"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">protected</strong> File linkcheckOutput; +<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"> * The HTTP method to use. Currently supported are "GET" and "HEAD".</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * <dl></em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * <dt>HTTP GET</dt></em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <dd></em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * The HTTP GET method is defined in section 9.3 of</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.ietf.org/rfc/rfc2616.txt"; target="alexandria_uri">http://www.ietf.org/rfc/rfc2616.txt</a>">RFC2616</a>:</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * The GET method means retrieve whatever information (in the form of an</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * entity) is identified by the Request-URI.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * </dd></em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <dt>HTTP HEAD</dt></em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * <dd></em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * The HTTP HEAD method is defined in section 9.4 of</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.ietf.org/rfc/rfc2616.txt"; target="alexandria_uri">http://www.ietf.org/rfc/rfc2616.txt</a>">RFC2616</a>:</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * The HEAD method is identical to GET except that the server MUST NOT</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * return a message-body in the response.</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * </dd></em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * </dl></em> +<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> @Parameter( defaultValue = <span class="jxr_string">"head"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">private</strong> String httpMethod; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> +<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> <em class="jxr_javadoccomment"> * The list of HTTP errors to ignored, like <code>404</code>.</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> Integer[] excludedHttpStatusErrors; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * The list of HTTP warnings to ignored, like <code>301</code>.</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> @Parameter +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> Integer[] excludedHttpStatusWarnings; +<a class="jxr_linenumber" name="L160" href="#L160">160</a> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * A list of pages to exclude.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * <br/></em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * <b>Note</b>:</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * <br/></em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * <li>This report, i.e. <code>linkcheck.html</code>, is always excluded.</li></em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * <li>May contain Ant-style wildcards and double wildcards, e.g. <code>apidocs/**</code>, etc.</li></em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> @Parameter +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">private</strong> String[] excludedPages; +<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"> * The list of links to exclude.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * <br/></em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * <b>Note</b>: Patterns like <code>&#42;&#42;/dummy/&#42;</code> are allowed for excludedLink.</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> @Parameter +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">private</strong> String[] excludedLinks; +<a class="jxr_linenumber" name="L181" href="#L181">181</a> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * The file encoding to use when Linkcheck reads the source files. If the property</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * <code>project.build.sourceEncoding</code> is not set, the platform default encoding is used.</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">private</strong> String encoding; +<a class="jxr_linenumber" name="L188" href="#L188">188</a> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * The extra HttpClient parameters to be used when fetching links. For instance:</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * &lt;httpClientParameters&gt;</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * &nbsp;&lt;property&gt;</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * &nbsp;&nbsp;&lt;name&gt;http.protocol.max-redirects&lt;/name&gt;</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * &nbsp;&nbsp;&lt;value&gt;10&lt;/value&gt;</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * &nbsp;&lt;/property&gt;</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * &lt;/httpClientParameters&gt;</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * See <a href="<a href="http://hc.apache.org/httpclient-3.x/preference-api.html"; target="alexandria_uri">http://hc.apache.org/httpclient-3.x/preference-api.html</a>">HttpClient preference page</a></em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> @Parameter( property = <span class="jxr_string">"httpClientParameters"</span> ) +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">private</strong> Properties httpClientParameters; +<a class="jxr_linenumber" name="L203" href="#L203">203</a> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * Set the timeout to be used when fetching links. A value of zero means the timeout is not used.</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Parameter( property = <span class="jxr_string">"timeout"</span>, defaultValue = <span class="jxr_string">"2000"</span> ) +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> timeout; +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * <code>true</code> to skip the report execution, <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * The purpose is to prevent infinite call when {@link #forceSite} is enable.</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> @Parameter( property = <span class="jxr_string">"linkcheck.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L216" href="#L216">216</a> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * <code>true</code> to force the site generation, <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * Using this parameter ensures that all documents have been correctly generated.</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> @Parameter( property = <span class="jxr_string">"linkcheck.forceSite"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> forceSite; +<a class="jxr_linenumber" name="L223" href="#L223">223</a> +<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> <em class="jxr_javadoccomment"> * The base URL to use for absolute links (eg <code>/index.html</code>) in the site.</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> @Parameter( property = <span class="jxr_string">"linkcheck.baseURL"</span>, defaultValue = <span class="jxr_string">"${project.url}"</span> ) +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">private</strong> String baseURL; +<a class="jxr_linenumber" name="L229" href="#L229">229</a> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_comment">// Instance fields</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">/** Result of the linkcheck in {@link #execute()} */</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">private</strong> LinkcheckModel result; +<a class="jxr_linenumber" name="L236" href="#L236">236</a> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_SUCCESS = <span class="jxr_string">"images/icon_success_sml.gif"</span>; +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_WARNING = <span class="jxr_string">"images/icon_warning_sml.gif"</span>; +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_INFO = <span class="jxr_string">"images/icon_info_sml.gif"</span>; +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ICON_ERROR = <span class="jxr_string">"images/icon_error_sml.gif"</span>; +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String pluginResourcesBase = <span class="jxr_string">"org/apache/maven/plugin/linkcheck"</span>; +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String resourceNames[] = { ICON_SUCCESS, ICON_WARNING, ICON_INFO, ICON_ERROR }; +<a class="jxr_linenumber" name="L243" href="#L243">243</a> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// Public methods</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_comment">// ----------------------------------------------------------------------</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) +<a class="jxr_linenumber" name="L250" href="#L250">250</a> { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">return</strong> i18n.getString( <span class="jxr_string">"linkcheck-report"</span>, locale, <span class="jxr_string">"report.linkcheck.description"</span> );
[... 262 lines stripped ...]
