Modified: maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/xref/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/xref/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.html (original) +++ maven/website/components/plugins-archives/maven-scm-publish-plugin-LATEST/xref/org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.html Sun Jun 16 20:19:01 2024 @@ -62,144 +62,144 @@ <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository; <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.repository.ScmRepository; <a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.apache.maven.scm.repository.ScmRepositoryException; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Server; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.DefaultSettingsDecryptionRequest; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecrypter; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecryptionRequest; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.crypto.SettingsDecryptionResult; -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.config.ReleaseDescriptor; -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.config.ReleaseDescriptorBuilder; -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.scm.ScmRepositoryConfigurator; -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.logging.MessageUtils; -<a class="jxr_linenumber" name="L67" href="#L67">67</a> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Base class for the scm-publish mojos.</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractScmPublishMojo" href="../../../../../org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.html#AbstractScmPublishMojo">AbstractScmPublishMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">// CHECKSTYLE_OFF: LineLength</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Location of the scm publication tree:</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <code>scm:&lt;scm_provider&gt;&lt;delimiter&gt;&lt;provider_specific_part&gt;</code>.</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Example:</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * <code>scm:svn:<a href="https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code>" target="alexandria_uri">https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code></a></em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// CHECKSTYLE_ON: LineLength</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> @Parameter( -<a class="jxr_linenumber" name="L81" href="#L81">81</a> property = <span class="jxr_string">"scmpublish.pubScmUrl"</span>, -<a class="jxr_linenumber" name="L82" href="#L82">82</a> defaultValue = <span class="jxr_string">"${project.distributionManagement.site.url}"</span>, -<a class="jxr_linenumber" name="L83" href="#L83">83</a> required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">protected</strong> String pubScmUrl; -<a class="jxr_linenumber" name="L85" href="#L85">85</a> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * of delete then checkout.</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> @Parameter(property = <span class="jxr_string">"scmpublish.tryUpdate"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> tryUpdate; -<a class="jxr_linenumber" name="L92" href="#L92">92</a> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">// CHECKSTYLE_OFF: LineLength</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Location where the scm check-out is done. By default, scm checkout is done in build (target) directory,</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * which is deleted on every <code>mvn clean</code>. To avoid this and get better performance, configure</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * this location outside build structure and set <code>tryUpdate</code> to <code>true</code>.</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * See <a href="<a href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html" target="alexandria_uri">http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html</a>#Improving_SCM_Checkout_Performance"></em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * Improving SCM Checkout Performance</a> for more information.</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">// CHECKSTYLE_ON: LineLength</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> @Parameter( -<a class="jxr_linenumber" name="L103" href="#L103">103</a> property = <span class="jxr_string">"scmpublish.checkoutDirectory"</span>, -<a class="jxr_linenumber" name="L104" href="#L104">104</a> defaultValue = <span class="jxr_string">"${project.build.directory}/scmpublish-checkout"</span>) -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">protected</strong> File checkoutDirectory; -<a class="jxr_linenumber" name="L106" href="#L106">106</a> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Location where the content is published inside the <code>${checkoutDirectory}</code>.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * By default, content is copyed at the root of <code>${checkoutDirectory}</code>.</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> @Parameter(property = <span class="jxr_string">"scmpublish.subDirectory"</span>) -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">protected</strong> String subDirectory; -<a class="jxr_linenumber" name="L113" href="#L113">113</a> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * Display list of added, deleted, and changed files, but do not do any actual SCM operations.</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> @Parameter(property = <span class="jxr_string">"scmpublish.dryRun"</span>) -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> dryRun; -<a class="jxr_linenumber" name="L119" href="#L119">119</a> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Set this to 'true' to skip site deployment.</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @deprecated Please use {@link #skipDeployment}.</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Deprecated -<a class="jxr_linenumber" name="L126" href="#L126">126</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipDeployement; -<a class="jxr_linenumber" name="L128" href="#L128">128</a> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Set this to 'true' to skip site deployment.</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Parameter(property = <span class="jxr_string">"scmpublish.skipDeploy"</span>, alias = <span class="jxr_string">"maven.site.deploy.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipDeployment; -<a class="jxr_linenumber" name="L134" href="#L134">134</a> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Run add and delete commands, but leave the actually checkin for the user to run manually.</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> @Parameter(property = <span class="jxr_string">"scmpublish.skipCheckin"</span>) -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipCheckin; -<a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * SCM log/checkin comment for this publication.</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Parameter(property = <span class="jxr_string">"scmpublish.checkinComment"</span>, defaultValue = <span class="jxr_string">"Site checkin for project ${project.name}"</span>) -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> String checkinComment; -<a class="jxr_linenumber" name="L146" href="#L146">146</a> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Patterns to exclude from the scm tree.</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">protected</strong> String excludes; -<a class="jxr_linenumber" name="L152" href="#L152">152</a> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Patterns to include in the scm tree.</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> @Parameter -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">protected</strong> String includes; -<a class="jxr_linenumber" name="L158" href="#L158">158</a> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * List of SCM provider implementations.</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Key is the provider type, eg. <code>cvs</code>.</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * Value is the provider implementation (the role-hint of the provider), eg. <code>cvs</code> or</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * <code>cvs_native</code>.</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @see ScmManager.setScmProviderImplementation</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> @Parameter -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> Map<String, String> providerImplementations; -<a class="jxr_linenumber" name="L168" href="#L168">168</a> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * The SCM manager.</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> @Component -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">private</strong> ScmManager scmManager; -<a class="jxr_linenumber" name="L174" href="#L174">174</a> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * Tool that gets a configured SCM repository from release configuration.</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> @Component -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">protected</strong> ScmRepositoryConfigurator scmRepositoryConfigurator; -<a class="jxr_linenumber" name="L180" href="#L180">180</a> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * The serverId specified in the settings.xml, which should be used for the authentication.</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> @Parameter -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> String serverId; -<a class="jxr_linenumber" name="L186" href="#L186">186</a> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * The SCM username to use.</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> @Parameter(property = <span class="jxr_string">"username"</span>) -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> String username; -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * The SCM password to use.</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.apache.maven.settings.Settings; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.config.ReleaseDescriptor; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.config.ReleaseDescriptorBuilder; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.release.scm.ScmRepositoryConfigurator; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.logging.MessageUtils; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Base class for the scm-publish mojos.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractScmPublishMojo" href="../../../../../org/apache/maven/plugins/scmpublish/AbstractScmPublishMojo.html#AbstractScmPublishMojo">AbstractScmPublishMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_comment">// CHECKSTYLE_OFF: LineLength</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Location of the scm publication tree:</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * <code>scm:&lt;scm_provider&gt;&lt;delimiter&gt;&lt;provider_specific_part&gt;</code>.</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Example:</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <code>scm:svn:<a href="https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code>" target="alexandria_uri">https://svn.apache.org/repos/infra/websites/production/maven/content/plugins/maven-scm-publish-plugin-LATEST/</code></a></em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_comment">// CHECKSTYLE_ON: LineLength</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Parameter( +<a class="jxr_linenumber" name="L76" href="#L76">76</a> property = <span class="jxr_string">"scmpublish.pubScmUrl"</span>, +<a class="jxr_linenumber" name="L77" href="#L77">77</a> defaultValue = <span class="jxr_string">"${project.distributionManagement.site.url}"</span>, +<a class="jxr_linenumber" name="L78" href="#L78">78</a> required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">protected</strong> String pubScmUrl; +<a class="jxr_linenumber" name="L80" href="#L80">80</a> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * If the checkout directory exists and this flag is activated, the plugin will try an SCM-update instead</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * of delete then checkout.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Parameter(property = <span class="jxr_string">"scmpublish.tryUpdate"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> tryUpdate; +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// CHECKSTYLE_OFF: LineLength</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Location where the scm check-out is done. By default, scm checkout is done in build (target) directory,</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * which is deleted on every <code>mvn clean</code>. To avoid this and get better performance, configure</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * this location outside build structure and set <code>tryUpdate</code> to <code>true</code>.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * See <a href="<a href="http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html" target="alexandria_uri">http://maven.apache.org/plugins/maven-scm-publish-plugin/various-tips.html</a>#Improving_SCM_Checkout_Performance"></em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Improving SCM Checkout Performance</a> for more information.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_comment">// CHECKSTYLE_ON: LineLength</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Parameter( +<a class="jxr_linenumber" name="L98" href="#L98">98</a> property = <span class="jxr_string">"scmpublish.checkoutDirectory"</span>, +<a class="jxr_linenumber" name="L99" href="#L99">99</a> defaultValue = <span class="jxr_string">"${project.build.directory}/scmpublish-checkout"</span>) +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> File checkoutDirectory; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Location where the content is published inside the <code>${checkoutDirectory}</code>.</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * By default, content is copyed at the root of <code>${checkoutDirectory}</code>.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> @Parameter(property = <span class="jxr_string">"scmpublish.subDirectory"</span>) +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">protected</strong> String subDirectory; +<a class="jxr_linenumber" name="L108" href="#L108">108</a> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * Display list of added, deleted, and changed files, but do not do any actual SCM operations.</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Parameter(property = <span class="jxr_string">"scmpublish.dryRun"</span>) +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> dryRun; +<a class="jxr_linenumber" name="L114" href="#L114">114</a> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Set this to 'true' to skip site deployment.</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @deprecated Please use {@link #skipDeployment}.</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> @Deprecated +<a class="jxr_linenumber" name="L121" href="#L121">121</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipDeployement; +<a class="jxr_linenumber" name="L123" href="#L123">123</a> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * Set this to 'true' to skip site deployment.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter(property = <span class="jxr_string">"scmpublish.skipDeploy"</span>, alias = <span class="jxr_string">"maven.site.deploy.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipDeployment; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Run add and delete commands, but leave the actually checkin for the user to run manually.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> @Parameter(property = <span class="jxr_string">"scmpublish.skipCheckin"</span>) +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipCheckin; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * SCM log/checkin comment for this publication.</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> @Parameter(property = <span class="jxr_string">"scmpublish.checkinComment"</span>, defaultValue = <span class="jxr_string">"Site checkin for project ${project.name}"</span>) +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">private</strong> String checkinComment; +<a class="jxr_linenumber" name="L141" href="#L141">141</a> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Patterns to exclude from the scm tree.</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">protected</strong> String excludes; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Patterns to include in the scm tree.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> @Parameter +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">protected</strong> String includes; +<a class="jxr_linenumber" name="L153" href="#L153">153</a> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * List of SCM provider implementations.</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Key is the provider type, eg. <code>cvs</code>.</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Value is the provider implementation (the role-hint of the provider), eg. <code>cvs</code> or</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * <code>cvs_native</code>.</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @see ScmManager.setScmProviderImplementation</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Parameter +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">private</strong> Map<String, String> providerImplementations; +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * The SCM manager.</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> @Component +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">private</strong> ScmManager scmManager; +<a class="jxr_linenumber" name="L169" href="#L169">169</a> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Tool that gets a configured SCM repository from release configuration.</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> @Component +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">protected</strong> ScmRepositoryConfigurator scmRepositoryConfigurator; +<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * The server id specified in the {@code settings.xml}, which should be used for the authentication.</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="https://maven.apache.org/settings.html" target="alexandria_uri">https://maven.apache.org/settings.html</a>#servers">Settings Reference</a></em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> @Parameter(property = <span class="jxr_string">"scmpublish.serverId"</span>, defaultValue = <span class="jxr_string">"${project.distributionManagement.site.id}"</span>) +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">private</strong> String serverId; +<a class="jxr_linenumber" name="L182" href="#L182">182</a> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * The SCM username to use.</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * This value takes precedence over the username derived from {@link #serverId}.</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @see #serverId</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> @Parameter(property = <span class="jxr_string">"username"</span>) +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">protected</strong> String username; +<a class="jxr_linenumber" name="L190" href="#L190">190</a> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * The SCM password to use.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * This value takes precedence over the password derived from {@link #serverId}.</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @see #serverId</em> <a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L196" href="#L196">196</a> @Parameter(property = <span class="jxr_string">"password"</span>) <a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">protected</strong> String password; @@ -242,447 +242,419 @@ <a class="jxr_linenumber" name="L234" href="#L234">234</a> @Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) <a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">protected</strong> Settings settings; <a class="jxr_linenumber" name="L236" href="#L236">236</a> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> @Component -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">private</strong> SettingsDecrypter settingsDecrypter; -<a class="jxr_linenumber" name="L239" href="#L239">239</a> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * Collections of paths not to delete when checking content to delete.</em> -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * If your site has subdirectories published by an other mechanism/build</em> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> @Parameter -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">protected</strong> String[] ignorePathsToDelete; -<a class="jxr_linenumber" name="L246" href="#L246">246</a> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * SCM branch to use. For github, you must configure with <code>gh-pages</code>.</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> @Parameter(property = <span class="jxr_string">"scmpublish.scm.branch"</span>) -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">protected</strong> String scmBranch; -<a class="jxr_linenumber" name="L252" href="#L252">252</a> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Configure svn automatic remote url creation.</em> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> @Parameter(property = <span class="jxr_string">"scmpublish.automaticRemotePathCreation"</span>, defaultValue = <span class="jxr_string">"true"</span>) -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> automaticRemotePathCreation; -<a class="jxr_linenumber" name="L258" href="#L258">258</a> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * Filename extensions of files which need new line normalization.</em> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] NORMALIZE_EXTENSIONS = {<span class="jxr_string">"html"</span>, <span class="jxr_string">"css"</span>, <span class="jxr_string">"js"</span>}; -<a class="jxr_linenumber" name="L263" href="#L263">263</a> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Extra file extensions to normalize line ending (will be added to default</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * <code>html</code>,<code>css</code>,<code>js</code> list)</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> @Parameter -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">protected</strong> String[] extraNormalizeExtensions; -<a class="jxr_linenumber" name="L270" href="#L270">270</a> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">private</strong> Set<String> normalizeExtensions; -<a class="jxr_linenumber" name="L272" href="#L272">272</a> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">protected</strong> ScmProvider scmProvider; -<a class="jxr_linenumber" name="L274" href="#L274">274</a> -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">protected</strong> ScmRepository scmRepository; -<a class="jxr_linenumber" name="L276" href="#L276">276</a> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logInfo(String format, Object... params) { -<a class="jxr_linenumber" name="L278" href="#L278">278</a> getLog().info(String.format(format, params)); -<a class="jxr_linenumber" name="L279" href="#L279">279</a> } -<a class="jxr_linenumber" name="L280" href="#L280">280</a> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logWarn(String format, Object... params) { -<a class="jxr_linenumber" name="L282" href="#L282">282</a> getLog().warn(String.format(format, params)); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logError(String format, Object... params) { -<a class="jxr_linenumber" name="L286" href="#L286">286</a> getLog().error(String.format(format, params)); -<a class="jxr_linenumber" name="L287" href="#L287">287</a> } -<a class="jxr_linenumber" name="L288" href="#L288">288</a> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">private</strong> File relativize(File base, File file) { -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(base.toURI().relativize(file.toURI()).getPath()); -<a class="jxr_linenumber" name="L291" href="#L291">291</a> } -<a class="jxr_linenumber" name="L292" href="#L292">292</a> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> requireNormalizeNewlines(File f) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">if</strong> (normalizeExtensions == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L295" href="#L295">295</a> normalizeExtensions = <strong class="jxr_keyword">new</strong> HashSet<>(Arrays.asList(NORMALIZE_EXTENSIONS)); -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">if</strong> (extraNormalizeExtensions != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L297" href="#L297">297</a> normalizeExtensions.addAll(Arrays.asList(extraNormalizeExtensions)); -<a class="jxr_linenumber" name="L298" href="#L298">298</a> } -<a class="jxr_linenumber" name="L299" href="#L299">299</a> } +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Collections of paths not to delete when checking content to delete.</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * If your site has subdirectories published by an other mechanism/build</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> @Parameter +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">protected</strong> String[] ignorePathsToDelete; +<a class="jxr_linenumber" name="L243" href="#L243">243</a> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * SCM branch to use. For github, you must configure with <code>gh-pages</code>.</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> @Parameter(property = <span class="jxr_string">"scmpublish.scm.branch"</span>) +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">protected</strong> String scmBranch; +<a class="jxr_linenumber" name="L249" href="#L249">249</a> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * Configure svn automatic remote url creation.</em> +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> @Parameter(property = <span class="jxr_string">"scmpublish.automaticRemotePathCreation"</span>, defaultValue = <span class="jxr_string">"true"</span>) +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> automaticRemotePathCreation; +<a class="jxr_linenumber" name="L255" href="#L255">255</a> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * Filename extensions of files which need new line normalization.</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String[] NORMALIZE_EXTENSIONS = {<span class="jxr_string">"html"</span>, <span class="jxr_string">"css"</span>, <span class="jxr_string">"js"</span>}; +<a class="jxr_linenumber" name="L260" href="#L260">260</a> +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * Extra file extensions to normalize line ending (will be added to default</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * <code>html</code>,<code>css</code>,<code>js</code> list)</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> @Parameter +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">protected</strong> String[] extraNormalizeExtensions; +<a class="jxr_linenumber" name="L267" href="#L267">267</a> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">private</strong> Set<String> normalizeExtensions; +<a class="jxr_linenumber" name="L269" href="#L269">269</a> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">protected</strong> ScmProvider scmProvider; +<a class="jxr_linenumber" name="L271" href="#L271">271</a> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">protected</strong> ScmRepository scmRepository; +<a class="jxr_linenumber" name="L273" href="#L273">273</a> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logInfo(String format, Object... params) { +<a class="jxr_linenumber" name="L275" href="#L275">275</a> getLog().info(String.format(format, params)); +<a class="jxr_linenumber" name="L276" href="#L276">276</a> } +<a class="jxr_linenumber" name="L277" href="#L277">277</a> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logWarn(String format, Object... params) { +<a class="jxr_linenumber" name="L279" href="#L279">279</a> getLog().warn(String.format(format, params)); +<a class="jxr_linenumber" name="L280" href="#L280">280</a> } +<a class="jxr_linenumber" name="L281" href="#L281">281</a> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> logError(String format, Object... params) { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> getLog().error(String.format(format, params)); +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">private</strong> File relativize(File base, File file) { +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(base.toURI().relativize(file.toURI()).getPath()); +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> requireNormalizeNewlines(File f) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">if</strong> (normalizeExtensions == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L292" href="#L292">292</a> normalizeExtensions = <strong class="jxr_keyword">new</strong> HashSet<>(Arrays.asList(NORMALIZE_EXTENSIONS)); +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">if</strong> (extraNormalizeExtensions != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L294" href="#L294">294</a> normalizeExtensions.addAll(Arrays.asList(extraNormalizeExtensions)); +<a class="jxr_linenumber" name="L295" href="#L295">295</a> } +<a class="jxr_linenumber" name="L296" href="#L296">296</a> } +<a class="jxr_linenumber" name="L297" href="#L297">297</a> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">return</strong> FilenameUtils.isExtension(f.getName(), normalizeExtensions); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> } <a class="jxr_linenumber" name="L300" href="#L300">300</a> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">return</strong> FilenameUtils.isExtension(f.getName(), normalizeExtensions); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> } -<a class="jxr_linenumber" name="L303" href="#L303">303</a> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">private</strong> ReleaseDescriptor setupScm() <strong class="jxr_keyword">throws</strong> ScmRepositoryException, NoSuchScmProviderException { -<a class="jxr_linenumber" name="L305" href="#L305">305</a> String scmUrl; -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">if</strong> (localCheckout) { -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_comment">// in the release phase we have to change the checkout URL</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_comment">// to do a local checkout instead of going over the network.</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setupScm() <strong class="jxr_keyword">throws</strong> ScmRepositoryException, NoSuchScmProviderException { +<a class="jxr_linenumber" name="L302" href="#L302">302</a> String scmUrl; +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">if</strong> (localCheckout) { +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_comment">// in the release phase we have to change the checkout URL</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_comment">// to do a local checkout instead of going over the network.</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> +<a class="jxr_linenumber" name="L307" href="#L307">307</a> String provider = ScmUrlUtils.getProvider(pubScmUrl); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> String delimiter = ScmUrlUtils.getDelimiter(pubScmUrl); <a class="jxr_linenumber" name="L309" href="#L309">309</a> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> String provider = ScmUrlUtils.getProvider(pubScmUrl); -<a class="jxr_linenumber" name="L311" href="#L311">311</a> String delimiter = ScmUrlUtils.getDelimiter(pubScmUrl); -<a class="jxr_linenumber" name="L312" href="#L312">312</a> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> String providerPart = <span class="jxr_string">"scm:"</span> + provider + delimiter; -<a class="jxr_linenumber" name="L314" href="#L314">314</a> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_comment">// X TODO: also check the information from releaseDescriptor.getScmRelativePathProjectDirectory()</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_comment">// X TODO: in case our toplevel git directory has no pom.</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_comment">// X TODO: fix pathname once I understand this.</em> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> scmUrl = providerPart + <span class="jxr_string">"file://"</span> + <span class="jxr_string">"target/localCheckout"</span>; -<a class="jxr_linenumber" name="L319" href="#L319">319</a> logInfo(<span class="jxr_string">"Performing a LOCAL checkout from "</span> + scmUrl); -<a class="jxr_linenumber" name="L320" href="#L320">320</a> } +<a class="jxr_linenumber" name="L310" href="#L310">310</a> String providerPart = <span class="jxr_string">"scm:"</span> + provider + delimiter; +<a class="jxr_linenumber" name="L311" href="#L311">311</a> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_comment">// X TODO: also check the information from releaseDescriptor.getScmRelativePathProjectDirectory()</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_comment">// X TODO: in case our toplevel git directory has no pom.</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_comment">// X TODO: fix pathname once I understand this.</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> scmUrl = providerPart + <span class="jxr_string">"file://"</span> + <span class="jxr_string">"target/localCheckout"</span>; +<a class="jxr_linenumber" name="L316" href="#L316">316</a> logInfo(<span class="jxr_string">"Performing a LOCAL checkout from "</span> + scmUrl); +<a class="jxr_linenumber" name="L317" href="#L317">317</a> } +<a class="jxr_linenumber" name="L318" href="#L318">318</a> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> ReleaseDescriptorBuilder descriptorBuilder = <strong class="jxr_keyword">new</strong> ReleaseDescriptorBuilder(); +<a class="jxr_linenumber" name="L320" href="#L320">320</a> descriptorBuilder.setInteractive(settings.isInteractiveMode()); <a class="jxr_linenumber" name="L321" href="#L321">321</a> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> ReleaseDescriptorBuilder descriptorBuilder = <strong class="jxr_keyword">new</strong> ReleaseDescriptorBuilder(); -<a class="jxr_linenumber" name="L323" href="#L323">323</a> descriptorBuilder.setInteractive(settings.isInteractiveMode()); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (username == <strong class="jxr_keyword">null</strong> || password == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">for</strong> (Server server : settings.getServers()) { -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">if</strong> (server.getId().equals(serverId)) { -<a class="jxr_linenumber" name="L328" href="#L328">328</a> SettingsDecryptionRequest decryptionRequest = <strong class="jxr_keyword">new</strong> DefaultSettingsDecryptionRequest(server); +<a class="jxr_linenumber" name="L322" href="#L322">322</a> descriptorBuilder.setScmPassword(password); +<a class="jxr_linenumber" name="L323" href="#L323">323</a> descriptorBuilder.setScmUsername(username); +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_comment">// used for lookup of credentials from settings.xml in DefaultScmRepositoryConfigurator</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> descriptorBuilder.setScmId(serverId); +<a class="jxr_linenumber" name="L326" href="#L326">326</a> descriptorBuilder.setWorkingDirectory(basedir.getAbsolutePath()); +<a class="jxr_linenumber" name="L327" href="#L327">327</a> descriptorBuilder.setLocalCheckout(localCheckout); +<a class="jxr_linenumber" name="L328" href="#L328">328</a> descriptorBuilder.setScmSourceUrl(pubScmUrl); <a class="jxr_linenumber" name="L329" href="#L329">329</a> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> SettingsDecryptionResult decryptionResult = settingsDecrypter.decrypt(decryptionRequest); -<a class="jxr_linenumber" name="L331" href="#L331">331</a> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">if</strong> (!decryptionResult.getProblems().isEmpty()) { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_comment">// todo throw exception?</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> } -<a class="jxr_linenumber" name="L335" href="#L335">335</a> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">if</strong> (username == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L337" href="#L337">337</a> username = decryptionResult.getServer().getUsername(); -<a class="jxr_linenumber" name="L338" href="#L338">338</a> } -<a class="jxr_linenumber" name="L339" href="#L339">339</a> -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> (password == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> password = decryptionResult.getServer().getPassword(); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L345" href="#L345">345</a> } -<a class="jxr_linenumber" name="L346" href="#L346">346</a> } -<a class="jxr_linenumber" name="L347" href="#L347">347</a> } -<a class="jxr_linenumber" name="L348" href="#L348">348</a> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> descriptorBuilder.setScmPassword(password); -<a class="jxr_linenumber" name="L350" href="#L350">350</a> descriptorBuilder.setScmUsername(username); -<a class="jxr_linenumber" name="L351" href="#L351">351</a> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> descriptorBuilder.setWorkingDirectory(basedir.getAbsolutePath()); -<a class="jxr_linenumber" name="L353" href="#L353">353</a> descriptorBuilder.setLocalCheckout(localCheckout); -<a class="jxr_linenumber" name="L354" href="#L354">354</a> descriptorBuilder.setScmSourceUrl(pubScmUrl); -<a class="jxr_linenumber" name="L355" href="#L355">355</a> -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">if</strong> (providerImplementations != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, String> providerEntry : providerImplementations.entrySet()) { -<a class="jxr_linenumber" name="L358" href="#L358">358</a> logInfo( -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <span class="jxr_string">"Changing the default '%s' provider implementation to '%s'."</span>, -<a class="jxr_linenumber" name="L360" href="#L360">360</a> providerEntry.getKey(), providerEntry.getValue()); -<a class="jxr_linenumber" name="L361" href="#L361">361</a> scmManager.setScmProviderImplementation(providerEntry.getKey(), providerEntry.getValue()); -<a class="jxr_linenumber" name="L362" href="#L362">362</a> } -<a class="jxr_linenumber" name="L363" href="#L363">363</a> } +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">if</strong> (providerImplementations != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, String> providerEntry : providerImplementations.entrySet()) { +<a class="jxr_linenumber" name="L332" href="#L332">332</a> logInfo( +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <span class="jxr_string">"Changing the default '%s' provider implementation to '%s'."</span>, +<a class="jxr_linenumber" name="L334" href="#L334">334</a> providerEntry.getKey(), providerEntry.getValue()); +<a class="jxr_linenumber" name="L335" href="#L335">335</a> scmManager.setScmProviderImplementation(providerEntry.getKey(), providerEntry.getValue()); +<a class="jxr_linenumber" name="L336" href="#L336">336</a> } +<a class="jxr_linenumber" name="L337" href="#L337">337</a> } +<a class="jxr_linenumber" name="L338" href="#L338">338</a> +<a class="jxr_linenumber" name="L339" href="#L339">339</a> ReleaseDescriptor releaseDescriptor = descriptorBuilder.build(); +<a class="jxr_linenumber" name="L340" href="#L340">340</a> scmRepository = scmRepositoryConfigurator.getConfiguredRepository(releaseDescriptor, settings); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> +<a class="jxr_linenumber" name="L342" href="#L342">342</a> scmProvider = scmRepositoryConfigurator.getRepositoryProvider(scmRepository); +<a class="jxr_linenumber" name="L343" href="#L343">343</a> } +<a class="jxr_linenumber" name="L344" href="#L344">344</a> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkoutExisting() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L346" href="#L346">346</a> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> (scmProvider instanceof AbstractSvnScmProvider) { +<a class="jxr_linenumber" name="L348" href="#L348">348</a> checkCreateRemoteSvnPath(); +<a class="jxr_linenumber" name="L349" href="#L349">349</a> } +<a class="jxr_linenumber" name="L350" href="#L350">350</a> +<a class="jxr_linenumber" name="L351" href="#L351">351</a> logInfo( +<a class="jxr_linenumber" name="L352" href="#L352">352</a> MessageUtils.buffer().strong(<span class="jxr_string">"%s"</span>) + <span class="jxr_string">" the pub tree from "</span> +<a class="jxr_linenumber" name="L353" href="#L353">353</a> + MessageUtils.buffer().strong(<span class="jxr_string">"%s"</span>) + <span class="jxr_string">" into %s"</span>, +<a class="jxr_linenumber" name="L354" href="#L354">354</a> (tryUpdate ? <span class="jxr_string">"Updating"</span> : <span class="jxr_string">"Checking out"</span>), +<a class="jxr_linenumber" name="L355" href="#L355">355</a> pubScmUrl, +<a class="jxr_linenumber" name="L356" href="#L356">356</a> checkoutDirectory); +<a class="jxr_linenumber" name="L357" href="#L357">357</a> +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">if</strong> (checkoutDirectory.exists() && !tryUpdate) { +<a class="jxr_linenumber" name="L359" href="#L359">359</a> +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L361" href="#L361">361</a> FileUtils.deleteDirectory(checkoutDirectory); +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L363" href="#L363">363</a> logError(e.getMessage()); <a class="jxr_linenumber" name="L364" href="#L364">364</a> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> ReleaseDescriptor releaseDescriptor = descriptorBuilder.build(); -<a class="jxr_linenumber" name="L366" href="#L366">366</a> scmRepository = scmRepositoryConfigurator.getConfiguredRepository(releaseDescriptor, settings); -<a class="jxr_linenumber" name="L367" href="#L367">367</a> -<a class="jxr_linenumber" name="L368" href="#L368">368</a> scmProvider = scmRepositoryConfigurator.getRepositoryProvider(scmRepository); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">return</strong> releaseDescriptor; -<a class="jxr_linenumber" name="L371" href="#L371">371</a> } +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to remove old checkout directory: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L366" href="#L366">366</a> } +<a class="jxr_linenumber" name="L367" href="#L367">367</a> } +<a class="jxr_linenumber" name="L368" href="#L368">368</a> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">boolean</strong> forceCheckout = false; +<a class="jxr_linenumber" name="L370" href="#L370">370</a> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> (!checkoutDirectory.exists()) { <a class="jxr_linenumber" name="L372" href="#L372">372</a> -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkoutExisting() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L374" href="#L374">374</a> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">if</strong> (scmProvider instanceof AbstractSvnScmProvider) { -<a class="jxr_linenumber" name="L376" href="#L376">376</a> checkCreateRemoteSvnPath(); -<a class="jxr_linenumber" name="L377" href="#L377">377</a> } -<a class="jxr_linenumber" name="L378" href="#L378">378</a> -<a class="jxr_linenumber" name="L379" href="#L379">379</a> logInfo( -<a class="jxr_linenumber" name="L380" href="#L380">380</a> MessageUtils.buffer().strong(<span class="jxr_string">"%s"</span>) + <span class="jxr_string">" the pub tree from "</span> -<a class="jxr_linenumber" name="L381" href="#L381">381</a> + MessageUtils.buffer().strong(<span class="jxr_string">"%s"</span>) + <span class="jxr_string">" into %s"</span>, -<a class="jxr_linenumber" name="L382" href="#L382">382</a> (tryUpdate ? <span class="jxr_string">"Updating"</span> : <span class="jxr_string">"Checking out"</span>), -<a class="jxr_linenumber" name="L383" href="#L383">383</a> pubScmUrl, -<a class="jxr_linenumber" name="L384" href="#L384">384</a> checkoutDirectory); -<a class="jxr_linenumber" name="L385" href="#L385">385</a> -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">if</strong> (checkoutDirectory.exists() && !tryUpdate) { -<a class="jxr_linenumber" name="L387" href="#L387">387</a> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L389" href="#L389">389</a> FileUtils.deleteDirectory(checkoutDirectory); -<a class="jxr_linenumber" name="L390" href="#L390">390</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L391" href="#L391">391</a> logError(e.getMessage()); -<a class="jxr_linenumber" name="L392" href="#L392">392</a> -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to remove old checkout directory: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L394" href="#L394">394</a> } -<a class="jxr_linenumber" name="L395" href="#L395">395</a> } -<a class="jxr_linenumber" name="L396" href="#L396">396</a> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">boolean</strong> forceCheckout = false; -<a class="jxr_linenumber" name="L398" href="#L398">398</a> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">if</strong> (!checkoutDirectory.exists()) { -<a class="jxr_linenumber" name="L400" href="#L400">400</a> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">if</strong> (tryUpdate) { -<a class="jxr_linenumber" name="L402" href="#L402">402</a> logInfo(<span class="jxr_string">"TryUpdate is configured but no local copy currently available: forcing checkout."</span>); -<a class="jxr_linenumber" name="L403" href="#L403">403</a> } -<a class="jxr_linenumber" name="L404" href="#L404">404</a> checkoutDirectory.mkdirs(); -<a class="jxr_linenumber" name="L405" href="#L405">405</a> forceCheckout = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L406" href="#L406">406</a> } -<a class="jxr_linenumber" name="L407" href="#L407">407</a> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L409" href="#L409">409</a> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(checkoutDirectory, includes, excludes); -<a class="jxr_linenumber" name="L410" href="#L410">410</a> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> ScmBranch branch = (scmBranch == <strong class="jxr_keyword">null</strong>) ? <strong class="jxr_keyword">null</strong> : <strong class="jxr_keyword">new</strong> ScmBranch(scmBranch); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> -<a class="jxr_linenumber" name="L413" href="#L413">413</a> ScmResult scmResult = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">if</strong> (tryUpdate && !forceCheckout) { -<a class="jxr_linenumber" name="L415" href="#L415">415</a> scmResult = scmProvider.update(scmRepository, fileSet, branch); -<a class="jxr_linenumber" name="L416" href="#L416">416</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">int</strong> attempt = 0; -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">while</strong> (scmResult == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L420" href="#L420">420</a> scmResult = scmProvider.checkOut(scmRepository, fileSet, branch); -<a class="jxr_linenumber" name="L421" href="#L421">421</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_comment">// give it max 2 times to retry</em> -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">if</strong> (attempt++ < 2) { -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_comment">// wait 3 seconds</em> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> Thread.sleep(3 * 1000); -<a class="jxr_linenumber" name="L427" href="#L427">427</a> } <strong class="jxr_keyword">catch</strong> (InterruptedException ie) { -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_comment">// noop</em> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> } -<a class="jxr_linenumber" name="L430" href="#L430">430</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">throw</strong> e; -<a class="jxr_linenumber" name="L432" href="#L432">432</a> } -<a class="jxr_linenumber" name="L433" href="#L433">433</a> } -<a class="jxr_linenumber" name="L434" href="#L434">434</a> } -<a class="jxr_linenumber" name="L435" href="#L435">435</a> } -<a class="jxr_linenumber" name="L436" href="#L436">436</a> checkScmResult(scmResult, <span class="jxr_string">"check out from SCM"</span>); -<a class="jxr_linenumber" name="L437" href="#L437">437</a> } <strong class="jxr_keyword">catch</strong> (ScmException | IOException e) { -<a class="jxr_linenumber" name="L438" href="#L438">438</a> logError(e.getMessage()); +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">if</strong> (tryUpdate) { +<a class="jxr_linenumber" name="L374" href="#L374">374</a> logInfo(<span class="jxr_string">"TryUpdate is configured but no local copy currently available: forcing checkout."</span>); +<a class="jxr_linenumber" name="L375" href="#L375">375</a> } +<a class="jxr_linenumber" name="L376" href="#L376">376</a> checkoutDirectory.mkdirs(); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> forceCheckout = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L378" href="#L378">378</a> } +<a class="jxr_linenumber" name="L379" href="#L379">379</a> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L381" href="#L381">381</a> ScmFileSet fileSet = <strong class="jxr_keyword">new</strong> ScmFileSet(checkoutDirectory, includes, excludes); +<a class="jxr_linenumber" name="L382" href="#L382">382</a> +<a class="jxr_linenumber" name="L383" href="#L383">383</a> ScmBranch branch = (scmBranch == <strong class="jxr_keyword">null</strong>) ? <strong class="jxr_keyword">null</strong> : <strong class="jxr_keyword">new</strong> ScmBranch(scmBranch); +<a class="jxr_linenumber" name="L384" href="#L384">384</a> +<a class="jxr_linenumber" name="L385" href="#L385">385</a> ScmResult scmResult = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">if</strong> (tryUpdate && !forceCheckout) { +<a class="jxr_linenumber" name="L387" href="#L387">387</a> scmResult = scmProvider.update(scmRepository, fileSet, branch); +<a class="jxr_linenumber" name="L388" href="#L388">388</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">int</strong> attempt = 0; +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">while</strong> (scmResult == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L392" href="#L392">392</a> scmResult = scmProvider.checkOut(scmRepository, fileSet, branch); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { +<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_comment">// give it max 2 times to retry</em> +<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">if</strong> (attempt++ < 2) { +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_comment">// wait 3 seconds</em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> Thread.sleep(3 * 1000); +<a class="jxr_linenumber" name="L399" href="#L399">399</a> } <strong class="jxr_keyword">catch</strong> (InterruptedException ie) { +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_comment">// noop</em> +<a class="jxr_linenumber" name="L401" href="#L401">401</a> } +<a class="jxr_linenumber" name="L402" href="#L402">402</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">throw</strong> e; +<a class="jxr_linenumber" name="L404" href="#L404">404</a> } +<a class="jxr_linenumber" name="L405" href="#L405">405</a> } +<a class="jxr_linenumber" name="L406" href="#L406">406</a> } +<a class="jxr_linenumber" name="L407" href="#L407">407</a> } +<a class="jxr_linenumber" name="L408" href="#L408">408</a> checkScmResult(scmResult, <span class="jxr_string">"check out from SCM"</span>); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> } <strong class="jxr_keyword">catch</strong> (ScmException | IOException e) { +<a class="jxr_linenumber" name="L410" href="#L410">410</a> logError(e.getMessage()); +<a class="jxr_linenumber" name="L411" href="#L411">411</a> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"An error occurred during the checkout process: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L413" href="#L413">413</a> } +<a class="jxr_linenumber" name="L414" href="#L414">414</a> } +<a class="jxr_linenumber" name="L415" href="#L415">415</a> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkCreateRemoteSvnPath() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L417" href="#L417">417</a> getLog().debug(<span class="jxr_string">"AbstractSvnScmProvider used, so we can check if remote url exists and eventually create it."</span>); +<a class="jxr_linenumber" name="L418" href="#L418">418</a> AbstractSvnScmProvider svnScmProvider = (AbstractSvnScmProvider) scmProvider; +<a class="jxr_linenumber" name="L419" href="#L419">419</a> +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">boolean</strong> remoteExists = svnScmProvider.remoteUrlExist(scmRepository.getProviderRepository(), <strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L422" href="#L422">422</a> +<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">if</strong> (remoteExists) { +<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L425" href="#L425">425</a> } +<a class="jxr_linenumber" name="L426" href="#L426">426</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) { +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(e.getMessage(), e); +<a class="jxr_linenumber" name="L428" href="#L428">428</a> } +<a class="jxr_linenumber" name="L429" href="#L429">429</a> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> String remoteUrl = ((SvnScmProviderRepository) scmRepository.getProviderRepository()).getUrl(); +<a class="jxr_linenumber" name="L431" href="#L431">431</a> +<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">if</strong> (!automaticRemotePathCreation) { +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_comment">// olamy: return ?? that will fail during checkout IMHO :-)</em> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> logWarn(<span class="jxr_string">"Remote svn url %s does not exist and automatic remote path creation disabled."</span>, remoteUrl); +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L436" href="#L436">436</a> } +<a class="jxr_linenumber" name="L437" href="#L437">437</a> +<a class="jxr_linenumber" name="L438" href="#L438">438</a> logInfo(<span class="jxr_string">"Remote svn url %s does not exist: creating."</span>, remoteUrl); <a class="jxr_linenumber" name="L439" href="#L439">439</a> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"An error occurred during the checkout process: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L441" href="#L441">441</a> } -<a class="jxr_linenumber" name="L442" href="#L442">442</a> } -<a class="jxr_linenumber" name="L443" href="#L443">443</a> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkCreateRemoteSvnPath() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L445" href="#L445">445</a> getLog().debug(<span class="jxr_string">"AbstractSvnScmProvider used, so we can check if remote url exists and eventually create it."</span>); -<a class="jxr_linenumber" name="L446" href="#L446">446</a> AbstractSvnScmProvider svnScmProvider = (AbstractSvnScmProvider) scmProvider; -<a class="jxr_linenumber" name="L447" href="#L447">447</a> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">boolean</strong> remoteExists = svnScmProvider.remoteUrlExist(scmRepository.getProviderRepository(), <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L450" href="#L450">450</a> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">if</strong> (remoteExists) { -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L453" href="#L453">453</a> } -<a class="jxr_linenumber" name="L454" href="#L454">454</a> } <strong class="jxr_keyword">catch</strong> (ScmException e) {
[... 426 lines stripped ...]