Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,205 @@ +<!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" /> +<title>CommonsSiteCompressionMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.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"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</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="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.release.plugin.mojos; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipEntry; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipOutputStream; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.zip.ParallelScatterZipCreator; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.zip.ScatterZipOutputStream; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.IOUtils; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<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"> * Takes the built <code>./target/site</code> directory and compresses it to</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <code>./target/commons-release-plugin/site.zip</code>.</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"> * @author chtompki</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @since 1.0</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * {@link CommonsDistributionStagingMojo}.</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> @Deprecated +<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Mojo(name = <span class="jxr_string">"compress-site"</span>, +<a class="jxr_linenumber" name="L50" href="#L50">50</a> defaultPhase = LifecyclePhase.POST_SITE, +<a class="jxr_linenumber" name="L51" href="#L51">51</a> threadSafe = <strong class="jxr_keyword">true</strong>, +<a class="jxr_linenumber" name="L52" href="#L52">52</a> aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html">CommonsSiteCompressionMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The working directory for the plugin which, assuming the maven uses the default</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</em> +<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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, +<a class="jxr_linenumber" name="L60" href="#L60">60</a> property = <span class="jxr_string">"commons.outputDirectory"</span>) +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<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"> */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/site"</span>, property = <span class="jxr_string">"commons.siteOutputDirectory"</span>) +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> File siteDirectory; +<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"> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * this would need to be of the form:</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * substring <code>https</code> is a requirement.</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> @Parameter(defaultValue = <span class="jxr_string">""</span>, property = <span class="jxr_string">"commons.distSvnStagingUrl"</span>) +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> +<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"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"commons.release.isDistModule"</span>) +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> Boolean isDistModule; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * A variable for the process of creating the site.zip file.</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> ScatterZipOutputStream dirs; +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * A second variable for the process of creating the site.zip file.</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> ParallelScatterZipCreator scatterZipCreator; +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * The list of files to compress into the site.zip file.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">private</strong> List<File> filesToCompress; +<a class="jxr_linenumber" name="L97" href="#L97">97</a> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> @Override +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (!isDistModule) { +<a class="jxr_linenumber" name="L101" href="#L101">101</a> getLog().info(<span class="jxr_string">"This module is marked as a non distribution "</span> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> + <span class="jxr_string">"or assembly module, and the plugin will not run."</span>); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(distSvnStagingUrl)) { +<a class="jxr_linenumber" name="L106" href="#L106">106</a> getLog().warn(<span class="jxr_string">"commons.distSvnStagingUrl is not set, the commons-release-plugin will not run."</span>); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">return</strong>; +<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> (!siteDirectory.exists()) { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> getLog().error(<span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span>); +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <span class="jxr_string">"\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> ); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L116" href="#L116">116</a> getLog().info(<span class="jxr_string">"Current project contains no distributions. Not executing."</span>); +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L118" href="#L118">118</a> } +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> filesToCompress = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> getAllSiteFiles(siteDirectory, filesToCompress); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> writeZipFile(workingDirectory, siteDirectory, filesToCompress); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> getLog().error(<span class="jxr_string">"Failed to create ./target/commons-release-plugin/site.zip: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <span class="jxr_string">"Failed to create ./target/commons-release-plugin/site.zip: "</span> + e.getMessage(), +<a class="jxr_linenumber" name="L127" href="#L127">127</a> e +<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> } +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * By default this method iterates across the <code>target/site</code> directory and adds all of the files</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @param filesToCompress the {@link List} to which to add all the files.</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> getAllSiteFiles(File siteDirectory, List<File> filesToCompress) { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> File[] files = siteDirectory.listFiles(); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">for</strong> (File file : files) { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> filesToCompress.add(file); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (file.isDirectory()) { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> getAllSiteFiles(file, filesToCompress); +<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> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * in the <code>workingDirectory</code>.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * <code>target/site</code>).</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @param fileList the list of files to be zipped up, generally generated by</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @throws IOException when the copying of the files goes incorrectly.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeZipFile(File outputDirectory, File directoryToZip, List<File> fileList) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">try</strong> (FileOutputStream fos = <strong class="jxr_keyword">new</strong> FileOutputStream(outputDirectory.getAbsolutePath() + <span class="jxr_string">"/site.zip"</span>); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> ZipOutputStream zos = <strong class="jxr_keyword">new</strong> ZipOutputStream(fos)) { +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">for</strong> (File file : fileList) { +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (!file.isDirectory()) { <em class="jxr_comment">// we only zip files, not directories</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> addToZip(directoryToZip, file, zos); +<a class="jxr_linenumber" name="L166" href="#L166">166</a> } +<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> } +<a class="jxr_linenumber" name="L170" href="#L170">170</a> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * Given the <code>directoryToZip</code> we add the <code>file</code> to the zip archive represented by</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * <code>zos</code>.</em> +<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"> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * compressing. Generally this is <code>target/site</code>.</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addToZip(File directoryToZip, File file, ZipOutputStream zos) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">try</strong> (FileInputStream fis = <strong class="jxr_keyword">new</strong> FileInputStream(file)) { +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_comment">// we want the zipEntry's path to be a relative path that is relative</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_comment">// to the directory being zipped, so chop off the rest of the path</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> String zipFilePath = file.getCanonicalPath().substring(directoryToZip.getCanonicalPath().length() + 1, +<a class="jxr_linenumber" name="L186" href="#L186">186</a> file.getCanonicalPath().length()); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> ZipEntry zipEntry = <strong class="jxr_keyword">new</strong> ZipEntry(zipFilePath); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> zos.putNextEntry(zipEntry); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> IOUtils.copy(fis, zos); +<a class="jxr_linenumber" name="L190" href="#L190">190</a> } +<a class="jxr_linenumber" name="L191" href="#L191">191</a> } +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,214 @@ +<!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" /> +<title>CommonsStagingCleanupMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.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"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</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="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.release.plugin.mojos; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.SharedFunctions; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmException; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmFileSet; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.checkin.CheckInScmResult; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.checkout.CheckOutScmResult; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.remove.RemoveScmResult; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.BasicScmManager; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.ScmManager; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.ScmProvider; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.repository.ScmRepository; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecrypter; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> java.io.File; +<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> +<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"> * This class checks out the dev distribution location, checkes whether anything exists in the</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * distribution location, and if it is non-empty it deletes all of the resources there.</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"> * @author chtompki</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @since 1.6</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> @Mojo(name = <span class="jxr_string">"clean-staging"</span>, +<a class="jxr_linenumber" name="L55" href="#L55">55</a> defaultPhase = LifecyclePhase.POST_CLEAN, +<a class="jxr_linenumber" name="L56" href="#L56">56</a> threadSafe = <strong class="jxr_keyword">true</strong>, +<a class="jxr_linenumber" name="L57" href="#L57">57</a> aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html">CommonsStagingCleanupMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * The {@link MavenProject} object is essentially the context of the maven build at</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * a given time.</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> +<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> <em class="jxr_javadoccomment"> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * that assumes that we're using the default maven <code>${project.build.directory}</code>.</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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, property = <span class="jxr_string">"commons.outputDirectory"</span>) +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<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"> * The location to which to checkout the dist subversion repository under our working directory, which</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * was given above. We then do an SVN delete on all of the directories in this repository.</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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin/scm-cleanup"</span>, +<a class="jxr_linenumber" name="L79" href="#L79">79</a> property = <span class="jxr_string">"commons.distCleanupDirectory"</span>) +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> File distCleanupDirectory; +<a class="jxr_linenumber" name="L81" href="#L81">81</a> +<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> <em class="jxr_javadoccomment"> * A boolean that determines whether or not we actually commit the files up to the subversion repository.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * If this is set to <code>true</code>, we do all but make the commits. We do checkout the repository in question</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * though.</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> @Parameter(property = <span class="jxr_string">"commons.release.dryRun"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> Boolean dryRun; +<a class="jxr_linenumber" name="L89" href="#L89">89</a> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * be of the form: <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>. Note. that</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * the prefix to the substring <code>https</code> is a requirement.</em> +<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> @Parameter(defaultValue = <span class="jxr_string">""</span>, property = <span class="jxr_string">"commons.distSvnStagingUrl"</span>) +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L97" href="#L97">97</a> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"commons.release.isDistModule"</span>) +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">private</strong> Boolean isDistModule; +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * The ID of the server (specified in settings.xml) which should be used for dist authentication.</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * This will be used in preference to {@link #username}/{@link #password}.</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(property = <span class="jxr_string">"commons.distServer"</span>) +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> String distServer; +<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 username for the distribution subversion repository. This is typically your Apache id.</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(property = <span class="jxr_string">"user.name"</span>) +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">private</strong> String username; +<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 password associated with {@link CommonsDistributionStagingMojo#username}.</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(property = <span class="jxr_string">"user.password"</span>) +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">private</strong> String password; +<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"> * Maven {@link Settings}.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</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="L127" href="#L127">127</a> <strong class="jxr_keyword">private</strong> Settings settings; +<a class="jxr_linenumber" name="L128" href="#L128">128</a> +<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> <em class="jxr_javadoccomment"> * Maven {@link SettingsDecrypter} component.</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Component +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> SettingsDecrypter settingsDecrypter; +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Override +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">if</strong> (!isDistModule) { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> getLog().info(<span class="jxr_string">"This module is marked as a non distribution "</span> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> + <span class="jxr_string">"or assembly module, and the plugin will not run."</span>); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L141" href="#L141">141</a> } +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(distSvnStagingUrl)) { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> getLog().warn(<span class="jxr_string">"commons.distSvnStagingUrl is not set, the commons-release-plugin will not run."</span>); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L147" href="#L147">147</a> SharedFunctions.initDirectory(getLog(), workingDirectory); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> } +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> ScmManager scmManager = <strong class="jxr_keyword">new</strong> BasicScmManager(); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> scmManager.setScmProvider(<span class="jxr_string">"svn"</span>, <strong class="jxr_keyword">new</strong> SvnExeScmProvider()); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl); +<a class="jxr_linenumber" name="L153" href="#L153">153</a> ScmProvider provider = scmManager.getProviderByRepository(repository); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository(); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> SharedFunctions.setAuthentication( +<a class="jxr_linenumber" name="L156" href="#L156">156</a> providerRepository, +<a class="jxr_linenumber" name="L157" href="#L157">157</a> distServer, +<a class="jxr_linenumber" name="L158" href="#L158">158</a> settings, +<a class="jxr_linenumber" name="L159" href="#L159">159</a> settingsDecrypter, +<a class="jxr_linenumber" name="L160" href="#L160">160</a> username, +<a class="jxr_linenumber" name="L161" href="#L161">161</a> password +<a class="jxr_linenumber" name="L162" href="#L162">162</a> ); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> getLog().info(<span class="jxr_string">"Checking out dist from: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> ScmFileSet scmFileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCleanupDirectory); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">final</strong> CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet); +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">if</strong> (!checkOutResult.isSuccess()) { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to checkout files from SCM: "</span> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> + checkOutResult.getProviderMessage() + <span class="jxr_string">" ["</span> + checkOutResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L169" href="#L169">169</a> } +<a class="jxr_linenumber" name="L170" href="#L170">170</a> List<File> filesToRemove = Arrays.asList(distCleanupDirectory.listFiles()); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (filesToRemove.size() == 1) { +<a class="jxr_linenumber" name="L172" href="#L172">172</a> getLog().info(<span class="jxr_string">"No files to delete"</span>); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L174" href="#L174">174</a> } +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> (!dryRun) { +<a class="jxr_linenumber" name="L176" href="#L176">176</a> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCleanupDirectory, filesToRemove); +<a class="jxr_linenumber" name="L177" href="#L177">177</a> RemoveScmResult removeScmResult = provider.remove(repository, fileSet, <span class="jxr_string">"Cleaning up staging area"</span>); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (!removeScmResult.isSuccess()) { +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"Failed to remove files from SCM: "</span> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> + removeScmResult.getProviderMessage() +<a class="jxr_linenumber" name="L181" href="#L181">181</a> + <span class="jxr_string">" ["</span> + removeScmResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> getLog().info(<span class="jxr_string">"Cleaning distribution area for: "</span> + project.getArtifactId()); +<a class="jxr_linenumber" name="L184" href="#L184">184</a> CheckInScmResult checkInResult = provider.checkIn( +<a class="jxr_linenumber" name="L185" href="#L185">185</a> repository, +<a class="jxr_linenumber" name="L186" href="#L186">186</a> fileSet, +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <span class="jxr_string">"Cleaning distribution area for: "</span> + project.getArtifactId() +<a class="jxr_linenumber" name="L188" href="#L188">188</a> ); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> (!checkInResult.isSuccess()) { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"Failed to commit files: "</span> + removeScmResult.getProviderMessage() +<a class="jxr_linenumber" name="L191" href="#L191">191</a> + <span class="jxr_string">" ["</span> + removeScmResult.getCommandOutput() + <span class="jxr_string">"]"</span>); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } +<a class="jxr_linenumber" name="L193" href="#L193">193</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L194" href="#L194">194</a> getLog().info(<span class="jxr_string">"Would have attempted to delete files from: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +<a class="jxr_linenumber" name="L196" href="#L196">196</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(e.getMessage()); +<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> } +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-frame.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-frame.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-frame.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,33 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Commons Release Plugin 1.6 Reference Package org.apache.commons.release.plugin.mojos</title> + <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" /> + </head> + <body> + + <h3> + <a href="package-summary.html" target="classFrame">org.apache.commons.release.plugin.mojos</a> + </h3> + + <h3>Classes</h3> + + <ul> + <li> + <a href="CommonsDistributionDetachmentMojo.html" target="classFrame">CommonsDistributionDetachmentMojo</a> + </li> + <li> + <a href="CommonsDistributionStagingMojo.html" target="classFrame">CommonsDistributionStagingMojo</a> + </li> + <li> + <a href="CommonsSiteCompressionMojo.html" target="classFrame">CommonsSiteCompressionMojo</a> + </li> + <li> + <a href="CommonsStagingCleanupMojo.html" target="classFrame">CommonsStagingCleanupMojo</a> + </li> + </ul> + + </body> +</html> \ No newline at end of file Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-summary.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-summary.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/mojos/package-summary.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,84 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Commons Release Plugin 1.6 Reference Package org.apache.commons.release.plugin.mojos</title> + <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" /> + </head> + <body> + <div class="overview"> + <ul> + <li> + <a href="../../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <h2>Package org.apache.commons.release.plugin.mojos</h2> + + <table class="summary"> + <thead> + <tr> + <th>Class Summary</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="CommonsDistributionDetachmentMojo.html" target="classFrame">CommonsDistributionDetachmentMojo</a> + </td> + </tr> + <tr> + <td> + <a href="CommonsDistributionStagingMojo.html" target="classFrame">CommonsDistributionStagingMojo</a> + </td> + </tr> + <tr> + <td> + <a href="CommonsSiteCompressionMojo.html" target="classFrame">CommonsSiteCompressionMojo</a> + </td> + </tr> + <tr> + <td> + <a href="CommonsStagingCleanupMojo.html" target="classFrame">CommonsStagingCleanupMojo</a> + </td> + </tr> + </tbody> + </table> + + <div class="overview"> + <ul> + <li> + <a href="../../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + <hr /> + <div id="footer"> + Copyright © 2018–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved. + </div> + </body> +</html> \ No newline at end of file Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-frame.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-frame.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-frame.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,24 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Commons Release Plugin 1.6 Reference Package org.apache.commons.release.plugin</title> + <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> + </head> + <body> + + <h3> + <a href="package-summary.html" target="classFrame">org.apache.commons.release.plugin</a> + </h3> + + <h3>Classes</h3> + + <ul> + <li> + <a href="SharedFunctions.html" target="classFrame">SharedFunctions</a> + </li> + </ul> + + </body> +</html> \ No newline at end of file Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-summary.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-summary.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/package-summary.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,69 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Commons Release Plugin 1.6 Reference Package org.apache.commons.release.plugin</title> + <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" /> + </head> + <body> + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + + <h2>Package org.apache.commons.release.plugin</h2> + + <table class="summary"> + <thead> + <tr> + <th>Class Summary</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <a href="SharedFunctions.html" target="classFrame">SharedFunctions</a> + </td> + </tr> + </tbody> + </table> + + <div class="overview"> + <ul> + <li> + <a href="../../../../../overview-summary.html">Overview</a> + </li> + <li class="selected">Package</li> + </ul> + </div> + <div class="framenoframe"> + <ul> + <li> + <a href="../../../../../index.html" target="_top">FRAMES</a> + </li> + <li> + <a href="package-summary.html" target="_top">NO FRAMES</a> + </li> + </ul> + </div> + <hr /> + <div id="footer"> + Copyright © 2018–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved. + </div> + </body> +</html> \ No newline at end of file Added: dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html ============================================================================== --- dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html (added) +++ dev/commons/commons-release-plugin/1.6-RC1/site/xref/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html Sat Mar 9 13:32:27 2019 @@ -0,0 +1,101 @@ +<!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" /> +<title>HeaderHtmlVelocityDelegate xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.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"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</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="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the License.</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.release.plugin.velocity; +<a class="jxr_linenumber" name="L18" href="#L18">18</a> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.Template; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.VelocityContext; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.VelocityEngine; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * This class' purpose is to generate the <code>HEADER.html</code> that moves along with the</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * release for the sake of downloading the release from the distribution area.</em> +<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"> * @author chtompki</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @since 1.3</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/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegate</a> { +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/** The location of the velocity tempate for this class. */</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TEMPLATE = <span class="jxr_string">"resources/org/apache/commons/release/plugin"</span> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> + <span class="jxr_string">"/velocity/HEADER.vm"</span>; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegate</a>() { +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">super</strong>(); +<a class="jxr_linenumber" name="L40" href="#L40">40</a> } +<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"> * For instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link HeaderHtmlVelocityDelegateBuilder}.</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @return a {@link HeaderHtmlVelocityDelegateBuilder}.</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegateBuilder</a> builder() { +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegateBuilder</a>(); +<a class="jxr_linenumber" name="L49" href="#L49">49</a> } +<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"> * Builds the HEADER.vm velocity template to the writer passed in.</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"> * @param writer any {@link Writer} that we wish to have the filled velocity template written to.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @return the {@link Writer} that we've filled out the template into.</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> Writer render(Writer writer) { +<a class="jxr_linenumber" name="L58" href="#L58">58</a> VelocityEngine ve = <strong class="jxr_keyword">new</strong> VelocityEngine(); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> ve.setProperty(RuntimeConstants.RESOURCE_LOADER, <span class="jxr_string">"classpath"</span>); +<a class="jxr_linenumber" name="L60" href="#L60">60</a> ve.setProperty(<span class="jxr_string">"classpath.resource.loader.class"</span>, ClasspathResourceLoader.<strong class="jxr_keyword">class</strong>.getName()); +<a class="jxr_linenumber" name="L61" href="#L61">61</a> ve.init(); +<a class="jxr_linenumber" name="L62" href="#L62">62</a> Template template = ve.getTemplate(TEMPLATE); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> VelocityContext context = <strong class="jxr_keyword">new</strong> VelocityContext(); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> template.merge(context, writer); +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">return</strong> writer; +<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"> * A builder class for instantiation of the {@link HeaderHtmlVelocityDelegate}.</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">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegateBuilder</a> { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Private constructor so that we can have a proper builder pattern.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegateBuilder</a>() { +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">super</strong>(); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } +<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"> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @return a new {@link ReadmeHtmlVelocityDelegate}.</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegate</a> build() { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html">HeaderHtmlVelocityDelegate</a>(); +<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> } +</pre> +<hr/> +<div id="footer">Copyright © 2018–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html>
