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
Tue Mar 12 12:37:46 2019
@@ -26,76 +26,106 @@
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a
name="line.20"></a>
-<span class="sourceLineNo">021</span><a name="line.21"></a>
-<span class="sourceLineNo">022</span>import
org.apache.maven.plugin.MojoExecutionException;<a name="line.22"></a>
-<span class="sourceLineNo">023</span>import
org.apache.maven.plugin.logging.Log;<a name="line.23"></a>
-<span class="sourceLineNo">024</span>import
org.codehaus.plexus.util.FileUtils;<a name="line.24"></a>
-<span class="sourceLineNo">025</span><a name="line.25"></a>
-<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
-<span class="sourceLineNo">027</span> * Shared static functions for all of our
Mojos.<a name="line.27"></a>
-<span class="sourceLineNo">028</span> *<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * @author chtompki<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * @since 1.0<a name="line.30"></a>
-<span class="sourceLineNo">031</span> */<a name="line.31"></a>
-<span class="sourceLineNo">032</span>public final class SharedFunctions {<a
name="line.32"></a>
-<span class="sourceLineNo">033</span><a name="line.33"></a>
-<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * I want a buffer that is an array
with 1024 elements of bytes. We declare<a name="line.35"></a>
-<span class="sourceLineNo">036</span> * the constant here for the sake of
making the code more readable.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> */<a name="line.37"></a>
-<span class="sourceLineNo">038</span> public static final int
BUFFER_BYTE_SIZE = 1024;<a name="line.38"></a>
-<span class="sourceLineNo">039</span><a name="line.39"></a>
-<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * Making the constructor private
because the class only contains static methods.<a name="line.41"></a>
-<span class="sourceLineNo">042</span> */<a name="line.42"></a>
-<span class="sourceLineNo">043</span> private SharedFunctions() {<a
name="line.43"></a>
-<span class="sourceLineNo">044</span> // Utility Class<a
name="line.44"></a>
-<span class="sourceLineNo">045</span> }<a name="line.45"></a>
+<span class="sourceLineNo">021</span>import java.util.Optional;<a
name="line.21"></a>
+<span class="sourceLineNo">022</span><a name="line.22"></a>
+<span class="sourceLineNo">023</span>import
org.apache.maven.plugin.MojoExecutionException;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import
org.apache.maven.plugin.logging.Log;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import
org.apache.maven.scm.provider.ScmProviderRepository;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import
org.apache.maven.settings.Server;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import
org.apache.maven.settings.Settings;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import
org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest;<a
name="line.28"></a>
+<span class="sourceLineNo">029</span>import
org.apache.maven.settings.crypto.SettingsDecrypter;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import
org.apache.maven.settings.crypto.SettingsDecryptionResult;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import
org.codehaus.plexus.util.FileUtils;<a name="line.31"></a>
+<span class="sourceLineNo">032</span><a name="line.32"></a>
+<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * Shared static functions for all of our
Mojos.<a name="line.34"></a>
+<span class="sourceLineNo">035</span> *<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * @author chtompki<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * @since 1.0<a name="line.37"></a>
+<span class="sourceLineNo">038</span> */<a name="line.38"></a>
+<span class="sourceLineNo">039</span>public final class SharedFunctions {<a
name="line.39"></a>
+<span class="sourceLineNo">040</span><a name="line.40"></a>
+<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * I want a buffer that is an array
with 1024 elements of bytes. We declare<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * the constant here for the sake of
making the code more readable.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> */<a name="line.44"></a>
+<span class="sourceLineNo">045</span> public static final int
BUFFER_BYTE_SIZE = 1024;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * Cleans and then initializes an
empty directory that is given by the
<code>workingDirectory</code><a name="line.48"></a>
-<span class="sourceLineNo">049</span> * parameter.<a name="line.49"></a>
-<span class="sourceLineNo">050</span> *<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * @param log is the Maven log for
output logging, particularly in regards to error management.<a
name="line.51"></a>
-<span class="sourceLineNo">052</span> * @param workingDirectory is a
{@link File} that represents the directory to first attempt to delete then
create.<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * @throws MojoExecutionException
when an {@link IOException} or {@link NullPointerException} is caught for the<a
name="line.53"></a>
-<span class="sourceLineNo">054</span> * purpose of bubbling the
exception up to Maven properly.<a name="line.54"></a>
-<span class="sourceLineNo">055</span> */<a name="line.55"></a>
-<span class="sourceLineNo">056</span> public static void initDirectory(Log
log, File workingDirectory) throws MojoExecutionException {<a
name="line.56"></a>
-<span class="sourceLineNo">057</span> if (workingDirectory.exists())
{<a name="line.57"></a>
-<span class="sourceLineNo">058</span> try {<a name="line.58"></a>
-<span class="sourceLineNo">059</span>
FileUtils.deleteDirectory(workingDirectory);<a name="line.59"></a>
-<span class="sourceLineNo">060</span> } catch (IOException |
NullPointerException e) {<a name="line.60"></a>
-<span class="sourceLineNo">061</span> final String message =
String.format("Unable to remove directory %s: %s", workingDirectory,<a
name="line.61"></a>
-<span class="sourceLineNo">062</span>
e.getMessage());<a name="line.62"></a>
-<span class="sourceLineNo">063</span> log.error(message);<a
name="line.63"></a>
-<span class="sourceLineNo">064</span> throw new
MojoExecutionException(message, e);<a name="line.64"></a>
-<span class="sourceLineNo">065</span> }<a name="line.65"></a>
-<span class="sourceLineNo">066</span> }<a name="line.66"></a>
-<span class="sourceLineNo">067</span> if (!workingDirectory.exists())
{<a name="line.67"></a>
-<span class="sourceLineNo">068</span> workingDirectory.mkdirs();<a
name="line.68"></a>
-<span class="sourceLineNo">069</span> }<a name="line.69"></a>
-<span class="sourceLineNo">070</span> }<a name="line.70"></a>
-<span class="sourceLineNo">071</span><a name="line.71"></a>
-<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
-<span class="sourceLineNo">073</span> * Copies a {@link File} from the
<code>fromFile</code> to the <code>toFile</code> and
logs the failure<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * using the Maven {@link Log}.<a
name="line.74"></a>
-<span class="sourceLineNo">075</span> *<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * @param log the {@link Log}, the
maven logger.<a name="line.76"></a>
-<span class="sourceLineNo">077</span> * @param fromFile the {@link File}
from which to copy.<a name="line.77"></a>
-<span class="sourceLineNo">078</span> * @param toFile the {@link File} to
which to copy into.<a name="line.78"></a>
-<span class="sourceLineNo">079</span> * @throws MojoExecutionException if
an {@link IOException} or {@link NullPointerException} is caught.<a
name="line.79"></a>
-<span class="sourceLineNo">080</span> */<a name="line.80"></a>
-<span class="sourceLineNo">081</span> public static void copyFile(Log log,
File fromFile, File toFile) throws MojoExecutionException {<a
name="line.81"></a>
-<span class="sourceLineNo">082</span> try {<a name="line.82"></a>
-<span class="sourceLineNo">083</span> FileUtils.copyFile(fromFile,
toFile);<a name="line.83"></a>
-<span class="sourceLineNo">084</span> } catch (IOException |
NullPointerException e) {<a name="line.84"></a>
-<span class="sourceLineNo">085</span> final String message =
String.format("Unable to copy file %s tp %s: %s", fromFile, toFile,
e.getMessage());<a name="line.85"></a>
-<span class="sourceLineNo">086</span> log.error(message);<a
name="line.86"></a>
-<span class="sourceLineNo">087</span> throw new
MojoExecutionException(message, e);<a name="line.87"></a>
-<span class="sourceLineNo">088</span> }<a name="line.88"></a>
-<span class="sourceLineNo">089</span> }<a name="line.89"></a>
-<span class="sourceLineNo">090</span>}<a name="line.90"></a>
+<span class="sourceLineNo">048</span> * Making the constructor private
because the class only contains static methods.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> */<a name="line.49"></a>
+<span class="sourceLineNo">050</span> private SharedFunctions() {<a
name="line.50"></a>
+<span class="sourceLineNo">051</span> // Utility Class<a
name="line.51"></a>
+<span class="sourceLineNo">052</span> }<a name="line.52"></a>
+<span class="sourceLineNo">053</span><a name="line.53"></a>
+<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * Cleans and then initializes an
empty directory that is given by the
<code>workingDirectory</code><a name="line.55"></a>
+<span class="sourceLineNo">056</span> * parameter.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> *<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * @param log is the Maven log for
output logging, particularly in regards to error management.<a
name="line.58"></a>
+<span class="sourceLineNo">059</span> * @param workingDirectory is a
{@link File} that represents the directory to first attempt to delete then
create.<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * @throws MojoExecutionException
when an {@link IOException} or {@link NullPointerException} is caught for the<a
name="line.60"></a>
+<span class="sourceLineNo">061</span> * purpose of bubbling the
exception up to Maven properly.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> public static void initDirectory(Log
log, File workingDirectory) throws MojoExecutionException {<a
name="line.63"></a>
+<span class="sourceLineNo">064</span> if (workingDirectory.exists())
{<a name="line.64"></a>
+<span class="sourceLineNo">065</span> try {<a name="line.65"></a>
+<span class="sourceLineNo">066</span>
FileUtils.deleteDirectory(workingDirectory);<a name="line.66"></a>
+<span class="sourceLineNo">067</span> } catch (IOException |
NullPointerException e) {<a name="line.67"></a>
+<span class="sourceLineNo">068</span> final String message =
String.format("Unable to remove directory %s: %s", workingDirectory,<a
name="line.68"></a>
+<span class="sourceLineNo">069</span>
e.getMessage());<a name="line.69"></a>
+<span class="sourceLineNo">070</span> log.error(message);<a
name="line.70"></a>
+<span class="sourceLineNo">071</span> throw new
MojoExecutionException(message, e);<a name="line.71"></a>
+<span class="sourceLineNo">072</span> }<a name="line.72"></a>
+<span class="sourceLineNo">073</span> }<a name="line.73"></a>
+<span class="sourceLineNo">074</span> if (!workingDirectory.exists())
{<a name="line.74"></a>
+<span class="sourceLineNo">075</span> workingDirectory.mkdirs();<a
name="line.75"></a>
+<span class="sourceLineNo">076</span> }<a name="line.76"></a>
+<span class="sourceLineNo">077</span> }<a name="line.77"></a>
+<span class="sourceLineNo">078</span><a name="line.78"></a>
+<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * Copies a {@link File} from the
<code>fromFile</code> to the <code>toFile</code> and
logs the failure<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * using the Maven {@link Log}.<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> *<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * @param log the {@link Log}, the
maven logger.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * @param fromFile the {@link File}
from which to copy.<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * @param toFile the {@link File} to
which to copy into.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * @throws MojoExecutionException if
an {@link IOException} or {@link NullPointerException} is caught.<a
name="line.86"></a>
+<span class="sourceLineNo">087</span> */<a name="line.87"></a>
+<span class="sourceLineNo">088</span> public static void copyFile(Log log,
File fromFile, File toFile) throws MojoExecutionException {<a
name="line.88"></a>
+<span class="sourceLineNo">089</span> try {<a name="line.89"></a>
+<span class="sourceLineNo">090</span> FileUtils.copyFile(fromFile,
toFile);<a name="line.90"></a>
+<span class="sourceLineNo">091</span> } catch (IOException |
NullPointerException e) {<a name="line.91"></a>
+<span class="sourceLineNo">092</span> final String message =
String.format("Unable to copy file %s tp %s: %s", fromFile, toFile,
e.getMessage());<a name="line.92"></a>
+<span class="sourceLineNo">093</span> log.error(message);<a
name="line.93"></a>
+<span class="sourceLineNo">094</span> throw new
MojoExecutionException(message, e);<a name="line.94"></a>
+<span class="sourceLineNo">095</span> }<a name="line.95"></a>
+<span class="sourceLineNo">096</span> }<a name="line.96"></a>
+<span class="sourceLineNo">097</span><a name="line.97"></a>
+<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * Set authentication information on
the specified {@link ScmProviderRepository}.<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * @param providerRepository
target.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * @param distServer temp.<a
name="line.101"></a>
+<span class="sourceLineNo">102</span> * @param settings temp.<a
name="line.102"></a>
+<span class="sourceLineNo">103</span> * @param settingsDecrypter temp.<a
name="line.103"></a>
+<span class="sourceLineNo">104</span> * @param username temp.<a
name="line.104"></a>
+<span class="sourceLineNo">105</span> * @param password temp.<a
name="line.105"></a>
+<span class="sourceLineNo">106</span> */<a name="line.106"></a>
+<span class="sourceLineNo">107</span> public static void
setAuthentication(ScmProviderRepository providerRepository,<a
name="line.107"></a>
+<span class="sourceLineNo">108</span> String
distServer,<a name="line.108"></a>
+<span class="sourceLineNo">109</span>
Settings settings,<a name="line.109"></a>
+<span class="sourceLineNo">110</span>
SettingsDecrypter settingsDecrypter,<a name="line.110"></a>
+<span class="sourceLineNo">111</span> String
username,<a name="line.111"></a>
+<span class="sourceLineNo">112</span> String
password) {<a name="line.112"></a>
+<span class="sourceLineNo">113</span> Optional<Server> server =<a
name="line.113"></a>
+<span class="sourceLineNo">114</span>
Optional.ofNullable(distServer).map(settings::getServer).map(DefaultSettingsDecryptionRequest::new)<a
name="line.114"></a>
+<span class="sourceLineNo">115</span>
.map(settingsDecrypter::decrypt).map(SettingsDecryptionResult::getServer);<a
name="line.115"></a>
+<span class="sourceLineNo">116</span><a name="line.116"></a>
+<span class="sourceLineNo">117</span>
providerRepository.setUser(server.map(Server::getUsername).orElse(username));<a
name="line.117"></a>
+<span class="sourceLineNo">118</span>
providerRepository.setPassword(server.map(Server::getPassword).orElse(password));<a
name="line.118"></a>
+<span class="sourceLineNo">119</span> }<a name="line.119"></a>
+<span class="sourceLineNo">120</span>}<a name="line.120"></a>
