Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/SharedFunctions.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/SharedFunctions.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/SharedFunctions.html Sat Apr 20 14:51:39 2024 @@ -1,208 +1,213 @@ <!DOCTYPE HTML> <html lang="en"> <head> +<!-- Generated by javadoc (17) --> <title>Source code</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta name="description" content="source: package: org.apache.commons.release.plugin, class: SharedFunctions"> +<meta name="generator" content="javadoc/SourceToHTMLConverter"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> </head> -<body> +<body class="source-page"> <main role="main"> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> -<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a> -<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a> -<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a> -<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a> -<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a> -<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a> -<span class="sourceLineNo">008</span><a id="line.8"> *</a> -<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a> -<span class="sourceLineNo">010</span><a id="line.10"> *</a> -<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a> -<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a> -<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a> -<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a> -<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a> -<span class="sourceLineNo">016</span><a id="line.16"> */</a> -<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin;</a> -<span class="sourceLineNo">018</span><a id="line.18"></a> -<span class="sourceLineNo">019</span><a id="line.19">import java.io.File;</a> -<span class="sourceLineNo">020</span><a id="line.20">import java.io.IOException;</a> -<span class="sourceLineNo">021</span><a id="line.21">import java.util.Optional;</a> -<span class="sourceLineNo">022</span><a id="line.22">import java.util.function.Supplier;</a> -<span class="sourceLineNo">023</span><a id="line.23"></a> -<span class="sourceLineNo">024</span><a id="line.24">import org.apache.maven.plugin.MojoExecutionException;</a> -<span class="sourceLineNo">025</span><a id="line.25">import org.apache.maven.plugin.logging.Log;</a> -<span class="sourceLineNo">026</span><a id="line.26">import org.apache.maven.scm.provider.ScmProviderRepository;</a> -<span class="sourceLineNo">027</span><a id="line.27">import org.apache.maven.settings.Server;</a> -<span class="sourceLineNo">028</span><a id="line.28">import org.apache.maven.settings.Settings;</a> -<span class="sourceLineNo">029</span><a id="line.29">import org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest;</a> -<span class="sourceLineNo">030</span><a id="line.30">import org.apache.maven.settings.crypto.SettingsDecrypter;</a> -<span class="sourceLineNo">031</span><a id="line.31">import org.apache.maven.settings.crypto.SettingsDecryptionResult;</a> -<span class="sourceLineNo">032</span><a id="line.32">import org.codehaus.plexus.util.FileUtils;</a> -<span class="sourceLineNo">033</span><a id="line.33"></a> -<span class="sourceLineNo">034</span><a id="line.34">/**</a> -<span class="sourceLineNo">035</span><a id="line.35"> * Shared static functions for all of our Mojos.</a> -<span class="sourceLineNo">036</span><a id="line.36"> *</a> -<span class="sourceLineNo">037</span><a id="line.37"> * @since 1.0</a> -<span class="sourceLineNo">038</span><a id="line.38"> */</a> -<span class="sourceLineNo">039</span><a id="line.39">public final class SharedFunctions {</a> -<span class="sourceLineNo">040</span><a id="line.40"></a> -<span class="sourceLineNo">041</span><a id="line.41"> /**</a> -<span class="sourceLineNo">042</span><a id="line.42"> * I want a buffer that is an array with 1024 elements of bytes. We declare</a> -<span class="sourceLineNo">043</span><a id="line.43"> * the constant here for the sake of making the code more readable.</a> -<span class="sourceLineNo">044</span><a id="line.44"> */</a> -<span class="sourceLineNo">045</span><a id="line.45"> public static final int BUFFER_BYTE_SIZE = 1024;</a> -<span class="sourceLineNo">046</span><a id="line.46"></a> -<span class="sourceLineNo">047</span><a id="line.47"> /**</a> -<span class="sourceLineNo">048</span><a id="line.48"> * Copies a {@link File} from the <code>fromFile</code> to the <code>toFile</code> and logs the failure</a> -<span class="sourceLineNo">049</span><a id="line.49"> * using the Maven {@link Log}.</a> -<span class="sourceLineNo">050</span><a id="line.50"> *</a> -<span class="sourceLineNo">051</span><a id="line.51"> * @param log the {@link Log}, the maven logger.</a> -<span class="sourceLineNo">052</span><a id="line.52"> * @param fromFile the {@link File} from which to copy.</a> -<span class="sourceLineNo">053</span><a id="line.53"> * @param toFile the {@link File} to which to copy into.</a> -<span class="sourceLineNo">054</span><a id="line.54"> * @throws MojoExecutionException if an {@link IOException} or {@link NullPointerException} is caught.</a> -<span class="sourceLineNo">055</span><a id="line.55"> */</a> -<span class="sourceLineNo">056</span><a id="line.56"> public static void copyFile(final Log log, final File fromFile, final File toFile) throws MojoExecutionException {</a> -<span class="sourceLineNo">057</span><a id="line.57"> final String format = "Unable to copy file %s to %s: %s";</a> -<span class="sourceLineNo">058</span><a id="line.58"> requireNonNull(fromFile, () -> String.format(format, fromFile, toFile));</a> -<span class="sourceLineNo">059</span><a id="line.59"> requireNonNull(toFile, () -> String.format(format, fromFile, toFile));</a> -<span class="sourceLineNo">060</span><a id="line.60"> try {</a> -<span class="sourceLineNo">061</span><a id="line.61"> FileUtils.copyFile(fromFile, toFile);</a> -<span class="sourceLineNo">062</span><a id="line.62"> } catch (final IOException e) {</a> -<span class="sourceLineNo">063</span><a id="line.63"> final String message = String.format(format, fromFile, toFile, e.getMessage());</a> -<span class="sourceLineNo">064</span><a id="line.64"> log.error(message);</a> -<span class="sourceLineNo">065</span><a id="line.65"> throw new MojoExecutionException(message, e);</a> -<span class="sourceLineNo">066</span><a id="line.66"> }</a> -<span class="sourceLineNo">067</span><a id="line.67"> }</a> -<span class="sourceLineNo">068</span><a id="line.68"></a> -<span class="sourceLineNo">069</span><a id="line.69"> /**</a> -<span class="sourceLineNo">070</span><a id="line.70"> * Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code></a> -<span class="sourceLineNo">071</span><a id="line.71"> * parameter.</a> -<span class="sourceLineNo">072</span><a id="line.72"> *</a> -<span class="sourceLineNo">073</span><a id="line.73"> * @param log is the Maven log for output logging, particularly in regards to error management.</a> -<span class="sourceLineNo">074</span><a id="line.74"> * @param workingDirectory is a {@link File} that represents the directory to first attempt to delete then create.</a> -<span class="sourceLineNo">075</span><a id="line.75"> * @throws MojoExecutionException when an {@link IOException} or {@link NullPointerException} is caught for the</a> -<span class="sourceLineNo">076</span><a id="line.76"> * purpose of bubbling the exception up to Maven properly.</a> -<span class="sourceLineNo">077</span><a id="line.77"> */</a> -<span class="sourceLineNo">078</span><a id="line.78"> public static void initDirectory(final Log log, final File workingDirectory) throws MojoExecutionException {</a> -<span class="sourceLineNo">079</span><a id="line.79"> final String format = "Unable to remove directory %s: %s";</a> -<span class="sourceLineNo">080</span><a id="line.80"> requireNonNull(workingDirectory, () -> String.format(format, workingDirectory));</a> -<span class="sourceLineNo">081</span><a id="line.81"> if (workingDirectory.exists()) {</a> -<span class="sourceLineNo">082</span><a id="line.82"> try {</a> -<span class="sourceLineNo">083</span><a id="line.83"> FileUtils.deleteDirectory(workingDirectory);</a> -<span class="sourceLineNo">084</span><a id="line.84"> } catch (final IOException e) {</a> -<span class="sourceLineNo">085</span><a id="line.85"> final String message = String.format(format, workingDirectory, e.getMessage());</a> -<span class="sourceLineNo">086</span><a id="line.86"> log.error(message);</a> -<span class="sourceLineNo">087</span><a id="line.87"> throw new MojoExecutionException(message, e);</a> -<span class="sourceLineNo">088</span><a id="line.88"> }</a> -<span class="sourceLineNo">089</span><a id="line.89"> }</a> -<span class="sourceLineNo">090</span><a id="line.90"> if (!workingDirectory.exists()) {</a> -<span class="sourceLineNo">091</span><a id="line.91"> workingDirectory.mkdirs();</a> -<span class="sourceLineNo">092</span><a id="line.92"> }</a> -<span class="sourceLineNo">093</span><a id="line.93"> }</a> -<span class="sourceLineNo">094</span><a id="line.94"></a> -<span class="sourceLineNo">095</span><a id="line.95"> /**</a> -<span class="sourceLineNo">096</span><a id="line.96"> * Checks that the specified object reference is not {@code null}. This method is designed primarily for doing parameter validation in methods and</a> -<span class="sourceLineNo">097</span><a id="line.97"> * constructors, as demonstrated below: <blockquote></a> -<span class="sourceLineNo">098</span><a id="line.98"> *</a> -<span class="sourceLineNo">099</span><a id="line.99"> * <pre></a> -<span class="sourceLineNo">100</span><a id="line.100"> * public Foo(Bar bar) {</a> -<span class="sourceLineNo">101</span><a id="line.101"> * this.bar = SharedFunctions.requireNonNull(bar);</a> -<span class="sourceLineNo">102</span><a id="line.102"> * }</a> -<span class="sourceLineNo">103</span><a id="line.103"> * </pre></a> -<span class="sourceLineNo">104</span><a id="line.104"> *</a> -<span class="sourceLineNo">105</span><a id="line.105"> * </blockquote></a> -<span class="sourceLineNo">106</span><a id="line.106"> *</a> -<span class="sourceLineNo">107</span><a id="line.107"> * @param obj the object reference to check for nullity</a> -<span class="sourceLineNo">108</span><a id="line.108"> * @param <T> the type of the reference</a> -<span class="sourceLineNo">109</span><a id="line.109"> * @return {@code obj} if not {@code null}</a> -<span class="sourceLineNo">110</span><a id="line.110"> * @throws MojoExecutionException if {@code obj} is {@code null}</a> -<span class="sourceLineNo">111</span><a id="line.111"> */</a> -<span class="sourceLineNo">112</span><a id="line.112"> public static <T> T requireNonNull(final T obj) throws MojoExecutionException {</a> -<span class="sourceLineNo">113</span><a id="line.113"> if (obj == null) {</a> -<span class="sourceLineNo">114</span><a id="line.114"> throw new MojoExecutionException(new NullPointerException());</a> -<span class="sourceLineNo">115</span><a id="line.115"> }</a> -<span class="sourceLineNo">116</span><a id="line.116"> return obj;</a> -<span class="sourceLineNo">117</span><a id="line.117"> }</a> -<span class="sourceLineNo">118</span><a id="line.118"></a> -<span class="sourceLineNo">119</span><a id="line.119"> /**</a> -<span class="sourceLineNo">120</span><a id="line.120"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is. This method is designed</a> -<span class="sourceLineNo">121</span><a id="line.121"> * primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below: <blockquote></a> -<span class="sourceLineNo">122</span><a id="line.122"> *</a> -<span class="sourceLineNo">123</span><a id="line.123"> * <pre></a> -<span class="sourceLineNo">124</span><a id="line.124"> * public Foo(Bar bar, Baz baz) {</a> -<span class="sourceLineNo">125</span><a id="line.125"> * this.bar = SharedFunctions.requireNonNull(bar, "bar must not be null");</a> -<span class="sourceLineNo">126</span><a id="line.126"> * this.baz = SharedFunctions.requireNonNull(baz, "baz must not be null");</a> -<span class="sourceLineNo">127</span><a id="line.127"> * }</a> -<span class="sourceLineNo">128</span><a id="line.128"> * </pre></a> -<span class="sourceLineNo">129</span><a id="line.129"> *</a> -<span class="sourceLineNo">130</span><a id="line.130"> * </blockquote></a> -<span class="sourceLineNo">131</span><a id="line.131"> *</a> -<span class="sourceLineNo">132</span><a id="line.132"> * @param obj the object reference to check for nullity</a> -<span class="sourceLineNo">133</span><a id="line.133"> * @param message detail message to be used in the event that a {@code</a> -<span class="sourceLineNo">134</span><a id="line.134"> * NullPointerException} is thrown</a> -<span class="sourceLineNo">135</span><a id="line.135"> * @param <T> the type of the reference</a> -<span class="sourceLineNo">136</span><a id="line.136"> * @return {@code obj} if not {@code null}</a> -<span class="sourceLineNo">137</span><a id="line.137"> * @throws MojoExecutionException if {@code obj} is {@code null}</a> -<span class="sourceLineNo">138</span><a id="line.138"> */</a> -<span class="sourceLineNo">139</span><a id="line.139"> public static <T> T requireNonNull(final T obj, final String message) throws MojoExecutionException {</a> -<span class="sourceLineNo">140</span><a id="line.140"> if (obj == null) {</a> -<span class="sourceLineNo">141</span><a id="line.141"> throw new MojoExecutionException(new NullPointerException(message));</a> -<span class="sourceLineNo">142</span><a id="line.142"> }</a> -<span class="sourceLineNo">143</span><a id="line.143"> return obj;</a> -<span class="sourceLineNo">144</span><a id="line.144"> }</a> -<span class="sourceLineNo">145</span><a id="line.145"></a> -<span class="sourceLineNo">146</span><a id="line.146"> /**</a> -<span class="sourceLineNo">147</span><a id="line.147"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is.</a> -<span class="sourceLineNo">148</span><a id="line.148"> * <p></a> -<span class="sourceLineNo">149</span><a id="line.149"> * Unlike the method {@link #requireNonNull(Object, String)}, this method allows creation of the message to be deferred until after the null check is made.</a> -<span class="sourceLineNo">150</span><a id="line.150"> * 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</a> -<span class="sourceLineNo">151</span><a id="line.151"> * message supplier are less than the cost of just creating the string message directly.</a> -<span class="sourceLineNo">152</span><a id="line.152"> * </p></a> -<span class="sourceLineNo">153</span><a id="line.153"> *</a> -<span class="sourceLineNo">154</span><a id="line.154"> * @param obj the object reference to check for nullity</a> -<span class="sourceLineNo">155</span><a id="line.155"> * @param messageSupplier supplier of the detail message to be used in the event that a {@code NullPointerException} is thrown</a> -<span class="sourceLineNo">156</span><a id="line.156"> * @param <T> the type of the reference</a> -<span class="sourceLineNo">157</span><a id="line.157"> * @return {@code obj} if not {@code null}</a> -<span class="sourceLineNo">158</span><a id="line.158"> * @throws MojoExecutionException if {@code obj} is {@code null}</a> -<span class="sourceLineNo">159</span><a id="line.159"> */</a> -<span class="sourceLineNo">160</span><a id="line.160"> public static <T> T requireNonNull(final T obj, final Supplier<String> messageSupplier) throws MojoExecutionException {</a> -<span class="sourceLineNo">161</span><a id="line.161"> if (obj == null) {</a> -<span class="sourceLineNo">162</span><a id="line.162"> throw new MojoExecutionException(new NullPointerException(messageSupplier.get()));</a> -<span class="sourceLineNo">163</span><a id="line.163"> }</a> -<span class="sourceLineNo">164</span><a id="line.164"> return obj;</a> -<span class="sourceLineNo">165</span><a id="line.165"> }</a> -<span class="sourceLineNo">166</span><a id="line.166"></a> -<span class="sourceLineNo">167</span><a id="line.167"> /**</a> -<span class="sourceLineNo">168</span><a id="line.168"> * Set authentication information on the specified {@link ScmProviderRepository}.</a> -<span class="sourceLineNo">169</span><a id="line.169"> * @param providerRepository target.</a> -<span class="sourceLineNo">170</span><a id="line.170"> * @param distServer temp.</a> -<span class="sourceLineNo">171</span><a id="line.171"> * @param settings temp.</a> -<span class="sourceLineNo">172</span><a id="line.172"> * @param settingsDecrypter temp.</a> -<span class="sourceLineNo">173</span><a id="line.173"> * @param username temp.</a> -<span class="sourceLineNo">174</span><a id="line.174"> * @param password temp.</a> -<span class="sourceLineNo">175</span><a id="line.175"> */</a> -<span class="sourceLineNo">176</span><a id="line.176"> public static void setAuthentication(final ScmProviderRepository providerRepository,</a> -<span class="sourceLineNo">177</span><a id="line.177"> final String distServer,</a> -<span class="sourceLineNo">178</span><a id="line.178"> final Settings settings,</a> -<span class="sourceLineNo">179</span><a id="line.179"> final SettingsDecrypter settingsDecrypter,</a> -<span class="sourceLineNo">180</span><a id="line.180"> final String username,</a> -<span class="sourceLineNo">181</span><a id="line.181"> final String password) {</a> -<span class="sourceLineNo">182</span><a id="line.182"> final Optional<Server> server =</a> -<span class="sourceLineNo">183</span><a id="line.183"> Optional.ofNullable(distServer).map(settings::getServer).map(DefaultSettingsDecryptionRequest::new)</a> -<span class="sourceLineNo">184</span><a id="line.184"> .map(settingsDecrypter::decrypt).map(SettingsDecryptionResult::getServer);</a> -<span class="sourceLineNo">185</span><a id="line.185"></a> -<span class="sourceLineNo">186</span><a id="line.186"> providerRepository.setUser(server.map(Server::getUsername).orElse(username));</a> -<span class="sourceLineNo">187</span><a id="line.187"> providerRepository.setPassword(server.map(Server::getPassword).orElse(password));</a> -<span class="sourceLineNo">188</span><a id="line.188"> }</a> -<span class="sourceLineNo">189</span><a id="line.189"></a> -<span class="sourceLineNo">190</span><a id="line.190"> /**</a> -<span class="sourceLineNo">191</span><a id="line.191"> * Making the constructor private because the class only contains static methods.</a> -<span class="sourceLineNo">192</span><a id="line.192"> */</a> -<span class="sourceLineNo">193</span><a id="line.193"> private SharedFunctions() {</a> -<span class="sourceLineNo">194</span><a id="line.194"> // Utility Class</a> -<span class="sourceLineNo">195</span><a id="line.195"> }</a> -<span class="sourceLineNo">196</span><a id="line.196">}</a> +<div class="source-container"> +<pre><span class="source-line-no">001</span><span id="line-1">/*</span> +<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one or more</span> +<span class="source-line-no">003</span><span id="line-3"> * contributor license agreements. See the NOTICE file distributed with</span> +<span class="source-line-no">004</span><span id="line-4"> * this work for additional information regarding copyright ownership.</span> +<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> +<span class="source-line-no">006</span><span id="line-6"> * (the "License"); you may not use this file except in compliance with</span> +<span class="source-line-no">007</span><span id="line-7"> * the License. You may obtain a copy of the License at</span> +<span class="source-line-no">008</span><span id="line-8"> *</span> +<span class="source-line-no">009</span><span id="line-9"> * http://www.apache.org/licenses/LICENSE-2.0</span> +<span class="source-line-no">010</span><span id="line-10"> *</span> +<span class="source-line-no">011</span><span id="line-11"> * Unless required by applicable law or agreed to in writing, software</span> +<span class="source-line-no">012</span><span id="line-12"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +<span class="source-line-no">013</span><span id="line-13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +<span class="source-line-no">014</span><span id="line-14"> * See the License for the specific language governing permissions and</span> +<span class="source-line-no">015</span><span id="line-15"> * limitations under the License.</span> +<span class="source-line-no">016</span><span id="line-16"> */</span> +<span class="source-line-no">017</span><span id="line-17">package org.apache.commons.release.plugin;</span> +<span class="source-line-no">018</span><span id="line-18"></span> +<span class="source-line-no">019</span><span id="line-19">import java.io.File;</span> +<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> +<span class="source-line-no">021</span><span id="line-21">import java.util.Optional;</span> +<span class="source-line-no">022</span><span id="line-22">import java.util.function.Supplier;</span> +<span class="source-line-no">023</span><span id="line-23"></span> +<span class="source-line-no">024</span><span id="line-24">import org.apache.maven.plugin.MojoExecutionException;</span> +<span class="source-line-no">025</span><span id="line-25">import org.apache.maven.plugin.logging.Log;</span> +<span class="source-line-no">026</span><span id="line-26">import org.apache.maven.scm.provider.ScmProviderRepository;</span> +<span class="source-line-no">027</span><span id="line-27">import org.apache.maven.settings.Server;</span> +<span class="source-line-no">028</span><span id="line-28">import org.apache.maven.settings.Settings;</span> +<span class="source-line-no">029</span><span id="line-29">import org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest;</span> +<span class="source-line-no">030</span><span id="line-30">import org.apache.maven.settings.crypto.SettingsDecrypter;</span> +<span class="source-line-no">031</span><span id="line-31">import org.apache.maven.settings.crypto.SettingsDecryptionResult;</span> +<span class="source-line-no">032</span><span id="line-32">import org.codehaus.plexus.util.FileUtils;</span> +<span class="source-line-no">033</span><span id="line-33"></span> +<span class="source-line-no">034</span><span id="line-34">/**</span> +<span class="source-line-no">035</span><span id="line-35"> * Shared static functions for all of our Mojos.</span> +<span class="source-line-no">036</span><span id="line-36"> *</span> +<span class="source-line-no">037</span><span id="line-37"> * @since 1.0</span> +<span class="source-line-no">038</span><span id="line-38"> */</span> +<span class="source-line-no">039</span><span id="line-39">public final class SharedFunctions {</span> +<span class="source-line-no">040</span><span id="line-40"></span> +<span class="source-line-no">041</span><span id="line-41"> /**</span> +<span class="source-line-no">042</span><span id="line-42"> * I want a buffer that is an array with 1024 elements of bytes. We declare</span> +<span class="source-line-no">043</span><span id="line-43"> * the constant here for the sake of making the code more readable.</span> +<span class="source-line-no">044</span><span id="line-44"> */</span> +<span class="source-line-no">045</span><span id="line-45"> public static final int BUFFER_BYTE_SIZE = 1024;</span> +<span class="source-line-no">046</span><span id="line-46"></span> +<span class="source-line-no">047</span><span id="line-47"> /**</span> +<span class="source-line-no">048</span><span id="line-48"> * Copies a {@link File} from the <code>fromFile</code> to the <code>toFile</code> and logs the failure</span> +<span class="source-line-no">049</span><span id="line-49"> * using the Maven {@link Log}.</span> +<span class="source-line-no">050</span><span id="line-50"> *</span> +<span class="source-line-no">051</span><span id="line-51"> * @param log the {@link Log}, the maven logger.</span> +<span class="source-line-no">052</span><span id="line-52"> * @param fromFile the {@link File} from which to copy.</span> +<span class="source-line-no">053</span><span id="line-53"> * @param toFile the {@link File} to which to copy into.</span> +<span class="source-line-no">054</span><span id="line-54"> * @throws MojoExecutionException if an {@link IOException} or {@link NullPointerException} is caught.</span> +<span class="source-line-no">055</span><span id="line-55"> */</span> +<span class="source-line-no">056</span><span id="line-56"> public static void copyFile(final Log log, final File fromFile, final File toFile) throws MojoExecutionException {</span> +<span class="source-line-no">057</span><span id="line-57"> final String format = "Unable to copy file %s to %s: %s";</span> +<span class="source-line-no">058</span><span id="line-58"> requireNonNull(fromFile, () -> String.format(format, fromFile, toFile));</span> +<span class="source-line-no">059</span><span id="line-59"> requireNonNull(toFile, () -> String.format(format, fromFile, toFile));</span> +<span class="source-line-no">060</span><span id="line-60"> try {</span> +<span class="source-line-no">061</span><span id="line-61"> FileUtils.copyFile(fromFile, toFile);</span> +<span class="source-line-no">062</span><span id="line-62"> } catch (final IOException e) {</span> +<span class="source-line-no">063</span><span id="line-63"> final String message = String.format(format, fromFile, toFile, e.getMessage());</span> +<span class="source-line-no">064</span><span id="line-64"> log.error(message);</span> +<span class="source-line-no">065</span><span id="line-65"> throw new MojoExecutionException(message, e);</span> +<span class="source-line-no">066</span><span id="line-66"> }</span> +<span class="source-line-no">067</span><span id="line-67"> }</span> +<span class="source-line-no">068</span><span id="line-68"></span> +<span class="source-line-no">069</span><span id="line-69"> /**</span> +<span class="source-line-no">070</span><span id="line-70"> * Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code></span> +<span class="source-line-no">071</span><span id="line-71"> * parameter.</span> +<span class="source-line-no">072</span><span id="line-72"> *</span> +<span class="source-line-no">073</span><span id="line-73"> * @param log is the Maven log for output logging, particularly in regards to error management.</span> +<span class="source-line-no">074</span><span id="line-74"> * @param workingDirectory is a {@link File} that represents the directory to first attempt to delete then create.</span> +<span class="source-line-no">075</span><span id="line-75"> * @throws MojoExecutionException when an {@link IOException} or {@link NullPointerException} is caught for the</span> +<span class="source-line-no">076</span><span id="line-76"> * purpose of bubbling the exception up to Maven properly.</span> +<span class="source-line-no">077</span><span id="line-77"> */</span> +<span class="source-line-no">078</span><span id="line-78"> public static void initDirectory(final Log log, final File workingDirectory) throws MojoExecutionException {</span> +<span class="source-line-no">079</span><span id="line-79"> final String format = "Unable to remove directory %s: %s";</span> +<span class="source-line-no">080</span><span id="line-80"> requireNonNull(workingDirectory, () -> String.format(format, workingDirectory));</span> +<span class="source-line-no">081</span><span id="line-81"> if (workingDirectory.exists()) {</span> +<span class="source-line-no">082</span><span id="line-82"> try {</span> +<span class="source-line-no">083</span><span id="line-83"> FileUtils.deleteDirectory(workingDirectory);</span> +<span class="source-line-no">084</span><span id="line-84"> } catch (final IOException e) {</span> +<span class="source-line-no">085</span><span id="line-85"> final String message = String.format(format, workingDirectory, e.getMessage());</span> +<span class="source-line-no">086</span><span id="line-86"> log.error(message);</span> +<span class="source-line-no">087</span><span id="line-87"> throw new MojoExecutionException(message, e);</span> +<span class="source-line-no">088</span><span id="line-88"> }</span> +<span class="source-line-no">089</span><span id="line-89"> }</span> +<span class="source-line-no">090</span><span id="line-90"> if (!workingDirectory.exists()) {</span> +<span class="source-line-no">091</span><span id="line-91"> workingDirectory.mkdirs();</span> +<span class="source-line-no">092</span><span id="line-92"> }</span> +<span class="source-line-no">093</span><span id="line-93"> }</span> +<span class="source-line-no">094</span><span id="line-94"></span> +<span class="source-line-no">095</span><span id="line-95"> /**</span> +<span class="source-line-no">096</span><span id="line-96"> * Checks that the specified object reference is not {@code null}. This method is designed primarily for doing parameter validation in methods and</span> +<span class="source-line-no">097</span><span id="line-97"> * constructors, as demonstrated below: <blockquote></span> +<span class="source-line-no">098</span><span id="line-98"> *</span> +<span class="source-line-no">099</span><span id="line-99"> * <pre></span> +<span class="source-line-no">100</span><span id="line-100"> * public Foo(Bar bar) {</span> +<span class="source-line-no">101</span><span id="line-101"> * this.bar = SharedFunctions.requireNonNull(bar);</span> +<span class="source-line-no">102</span><span id="line-102"> * }</span> +<span class="source-line-no">103</span><span id="line-103"> * </pre></span> +<span class="source-line-no">104</span><span id="line-104"> *</span> +<span class="source-line-no">105</span><span id="line-105"> * </blockquote></span> +<span class="source-line-no">106</span><span id="line-106"> *</span> +<span class="source-line-no">107</span><span id="line-107"> * @param obj the object reference to check for nullity</span> +<span class="source-line-no">108</span><span id="line-108"> * @param <T> the type of the reference</span> +<span class="source-line-no">109</span><span id="line-109"> * @return {@code obj} if not {@code null}</span> +<span class="source-line-no">110</span><span id="line-110"> * @throws MojoExecutionException if {@code obj} is {@code null}</span> +<span class="source-line-no">111</span><span id="line-111"> */</span> +<span class="source-line-no">112</span><span id="line-112"> public static <T> T requireNonNull(final T obj) throws MojoExecutionException {</span> +<span class="source-line-no">113</span><span id="line-113"> if (obj == null) {</span> +<span class="source-line-no">114</span><span id="line-114"> throw new MojoExecutionException(new NullPointerException());</span> +<span class="source-line-no">115</span><span id="line-115"> }</span> +<span class="source-line-no">116</span><span id="line-116"> return obj;</span> +<span class="source-line-no">117</span><span id="line-117"> }</span> +<span class="source-line-no">118</span><span id="line-118"></span> +<span class="source-line-no">119</span><span id="line-119"> /**</span> +<span class="source-line-no">120</span><span id="line-120"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is. This method is designed</span> +<span class="source-line-no">121</span><span id="line-121"> * primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below: <blockquote></span> +<span class="source-line-no">122</span><span id="line-122"> *</span> +<span class="source-line-no">123</span><span id="line-123"> * <pre></span> +<span class="source-line-no">124</span><span id="line-124"> * public Foo(Bar bar, Baz baz) {</span> +<span class="source-line-no">125</span><span id="line-125"> * this.bar = SharedFunctions.requireNonNull(bar, "bar must not be null");</span> +<span class="source-line-no">126</span><span id="line-126"> * this.baz = SharedFunctions.requireNonNull(baz, "baz must not be null");</span> +<span class="source-line-no">127</span><span id="line-127"> * }</span> +<span class="source-line-no">128</span><span id="line-128"> * </pre></span> +<span class="source-line-no">129</span><span id="line-129"> *</span> +<span class="source-line-no">130</span><span id="line-130"> * </blockquote></span> +<span class="source-line-no">131</span><span id="line-131"> *</span> +<span class="source-line-no">132</span><span id="line-132"> * @param obj the object reference to check for nullity</span> +<span class="source-line-no">133</span><span id="line-133"> * @param message detail message to be used in the event that a {@code</span> +<span class="source-line-no">134</span><span id="line-134"> * NullPointerException} is thrown</span> +<span class="source-line-no">135</span><span id="line-135"> * @param <T> the type of the reference</span> +<span class="source-line-no">136</span><span id="line-136"> * @return {@code obj} if not {@code null}</span> +<span class="source-line-no">137</span><span id="line-137"> * @throws MojoExecutionException if {@code obj} is {@code null}</span> +<span class="source-line-no">138</span><span id="line-138"> */</span> +<span class="source-line-no">139</span><span id="line-139"> public static <T> T requireNonNull(final T obj, final String message) throws MojoExecutionException {</span> +<span class="source-line-no">140</span><span id="line-140"> if (obj == null) {</span> +<span class="source-line-no">141</span><span id="line-141"> throw new MojoExecutionException(new NullPointerException(message));</span> +<span class="source-line-no">142</span><span id="line-142"> }</span> +<span class="source-line-no">143</span><span id="line-143"> return obj;</span> +<span class="source-line-no">144</span><span id="line-144"> }</span> +<span class="source-line-no">145</span><span id="line-145"></span> +<span class="source-line-no">146</span><span id="line-146"> /**</span> +<span class="source-line-no">147</span><span id="line-147"> * Checks that the specified object reference is not {@code null} and throws a customized {@link MojoExecutionException} if it is.</span> +<span class="source-line-no">148</span><span id="line-148"> * <p></span> +<span class="source-line-no">149</span><span id="line-149"> * Unlike the method {@link #requireNonNull(Object, String)}, this method allows creation of the message to be deferred until after the null check is made.</span> +<span class="source-line-no">150</span><span id="line-150"> * 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</span> +<span class="source-line-no">151</span><span id="line-151"> * message supplier are less than the cost of just creating the string message directly.</span> +<span class="source-line-no">152</span><span id="line-152"> * </p></span> +<span class="source-line-no">153</span><span id="line-153"> *</span> +<span class="source-line-no">154</span><span id="line-154"> * @param obj the object reference to check for nullity</span> +<span class="source-line-no">155</span><span id="line-155"> * @param messageSupplier supplier of the detail message to be used in the event that a {@code NullPointerException} is thrown</span> +<span class="source-line-no">156</span><span id="line-156"> * @param <T> the type of the reference</span> +<span class="source-line-no">157</span><span id="line-157"> * @return {@code obj} if not {@code null}</span> +<span class="source-line-no">158</span><span id="line-158"> * @throws MojoExecutionException if {@code obj} is {@code null}</span> +<span class="source-line-no">159</span><span id="line-159"> */</span> +<span class="source-line-no">160</span><span id="line-160"> public static <T> T requireNonNull(final T obj, final Supplier<String> messageSupplier) throws MojoExecutionException {</span> +<span class="source-line-no">161</span><span id="line-161"> if (obj == null) {</span> +<span class="source-line-no">162</span><span id="line-162"> throw new MojoExecutionException(new NullPointerException(messageSupplier.get()));</span> +<span class="source-line-no">163</span><span id="line-163"> }</span> +<span class="source-line-no">164</span><span id="line-164"> return obj;</span> +<span class="source-line-no">165</span><span id="line-165"> }</span> +<span class="source-line-no">166</span><span id="line-166"></span> +<span class="source-line-no">167</span><span id="line-167"> /**</span> +<span class="source-line-no">168</span><span id="line-168"> * Sets authentication information on the specified {@link ScmProviderRepository}.</span> +<span class="source-line-no">169</span><span id="line-169"> *</span> +<span class="source-line-no">170</span><span id="line-170"> * @param providerRepository target.</span> +<span class="source-line-no">171</span><span id="line-171"> * @param distServer temp.</span> +<span class="source-line-no">172</span><span id="line-172"> * @param settings temp.</span> +<span class="source-line-no">173</span><span id="line-173"> * @param settingsDecrypter temp.</span> +<span class="source-line-no">174</span><span id="line-174"> * @param username temp.</span> +<span class="source-line-no">175</span><span id="line-175"> * @param password temp.</span> +<span class="source-line-no">176</span><span id="line-176"> */</span> +<span class="source-line-no">177</span><span id="line-177"> public static void setAuthentication(final ScmProviderRepository providerRepository,</span> +<span class="source-line-no">178</span><span id="line-178"> final String distServer,</span> +<span class="source-line-no">179</span><span id="line-179"> final Settings settings,</span> +<span class="source-line-no">180</span><span id="line-180"> final SettingsDecrypter settingsDecrypter,</span> +<span class="source-line-no">181</span><span id="line-181"> final String username,</span> +<span class="source-line-no">182</span><span id="line-182"> final String password) {</span> +<span class="source-line-no">183</span><span id="line-183"> final Optional<Server> server =</span> +<span class="source-line-no">184</span><span id="line-184"> Optional.ofNullable(distServer).map(settings::getServer).map(DefaultSettingsDecryptionRequest::new)</span> +<span class="source-line-no">185</span><span id="line-185"> .map(settingsDecrypter::decrypt).map(SettingsDecryptionResult::getServer);</span> +<span class="source-line-no">186</span><span id="line-186"></span> +<span class="source-line-no">187</span><span id="line-187"> providerRepository.setUser(server.map(Server::getUsername).orElse(username));</span> +<span class="source-line-no">188</span><span id="line-188"> providerRepository.setPassword(server.map(Server::getPassword).orElse(password));</span> +<span class="source-line-no">189</span><span id="line-189"> }</span> +<span class="source-line-no">190</span><span id="line-190"></span> +<span class="source-line-no">191</span><span id="line-191"> /**</span> +<span class="source-line-no">192</span><span id="line-192"> * Making the constructor private because the class only contains static methods.</span> +<span class="source-line-no">193</span><span id="line-193"> */</span> +<span class="source-line-no">194</span><span id="line-194"> private SharedFunctions() {</span> +<span class="source-line-no">195</span><span id="line-195"> // Utility Class</span> +<span class="source-line-no">196</span><span id="line-196"> }</span> +<span class="source-line-no">197</span><span id="line-197">}</span>
