Added: websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Thu Jan 11 01:05:54 2018 @@ -0,0 +1,203 @@ +<!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>CommonsDistributionDetachmentMojo 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/CommonsDistributionDetachmentMojo.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.codec.digest.DigestUtils; +<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.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.io.PrintWriter; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * The purpose of this maven mojo is to detach the artifacts generated by the maven-assembly-plugin,</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * in the dev distribution location for apache projects.</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author chtompki</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @since 1.0</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> @Mojo(name = <span class="jxr_string">"detach-distributions"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html">CommonsDistributionDetachmentMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * A list of "artifact types" in the maven vernacular, to</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * be detached from the deployment. For the time being we want</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * all artifacts generated by the maven-assembly-plugin to be detatched</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * from the deployment, namely *-src.zip, *-src.tar.gz, *-bin.zip,</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * *-bin.tar.gz, and the corresponding .asc pgp signatures.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Set<String> ARTIFACT_TYPES_TO_DETATCH; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">static</strong> { +<a class="jxr_linenumber" name="L59" href="#L59">59</a> Set<String> hashSet = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L60" href="#L60">60</a> hashSet.add(<span class="jxr_string">"zip"</span>); +<a class="jxr_linenumber" name="L61" href="#L61">61</a> hashSet.add(<span class="jxr_string">"tar.gz"</span>); +<a class="jxr_linenumber" name="L62" href="#L62">62</a> hashSet.add(<span class="jxr_string">"zip.asc"</span>); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> hashSet.add(<span class="jxr_string">"tar.gz.asc"</span>); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> ARTIFACT_TYPES_TO_DETATCH = Collections.unmodifiableSet(hashSet); +<a class="jxr_linenumber" name="L65" href="#L65">65</a> } +<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"> * This list is supposed to hold the maven references to the aformentioned artifacts so that we</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * can upload them to svn after they've been detatched from the maven deployment.</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> List<Artifact> detatchedArtifacts = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<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"> * The maven project context injection so that we can get a hold of the variables at hand.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * The working directory in <code>target</code> that we use as a sandbox for the plugin.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, alias = <span class="jxr_string">"outputDirectory"</span>) +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * The subversion staging url to which we upload all of our staged artifacts.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Parameter(required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> @Override +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L93" href="#L93">93</a> getLog().info(<span class="jxr_string">"Detatching Assemblies"</span>); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">for</strong> (Object attachedArtifact : project.getAttachedArtifacts()) { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (ARTIFACT_TYPES_TO_DETATCH.contains(((Artifact) attachedArtifact).getType())) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> detatchedArtifacts.add((Artifact) attachedArtifact); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">for</strong> (Artifact artifactToRemove : detatchedArtifacts) { +<a class="jxr_linenumber" name="L100" href="#L100">100</a> project.getAttachedArtifacts().remove(artifactToRemove); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> SharedFunctions.initDirectory(getLog(), workingDirectory); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> copyRemovedArtifactsToWorkingDirectory(); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> getLog().info(<span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> sha1AndMd5SignArtifacts(); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> } +<a class="jxr_linenumber" name="L109" href="#L109">109</a> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code></em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * so that the {@link CommonsDistributionStagingMojo} can find the artifacts later.</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * properly wrapped so that maven can handle it.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> copyRemovedArtifactsToWorkingDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L118" href="#L118">118</a> StringBuffer copiedArtifactAbsolutePath; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> getLog().info(<span class="jxr_string">"Copying detatched artifacts to working directory."</span>); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">for</strong> (Artifact artifact: detatchedArtifacts) { +<a class="jxr_linenumber" name="L121" href="#L121">121</a> File artifactFile = artifact.getFile(); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> copiedArtifactAbsolutePath = <strong class="jxr_keyword">new</strong> StringBuffer(workingDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> copiedArtifactAbsolutePath.append(<span class="jxr_string">"/"</span>); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> copiedArtifactAbsolutePath.append(artifactFile.getName()); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> File copiedArtifact = <strong class="jxr_keyword">new</strong> File(copiedArtifactAbsolutePath.toString()); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> getLog().info(<span class="jxr_string">"Copying: "</span> + artifactFile.getName()); +<a class="jxr_linenumber" name="L127" href="#L127">127</a> SharedFunctions.copyFile(getLog(), artifactFile, copiedArtifact); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * A helper method that creates md5 and sha1 signature files for our detached artifacts in the</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <code>target/commons-release-plugin</code> directory for the purpose of being uploade by</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * the {@link CommonsDistributionStagingMojo}.</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"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * properly wrapped so that maven can handle it.</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> sha1AndMd5SignArtifacts() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">for</strong> (Artifact artifact : detatchedArtifacts) { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (!artifact.getFile().getName().contains(<span class="jxr_string">"asc"</span>)) { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> FileInputStream artifactFileInputStream = <strong class="jxr_keyword">new</strong> FileInputStream(artifact.getFile()); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> String md5 = DigestUtils.md5Hex(artifactFileInputStream); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> getLog().info(artifact.getFile().getName() + <span class="jxr_string">" md5: "</span> + md5); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> PrintWriter md5Writer = <strong class="jxr_keyword">new</strong> PrintWriter(getMd5FilePath(workingDirectory, artifact.getFile())); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> md5Writer.println(md5); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> String sha1 = DigestUtils.sha1Hex(artifactFileInputStream); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> getLog().info(artifact.getFile().getName() + <span class="jxr_string">" sha1: "</span> + sha1); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> PrintWriter sha1Writer = <strong class="jxr_keyword">new</strong> PrintWriter(getSha1FilePath(workingDirectory, artifact.getFile())); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> sha1Writer.println(sha1); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> md5Writer.close(); +<a class="jxr_linenumber" name="L153" href="#L153">153</a> sha1Writer.close(); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Could not sign file: "</span> + artifact.getFile().getName(), e); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> } +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> } +<a class="jxr_linenumber" name="L159" href="#L159">159</a> } +<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 helper method to create a file path for the <code>md5</code> signature file from a given file.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param workingDirectory is the {@link File} for the directory in which to make the <code>.md5</code> file.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @param file the {@link File} whose name we should use to create the <code>.md5</code> file.</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @return a {@link String} that is the absolute path to the <code>.md5</code> file.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">private</strong> String getMd5FilePath(File workingDirectory, File file) { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(workingDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> buffer.append(<span class="jxr_string">"/"</span>); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> buffer.append(file.getName()); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> buffer.append(<span class="jxr_string">".md5"</span>); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong> buffer.toString(); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> } +<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * A helper method to create a file path for the <code>sha1</code> signature file from a given file.</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> <em class="jxr_javadoccomment"> * @param workingDirectory is the {@link File} for the directory in which to make the <code>.sha1</code> file.</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @param file the {@link File} whose name we should use to create the <code>.sha1</code> file.</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @return a {@link String} that is the absolute path to the <code>.sha1</code> file.</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> String getSha1FilePath(File workingDirectory, File file) { +<a class="jxr_linenumber" name="L184" href="#L184">184</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(workingDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> buffer.append(<span class="jxr_string">"/"</span>); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> buffer.append(file.getName()); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> buffer.append(<span class="jxr_string">".sha1"</span>); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">return</strong> buffer.toString(); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> } +<a class="jxr_linenumber" name="L190" href="#L190">190</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
Added: websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Thu Jan 11 01:05:54 2018 @@ -0,0 +1,284 @@ +<!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>CommonsDistributionStagingMojo 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/CommonsDistributionStagingMojo.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.release.plugin.SharedFunctions; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.ScmFileSet; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.add.AddScmResult; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.command.checkin.CheckInScmResult; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.BasicScmManager; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.manager.ScmManager; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.ScmProvider; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.repository.ScmRepository; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<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"> * This class checks out the dev distribution location, copies the distributions into that directory</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * structure under the <code>target/commons-release-plugin/scm</code> directory. Then commits the</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * distributions back up to SVN. Also, we include the built and zipped site as well as the RELEASE-NOTES.txt.</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @author chtompki</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @since 1.0</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> @Mojo(name = <span class="jxr_string">"stage-distributions"</span>, defaultPhase = LifecyclePhase.DEPLOY, threadSafe = <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/CommonsDistributionStagingMojo.html">CommonsDistributionStagingMojo</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 {@link MavenProject} object is essentially the context of the maven build at</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * a given time.</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}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * The {@link File} that contains a file to the root directory of the working project. Typically</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * this directory is where the <code>pom.xml</code> resides.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}"</span>) +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> File basedir; +<a class="jxr_linenumber" name="L68" href="#L68">68</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</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="L71" href="#L71">71</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="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, alias = <span class="jxr_string">"outputDirectory"</span>) +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * The location to which to checkout the dist subversion repository under our working directory, which</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * was given above.</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">"${project.build.directory}/commons-release-plugin/scm"</span>, alias = <span class="jxr_string">"outputDirectory"</span>) +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> File distCheckoutDirectory; +<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 boolean that determines whether or not we actually commit the files up to the subversion repository.</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</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="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * though.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> Boolean dryRun; +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * The url of the subversion repository to which we wish the artifacts to be staged. Typicallly</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * this would need to be of the form:</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</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="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * substring <code>https</code> is a requirement.</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Parameter(required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<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> <em class="jxr_javadoccomment"> * The username for the distribution subversion repository. This is typically your apache id.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> @Parameter(property = <span class="jxr_string">"user.name"</span>) +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> String username; +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * The password associated with {@link CommonsDistributionStagingMojo#username}.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Parameter(property = <span class="jxr_string">"user.password"</span>) +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> String password; +<a class="jxr_linenumber" name="L111" href="#L111">111</a> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> getLog().info(<span class="jxr_string">"Preparing to stage distributions"</span>); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L116" href="#L116">116</a> ScmManager scmManager = <strong class="jxr_keyword">new</strong> BasicScmManager(); +<a class="jxr_linenumber" name="L117" href="#L117">117</a> scmManager.setScmProvider(<span class="jxr_string">"svn"</span>, <strong class="jxr_keyword">new</strong> SvnExeScmProvider()); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> ScmProvider provider = scmManager.getProviderByRepository(repository); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository(); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> providerRepository.setUser(username); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> providerRepository.setPassword(password); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> SharedFunctions.initDirectory(getLog(), workingDirectory); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> } +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> (!distCheckoutDirectory.exists()) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> SharedFunctions.initDirectory(getLog(), distCheckoutDirectory); +<a class="jxr_linenumber" name="L128" href="#L128">128</a> } +<a class="jxr_linenumber" name="L129" href="#L129">129</a> ScmFileSet scmFileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory); +<a class="jxr_linenumber" name="L130" href="#L130">130</a> getLog().info(<span class="jxr_string">"Checking out dist from: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> provider.checkOut(repository, scmFileSet); +<a class="jxr_linenumber" name="L132" href="#L132">132</a> copyReleaseNotesToWorkingDirectory(); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> List<File> filesToCommit = copyDistributionsIntoScmDirectoryStructure(); +<a class="jxr_linenumber" name="L134" href="#L134">134</a> ScmFileSet scmFileSetToCommit = <strong class="jxr_keyword">new</strong> ScmFileSet(distCheckoutDirectory, filesToCommit); +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">if</strong> (!dryRun) { +<a class="jxr_linenumber" name="L136" href="#L136">136</a> AddScmResult addResult = provider.add( +<a class="jxr_linenumber" name="L137" href="#L137">137</a> repository, +<a class="jxr_linenumber" name="L138" href="#L138">138</a> scmFileSetToCommit, +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion() +<a class="jxr_linenumber" name="L140" href="#L140">140</a> ); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (addResult.isSuccess()) { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> getLog().info(<span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> CheckInScmResult checkInResult = provider.checkIn( +<a class="jxr_linenumber" name="L144" href="#L144">144</a> repository, +<a class="jxr_linenumber" name="L145" href="#L145">145</a> scmFileSetToCommit, +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion() +<a class="jxr_linenumber" name="L147" href="#L147">147</a> ); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> (!checkInResult.isSuccess()) { +<a class="jxr_linenumber" name="L149" href="#L149">149</a> getLog().error(<span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput()); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <span class="jxr_string">"Committing dist files failed: "</span> + checkInResult.getCommandOutput() +<a class="jxr_linenumber" name="L152" href="#L152">152</a> ); +<a class="jxr_linenumber" name="L153" href="#L153">153</a> } +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> getLog().error(<span class="jxr_string">"Adding dist files failed: "</span> + addResult.getCommandOutput()); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Adding dist files failed: "</span> + addResult.getCommandOutput()); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> getLog().info(<span class="jxr_string">"Would have committed to: "</span> + distSvnStagingUrl); +<a class="jxr_linenumber" name="L160" href="#L160">160</a> getLog().info(<span class="jxr_string">"Staging release: "</span> + project.getArtifactId() + <span class="jxr_string">", version: "</span> + project.getVersion()); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } +<a class="jxr_linenumber" name="L162" href="#L162">162</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { +<a class="jxr_linenumber" name="L163" href="#L163">163</a> getLog().error(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Could not commit files to dist: "</span> + distSvnStagingUrl, e); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +<a class="jxr_linenumber" name="L166" href="#L166">166</a> } +<a class="jxr_linenumber" name="L167" href="#L167">167</a> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * project and copies it into {@link CommonsDistributionStagingMojo#workingDirectory}.</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurrs as a wrapper so that maven</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * can properly handle the exception.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> copyReleaseNotesToWorkingDirectory() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L176" href="#L176">176</a> StringBuffer copiedReleaseNotesAbsolutePath; +<a class="jxr_linenumber" name="L177" href="#L177">177</a> getLog().info(<span class="jxr_string">"Copying RELEASE-NOTES.txt to working directory."</span>); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> File releaseNotes = <strong class="jxr_keyword">new</strong> File(basedir + <span class="jxr_string">"/RELEASE-NOTES.txt"</span>); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> copiedReleaseNotesAbsolutePath = <strong class="jxr_keyword">new</strong> StringBuffer(workingDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> copiedReleaseNotesAbsolutePath.append(<span class="jxr_string">"/scm/"</span>); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> copiedReleaseNotesAbsolutePath.append(releaseNotes.getName()); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> File copiedReleaseNotes = <strong class="jxr_keyword">new</strong> File(copiedReleaseNotesAbsolutePath.toString()); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> SharedFunctions.copyFile(getLog(), releaseNotes, copiedReleaseNotes); +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</a> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * the directory structure of the distribution staging repository. Specifically:</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * <li>root:</li></em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <li><ul></em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * <li>site.zip</li></em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * <li>RELEASE-NOTES.txt</li></em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * <li>source:</li></em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * <li><ul></em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <li>-src artifacts....</li></em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * </ul></li></em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * <li>binaries:</li></em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * <li><ul></em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * <li>-bin artifacts....</li></em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * </ul></li></em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * </ul></li></em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @return a {@link List} of {@link File}'s in the directory for the purpose of adding them to the maven</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * {@link ScmFileSet}.</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurrs so that Maven can handle it properly.</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">private</strong> List<File> copyDistributionsIntoScmDirectoryStructure() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L210" href="#L210">210</a> List<File> workingDirectoryFiles = Arrays.asList(workingDirectory.listFiles()); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> String scmBinariesRoot = buildDistBinariesRoot(); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> String scmSourceRoot = buildDistSourceRoot(); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> List<File> filesForMavenScmFileSet = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> File copy; +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">for</strong> (File file : workingDirectoryFiles) { +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"src"</span>)) { +<a class="jxr_linenumber" name="L217" href="#L217">217</a> copy = <strong class="jxr_keyword">new</strong> File(scmSourceRoot + <span class="jxr_string">"/"</span> + file.getName()); +<a class="jxr_linenumber" name="L218" href="#L218">218</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> filesForMavenScmFileSet.add(copy); +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"bin"</span>)) { +<a class="jxr_linenumber" name="L221" href="#L221">221</a> copy = <strong class="jxr_keyword">new</strong> File(scmBinariesRoot + <span class="jxr_string">"/"</span> + file.getName()); +<a class="jxr_linenumber" name="L222" href="#L222">222</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> filesForMavenScmFileSet.add(copy); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (file.getName().contains(<span class="jxr_string">"scm"</span>)) { +<a class="jxr_linenumber" name="L225" href="#L225">225</a> getLog().debug(<span class="jxr_string">"Not copying scm directory over to the scm directory because it is the scm directory."</span>); +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_comment">//do nothing because we are copying into scm</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L228" href="#L228">228</a> copy = <strong class="jxr_keyword">new</strong> File(distCheckoutDirectory.getAbsolutePath() + <span class="jxr_string">"/"</span> + file.getName()); +<a class="jxr_linenumber" name="L229" href="#L229">229</a> SharedFunctions.copyFile(getLog(), file, copy); +<a class="jxr_linenumber" name="L230" href="#L230">230</a> filesForMavenScmFileSet.add(copy); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> } +<a class="jxr_linenumber" name="L232" href="#L232">232</a> } +<a class="jxr_linenumber" name="L233" href="#L233">233</a> filesForMavenScmFileSet.add(<strong class="jxr_keyword">new</strong> File(distCheckoutDirectory + <span class="jxr_string">"/RELEASE-NOTES.txt"</span>)); +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">return</strong> filesForMavenScmFileSet; +<a class="jxr_linenumber" name="L235" href="#L235">235</a> } +<a class="jxr_linenumber" name="L236" href="#L236">236</a> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Build the path for the distribution binaries directory.</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @return the local absolute path into the checkedout subversion repository that is where</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * the binaries distributions are to be copied.</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">private</strong> String buildDistBinariesRoot() { +<a class="jxr_linenumber" name="L244" href="#L244">244</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(distCheckoutDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> buffer.append(<span class="jxr_string">"/binaries"</span>); +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">return</strong> buffer.toString(); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> } +<a class="jxr_linenumber" name="L248" href="#L248">248</a> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * Build the path for the distribution source directory.</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @return the local absolute path into the checkedout subversion repository that is where</em> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * the source distributions are to be copied.</em> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">private</strong> String buildDistSourceRoot() { +<a class="jxr_linenumber" name="L256" href="#L256">256</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(distCheckoutDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L257" href="#L257">257</a> buffer.append(<span class="jxr_string">"/source"</span>); +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">return</strong> buffer.toString(); +<a class="jxr_linenumber" name="L259" href="#L259">259</a> } +<a class="jxr_linenumber" name="L260" href="#L260">260</a> +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * This method is the setter for the {@link CommonsDistributionStagingMojo#basedir} field, specifically</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * for the usage in the unit tests.</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @param basedir is the {@link File} to be used as the project's root directory when this mojo</em> +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * is invoked.</em> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setBasedir(File basedir) { +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">this</strong>.basedir = basedir; +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } +<a class="jxr_linenumber" name="L271" href="#L271">271</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file Added: websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/xref/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Thu Jan 11 01:05:54 2018 @@ -0,0 +1,178 @@ +<!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> org.apache.commons.compress.archivers.zip.ParallelScatterZipCreator; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.compress.archivers.zip.ScatterZipOutputStream; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.SharedFunctions; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<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> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipEntry; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> java.util.zip.ZipOutputStream; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Takes the built <code>./target/site</code> directory and compresses it to</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <code>./target/commons-release-plugin/site.zip</code>.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @author chtompki</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 1.0</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> @Mojo(name = <span class="jxr_string">"compress-site"</span>, defaultPhase = LifecyclePhase.POST_SITE, threadSafe = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L46" href="#L46">46</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="L47" href="#L47">47</a> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * The working directory for the plugin which, assuming the maven uses the default</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</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> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, alias = <span class="jxr_string">"outputDirectory"</span>) +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<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"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/site"</span>, alias = <span class="jxr_string">"siteOutputDirectory"</span>) +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> File siteDirectory; +<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"> * A variable for the process of creating the site.zip file.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> ScatterZipOutputStream dirs; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * A second variable for the process of creating the site.zip file.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> ParallelScatterZipCreator scatterZipCreator; +<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"> * The list of files to compress into the site.zip file.</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> <strong class="jxr_keyword">private</strong> List<File> filesToCompress; +<a class="jxr_linenumber" name="L74" href="#L74">74</a> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Override +<a class="jxr_linenumber" name="L76" href="#L76">76</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="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (!siteDirectory.exists()) { +<a class="jxr_linenumber" name="L78" href="#L78">78</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="L79" href="#L79">79</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( +<a class="jxr_linenumber" name="L80" href="#L80">80</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="L81" href="#L81">81</a> ); +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L84" href="#L84">84</a> SharedFunctions.initDirectory(getLog(), workingDirectory); +<a class="jxr_linenumber" name="L85" href="#L85">85</a> } +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L87" href="#L87">87</a> filesToCompress = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> getAllSiteFiles(siteDirectory, filesToCompress); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> writeZipFile(workingDirectory, siteDirectory, filesToCompress); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L91" href="#L91">91</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="L92" href="#L92">92</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <span class="jxr_string">"Failed to create ./target/commons-release-plugin/site.zip: "</span> + e.getMessage(), +<a class="jxr_linenumber" name="L94" href="#L94">94</a> e +<a class="jxr_linenumber" name="L95" href="#L95">95</a> ); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> } +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * By default this method iterates across the <code>target/site</code> directory and adds all of the files</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @param filesToCompress the {@link List} to which to add all the files.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> getAllSiteFiles(File siteDirectory, List<File> filesToCompress) { +<a class="jxr_linenumber" name="L107" href="#L107">107</a> File[] files = siteDirectory.listFiles(); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">for</strong> (File file : files) { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> filesToCompress.add(file); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> (file.isDirectory()) { +<a class="jxr_linenumber" name="L111" href="#L111">111</a> getAllSiteFiles(file, filesToCompress); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<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> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <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="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * in the <code>workingDirectory</code>.</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @param workingDirectory is a {@link File} representing the place to put the site.zip file.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * <code>target/site</code>).</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @param fileList the list of files to be zipped up, generally generated by</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @throws IOException when the copying of the files goes incorrectly.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeZipFile(File workingDirectory, File directoryToZip, List<File> fileList) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L128" href="#L128">128</a> FileOutputStream fos = <strong class="jxr_keyword">new</strong> FileOutputStream(workingDirectory.getAbsolutePath() + <span class="jxr_string">"/site.zip"</span>); +<a class="jxr_linenumber" name="L129" href="#L129">129</a> ZipOutputStream zos = <strong class="jxr_keyword">new</strong> ZipOutputStream(fos); +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">for</strong> (File file : fileList) { +<a class="jxr_linenumber" name="L131" href="#L131">131</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="L132" href="#L132">132</a> addToZip(directoryToZip, file, zos); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> } +<a class="jxr_linenumber" name="L135" href="#L135">135</a> zos.close(); +<a class="jxr_linenumber" name="L136" href="#L136">136</a> fos.close(); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> } +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</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="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * <code>zos</code>.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <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="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * compressing. Generally this is <code>target/site</code>.</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</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="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addToZip(File directoryToZip, File file, ZipOutputStream zos) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> FileInputStream fis = <strong class="jxr_keyword">new</strong> FileInputStream(file); +<a class="jxr_linenumber" name="L151" href="#L151">151</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="L152" href="#L152">152</a> <em class="jxr_comment">// to the directory being zipped, so chop off the rest of the path</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> String zipFilePath = file.getCanonicalPath().substring(directoryToZip.getCanonicalPath().length() + 1, +<a class="jxr_linenumber" name="L154" href="#L154">154</a> file.getCanonicalPath().length()); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> ZipEntry zipEntry = <strong class="jxr_keyword">new</strong> ZipEntry(zipFilePath); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> zos.putNextEntry(zipEntry); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> byte[] bytes = <strong class="jxr_keyword">new</strong> byte[SharedFunctions.BUFFER_BYTE_SIZE]; +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">int</strong> length; +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">while</strong> ((length = fis.read(bytes)) >= 0) { +<a class="jxr_linenumber" name="L160" href="#L160">160</a> zos.write(bytes, 0, length); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } +<a class="jxr_linenumber" name="L162" href="#L162">162</a> zos.closeEntry(); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> fis.close(); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
