Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Sat Apr 20 14:51:39 2024 @@ -1,195 +1,199 @@ <!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.mojos, class: CommonsSiteCompressionMojo"> +<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.mojos;</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.io.InputStream;</a> -<span class="sourceLineNo">022</span><a id="line.22">import java.io.OutputStream;</a> -<span class="sourceLineNo">023</span><a id="line.23">import java.nio.file.Files;</a> -<span class="sourceLineNo">024</span><a id="line.24">import java.util.ArrayList;</a> -<span class="sourceLineNo">025</span><a id="line.25">import java.util.List;</a> -<span class="sourceLineNo">026</span><a id="line.26">import java.util.zip.ZipEntry;</a> -<span class="sourceLineNo">027</span><a id="line.27">import java.util.zip.ZipOutputStream;</a> -<span class="sourceLineNo">028</span><a id="line.28"></a> -<span class="sourceLineNo">029</span><a id="line.29">import org.apache.commons.io.IOUtils;</a> -<span class="sourceLineNo">030</span><a id="line.30">import org.apache.commons.lang3.StringUtils;</a> -<span class="sourceLineNo">031</span><a id="line.31">import org.apache.maven.plugin.AbstractMojo;</a> -<span class="sourceLineNo">032</span><a id="line.32">import org.apache.maven.plugin.MojoExecutionException;</a> -<span class="sourceLineNo">033</span><a id="line.33">import org.apache.maven.plugin.MojoFailureException;</a> -<span class="sourceLineNo">034</span><a id="line.34">import org.apache.maven.plugins.annotations.LifecyclePhase;</a> -<span class="sourceLineNo">035</span><a id="line.35">import org.apache.maven.plugins.annotations.Mojo;</a> -<span class="sourceLineNo">036</span><a id="line.36">import org.apache.maven.plugins.annotations.Parameter;</a> -<span class="sourceLineNo">037</span><a id="line.37"></a> -<span class="sourceLineNo">038</span><a id="line.38">/**</a> -<span class="sourceLineNo">039</span><a id="line.39"> * Takes the built <code>./target/site</code> directory and compresses it to</a> -<span class="sourceLineNo">040</span><a id="line.40"> * <code>./target/commons-release-plugin/site.zip</code>.</a> -<span class="sourceLineNo">041</span><a id="line.41"> *</a> -<span class="sourceLineNo">042</span><a id="line.42"> * @since 1.0</a> -<span class="sourceLineNo">043</span><a id="line.43"> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the</a> -<span class="sourceLineNo">044</span><a id="line.44"> * {@link CommonsDistributionStagingMojo}.</a> -<span class="sourceLineNo">045</span><a id="line.45"> */</a> -<span class="sourceLineNo">046</span><a id="line.46">@Deprecated</a> -<span class="sourceLineNo">047</span><a id="line.47">@Mojo(name = "compress-site",</a> -<span class="sourceLineNo">048</span><a id="line.48"> defaultPhase = LifecyclePhase.POST_SITE,</a> -<span class="sourceLineNo">049</span><a id="line.49"> threadSafe = true,</a> -<span class="sourceLineNo">050</span><a id="line.50"> aggregator = true)</a> -<span class="sourceLineNo">051</span><a id="line.51">public class CommonsSiteCompressionMojo extends AbstractMojo {</a> -<span class="sourceLineNo">052</span><a id="line.52"></a> -<span class="sourceLineNo">053</span><a id="line.53"> /**</a> -<span class="sourceLineNo">054</span><a id="line.54"> * The working directory for the plugin which, assuming the maven uses the default</a> -<span class="sourceLineNo">055</span><a id="line.55"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</a> -<span class="sourceLineNo">056</span><a id="line.56"> */</a> -<span class="sourceLineNo">057</span><a id="line.57"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</a> -<span class="sourceLineNo">058</span><a id="line.58"> property = "commons.outputDirectory")</a> -<span class="sourceLineNo">059</span><a id="line.59"> private File workingDirectory;</a> -<span class="sourceLineNo">060</span><a id="line.60"></a> -<span class="sourceLineNo">061</span><a id="line.61"> /**</a> -<span class="sourceLineNo">062</span><a id="line.62"> */</a> -<span class="sourceLineNo">063</span><a id="line.63"> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")</a> -<span class="sourceLineNo">064</span><a id="line.64"> private File siteDirectory;</a> -<span class="sourceLineNo">065</span><a id="line.65"></a> -<span class="sourceLineNo">066</span><a id="line.66"> /**</a> -<span class="sourceLineNo">067</span><a id="line.67"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically</a> -<span class="sourceLineNo">068</span><a id="line.68"> * this would need to be of the form:</a> -<span class="sourceLineNo">069</span><a id="line.69"> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the</a> -<span class="sourceLineNo">070</span><a id="line.70"> * substring <code>https</code> is a requirement.</a> -<span class="sourceLineNo">071</span><a id="line.71"> */</a> -<span class="sourceLineNo">072</span><a id="line.72"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</a> -<span class="sourceLineNo">073</span><a id="line.73"> private String distSvnStagingUrl;</a> -<span class="sourceLineNo">074</span><a id="line.74"></a> -<span class="sourceLineNo">075</span><a id="line.75"> /**</a> -<span class="sourceLineNo">076</span><a id="line.76"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</a> -<span class="sourceLineNo">077</span><a id="line.77"> */</a> -<span class="sourceLineNo">078</span><a id="line.78"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</a> -<span class="sourceLineNo">079</span><a id="line.79"> private Boolean isDistModule;</a> -<span class="sourceLineNo">080</span><a id="line.80"></a> -<span class="sourceLineNo">081</span><a id="line.81"> /**</a> -<span class="sourceLineNo">082</span><a id="line.82"> * The list of files to compress into the site.zip file.</a> -<span class="sourceLineNo">083</span><a id="line.83"> */</a> -<span class="sourceLineNo">084</span><a id="line.84"> private List<File> filesToCompress;</a> -<span class="sourceLineNo">085</span><a id="line.85"></a> -<span class="sourceLineNo">086</span><a id="line.86"> @Override</a> -<span class="sourceLineNo">087</span><a id="line.87"> public void execute() throws MojoExecutionException, MojoFailureException {</a> -<span class="sourceLineNo">088</span><a id="line.88"> if (!isDistModule) {</a> -<span class="sourceLineNo">089</span><a id="line.89"> getLog().info("This module is marked as a non distribution "</a> -<span class="sourceLineNo">090</span><a id="line.90"> + "or assembly module, and the plugin will not run.");</a> -<span class="sourceLineNo">091</span><a id="line.91"> return;</a> -<span class="sourceLineNo">092</span><a id="line.92"> }</a> -<span class="sourceLineNo">093</span><a id="line.93"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</a> -<span class="sourceLineNo">094</span><a id="line.94"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</a> -<span class="sourceLineNo">095</span><a id="line.95"> return;</a> -<span class="sourceLineNo">096</span><a id="line.96"> }</a> -<span class="sourceLineNo">097</span><a id="line.97"> if (!siteDirectory.exists()) {</a> -<span class="sourceLineNo">098</span><a id="line.98"> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");</a> -<span class="sourceLineNo">099</span><a id="line.99"> throw new MojoFailureException(</a> -<span class="sourceLineNo">100</span><a id="line.100"> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</a> -<span class="sourceLineNo">101</span><a id="line.101"> );</a> -<span class="sourceLineNo">102</span><a id="line.102"> }</a> -<span class="sourceLineNo">103</span><a id="line.103"> if (!workingDirectory.exists()) {</a> -<span class="sourceLineNo">104</span><a id="line.104"> getLog().info("Current project contains no distributions. Not executing.");</a> -<span class="sourceLineNo">105</span><a id="line.105"> return;</a> -<span class="sourceLineNo">106</span><a id="line.106"> }</a> -<span class="sourceLineNo">107</span><a id="line.107"> try {</a> -<span class="sourceLineNo">108</span><a id="line.108"> filesToCompress = new ArrayList<>();</a> -<span class="sourceLineNo">109</span><a id="line.109"> getAllSiteFiles(siteDirectory, filesToCompress);</a> -<span class="sourceLineNo">110</span><a id="line.110"> writeZipFile(workingDirectory, siteDirectory, filesToCompress);</a> -<span class="sourceLineNo">111</span><a id="line.111"> } catch (final IOException e) {</a> -<span class="sourceLineNo">112</span><a id="line.112"> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);</a> -<span class="sourceLineNo">113</span><a id="line.113"> throw new MojoExecutionException(</a> -<span class="sourceLineNo">114</span><a id="line.114"> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),</a> -<span class="sourceLineNo">115</span><a id="line.115"> e</a> -<span class="sourceLineNo">116</span><a id="line.116"> );</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"> /**</a> -<span class="sourceLineNo">121</span><a id="line.121"> * By default this method iterates across the <code>target/site</code> directory and adds all the files</a> -<span class="sourceLineNo">122</span><a id="line.122"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</a> -<span class="sourceLineNo">123</span><a id="line.123"> *</a> -<span class="sourceLineNo">124</span><a id="line.124"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</a> -<span class="sourceLineNo">125</span><a id="line.125"> * @param filesToCompress the {@link List} to which to add all the files.</a> -<span class="sourceLineNo">126</span><a id="line.126"> */</a> -<span class="sourceLineNo">127</span><a id="line.127"> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {</a> -<span class="sourceLineNo">128</span><a id="line.128"> final File[] files = siteDirectory.listFiles();</a> -<span class="sourceLineNo">129</span><a id="line.129"> for (final File file : files) {</a> -<span class="sourceLineNo">130</span><a id="line.130"> filesToCompress.add(file);</a> -<span class="sourceLineNo">131</span><a id="line.131"> if (file.isDirectory()) {</a> -<span class="sourceLineNo">132</span><a id="line.132"> getAllSiteFiles(file, filesToCompress);</a> -<span class="sourceLineNo">133</span><a id="line.133"> }</a> -<span class="sourceLineNo">134</span><a id="line.134"> }</a> -<span class="sourceLineNo">135</span><a id="line.135"> }</a> -<span class="sourceLineNo">136</span><a id="line.136"></a> -<span class="sourceLineNo">137</span><a id="line.137"> /**</a> -<span class="sourceLineNo">138</span><a id="line.138"> * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file</a> -<span class="sourceLineNo">139</span><a id="line.139"> * in the <code>workingDirectory</code>.</a> -<span class="sourceLineNo">140</span><a id="line.140"> *</a> -<span class="sourceLineNo">141</span><a id="line.141"> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.</a> -<span class="sourceLineNo">142</span><a id="line.142"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</a> -<span class="sourceLineNo">143</span><a id="line.143"> * <code>target/site</code>).</a> -<span class="sourceLineNo">144</span><a id="line.144"> * @param fileList the list of files to be zipped up, generally generated by</a> -<span class="sourceLineNo">145</span><a id="line.145"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</a> -<span class="sourceLineNo">146</span><a id="line.146"> * @throws IOException when the copying of the files goes incorrectly.</a> -<span class="sourceLineNo">147</span><a id="line.147"> */</a> -<span class="sourceLineNo">148</span><a id="line.148"> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)</a> -<span class="sourceLineNo">149</span><a id="line.149"> throws IOException {</a> -<span class="sourceLineNo">150</span><a id="line.150"> try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")</a> -<span class="sourceLineNo">151</span><a id="line.151"> .toPath());</a> -<span class="sourceLineNo">152</span><a id="line.152"> ZipOutputStream zos = new ZipOutputStream(fos)) {</a> -<span class="sourceLineNo">153</span><a id="line.153"> for (final File file : fileList) {</a> -<span class="sourceLineNo">154</span><a id="line.154"> if (!file.isDirectory()) { // we only ZIP files, not directories</a> -<span class="sourceLineNo">155</span><a id="line.155"> addToZip(directoryToZip, file, zos);</a> -<span class="sourceLineNo">156</span><a id="line.156"> }</a> -<span class="sourceLineNo">157</span><a id="line.157"> }</a> -<span class="sourceLineNo">158</span><a id="line.158"> }</a> -<span class="sourceLineNo">159</span><a id="line.159"> }</a> -<span class="sourceLineNo">160</span><a id="line.160"></a> -<span class="sourceLineNo">161</span><a id="line.161"> /**</a> -<span class="sourceLineNo">162</span><a id="line.162"> * Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by</a> -<span class="sourceLineNo">163</span><a id="line.163"> * <code>zos</code>.</a> -<span class="sourceLineNo">164</span><a id="line.164"> *</a> -<span class="sourceLineNo">165</span><a id="line.165"> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are</a> -<span class="sourceLineNo">166</span><a id="line.166"> * compressing. Generally this is <code>target/site</code>.</a> -<span class="sourceLineNo">167</span><a id="line.167"> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.</a> -<span class="sourceLineNo">168</span><a id="line.168"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</a> -<span class="sourceLineNo">169</span><a id="line.169"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</a> -<span class="sourceLineNo">170</span><a id="line.170"> */</a> -<span class="sourceLineNo">171</span><a id="line.171"> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {</a> -<span class="sourceLineNo">172</span><a id="line.172"> try (InputStream fis = Files.newInputStream(file.toPath())) {</a> -<span class="sourceLineNo">173</span><a id="line.173"> // we want the zipEntry's path to be a relative path that is relative</a> -<span class="sourceLineNo">174</span><a id="line.174"> // to the directory being zipped, so chop off the rest of the path</a> -<span class="sourceLineNo">175</span><a id="line.175"> final String zipFilePath = file.getCanonicalPath().substring(</a> -<span class="sourceLineNo">176</span><a id="line.176"> directoryToZip.getCanonicalPath().length() + 1,</a> -<span class="sourceLineNo">177</span><a id="line.177"> file.getCanonicalPath().length());</a> -<span class="sourceLineNo">178</span><a id="line.178"> final ZipEntry zipEntry = new ZipEntry(zipFilePath);</a> -<span class="sourceLineNo">179</span><a id="line.179"> zos.putNextEntry(zipEntry);</a> -<span class="sourceLineNo">180</span><a id="line.180"> IOUtils.copy(fis, zos);</a> -<span class="sourceLineNo">181</span><a id="line.181"> }</a> -<span class="sourceLineNo">182</span><a id="line.182"> }</a> -<span class="sourceLineNo">183</span><a id="line.183">}</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.mojos;</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.io.InputStream;</span> +<span class="source-line-no">022</span><span id="line-22">import java.io.OutputStream;</span> +<span class="source-line-no">023</span><span id="line-23">import java.nio.file.Files;</span> +<span class="source-line-no">024</span><span id="line-24">import java.util.ArrayList;</span> +<span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> +<span class="source-line-no">026</span><span id="line-26">import java.util.zip.ZipEntry;</span> +<span class="source-line-no">027</span><span id="line-27">import java.util.zip.ZipOutputStream;</span> +<span class="source-line-no">028</span><span id="line-28"></span> +<span class="source-line-no">029</span><span id="line-29">import org.apache.commons.io.IOUtils;</span> +<span class="source-line-no">030</span><span id="line-30">import org.apache.commons.lang3.StringUtils;</span> +<span class="source-line-no">031</span><span id="line-31">import org.apache.maven.plugin.AbstractMojo;</span> +<span class="source-line-no">032</span><span id="line-32">import org.apache.maven.plugin.MojoExecutionException;</span> +<span class="source-line-no">033</span><span id="line-33">import org.apache.maven.plugin.MojoFailureException;</span> +<span class="source-line-no">034</span><span id="line-34">import org.apache.maven.plugins.annotations.LifecyclePhase;</span> +<span class="source-line-no">035</span><span id="line-35">import org.apache.maven.plugins.annotations.Mojo;</span> +<span class="source-line-no">036</span><span id="line-36">import org.apache.maven.plugins.annotations.Parameter;</span> +<span class="source-line-no">037</span><span id="line-37"></span> +<span class="source-line-no">038</span><span id="line-38">/**</span> +<span class="source-line-no">039</span><span id="line-39"> * Takes the built <code>./target/site</code> directory and compresses it to</span> +<span class="source-line-no">040</span><span id="line-40"> * <code>./target/commons-release-plugin/site.zip</code>.</span> +<span class="source-line-no">041</span><span id="line-41"> *</span> +<span class="source-line-no">042</span><span id="line-42"> * @since 1.0</span> +<span class="source-line-no">043</span><span id="line-43"> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the</span> +<span class="source-line-no">044</span><span id="line-44"> * {@link CommonsDistributionStagingMojo}.</span> +<span class="source-line-no">045</span><span id="line-45"> */</span> +<span class="source-line-no">046</span><span id="line-46">@Deprecated</span> +<span class="source-line-no">047</span><span id="line-47">@Mojo(name = "compress-site",</span> +<span class="source-line-no">048</span><span id="line-48"> defaultPhase = LifecyclePhase.POST_SITE,</span> +<span class="source-line-no">049</span><span id="line-49"> threadSafe = true,</span> +<span class="source-line-no">050</span><span id="line-50"> aggregator = true)</span> +<span class="source-line-no">051</span><span id="line-51">public class CommonsSiteCompressionMojo extends AbstractMojo {</span> +<span class="source-line-no">052</span><span id="line-52"></span> +<span class="source-line-no">053</span><span id="line-53"> /**</span> +<span class="source-line-no">054</span><span id="line-54"> * The working directory for the plugin which, assuming the maven uses the default</span> +<span class="source-line-no">055</span><span id="line-55"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</span> +<span class="source-line-no">056</span><span id="line-56"> */</span> +<span class="source-line-no">057</span><span id="line-57"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</span> +<span class="source-line-no">058</span><span id="line-58"> property = "commons.outputDirectory")</span> +<span class="source-line-no">059</span><span id="line-59"> private File workingDirectory;</span> +<span class="source-line-no">060</span><span id="line-60"></span> +<span class="source-line-no">061</span><span id="line-61"> /**</span> +<span class="source-line-no">062</span><span id="line-62"> */</span> +<span class="source-line-no">063</span><span id="line-63"> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")</span> +<span class="source-line-no">064</span><span id="line-64"> private File siteDirectory;</span> +<span class="source-line-no">065</span><span id="line-65"></span> +<span class="source-line-no">066</span><span id="line-66"> /**</span> +<span class="source-line-no">067</span><span id="line-67"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically</span> +<span class="source-line-no">068</span><span id="line-68"> * this would need to be of the form:</span> +<span class="source-line-no">069</span><span id="line-69"> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the</span> +<span class="source-line-no">070</span><span id="line-70"> * substring <code>https</code> is a requirement.</span> +<span class="source-line-no">071</span><span id="line-71"> */</span> +<span class="source-line-no">072</span><span id="line-72"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</span> +<span class="source-line-no">073</span><span id="line-73"> private String distSvnStagingUrl;</span> +<span class="source-line-no">074</span><span id="line-74"></span> +<span class="source-line-no">075</span><span id="line-75"> /**</span> +<span class="source-line-no">076</span><span id="line-76"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</span> +<span class="source-line-no">077</span><span id="line-77"> */</span> +<span class="source-line-no">078</span><span id="line-78"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</span> +<span class="source-line-no">079</span><span id="line-79"> private Boolean isDistModule;</span> +<span class="source-line-no">080</span><span id="line-80"></span> +<span class="source-line-no">081</span><span id="line-81"> /**</span> +<span class="source-line-no">082</span><span id="line-82"> * The list of files to compress into the site.zip file.</span> +<span class="source-line-no">083</span><span id="line-83"> */</span> +<span class="source-line-no">084</span><span id="line-84"> private List<File> filesToCompress;</span> +<span class="source-line-no">085</span><span id="line-85"></span> +<span class="source-line-no">086</span><span id="line-86"> @Override</span> +<span class="source-line-no">087</span><span id="line-87"> public void execute() throws MojoExecutionException, MojoFailureException {</span> +<span class="source-line-no">088</span><span id="line-88"> if (!isDistModule) {</span> +<span class="source-line-no">089</span><span id="line-89"> getLog().info("This module is marked as a non distribution "</span> +<span class="source-line-no">090</span><span id="line-90"> + "or assembly module, and the plugin will not run.");</span> +<span class="source-line-no">091</span><span id="line-91"> return;</span> +<span class="source-line-no">092</span><span id="line-92"> }</span> +<span class="source-line-no">093</span><span id="line-93"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</span> +<span class="source-line-no">094</span><span id="line-94"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</span> +<span class="source-line-no">095</span><span id="line-95"> return;</span> +<span class="source-line-no">096</span><span id="line-96"> }</span> +<span class="source-line-no">097</span><span id="line-97"> if (!siteDirectory.exists()) {</span> +<span class="source-line-no">098</span><span id="line-98"> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");</span> +<span class="source-line-no">099</span><span id="line-99"> throw new MojoFailureException(</span> +<span class="source-line-no">100</span><span id="line-100"> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</span> +<span class="source-line-no">101</span><span id="line-101"> );</span> +<span class="source-line-no">102</span><span id="line-102"> }</span> +<span class="source-line-no">103</span><span id="line-103"> if (!workingDirectory.exists()) {</span> +<span class="source-line-no">104</span><span id="line-104"> getLog().info("Current project contains no distributions. Not executing.");</span> +<span class="source-line-no">105</span><span id="line-105"> return;</span> +<span class="source-line-no">106</span><span id="line-106"> }</span> +<span class="source-line-no">107</span><span id="line-107"> try {</span> +<span class="source-line-no">108</span><span id="line-108"> filesToCompress = new ArrayList<>();</span> +<span class="source-line-no">109</span><span id="line-109"> getAllSiteFiles(siteDirectory, filesToCompress);</span> +<span class="source-line-no">110</span><span id="line-110"> writeZipFile(workingDirectory, siteDirectory, filesToCompress);</span> +<span class="source-line-no">111</span><span id="line-111"> } catch (final IOException e) {</span> +<span class="source-line-no">112</span><span id="line-112"> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);</span> +<span class="source-line-no">113</span><span id="line-113"> throw new MojoExecutionException(</span> +<span class="source-line-no">114</span><span id="line-114"> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),</span> +<span class="source-line-no">115</span><span id="line-115"> e</span> +<span class="source-line-no">116</span><span id="line-116"> );</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"> /**</span> +<span class="source-line-no">121</span><span id="line-121"> * By default this method iterates across the <code>target/site</code> directory and adds all the files</span> +<span class="source-line-no">122</span><span id="line-122"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</span> +<span class="source-line-no">123</span><span id="line-123"> *</span> +<span class="source-line-no">124</span><span id="line-124"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</span> +<span class="source-line-no">125</span><span id="line-125"> * @param filesToCompress the {@link List} to which to add all the files.</span> +<span class="source-line-no">126</span><span id="line-126"> */</span> +<span class="source-line-no">127</span><span id="line-127"> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {</span> +<span class="source-line-no">128</span><span id="line-128"> final File[] files = siteDirectory.listFiles();</span> +<span class="source-line-no">129</span><span id="line-129"> for (final File file : files) {</span> +<span class="source-line-no">130</span><span id="line-130"> filesToCompress.add(file);</span> +<span class="source-line-no">131</span><span id="line-131"> if (file.isDirectory()) {</span> +<span class="source-line-no">132</span><span id="line-132"> getAllSiteFiles(file, filesToCompress);</span> +<span class="source-line-no">133</span><span id="line-133"> }</span> +<span class="source-line-no">134</span><span id="line-134"> }</span> +<span class="source-line-no">135</span><span id="line-135"> }</span> +<span class="source-line-no">136</span><span id="line-136"></span> +<span class="source-line-no">137</span><span id="line-137"> /**</span> +<span class="source-line-no">138</span><span id="line-138"> * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file</span> +<span class="source-line-no">139</span><span id="line-139"> * in the <code>workingDirectory</code>.</span> +<span class="source-line-no">140</span><span id="line-140"> *</span> +<span class="source-line-no">141</span><span id="line-141"> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.</span> +<span class="source-line-no">142</span><span id="line-142"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</span> +<span class="source-line-no">143</span><span id="line-143"> * <code>target/site</code>).</span> +<span class="source-line-no">144</span><span id="line-144"> * @param fileList the list of files to be zipped up, generally generated by</span> +<span class="source-line-no">145</span><span id="line-145"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</span> +<span class="source-line-no">146</span><span id="line-146"> * @throws IOException when the copying of the files goes incorrectly.</span> +<span class="source-line-no">147</span><span id="line-147"> */</span> +<span class="source-line-no">148</span><span id="line-148"> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)</span> +<span class="source-line-no">149</span><span id="line-149"> throws IOException {</span> +<span class="source-line-no">150</span><span id="line-150"> try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")</span> +<span class="source-line-no">151</span><span id="line-151"> .toPath());</span> +<span class="source-line-no">152</span><span id="line-152"> ZipOutputStream zos = new ZipOutputStream(fos)) {</span> +<span class="source-line-no">153</span><span id="line-153"> for (final File file : fileList) {</span> +<span class="source-line-no">154</span><span id="line-154"> if (!file.isDirectory()) { // we only ZIP files, not directories</span> +<span class="source-line-no">155</span><span id="line-155"> addToZip(directoryToZip, file, zos);</span> +<span class="source-line-no">156</span><span id="line-156"> }</span> +<span class="source-line-no">157</span><span id="line-157"> }</span> +<span class="source-line-no">158</span><span id="line-158"> }</span> +<span class="source-line-no">159</span><span id="line-159"> }</span> +<span class="source-line-no">160</span><span id="line-160"></span> +<span class="source-line-no">161</span><span id="line-161"> /**</span> +<span class="source-line-no">162</span><span id="line-162"> * Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by</span> +<span class="source-line-no">163</span><span id="line-163"> * <code>zos</code>.</span> +<span class="source-line-no">164</span><span id="line-164"> *</span> +<span class="source-line-no">165</span><span id="line-165"> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are</span> +<span class="source-line-no">166</span><span id="line-166"> * compressing. Generally this is <code>target/site</code>.</span> +<span class="source-line-no">167</span><span id="line-167"> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.</span> +<span class="source-line-no">168</span><span id="line-168"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</span> +<span class="source-line-no">169</span><span id="line-169"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</span> +<span class="source-line-no">170</span><span id="line-170"> */</span> +<span class="source-line-no">171</span><span id="line-171"> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {</span> +<span class="source-line-no">172</span><span id="line-172"> try (InputStream fis = Files.newInputStream(file.toPath())) {</span> +<span class="source-line-no">173</span><span id="line-173"> // we want the zipEntry's path to be a relative path that is relative</span> +<span class="source-line-no">174</span><span id="line-174"> // to the directory being zipped, so chop off the rest of the path</span> +<span class="source-line-no">175</span><span id="line-175"> final String zipFilePath = file.getCanonicalPath().substring(</span> +<span class="source-line-no">176</span><span id="line-176"> directoryToZip.getCanonicalPath().length() + 1,</span> +<span class="source-line-no">177</span><span id="line-177"> file.getCanonicalPath().length());</span> +<span class="source-line-no">178</span><span id="line-178"> final ZipEntry zipEntry = new ZipEntry(zipFilePath);</span> +<span class="source-line-no">179</span><span id="line-179"> zos.putNextEntry(zipEntry);</span> +<span class="source-line-no">180</span><span id="line-180"> IOUtils.copy(fis, zos);</span> +<span class="source-line-no">181</span><span id="line-181"> }</span> +<span class="source-line-no">182</span><span id="line-182"> }</span> +<span class="source-line-no">183</span><span id="line-183">}</span>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html Sat Apr 20 14:51:39 2024 @@ -1,214 +1,218 @@ <!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.mojos, class: CommonsStagingCleanupMojo"> +<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.mojos;</a> -<span class="sourceLineNo">018</span><a id="line.18"></a> -<span class="sourceLineNo">019</span><a id="line.19">import org.apache.commons.lang3.StringUtils;</a> -<span class="sourceLineNo">020</span><a id="line.20">import org.apache.commons.release.plugin.SharedFunctions;</a> -<span class="sourceLineNo">021</span><a id="line.21">import org.apache.maven.plugin.AbstractMojo;</a> -<span class="sourceLineNo">022</span><a id="line.22">import org.apache.maven.plugin.MojoExecutionException;</a> -<span class="sourceLineNo">023</span><a id="line.23">import org.apache.maven.plugin.MojoFailureException;</a> -<span class="sourceLineNo">024</span><a id="line.24">import org.apache.maven.plugins.annotations.Component;</a> -<span class="sourceLineNo">025</span><a id="line.25">import org.apache.maven.plugins.annotations.LifecyclePhase;</a> -<span class="sourceLineNo">026</span><a id="line.26">import org.apache.maven.plugins.annotations.Mojo;</a> -<span class="sourceLineNo">027</span><a id="line.27">import org.apache.maven.plugins.annotations.Parameter;</a> -<span class="sourceLineNo">028</span><a id="line.28">import org.apache.maven.project.MavenProject;</a> -<span class="sourceLineNo">029</span><a id="line.29">import org.apache.maven.scm.ScmException;</a> -<span class="sourceLineNo">030</span><a id="line.30">import org.apache.maven.scm.ScmFileSet;</a> -<span class="sourceLineNo">031</span><a id="line.31">import org.apache.maven.scm.command.checkin.CheckInScmResult;</a> -<span class="sourceLineNo">032</span><a id="line.32">import org.apache.maven.scm.command.checkout.CheckOutScmResult;</a> -<span class="sourceLineNo">033</span><a id="line.33">import org.apache.maven.scm.command.remove.RemoveScmResult;</a> -<span class="sourceLineNo">034</span><a id="line.34">import org.apache.maven.scm.manager.BasicScmManager;</a> -<span class="sourceLineNo">035</span><a id="line.35">import org.apache.maven.scm.manager.ScmManager;</a> -<span class="sourceLineNo">036</span><a id="line.36">import org.apache.maven.scm.provider.ScmProvider;</a> -<span class="sourceLineNo">037</span><a id="line.37">import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;</a> -<span class="sourceLineNo">038</span><a id="line.38">import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;</a> -<span class="sourceLineNo">039</span><a id="line.39">import org.apache.maven.scm.repository.ScmRepository;</a> -<span class="sourceLineNo">040</span><a id="line.40">import org.apache.maven.settings.Settings;</a> -<span class="sourceLineNo">041</span><a id="line.41">import org.apache.maven.settings.crypto.SettingsDecrypter;</a> -<span class="sourceLineNo">042</span><a id="line.42"></a> -<span class="sourceLineNo">043</span><a id="line.43">import java.io.File;</a> -<span class="sourceLineNo">044</span><a id="line.44">import java.util.Arrays;</a> -<span class="sourceLineNo">045</span><a id="line.45">import java.util.List;</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"> * This class checks out the dev distribution location, checks whether anything exists in the</a> -<span class="sourceLineNo">049</span><a id="line.49"> * distribution location, and if it is non-empty it deletes all the resources there.</a> -<span class="sourceLineNo">050</span><a id="line.50"> *</a> -<span class="sourceLineNo">051</span><a id="line.51"> * @since 1.6</a> -<span class="sourceLineNo">052</span><a id="line.52"> */</a> -<span class="sourceLineNo">053</span><a id="line.53">@Mojo(name = "clean-staging",</a> -<span class="sourceLineNo">054</span><a id="line.54"> defaultPhase = LifecyclePhase.POST_CLEAN,</a> -<span class="sourceLineNo">055</span><a id="line.55"> threadSafe = true,</a> -<span class="sourceLineNo">056</span><a id="line.56"> aggregator = true)</a> -<span class="sourceLineNo">057</span><a id="line.57">public class CommonsStagingCleanupMojo extends AbstractMojo {</a> -<span class="sourceLineNo">058</span><a id="line.58"></a> -<span class="sourceLineNo">059</span><a id="line.59"> /**</a> -<span class="sourceLineNo">060</span><a id="line.60"> * The {@link MavenProject} object is essentially the context of the maven build at</a> -<span class="sourceLineNo">061</span><a id="line.61"> * a given time.</a> -<span class="sourceLineNo">062</span><a id="line.62"> */</a> -<span class="sourceLineNo">063</span><a id="line.63"> @Parameter(defaultValue = "${project}", required = true)</a> -<span class="sourceLineNo">064</span><a id="line.64"> private MavenProject project;</a> -<span class="sourceLineNo">065</span><a id="line.65"></a> -<span class="sourceLineNo">066</span><a id="line.66"> /**</a> -<span class="sourceLineNo">067</span><a id="line.67"> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but</a> -<span class="sourceLineNo">068</span><a id="line.68"> * that assumes that we're using the default maven <code>${project.build.directory}</code>.</a> -<span class="sourceLineNo">069</span><a id="line.69"> */</a> -<span class="sourceLineNo">070</span><a id="line.70"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")</a> -<span class="sourceLineNo">071</span><a id="line.71"> private File workingDirectory;</a> -<span class="sourceLineNo">072</span><a id="line.72"></a> -<span class="sourceLineNo">073</span><a id="line.73"> /**</a> -<span class="sourceLineNo">074</span><a id="line.74"> * The location to which to checkout the dist subversion repository under our working directory, which</a> -<span class="sourceLineNo">075</span><a id="line.75"> * was given above. We then do an SVN delete on all the directories in this repository.</a> -<span class="sourceLineNo">076</span><a id="line.76"> */</a> -<span class="sourceLineNo">077</span><a id="line.77"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm-cleanup",</a> -<span class="sourceLineNo">078</span><a id="line.78"> property = "commons.distCleanupDirectory")</a> -<span class="sourceLineNo">079</span><a id="line.79"> private File distCleanupDirectory;</a> -<span class="sourceLineNo">080</span><a id="line.80"></a> -<span class="sourceLineNo">081</span><a id="line.81"> /**</a> -<span class="sourceLineNo">082</span><a id="line.82"> * A boolean that determines whether or not we actually commit the files up to the subversion repository.</a> -<span class="sourceLineNo">083</span><a id="line.83"> * If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question</a> -<span class="sourceLineNo">084</span><a id="line.84"> * though.</a> -<span class="sourceLineNo">085</span><a id="line.85"> */</a> -<span class="sourceLineNo">086</span><a id="line.86"> @Parameter(property = "commons.release.dryRun", defaultValue = "false")</a> -<span class="sourceLineNo">087</span><a id="line.87"> private Boolean dryRun;</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"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</a> -<span class="sourceLineNo">091</span><a id="line.91"> * be of the form: <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>. Note. that</a> -<span class="sourceLineNo">092</span><a id="line.92"> * the prefix to the substring <code>https</code> is a requirement.</a> -<span class="sourceLineNo">093</span><a id="line.93"> */</a> -<span class="sourceLineNo">094</span><a id="line.94"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</a> -<span class="sourceLineNo">095</span><a id="line.95"> private String distSvnStagingUrl;</a> -<span class="sourceLineNo">096</span><a id="line.96"></a> -<span class="sourceLineNo">097</span><a id="line.97"> /**</a> -<span class="sourceLineNo">098</span><a id="line.98"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</a> -<span class="sourceLineNo">099</span><a id="line.99"> */</a> -<span class="sourceLineNo">100</span><a id="line.100"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</a> -<span class="sourceLineNo">101</span><a id="line.101"> private Boolean isDistModule;</a> -<span class="sourceLineNo">102</span><a id="line.102"></a> -<span class="sourceLineNo">103</span><a id="line.103"> /**</a> -<span class="sourceLineNo">104</span><a id="line.104"> * The ID of the server (specified in settings.xml) which should be used for dist authentication.</a> -<span class="sourceLineNo">105</span><a id="line.105"> * This will be used in preference to {@link #username}/{@link #password}.</a> -<span class="sourceLineNo">106</span><a id="line.106"> */</a> -<span class="sourceLineNo">107</span><a id="line.107"> @Parameter(property = "commons.distServer")</a> -<span class="sourceLineNo">108</span><a id="line.108"> private String distServer;</a> -<span class="sourceLineNo">109</span><a id="line.109"></a> -<span class="sourceLineNo">110</span><a id="line.110"> /**</a> -<span class="sourceLineNo">111</span><a id="line.111"> * The username for the distribution subversion repository. This is typically your Apache id.</a> -<span class="sourceLineNo">112</span><a id="line.112"> */</a> -<span class="sourceLineNo">113</span><a id="line.113"> @Parameter(property = "user.name")</a> -<span class="sourceLineNo">114</span><a id="line.114"> private String username;</a> -<span class="sourceLineNo">115</span><a id="line.115"></a> -<span class="sourceLineNo">116</span><a id="line.116"> /**</a> -<span class="sourceLineNo">117</span><a id="line.117"> * The password associated with {@link CommonsDistributionStagingMojo#username}.</a> -<span class="sourceLineNo">118</span><a id="line.118"> */</a> -<span class="sourceLineNo">119</span><a id="line.119"> @Parameter(property = "user.password")</a> -<span class="sourceLineNo">120</span><a id="line.120"> private String password;</a> -<span class="sourceLineNo">121</span><a id="line.121"></a> -<span class="sourceLineNo">122</span><a id="line.122"> /**</a> -<span class="sourceLineNo">123</span><a id="line.123"> * Maven {@link Settings}.</a> -<span class="sourceLineNo">124</span><a id="line.124"> */</a> -<span class="sourceLineNo">125</span><a id="line.125"> @Parameter(defaultValue = "${settings}", readonly = true, required = true)</a> -<span class="sourceLineNo">126</span><a id="line.126"> private Settings settings;</a> -<span class="sourceLineNo">127</span><a id="line.127"></a> -<span class="sourceLineNo">128</span><a id="line.128"> /**</a> -<span class="sourceLineNo">129</span><a id="line.129"> * Maven {@link SettingsDecrypter} component.</a> -<span class="sourceLineNo">130</span><a id="line.130"> */</a> -<span class="sourceLineNo">131</span><a id="line.131"> @Component</a> -<span class="sourceLineNo">132</span><a id="line.132"> private SettingsDecrypter settingsDecrypter;</a> -<span class="sourceLineNo">133</span><a id="line.133"></a> -<span class="sourceLineNo">134</span><a id="line.134"> @Override</a> -<span class="sourceLineNo">135</span><a id="line.135"> public void execute() throws MojoExecutionException, MojoFailureException {</a> -<span class="sourceLineNo">136</span><a id="line.136"> if (!isDistModule) {</a> -<span class="sourceLineNo">137</span><a id="line.137"> getLog().info("This module is marked as a non distribution "</a> -<span class="sourceLineNo">138</span><a id="line.138"> + "or assembly module, and the plugin will not run.");</a> -<span class="sourceLineNo">139</span><a id="line.139"> return;</a> -<span class="sourceLineNo">140</span><a id="line.140"> }</a> -<span class="sourceLineNo">141</span><a id="line.141"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</a> -<span class="sourceLineNo">142</span><a id="line.142"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</a> -<span class="sourceLineNo">143</span><a id="line.143"> return;</a> -<span class="sourceLineNo">144</span><a id="line.144"> }</a> -<span class="sourceLineNo">145</span><a id="line.145"> if (!workingDirectory.exists()) {</a> -<span class="sourceLineNo">146</span><a id="line.146"> SharedFunctions.initDirectory(getLog(), workingDirectory);</a> -<span class="sourceLineNo">147</span><a id="line.147"> }</a> -<span class="sourceLineNo">148</span><a id="line.148"> try {</a> -<span class="sourceLineNo">149</span><a id="line.149"> final ScmManager scmManager = new BasicScmManager();</a> -<span class="sourceLineNo">150</span><a id="line.150"> scmManager.setScmProvider("svn", new SvnExeScmProvider());</a> -<span class="sourceLineNo">151</span><a id="line.151"> final ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);</a> -<span class="sourceLineNo">152</span><a id="line.152"> final ScmProvider provider = scmManager.getProviderByRepository(repository);</a> -<span class="sourceLineNo">153</span><a id="line.153"> final SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository</a> -<span class="sourceLineNo">154</span><a id="line.154"> .getProviderRepository();</a> -<span class="sourceLineNo">155</span><a id="line.155"> SharedFunctions.setAuthentication(</a> -<span class="sourceLineNo">156</span><a id="line.156"> providerRepository,</a> -<span class="sourceLineNo">157</span><a id="line.157"> distServer,</a> -<span class="sourceLineNo">158</span><a id="line.158"> settings,</a> -<span class="sourceLineNo">159</span><a id="line.159"> settingsDecrypter,</a> -<span class="sourceLineNo">160</span><a id="line.160"> username,</a> -<span class="sourceLineNo">161</span><a id="line.161"> password</a> -<span class="sourceLineNo">162</span><a id="line.162"> );</a> -<span class="sourceLineNo">163</span><a id="line.163"> getLog().info("Checking out dist from: " + distSvnStagingUrl);</a> -<span class="sourceLineNo">164</span><a id="line.164"> final ScmFileSet scmFileSet = new ScmFileSet(distCleanupDirectory);</a> -<span class="sourceLineNo">165</span><a id="line.165"> final CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet);</a> -<span class="sourceLineNo">166</span><a id="line.166"> if (!checkOutResult.isSuccess()) {</a> -<span class="sourceLineNo">167</span><a id="line.167"> throw new MojoExecutionException("Failed to checkout files from SCM: "</a> -<span class="sourceLineNo">168</span><a id="line.168"> + checkOutResult.getProviderMessage() + " [" + checkOutResult.getCommandOutput() + "]");</a> -<span class="sourceLineNo">169</span><a id="line.169"> }</a> -<span class="sourceLineNo">170</span><a id="line.170"> final List<File> filesToRemove = Arrays.asList(distCleanupDirectory.listFiles());</a> -<span class="sourceLineNo">171</span><a id="line.171"> if (filesToRemove.size() == 1) {</a> -<span class="sourceLineNo">172</span><a id="line.172"> getLog().info("No files to delete");</a> -<span class="sourceLineNo">173</span><a id="line.173"> return;</a> -<span class="sourceLineNo">174</span><a id="line.174"> }</a> -<span class="sourceLineNo">175</span><a id="line.175"> if (!dryRun) {</a> -<span class="sourceLineNo">176</span><a id="line.176"> final ScmFileSet fileSet = new ScmFileSet(distCleanupDirectory, filesToRemove);</a> -<span class="sourceLineNo">177</span><a id="line.177"> final RemoveScmResult removeScmResult = provider.remove(repository, fileSet,</a> -<span class="sourceLineNo">178</span><a id="line.178"> "Cleaning up staging area");</a> -<span class="sourceLineNo">179</span><a id="line.179"> if (!removeScmResult.isSuccess()) {</a> -<span class="sourceLineNo">180</span><a id="line.180"> throw new MojoFailureException("Failed to remove files from SCM: "</a> -<span class="sourceLineNo">181</span><a id="line.181"> + removeScmResult.getProviderMessage()</a> -<span class="sourceLineNo">182</span><a id="line.182"> + " [" + removeScmResult.getCommandOutput() + "]");</a> -<span class="sourceLineNo">183</span><a id="line.183"> }</a> -<span class="sourceLineNo">184</span><a id="line.184"> getLog().info("Cleaning distribution area for: " + project.getArtifactId());</a> -<span class="sourceLineNo">185</span><a id="line.185"> final CheckInScmResult checkInResult = provider.checkIn(</a> -<span class="sourceLineNo">186</span><a id="line.186"> repository,</a> -<span class="sourceLineNo">187</span><a id="line.187"> fileSet,</a> -<span class="sourceLineNo">188</span><a id="line.188"> "Cleaning distribution area for: " + project.getArtifactId()</a> -<span class="sourceLineNo">189</span><a id="line.189"> );</a> -<span class="sourceLineNo">190</span><a id="line.190"> if (!checkInResult.isSuccess()) {</a> -<span class="sourceLineNo">191</span><a id="line.191"> throw new MojoFailureException("Failed to commit files: " + removeScmResult.getProviderMessage()</a> -<span class="sourceLineNo">192</span><a id="line.192"> + " [" + removeScmResult.getCommandOutput() + "]");</a> -<span class="sourceLineNo">193</span><a id="line.193"> }</a> -<span class="sourceLineNo">194</span><a id="line.194"> } else {</a> -<span class="sourceLineNo">195</span><a id="line.195"> getLog().info("Would have attempted to delete files from: " + distSvnStagingUrl);</a> -<span class="sourceLineNo">196</span><a id="line.196"> }</a> -<span class="sourceLineNo">197</span><a id="line.197"> } catch (final ScmException e) {</a> -<span class="sourceLineNo">198</span><a id="line.198"> throw new MojoFailureException(e.getMessage());</a> -<span class="sourceLineNo">199</span><a id="line.199"> }</a> -<span class="sourceLineNo">200</span><a id="line.200"></a> -<span class="sourceLineNo">201</span><a id="line.201"> }</a> -<span class="sourceLineNo">202</span><a id="line.202">}</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.mojos;</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.util.Arrays;</span> +<span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> +<span class="source-line-no">022</span><span id="line-22"></span> +<span class="source-line-no">023</span><span id="line-23">import org.apache.commons.lang3.StringUtils;</span> +<span class="source-line-no">024</span><span id="line-24">import org.apache.commons.release.plugin.SharedFunctions;</span> +<span class="source-line-no">025</span><span id="line-25">import org.apache.maven.plugin.AbstractMojo;</span> +<span class="source-line-no">026</span><span id="line-26">import org.apache.maven.plugin.MojoExecutionException;</span> +<span class="source-line-no">027</span><span id="line-27">import org.apache.maven.plugin.MojoFailureException;</span> +<span class="source-line-no">028</span><span id="line-28">import org.apache.maven.plugins.annotations.Component;</span> +<span class="source-line-no">029</span><span id="line-29">import org.apache.maven.plugins.annotations.LifecyclePhase;</span> +<span class="source-line-no">030</span><span id="line-30">import org.apache.maven.plugins.annotations.Mojo;</span> +<span class="source-line-no">031</span><span id="line-31">import org.apache.maven.plugins.annotations.Parameter;</span> +<span class="source-line-no">032</span><span id="line-32">import org.apache.maven.project.MavenProject;</span> +<span class="source-line-no">033</span><span id="line-33">import org.apache.maven.scm.ScmException;</span> +<span class="source-line-no">034</span><span id="line-34">import org.apache.maven.scm.ScmFileSet;</span> +<span class="source-line-no">035</span><span id="line-35">import org.apache.maven.scm.command.checkin.CheckInScmResult;</span> +<span class="source-line-no">036</span><span id="line-36">import org.apache.maven.scm.command.checkout.CheckOutScmResult;</span> +<span class="source-line-no">037</span><span id="line-37">import org.apache.maven.scm.command.remove.RemoveScmResult;</span> +<span class="source-line-no">038</span><span id="line-38">import org.apache.maven.scm.manager.BasicScmManager;</span> +<span class="source-line-no">039</span><span id="line-39">import org.apache.maven.scm.manager.ScmManager;</span> +<span class="source-line-no">040</span><span id="line-40">import org.apache.maven.scm.provider.ScmProvider;</span> +<span class="source-line-no">041</span><span id="line-41">import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;</span> +<span class="source-line-no">042</span><span id="line-42">import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;</span> +<span class="source-line-no">043</span><span id="line-43">import org.apache.maven.scm.repository.ScmRepository;</span> +<span class="source-line-no">044</span><span id="line-44">import org.apache.maven.settings.Settings;</span> +<span class="source-line-no">045</span><span id="line-45">import org.apache.maven.settings.crypto.SettingsDecrypter;</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"> * This class checks out the dev distribution location, checks whether anything exists in the</span> +<span class="source-line-no">049</span><span id="line-49"> * distribution location, and if it is non-empty it deletes all the resources there.</span> +<span class="source-line-no">050</span><span id="line-50"> *</span> +<span class="source-line-no">051</span><span id="line-51"> * @since 1.6</span> +<span class="source-line-no">052</span><span id="line-52"> */</span> +<span class="source-line-no">053</span><span id="line-53">@Mojo(name = "clean-staging",</span> +<span class="source-line-no">054</span><span id="line-54"> defaultPhase = LifecyclePhase.POST_CLEAN,</span> +<span class="source-line-no">055</span><span id="line-55"> threadSafe = true,</span> +<span class="source-line-no">056</span><span id="line-56"> aggregator = true)</span> +<span class="source-line-no">057</span><span id="line-57">public class CommonsStagingCleanupMojo extends AbstractMojo {</span> +<span class="source-line-no">058</span><span id="line-58"></span> +<span class="source-line-no">059</span><span id="line-59"> /**</span> +<span class="source-line-no">060</span><span id="line-60"> * The {@link MavenProject} object is essentially the context of the maven build at</span> +<span class="source-line-no">061</span><span id="line-61"> * a given time.</span> +<span class="source-line-no">062</span><span id="line-62"> */</span> +<span class="source-line-no">063</span><span id="line-63"> @Parameter(defaultValue = "${project}", required = true)</span> +<span class="source-line-no">064</span><span id="line-64"> private MavenProject project;</span> +<span class="source-line-no">065</span><span id="line-65"></span> +<span class="source-line-no">066</span><span id="line-66"> /**</span> +<span class="source-line-no">067</span><span id="line-67"> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but</span> +<span class="source-line-no">068</span><span id="line-68"> * that assumes that we're using the default maven <code>${project.build.directory}</code>.</span> +<span class="source-line-no">069</span><span id="line-69"> */</span> +<span class="source-line-no">070</span><span id="line-70"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")</span> +<span class="source-line-no">071</span><span id="line-71"> private File workingDirectory;</span> +<span class="source-line-no">072</span><span id="line-72"></span> +<span class="source-line-no">073</span><span id="line-73"> /**</span> +<span class="source-line-no">074</span><span id="line-74"> * The location to which to checkout the dist subversion repository under our working directory, which</span> +<span class="source-line-no">075</span><span id="line-75"> * was given above. We then do an SVN delete on all the directories in this repository.</span> +<span class="source-line-no">076</span><span id="line-76"> */</span> +<span class="source-line-no">077</span><span id="line-77"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm-cleanup",</span> +<span class="source-line-no">078</span><span id="line-78"> property = "commons.distCleanupDirectory")</span> +<span class="source-line-no">079</span><span id="line-79"> private File distCleanupDirectory;</span> +<span class="source-line-no">080</span><span id="line-80"></span> +<span class="source-line-no">081</span><span id="line-81"> /**</span> +<span class="source-line-no">082</span><span id="line-82"> * A boolean that determines whether or not we actually commit the files up to the subversion repository.</span> +<span class="source-line-no">083</span><span id="line-83"> * If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question</span> +<span class="source-line-no">084</span><span id="line-84"> * though.</span> +<span class="source-line-no">085</span><span id="line-85"> */</span> +<span class="source-line-no">086</span><span id="line-86"> @Parameter(property = "commons.release.dryRun", defaultValue = "false")</span> +<span class="source-line-no">087</span><span id="line-87"> private Boolean dryRun;</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"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</span> +<span class="source-line-no">091</span><span id="line-91"> * be of the form: <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>. Note. that</span> +<span class="source-line-no">092</span><span id="line-92"> * the prefix to the substring <code>https</code> is a requirement.</span> +<span class="source-line-no">093</span><span id="line-93"> */</span> +<span class="source-line-no">094</span><span id="line-94"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</span> +<span class="source-line-no">095</span><span id="line-95"> private String distSvnStagingUrl;</span> +<span class="source-line-no">096</span><span id="line-96"></span> +<span class="source-line-no">097</span><span id="line-97"> /**</span> +<span class="source-line-no">098</span><span id="line-98"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</span> +<span class="source-line-no">099</span><span id="line-99"> */</span> +<span class="source-line-no">100</span><span id="line-100"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</span> +<span class="source-line-no">101</span><span id="line-101"> private Boolean isDistModule;</span> +<span class="source-line-no">102</span><span id="line-102"></span> +<span class="source-line-no">103</span><span id="line-103"> /**</span> +<span class="source-line-no">104</span><span id="line-104"> * The ID of the server (specified in settings.xml) which should be used for dist authentication.</span> +<span class="source-line-no">105</span><span id="line-105"> * This will be used in preference to {@link #username}/{@link #password}.</span> +<span class="source-line-no">106</span><span id="line-106"> */</span> +<span class="source-line-no">107</span><span id="line-107"> @Parameter(property = "commons.distServer")</span> +<span class="source-line-no">108</span><span id="line-108"> private String distServer;</span> +<span class="source-line-no">109</span><span id="line-109"></span> +<span class="source-line-no">110</span><span id="line-110"> /**</span> +<span class="source-line-no">111</span><span id="line-111"> * The username for the distribution subversion repository. This is typically your Apache id.</span> +<span class="source-line-no">112</span><span id="line-112"> */</span> +<span class="source-line-no">113</span><span id="line-113"> @Parameter(property = "user.name")</span> +<span class="source-line-no">114</span><span id="line-114"> private String username;</span> +<span class="source-line-no">115</span><span id="line-115"></span> +<span class="source-line-no">116</span><span id="line-116"> /**</span> +<span class="source-line-no">117</span><span id="line-117"> * The password associated with {@link CommonsDistributionStagingMojo#username}.</span> +<span class="source-line-no">118</span><span id="line-118"> */</span> +<span class="source-line-no">119</span><span id="line-119"> @Parameter(property = "user.password")</span> +<span class="source-line-no">120</span><span id="line-120"> private String password;</span> +<span class="source-line-no">121</span><span id="line-121"></span> +<span class="source-line-no">122</span><span id="line-122"> /**</span> +<span class="source-line-no">123</span><span id="line-123"> * Maven {@link Settings}.</span> +<span class="source-line-no">124</span><span id="line-124"> */</span> +<span class="source-line-no">125</span><span id="line-125"> @Parameter(defaultValue = "${settings}", readonly = true, required = true)</span> +<span class="source-line-no">126</span><span id="line-126"> private Settings settings;</span> +<span class="source-line-no">127</span><span id="line-127"></span> +<span class="source-line-no">128</span><span id="line-128"> /**</span> +<span class="source-line-no">129</span><span id="line-129"> * Maven {@link SettingsDecrypter} component.</span> +<span class="source-line-no">130</span><span id="line-130"> */</span> +<span class="source-line-no">131</span><span id="line-131"> @Component</span> +<span class="source-line-no">132</span><span id="line-132"> private SettingsDecrypter settingsDecrypter;</span> +<span class="source-line-no">133</span><span id="line-133"></span> +<span class="source-line-no">134</span><span id="line-134"> @Override</span> +<span class="source-line-no">135</span><span id="line-135"> public void execute() throws MojoExecutionException, MojoFailureException {</span> +<span class="source-line-no">136</span><span id="line-136"> if (!isDistModule) {</span> +<span class="source-line-no">137</span><span id="line-137"> getLog().info("This module is marked as a non distribution "</span> +<span class="source-line-no">138</span><span id="line-138"> + "or assembly module, and the plugin will not run.");</span> +<span class="source-line-no">139</span><span id="line-139"> return;</span> +<span class="source-line-no">140</span><span id="line-140"> }</span> +<span class="source-line-no">141</span><span id="line-141"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</span> +<span class="source-line-no">142</span><span id="line-142"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</span> +<span class="source-line-no">143</span><span id="line-143"> return;</span> +<span class="source-line-no">144</span><span id="line-144"> }</span> +<span class="source-line-no">145</span><span id="line-145"> if (!workingDirectory.exists()) {</span> +<span class="source-line-no">146</span><span id="line-146"> SharedFunctions.initDirectory(getLog(), workingDirectory);</span> +<span class="source-line-no">147</span><span id="line-147"> }</span> +<span class="source-line-no">148</span><span id="line-148"> try {</span> +<span class="source-line-no">149</span><span id="line-149"> final ScmManager scmManager = new BasicScmManager();</span> +<span class="source-line-no">150</span><span id="line-150"> scmManager.setScmProvider("svn", new SvnExeScmProvider());</span> +<span class="source-line-no">151</span><span id="line-151"> final ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);</span> +<span class="source-line-no">152</span><span id="line-152"> final ScmProvider provider = scmManager.getProviderByRepository(repository);</span> +<span class="source-line-no">153</span><span id="line-153"> final SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository</span> +<span class="source-line-no">154</span><span id="line-154"> .getProviderRepository();</span> +<span class="source-line-no">155</span><span id="line-155"> SharedFunctions.setAuthentication(</span> +<span class="source-line-no">156</span><span id="line-156"> providerRepository,</span> +<span class="source-line-no">157</span><span id="line-157"> distServer,</span> +<span class="source-line-no">158</span><span id="line-158"> settings,</span> +<span class="source-line-no">159</span><span id="line-159"> settingsDecrypter,</span> +<span class="source-line-no">160</span><span id="line-160"> username,</span> +<span class="source-line-no">161</span><span id="line-161"> password</span> +<span class="source-line-no">162</span><span id="line-162"> );</span> +<span class="source-line-no">163</span><span id="line-163"> getLog().info("Checking out dist from: " + distSvnStagingUrl);</span> +<span class="source-line-no">164</span><span id="line-164"> final ScmFileSet scmFileSet = new ScmFileSet(distCleanupDirectory);</span> +<span class="source-line-no">165</span><span id="line-165"> final CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet);</span> +<span class="source-line-no">166</span><span id="line-166"> if (!checkOutResult.isSuccess()) {</span> +<span class="source-line-no">167</span><span id="line-167"> throw new MojoExecutionException("Failed to checkout files from SCM: "</span> +<span class="source-line-no">168</span><span id="line-168"> + checkOutResult.getProviderMessage() + " [" + checkOutResult.getCommandOutput() + "]");</span> +<span class="source-line-no">169</span><span id="line-169"> }</span> +<span class="source-line-no">170</span><span id="line-170"> final List<File> filesToRemove = Arrays.asList(distCleanupDirectory.listFiles());</span> +<span class="source-line-no">171</span><span id="line-171"> if (filesToRemove.size() == 1) {</span> +<span class="source-line-no">172</span><span id="line-172"> getLog().info("No files to delete");</span> +<span class="source-line-no">173</span><span id="line-173"> return;</span> +<span class="source-line-no">174</span><span id="line-174"> }</span> +<span class="source-line-no">175</span><span id="line-175"> if (!dryRun) {</span> +<span class="source-line-no">176</span><span id="line-176"> final ScmFileSet fileSet = new ScmFileSet(distCleanupDirectory, filesToRemove);</span> +<span class="source-line-no">177</span><span id="line-177"> final RemoveScmResult removeScmResult = provider.remove(repository, fileSet,</span> +<span class="source-line-no">178</span><span id="line-178"> "Cleaning up staging area");</span> +<span class="source-line-no">179</span><span id="line-179"> if (!removeScmResult.isSuccess()) {</span> +<span class="source-line-no">180</span><span id="line-180"> throw new MojoFailureException("Failed to remove files from SCM: "</span> +<span class="source-line-no">181</span><span id="line-181"> + removeScmResult.getProviderMessage()</span> +<span class="source-line-no">182</span><span id="line-182"> + " [" + removeScmResult.getCommandOutput() + "]");</span> +<span class="source-line-no">183</span><span id="line-183"> }</span> +<span class="source-line-no">184</span><span id="line-184"> getLog().info("Cleaning distribution area for: " + project.getArtifactId());</span> +<span class="source-line-no">185</span><span id="line-185"> final CheckInScmResult checkInResult = provider.checkIn(</span> +<span class="source-line-no">186</span><span id="line-186"> repository,</span> +<span class="source-line-no">187</span><span id="line-187"> fileSet,</span> +<span class="source-line-no">188</span><span id="line-188"> "Cleaning distribution area for: " + project.getArtifactId()</span> +<span class="source-line-no">189</span><span id="line-189"> );</span> +<span class="source-line-no">190</span><span id="line-190"> if (!checkInResult.isSuccess()) {</span> +<span class="source-line-no">191</span><span id="line-191"> throw new MojoFailureException("Failed to commit files: " + removeScmResult.getProviderMessage()</span> +<span class="source-line-no">192</span><span id="line-192"> + " [" + removeScmResult.getCommandOutput() + "]");</span> +<span class="source-line-no">193</span><span id="line-193"> }</span> +<span class="source-line-no">194</span><span id="line-194"> } else {</span> +<span class="source-line-no">195</span><span id="line-195"> getLog().info("Would have attempted to delete files from: " + distSvnStagingUrl);</span> +<span class="source-line-no">196</span><span id="line-196"> }</span> +<span class="source-line-no">197</span><span id="line-197"> } catch (final ScmException e) {</span> +<span class="source-line-no">198</span><span id="line-198"> throw new MojoFailureException(e.getMessage());</span> +<span class="source-line-no">199</span><span id="line-199"> }</span> +<span class="source-line-no">200</span><span id="line-200"></span> +<span class="source-line-no">201</span><span id="line-201"> }</span> +<span class="source-line-no">202</span><span id="line-202">}</span>
