Added: dev/commons/release-plugin/1.8.3-RC1/site/xref/allclasses-frame.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/xref/allclasses-frame.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/xref/allclasses-frame.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,25 @@ + +<!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"> + <!-- generated by Apache Maven JXR (jdk8) --> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>All Classes</title> + <link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" /> + </head> + <body> + <h1 class="bar">All Classes</h1> + <div class="indexContainer"> + <ul> + <li><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#CommonsDistributionDetachmentMojo" target="classFrame">CommonsDistributionDetachmentMojo</a></li> + <li><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#CommonsDistributionStagingMojo" target="classFrame">CommonsDistributionStagingMojo</a></li> + <li><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#CommonsSiteCompressionMojo" target="classFrame">CommonsSiteCompressionMojo</a></li> + <li><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#CommonsStagingCleanupMojo" target="classFrame">CommonsStagingCleanupMojo</a></li> + <li><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#HeaderHtmlVelocityDelegate" target="classFrame">HeaderHtmlVelocityDelegate</a></li> + <li><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder" target="classFrame">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a></li> + <li><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#ReadmeHtmlVelocityDelegate" target="classFrame">ReadmeHtmlVelocityDelegate</a></li> + <li><a href="org/apache/commons/release/plugin/SharedFunctions.html#SharedFunctions" target="classFrame">SharedFunctions</a></li> + </ul> + </div> + </body> +</html>
Added: dev/commons/release-plugin/1.8.3-RC1/site/xref/index.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/xref/index.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/xref/index.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,75 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd";> +<html xml:lang="en" lang="en"> + <!-- this is a JXR report set (jdk8) --> + <head> + <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> + <title>Apache Commons Release Plugin 1.8.3 Reference</title> + <script type="text/javascript"> + tmpTargetPage = "" + window.location.search; + if (tmpTargetPage != "" && tmpTargetPage != "undefined") + tmpTargetPage = tmpTargetPage.substring(1); + if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage))) + tmpTargetPage = "undefined"; + targetPage = tmpTargetPage; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } + </script> + </head> + <frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> + <frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> + <frame src="overview-frame.html" name="packageListFrame" title="All Packages"/> + <frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"/> + </frameset> + <frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"/> + <noframes> + <h1>Frame Alert</h1> + <p> + You don't have frames. Go <a href="overview-summary.html">here</a> + </p> + </noframes> + </frameset> +</html> Added: dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/SharedFunctions.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/SharedFunctions.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/SharedFunctions.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,210 @@ +<!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>SharedFunctions xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/release/plugin/SharedFunctions.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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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; +<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.IOException; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Optional; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.function.Supplier; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.ScmProviderRepository; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Server; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecrypter; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecryptionResult; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Shared static functions for all of our Mojos.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @since 1.0</em> +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="SharedFunctions" href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#SharedFunctions">SharedFunctions</a> { +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<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"> * I want a buffer that is an array with 1024 elements of bytes. We declare</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * the constant here for the sake of making the code more readable.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> BUFFER_BYTE_SIZE = 1024; +<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"> * Copies a {@link File} from the <code>fromFile</code> to the <code>toFile</code> and logs the failure</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * using the Maven {@link Log}.</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param log the {@link Log}, the maven logger.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param fromFile the {@link File} from which to copy.</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param toFile the {@link File} to which to copy into.</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} or {@link NullPointerException} is caught.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> copyFile(<strong class="jxr_keyword">final</strong> Log log, <strong class="jxr_keyword">final</strong> File fromFile, <strong class="jxr_keyword">final</strong> File toFile) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">final</strong> String format = <span class="jxr_string">"Unable to copy file %s to %s: %s"</span>; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> requireNonNull(fromFile, () -> String.format(format, fromFile, toFile)); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> requireNonNull(toFile, () -> String.format(format, fromFile, toFile)); +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L61" href="#L61">61</a> FileUtils.copyFile(fromFile, toFile); +<a class="jxr_linenumber" name="L62" href="#L62">62</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">final</strong> String message = String.format(format, fromFile, toFile, e.getMessage()); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> log.error(message); +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<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> +<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"> * Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code></em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * parameter.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @param log is the Maven log for output logging, particularly in regards to error management.</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @param workingDirectory is a {@link File} that represents the directory to first attempt to delete then create.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException when an {@link IOException} or {@link NullPointerException} is caught for the</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * purpose of bubbling the exception up to Maven properly.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> initDirectory(<strong class="jxr_keyword">final</strong> Log log, <strong class="jxr_keyword">final</strong> File workingDirectory) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">final</strong> String format = <span class="jxr_string">"Unable to remove directory %s: %s"</span>; +<a class="jxr_linenumber" name="L80" href="#L80">80</a> requireNonNull(workingDirectory, () -> String.format(format, workingDirectory)); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (workingDirectory.exists()) { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L83" href="#L83">83</a> FileUtils.deleteDirectory(workingDirectory); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">final</strong> String message = String.format(format, workingDirectory, e.getMessage()); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> log.error(message); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(message, e); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> } +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L91" href="#L91">91</a> workingDirectory.mkdirs(); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> } +<a class="jxr_linenumber" name="L93" href="#L93">93</a> } +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * Checks that the specified object reference is not {@code null}. This method is designed primarily for doing parameter validation in methods and</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * constructors, as demonstrated below: <blockquote></em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * public Foo(Bar bar) {</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * this.bar = SharedFunctions.requireNonNull(bar);</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"> * </pre></em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * </blockquote></em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param obj the object reference to check for nullity</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param <T> the type of the reference</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @return {@code obj} if not {@code null}</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if {@code obj} is {@code null}</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <T> T requireNonNull(<strong class="jxr_keyword">final</strong> T obj) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<strong class="jxr_keyword">new</strong> NullPointerException()); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> } +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">return</strong> obj; +<a class="jxr_linenumber" name="L117" href="#L117">117</a> } +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is. This method is designed</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below: <blockquote></em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * public Foo(Bar bar, Baz baz) {</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * this.bar = SharedFunctions.requireNonNull(bar, "bar must not be null");</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * this.baz = SharedFunctions.requireNonNull(baz, "baz must not be null");</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * }</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * </blockquote></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> <em class="jxr_javadoccomment"> * @param obj the object reference to check for nullity</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @param message detail message to be used in the event that a {@code</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * NullPointerException} is thrown</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @param <T> the type of the reference</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @return {@code obj} if not {@code null}</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if {@code obj} is {@code null}</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">public</strong> <strong class="jxr_keyword">static</strong> <T> T requireNonNull(<strong class="jxr_keyword">final</strong> T obj, <strong class="jxr_keyword">final</strong> String message) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<strong class="jxr_keyword">new</strong> NullPointerException(message)); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> } +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong> obj; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> } +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is.</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Unlike the method {@link #requireNonNull(Object, String)}, this method allows creation of the message to be deferred until after the null check is made.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * message supplier are less than the cost of just creating the string message directly.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * @param obj the object reference to check for nullity</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @param messageSupplier supplier of the detail message to be used in the event that a {@code NullPointerException} is thrown</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @param <T> the type of the reference</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * @return {@code obj} if not {@code null}</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if {@code obj} is {@code null}</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">public</strong> <strong class="jxr_keyword">static</strong> <T> T requireNonNull(<strong class="jxr_keyword">final</strong> T obj, <strong class="jxr_keyword">final</strong> Supplier<String> messageSupplier) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<strong class="jxr_keyword">new</strong> NullPointerException(messageSupplier.get())); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> } +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">return</strong> obj; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * Sets authentication information on the specified {@link ScmProviderRepository}.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @param providerRepository target.</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @param distServer temp.</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * @param settings temp.</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param settingsDecrypter temp.</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param username temp.</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @param password temp.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setAuthentication(<strong class="jxr_keyword">final</strong> ScmProviderRepository providerRepository, +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">final</strong> String distServer, +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">final</strong> Settings settings, +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">final</strong> SettingsDecrypter settingsDecrypter, +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">final</strong> String username, +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">final</strong> String password) { +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">final</strong> Optional<Server> server = +<a class="jxr_linenumber" name="L184" href="#L184">184</a> Optional.ofNullable(distServer).map(settings::getServer).map(DefaultSettingsDecryptionRequest::<strong class="jxr_keyword">new</strong>) +<a class="jxr_linenumber" name="L185" href="#L185">185</a> .map(settingsDecrypter::decrypt).map(SettingsDecryptionResult::getServer); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> providerRepository.setUser(server.map(Server::getUsername).orElse(username)); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> providerRepository.setPassword(server.map(Server::getPassword).orElse(password)); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> } +<a class="jxr_linenumber" name="L190" href="#L190">190</a> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * Making the constructor private because the class only contains static methods.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">private</strong> <a name="SharedFunctions" href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#SharedFunctions">SharedFunctions</a>() { +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_comment">// Utility Class</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> } +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +</pre> +<hr/> +<div id="footer">© 2018?2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a></div> +</body> +</html> Added: dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/xref/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,293 @@ +<!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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.IOException; +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.PrintWriter; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.codec.digest.DigestUtils; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections4.properties.SortedProperties; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.reflect.MethodUtils; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.commons.release.plugin.SharedFunctions; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin,</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</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="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * in the dev distribution location for Apache projects.</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @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">"detach-distributions"</span>, +<a class="jxr_linenumber" name="L53" href="#L53">53</a> defaultPhase = LifecyclePhase.VERIFY, +<a class="jxr_linenumber" name="L54" href="#L54">54</a> threadSafe = <strong class="jxr_keyword">true</strong>, +<a class="jxr_linenumber" name="L55" href="#L55">55</a> aggregator = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CommonsDistributionDetachmentMojo" href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#CommonsDistributionDetachmentMojo">CommonsDistributionDetachmentMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L57" href="#L57">57</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * A list of "artifact types" in the Maven vernacular, to</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * be detached from the deployment. For the time being we want</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * all artifacts generated by the maven-assembly-plugin to be detached</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * from the deployment, namely *-src.zip, *-src.tar.gz, *-bin.zip,</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * *-bin.tar.gz, and the corresponding .asc pgp signatures.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Set<String> ARTIFACT_TYPES_TO_DETACH; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">static</strong> { +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">final</strong> Set<String> hashSet = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L68" href="#L68">68</a> hashSet.add(<span class="jxr_string">"zip"</span>); +<a class="jxr_linenumber" name="L69" href="#L69">69</a> hashSet.add(<span class="jxr_string">"tar.gz"</span>); +<a class="jxr_linenumber" name="L70" href="#L70">70</a> hashSet.add(<span class="jxr_string">"zip.asc"</span>); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> hashSet.add(<span class="jxr_string">"tar.gz.asc"</span>); +<a class="jxr_linenumber" name="L72" href="#L72">72</a> ARTIFACT_TYPES_TO_DETACH = Collections.unmodifiableSet(hashSet); +<a class="jxr_linenumber" name="L73" href="#L73">73</a> } +<a class="jxr_linenumber" name="L74" href="#L74">74</a> +<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> <em class="jxr_javadoccomment"> * This list is supposed to hold the Maven references to the aforementioned artifacts so that we</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * can upload them to svn after they've been detached from the Maven deployment.</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<Artifact> detachedArtifacts = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * A {@link SortedProperties} of {@link Artifact} â {@link String} containing the sha512 signatures</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * for the individual artifacts, where the {@link Artifact} is represented as:</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * <code>groupId:artifactId:version:type=sha512</code>.</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> <strong class="jxr_keyword">final</strong> SortedProperties artifactSha512s = <strong class="jxr_keyword">new</strong> SortedProperties(); +<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"> * The maven project context injection so that we can get a hold of the variables at hand.</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> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L93" href="#L93">93</a> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * The working directory in <code>target</code> that we use as a sandbox for the plugin.</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(defaultValue = <span class="jxr_string">"${project.build.directory}/commons-release-plugin"</span>, +<a class="jxr_linenumber" name="L98" href="#L98">98</a> property = <span class="jxr_string">"commons.outputDirectory"</span>) +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> File workingDirectory; +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * The subversion staging url to which we upload all of our staged artifacts.</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> @Parameter(defaultValue = <span class="jxr_string">""</span>, property = <span class="jxr_string">"commons.distSvnStagingUrl"</span>) +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">private</strong> String distSvnStagingUrl; +<a class="jxr_linenumber" name="L106" href="#L106">106</a> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"commons.release.isDistModule"</span>) +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">private</strong> Boolean isDistModule; +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Override +<a class="jxr_linenumber" name="L114" href="#L114">114</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="L115" href="#L115">115</a> <strong class="jxr_keyword">if</strong> (!isDistModule) { +<a class="jxr_linenumber" name="L116" href="#L116">116</a> getLog().info(<span class="jxr_string">"This module is marked as a non distribution or assembly module, and the plugin will not run."</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">if</strong> (StringUtils.isEmpty(distSvnStagingUrl)) { +<a class="jxr_linenumber" name="L120" href="#L120">120</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="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L122" href="#L122">122</a> } +<a class="jxr_linenumber" name="L123" href="#L123">123</a> getLog().info(<span class="jxr_string">"Detaching Assemblies"</span>); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Artifact attachedArtifact : project.getAttachedArtifacts()) { +<a class="jxr_linenumber" name="L125" href="#L125">125</a> putAttachedArtifactInSha512Map(attachedArtifact); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> (ARTIFACT_TYPES_TO_DETACH.contains(attachedArtifact.getType())) { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> detachedArtifacts.add(attachedArtifact); +<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> <strong class="jxr_keyword">if</strong> (detachedArtifacts.isEmpty()) { +<a class="jxr_linenumber" name="L131" href="#L131">131</a> getLog().info(<span class="jxr_string">"Current project contains no distributions. Not executing."</span>); +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_comment">//</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_comment">// PROBLEM CODE for Maven >= 3.8.3</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_comment">// https://issues.apache.org/jira/browse/MNG-7316</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_comment">// (1) Try the normal way</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// Maven 3.8.3 throws an exception here because MavenProject.getAttachedArtifacts()</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// returns an IMMUTABLE collection.</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> project.getAttachedArtifacts().removeAll(detachedArtifacts); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> UnsupportedOperationException e) { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_comment">// (2) HACK workaround for https://issues.apache.org/jira/browse/MNG-7316</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">final</strong> ArrayList<Artifact> arrayList = <strong class="jxr_keyword">new</strong> ArrayList<>(project.getAttachedArtifacts()); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> arrayList.removeAll(detachedArtifacts); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">// MavenProject#setAttachedArtifacts(List) is protected</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> MethodUtils.invokeMethod(project, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"setAttachedArtifacts"</span>, arrayList); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> ReflectiveOperationException roe) { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(roe); +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> } +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> (!workingDirectory.exists()) { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> SharedFunctions.initDirectory(getLog(), workingDirectory); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> } +<a class="jxr_linenumber" name="L156" href="#L156">156</a> writeAllArtifactsInSha512PropertiesFile(); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> copyRemovedArtifactsToWorkingDirectory(); +<a class="jxr_linenumber" name="L158" href="#L158">158</a> getLog().info(<span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> hashArtifacts(); +<a class="jxr_linenumber" name="L160" href="#L160">160</a> } +<a class="jxr_linenumber" name="L161" href="#L161">161</a> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * Takes an attached artifact and puts the signature in the map.</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param artifact is a Maven {@link Artifact} taken from the project at start time of mojo.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an {@link IOException} occurs when getting the sha512 of the</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * artifact.</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> <strong class="jxr_keyword">void</strong> putAttachedArtifactInSha512Map(<strong class="jxr_keyword">final</strong> Artifact artifact) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">final</strong> String artifactKey = getArtifactKey(artifact); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">if</strong> (!artifactKey.endsWith(<span class="jxr_string">".asc"</span>)) { <em class="jxr_comment">// .asc files don't need hashes</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">try</strong> (InputStream fis = Files.newInputStream(artifact.getFile().toPath())) { +<a class="jxr_linenumber" name="L173" href="#L173">173</a> artifactSha512s.put(artifactKey, DigestUtils.sha512Hex(fis)); +<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> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <span class="jxr_string">"Could not find artifact signature for: "</span> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> + artifact.getArtifactId() +<a class="jxr_linenumber" name="L180" href="#L180">180</a> + <span class="jxr_string">"-"</span> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> + artifact.getClassifier() +<a class="jxr_linenumber" name="L182" href="#L182">182</a> + <span class="jxr_string">"-"</span> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> + artifact.getVersion() +<a class="jxr_linenumber" name="L184" href="#L184">184</a> + <span class="jxr_string">" type: "</span> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> + artifact.getType(), +<a class="jxr_linenumber" name="L186" href="#L186">186</a> e); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> } +<a class="jxr_linenumber" name="L188" href="#L188">188</a> } +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if we can't write the file due to an {@link IOException}.</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeAllArtifactsInSha512PropertiesFile() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">final</strong> File propertiesFile = <strong class="jxr_keyword">new</strong> File(workingDirectory, <span class="jxr_string">"sha512.properties"</span>); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> getLog().info(<span class="jxr_string">"Writing "</span> + propertiesFile); +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">try</strong> (OutputStream fileWriter = Files.newOutputStream(propertiesFile.toPath())) { +<a class="jxr_linenumber" name="L199" href="#L199">199</a> artifactSha512s.store(fileWriter, <span class="jxr_string">"Release SHA-512s"</span>); +<a class="jxr_linenumber" name="L200" href="#L200">200</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failure to write SHA-512's"</span>, e); +<a class="jxr_linenumber" name="L202" href="#L202">202</a> } +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } +<a class="jxr_linenumber" name="L204" href="#L204">204</a> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <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="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * so that the {@link CommonsDistributionStagingMojo} can find the artifacts later.</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> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * properly wrapped so that Maven can handle it.</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <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="L213" href="#L213">213</a> <strong class="jxr_keyword">final</strong> String wdAbsolutePath = workingDirectory.getAbsolutePath(); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> getLog().info( +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <span class="jxr_string">"Copying "</span> + detachedArtifacts.size() + <span class="jxr_string">" detached artifacts to working directory "</span> + wdAbsolutePath); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Artifact artifact: detachedArtifacts) { +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">final</strong> File artifactFile = artifact.getFile(); +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">final</strong> StringBuilder copiedArtifactAbsolutePath = <strong class="jxr_keyword">new</strong> StringBuilder(wdAbsolutePath); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> copiedArtifactAbsolutePath.append(<span class="jxr_string">"/"</span>); +<a class="jxr_linenumber" name="L220" href="#L220">220</a> copiedArtifactAbsolutePath.append(artifactFile.getName()); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">final</strong> File copiedArtifact = <strong class="jxr_keyword">new</strong> File(copiedArtifactAbsolutePath.toString()); +<a class="jxr_linenumber" name="L222" href="#L222">222</a> getLog().info(<span class="jxr_string">"Copying: "</span> + artifactFile.getName()); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> SharedFunctions.copyFile(getLog(), artifactFile, copiedArtifact); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } +<a class="jxr_linenumber" name="L226" href="#L226">226</a> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * A helper method that creates sha512 signature files for our detached artifacts in the</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * the {@link CommonsDistributionStagingMojo}.</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if some form of an {@link IOException} occurs, we want it</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * properly wrapped so that Maven can handle it.</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> hashArtifacts() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Artifact artifact : detachedArtifacts) { +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> (!artifact.getFile().getName().toLowerCase(Locale.ROOT).contains(<span class="jxr_string">"asc"</span>)) { +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">final</strong> String artifactKey = getArtifactKey(artifact); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">final</strong> String digest; +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_comment">// SHA-512</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> digest = artifactSha512s.getProperty(artifactKey.toString()); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> getLog().info(artifact.getFile().getName() + <span class="jxr_string">" sha512: "</span> + digest); +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">try</strong> (PrintWriter printWriter = <strong class="jxr_keyword">new</strong> PrintWriter( +<a class="jxr_linenumber" name="L245" href="#L245">245</a> getSha512FilePath(workingDirectory, artifact.getFile()))) { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> printWriter.println(digest); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> } +<a class="jxr_linenumber" name="L248" href="#L248">248</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { +<a class="jxr_linenumber" name="L249" href="#L249">249</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="L250" href="#L250">250</a> } +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L252" href="#L252">252</a> } +<a class="jxr_linenumber" name="L253" href="#L253">253</a> } +<a class="jxr_linenumber" name="L254" href="#L254">254</a> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * A helper method to create a file path for the <code>sha512</code> signature file from a given file.</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param directory is the {@link File} for the directory in which to make the <code>.sha512</code> file.</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @param file the {@link File} whose name we should use to create the <code>.sha512</code> file.</em> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @return a {@link String} that is the absolute path to the <code>.sha512</code> file.</em> +<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> <strong class="jxr_keyword">private</strong> String getSha512FilePath(<strong class="jxr_keyword">final</strong> File directory, <strong class="jxr_keyword">final</strong> File file) { +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">final</strong> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(directory.getAbsolutePath()); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> buffer.append(<span class="jxr_string">"/"</span>); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> buffer.append(file.getName()); +<a class="jxr_linenumber" name="L266" href="#L266">266</a> buffer.append(<span class="jxr_string">".sha512"</span>); +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">return</strong> buffer.toString(); +<a class="jxr_linenumber" name="L268" href="#L268">268</a> } +<a class="jxr_linenumber" name="L269" href="#L269">269</a> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * Generates the unique artifact key for storage in our sha512 map. For example,</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * commons-test-1.4-src.tar.gz should have its name as the key.</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * @param artifact the {@link Artifact} that we wish to generate a key for.</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * @return the generated key</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">private</strong> String getArtifactKey(<strong class="jxr_keyword">final</strong> Artifact artifact) { +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">return</strong> artifact.getFile().getName(); +<a class="jxr_linenumber" name="L279" href="#L279">279</a> } +<a class="jxr_linenumber" name="L280" href="#L280">280</a> } +</pre> +<hr/> +<div id="footer">© 2018?2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a></div> +</body> +</html>
