Modified: maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/CreateProjectFromArchetypeMojo.html ============================================================================== --- maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/CreateProjectFromArchetypeMojo.html (original) +++ maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/CreateProjectFromArchetypeMojo.html Fri Oct 25 06:12:42 2024 @@ -51,201 +51,211 @@ <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.invoker.InvocationResult; <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.invoker.Invoker; <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.invoker.MavenInvocationException; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Generates a new project from an archetype, or updates the actual project if using a partial archetype.</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * If the project is fully generated, it is generated in a directory corresponding to its artifactId.</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * If the project is updated with a partial archetype, it is done in the current directory.</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @author rafale</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> @Mojo(name = <span class="jxr_string">"generate"</span>, requiresProject = false) -<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Execute(phase = LifecyclePhase.GENERATE_SOURCES) -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CreateProjectFromArchetypeMojo" href="../../../../../org/apache/maven/archetype/mojos/CreateProjectFromArchetypeMojo.html#CreateProjectFromArchetypeMojo">CreateProjectFromArchetypeMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo <strong class="jxr_keyword">implements</strong> ContextEnabled { -<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Component -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> ArchetypeManager manager; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Component -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <a name="ArchetypeSelector" href="../../../../../org/apache/maven/archetype/ui/generation/ArchetypeSelector.html#ArchetypeSelector">ArchetypeSelector</a> selector; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> @Component -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <a name="ArchetypeGenerationConfigurator" href="../../../../../org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.html#ArchetypeGenerationConfigurator">ArchetypeGenerationConfigurator</a> configurator; -<a class="jxr_linenumber" name="L65" href="#L65">65</a> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Component -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> Invoker invoker; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * The archetype's artifactId.</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> @Parameter(property = <span class="jxr_string">"archetypeArtifactId"</span>) -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> String archetypeArtifactId; -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The archetype's groupId.</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> @Parameter(property = <span class="jxr_string">"archetypeGroupId"</span>) -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> String archetypeGroupId; -<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"> * The archetype's version.</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Parameter(property = <span class="jxr_string">"archetypeVersion"</span>) -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> String archetypeVersion; -<a class="jxr_linenumber" name="L86" href="#L86">86</a> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * The archetype catalogs to use to build a list and let the user choose from.</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * It is a comma-separated list of one or more of the following catalog schemes</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * <li><code>local</code> which is the shortcut to the local repository</li></em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * <li><code>remote</code> which is the shortcut for a repository with id {@code archetype},</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * the Maven Central repository (with id {@code central}) or the first matching mirror for either</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * of the repository ids {@code archetype} or {@code central}</li></em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * <li><code>internal</code> which is an <a href="<a href="https://maven.apache.org/archetype/archetype-common/internal.html" target="alexandria_uri">https://maven.apache.org/archetype/archetype-common/internal.html</a>">internal catalog</a></li></em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * If you want the catalog to come from a custom repository, please add</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * a dedicated repository with id {@code archetype} and optionally a server section with the same id to</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * your {@code settings.xml} and use the catalog scheme <code>remote</code>.</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * &lt;repository&gt;</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * &lt;id&gt;archetype&lt;/id&gt;</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * &lt;url&gt;<a href="https://repository.domain.com/path/to/repo/&lt;/url&gt;" target="alexandria_uri">https://repository.domain.com/path/to/repo/&lt;/url&gt;</a></em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * &lt;/repository&gt;</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * &lt;!-- in case of a repository with authentication --&gt;</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * &lt;server&gt;</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * &lt;id&gt;archetype&lt;/id&gt;</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * &lt;username&gt;user.name&lt;/username&gt;</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * &lt;password&gt;s3cr3t&lt;/password&gt;</em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * &lt;/server&gt;</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * In order to use that repository <em>only</em> for resolving the catalog (and not for downloading regular Maven dependencies from it) it is recommended to</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * include the repository in a <a href="<a href="https://maven.apache.org/settings.html" target="alexandria_uri">https://maven.apache.org/settings.html</a>#active-profiles">profile which is not active by default.</a> and explicitly select it via {@code -P<profile-id>}</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * when this goal is called on the command-line.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * In case of mirrors for either repository {@code archetype} or {@code central} the <a href="<a href="https://maven.apache.org/guides/mini/guide-mirror-settings.html" target="alexandria_uri">https://maven.apache.org/guides/mini/guide-mirror-settings.html</a>">matching mirror's id</a> is considered</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * for server settings (like authentication).</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * If the repository's catalog file is empty or cannot be retrieved, <code>internal</code> catalog is transparently used as fallback.</em> -<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> @Parameter(property = <span class="jxr_string">"archetypeCatalog"</span>, defaultValue = <span class="jxr_string">"remote,local"</span>) -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">private</strong> String archetypeCatalog; -<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"> * If set to {@code true} will ask for values also for properties having defaults in the first place.</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Only has an effect if {@link #interactiveMode} is used.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> @Parameter(property = <span class="jxr_string">"askForDefaultPropertyValues"</span>, defaultValue = <span class="jxr_string">"false"</span>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">private</strong> Boolean askForDefaultPropertyValues; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * User settings used to check the interactiveMode.</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> @Parameter(property = <span class="jxr_string">"interactiveMode"</span>, defaultValue = <span class="jxr_string">"${settings.interactiveMode}"</span>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">private</strong> Boolean interactiveMode; -<a class="jxr_linenumber" name="L136" href="#L136">136</a> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}"</span>, property = <span class="jxr_string">"outputDirectory"</span>) -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">private</strong> File outputDirectory; -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> @Parameter(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">private</strong> MavenSession session; -<a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> MavenProject project; -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Goals to immediately run on the project created from the archetype.</em> -<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> @Parameter(property = <span class="jxr_string">"goals"</span>) -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> String goals; -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Applying some filter on displayed archetypes list: format is <code>artifactId</code> or <code>groupId:artifactId</code>.</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * <li><code>org.apache:</code> -> displays all archetypes which contain org.apache in groupId</li></em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * <li><code>:jee</code> or <code>jee</code> -> displays all archetypes which contain jee in artifactId</li></em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * <li><code>org.apache:jee</code> -> displays all archetypes which contain org.apache in groupId AND jee in artifactId</li></em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> @Parameter(property = <span class="jxr_string">"filter"</span>) -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">private</strong> String filter; -<a class="jxr_linenumber" name="L164" href="#L164">164</a> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Override -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L167" href="#L167">167</a> Properties executionProperties = session.getUserProperties(); +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystem; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Generates a new project from an archetype, or updates the actual project if using a partial archetype.</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * If the project is fully generated, it is generated in a directory corresponding to its artifactId.</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * If the project is updated with a partial archetype, it is done in the current directory.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @author rafale</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Mojo(name = <span class="jxr_string">"generate"</span>, requiresProject = false) +<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Execute(phase = LifecyclePhase.GENERATE_SOURCES) +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CreateProjectFromArchetypeMojo" href="../../../../../org/apache/maven/archetype/mojos/CreateProjectFromArchetypeMojo.html#CreateProjectFromArchetypeMojo">CreateProjectFromArchetypeMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo <strong class="jxr_keyword">implements</strong> ContextEnabled { +<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Component +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> ArchetypeManager manager; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Component +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <a name="ArchetypeSelector" href="../../../../../org/apache/maven/archetype/ui/generation/ArchetypeSelector.html#ArchetypeSelector">ArchetypeSelector</a> selector; +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Component +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <a name="ArchetypeGenerationConfigurator" href="../../../../../org/apache/maven/archetype/ui/generation/ArchetypeGenerationConfigurator.html#ArchetypeGenerationConfigurator">ArchetypeGenerationConfigurator</a> configurator; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Component +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> Invoker invoker; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> @Component +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> RepositorySystem repositorySystem; +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<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"> * The archetype's artifactId.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter(property = <span class="jxr_string">"archetypeArtifactId"</span>) +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> String archetypeArtifactId; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * The archetype's groupId.</em> +<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> @Parameter(property = <span class="jxr_string">"archetypeGroupId"</span>) +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> String archetypeGroupId; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * The archetype's version.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> @Parameter(property = <span class="jxr_string">"archetypeVersion"</span>) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> String archetypeVersion; +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * The archetype catalogs to use to build a list and let the user choose from.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * It is a comma-separated list of one or more of the following catalog schemes</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * <li><code>local</code> which is the shortcut to the local repository</li></em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * <li><code>remote</code> which is the shortcut for a repository with id {@code archetype},</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * the Maven Central repository (with id {@code central}) or the first matching mirror for either</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * of the repository ids {@code archetype} or {@code central}</li></em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <li><code>internal</code> which is an <a href="<a href="https://maven.apache.org/archetype/archetype-common/internal.html" target="alexandria_uri">https://maven.apache.org/archetype/archetype-common/internal.html</a>">internal catalog</a></li></em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * If you want the catalog to come from a custom repository, please add</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * a dedicated repository with id {@code archetype} and optionally a server section with the same id to</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * your {@code settings.xml} and use the catalog scheme <code>remote</code>.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * &lt;repository&gt;</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * &lt;id&gt;archetype&lt;/id&gt;</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * &lt;url&gt;<a href="https://repository.domain.com/path/to/repo/&lt;/url&gt;" target="alexandria_uri">https://repository.domain.com/path/to/repo/&lt;/url&gt;</a></em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * &lt;/repository&gt;</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> <em class="jxr_javadoccomment"> * &lt;!-- in case of a repository with authentication --&gt;</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * &lt;server&gt;</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * &lt;id&gt;archetype&lt;/id&gt;</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * &lt;username&gt;user.name&lt;/username&gt;</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * &lt;password&gt;s3cr3t&lt;/password&gt;</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * &lt;/server&gt;</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * In order to use that repository <em>only</em> for resolving the catalog (and not for downloading regular Maven dependencies from it) it is recommended to</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * include the repository in a <a href="<a href="https://maven.apache.org/settings.html" target="alexandria_uri">https://maven.apache.org/settings.html</a>#active-profiles">profile which is not active by default.</a> and explicitly select it via {@code -P<profile-id>}</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * when this goal is called on the command-line.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * In case of mirrors for either repository {@code archetype} or {@code central} the <a href="<a href="https://maven.apache.org/guides/mini/guide-mirror-settings.html" target="alexandria_uri">https://maven.apache.org/guides/mini/guide-mirror-settings.html</a>">matching mirror's id</a> is considered</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * for server settings (like authentication).</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * If the repository's catalog file is empty or cannot be retrieved, <code>internal</code> catalog is transparently used as fallback.</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> @Parameter(property = <span class="jxr_string">"archetypeCatalog"</span>, defaultValue = <span class="jxr_string">"remote,local"</span>) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> String archetypeCatalog; +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * If set to {@code true} will ask for values also for properties having defaults in the first place.</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Only has an effect if {@link #interactiveMode} is used.</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">"askForDefaultPropertyValues"</span>, defaultValue = <span class="jxr_string">"false"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> Boolean askForDefaultPropertyValues; +<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"> * User settings used to check the interactiveMode.</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">"interactiveMode"</span>, defaultValue = <span class="jxr_string">"${settings.interactiveMode}"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> Boolean interactiveMode; +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}"</span>, property = <span class="jxr_string">"outputDirectory"</span>) +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">private</strong> File outputDirectory; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Parameter(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> MavenSession session; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">private</strong> MavenProject project; +<a class="jxr_linenumber" name="L149" href="#L149">149</a> +<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> <em class="jxr_javadoccomment"> * Goals to immediately run on the project created from the archetype.</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Parameter(property = <span class="jxr_string">"goals"</span>) +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> String goals; +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Applying some filter on displayed archetypes list: format is <code>artifactId</code> or <code>groupId:artifactId</code>.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * <li><code>org.apache:</code> -> displays all archetypes which contain org.apache in groupId</li></em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * <li><code>:jee</code> or <code>jee</code> -> displays all archetypes which contain jee in artifactId</li></em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * <li><code>org.apache:jee</code> -> displays all archetypes which contain org.apache in groupId AND jee in artifactId</li></em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @since 2.1</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(property = <span class="jxr_string">"filter"</span>) +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> String filter; <a class="jxr_linenumber" name="L168" href="#L168">168</a> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> ArchetypeGenerationRequest request = <strong class="jxr_keyword">new</strong> ArchetypeGenerationRequest() -<a class="jxr_linenumber" name="L170" href="#L170">170</a> .setArchetypeGroupId(archetypeGroupId) -<a class="jxr_linenumber" name="L171" href="#L171">171</a> .setArchetypeArtifactId(archetypeArtifactId) -<a class="jxr_linenumber" name="L172" href="#L172">172</a> .setArchetypeVersion(archetypeVersion) -<a class="jxr_linenumber" name="L173" href="#L173">173</a> .setOutputDirectory(outputDirectory.getAbsolutePath()) -<a class="jxr_linenumber" name="L174" href="#L174">174</a> .setRemoteArtifactRepositories(project.getRemoteProjectRepositories()) -<a class="jxr_linenumber" name="L175" href="#L175">175</a> .setRepositorySession(session.getRepositorySession()) -<a class="jxr_linenumber" name="L176" href="#L176">176</a> .setFilter(filter) -<a class="jxr_linenumber" name="L177" href="#L177">177</a> .setAskForDefaultPropertyValues(askForDefaultPropertyValues); -<a class="jxr_linenumber" name="L178" href="#L178">178</a> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">if</strong> (interactiveMode.booleanValue()) { -<a class="jxr_linenumber" name="L181" href="#L181">181</a> getLog().info(<span class="jxr_string">"Generating project in Interactive mode"</span>); -<a class="jxr_linenumber" name="L182" href="#L182">182</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L183" href="#L183">183</a> getLog().info(<span class="jxr_string">"Generating project in Batch mode"</span>); -<a class="jxr_linenumber" name="L184" href="#L184">184</a> } -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> selector.selectArchetype(request, interactiveMode, archetypeCatalog); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(request.getArchetypeArtifactId())) { -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_comment">// no archetype found: stopping</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L191" href="#L191">191</a> } -<a class="jxr_linenumber" name="L192" href="#L192">192</a> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> configurator.configureArchetype(request, interactiveMode, executionProperties); -<a class="jxr_linenumber" name="L194" href="#L194">194</a> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> ArchetypeGenerationResult generationResult = manager.generateProjectFromArchetype(request); -<a class="jxr_linenumber" name="L196" href="#L196">196</a> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">if</strong> (generationResult.getCause() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(generationResult.getCause().getMessage(), generationResult.getCause()); -<a class="jxr_linenumber" name="L199" href="#L199">199</a> } -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) { -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(ex.getMessage(), ex); -<a class="jxr_linenumber" name="L202" href="#L202">202</a> } -<a class="jxr_linenumber" name="L203" href="#L203">203</a> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> String artifactId = request.getArtifactId(); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> String postArchetypeGenerationGoals = request.getArchetypeGoals(); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">if</strong> (postArchetypeGenerationGoals == <strong class="jxr_keyword">null</strong> || postArchetypeGenerationGoals.isEmpty()) { -<a class="jxr_linenumber" name="L209" href="#L209">209</a> postArchetypeGenerationGoals = goals; -<a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">if</strong> (postArchetypeGenerationGoals != <strong class="jxr_keyword">null</strong> && !postArchetypeGenerationGoals.isEmpty()) { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> invokePostArchetypeGenerationGoals(postArchetypeGenerationGoals, artifactId); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> } -<a class="jxr_linenumber" name="L215" href="#L215">215</a> } -<a class="jxr_linenumber" name="L216" href="#L216">216</a> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> invokePostArchetypeGenerationGoals(String goals, String artifactId) <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L218" href="#L218">218</a> getLog().info(<span class="jxr_string">"Invoking post-archetype-generation goals: "</span> + goals); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> File projectBasedir = <strong class="jxr_keyword">new</strong> File(outputDirectory, artifactId); +<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Override +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L171" href="#L171">171</a> Properties executionProperties = session.getUserProperties(); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> ArchetypeGenerationRequest request = <strong class="jxr_keyword">new</strong> ArchetypeGenerationRequest() +<a class="jxr_linenumber" name="L174" href="#L174">174</a> .setArchetypeGroupId(archetypeGroupId) +<a class="jxr_linenumber" name="L175" href="#L175">175</a> .setArchetypeArtifactId(archetypeArtifactId) +<a class="jxr_linenumber" name="L176" href="#L176">176</a> .setArchetypeVersion(archetypeVersion) +<a class="jxr_linenumber" name="L177" href="#L177">177</a> .setOutputDirectory(outputDirectory.getAbsolutePath()) +<a class="jxr_linenumber" name="L178" href="#L178">178</a> .setRemoteRepositories(project.getRemoteProjectRepositories()) +<a class="jxr_linenumber" name="L179" href="#L179">179</a> .setRemoteArtifactRepositories(project.getRemoteArtifactRepositories()) +<a class="jxr_linenumber" name="L180" href="#L180">180</a> .setMavenSession(session) +<a class="jxr_linenumber" name="L181" href="#L181">181</a> .setRepositorySession(session.getRepositorySession()) +<a class="jxr_linenumber" name="L182" href="#L182">182</a> .setRepositorySystem(repositorySystem) +<a class="jxr_linenumber" name="L183" href="#L183">183</a> .setProjectBuildingRequest(session.getProjectBuildingRequest()) +<a class="jxr_linenumber" name="L184" href="#L184">184</a> .setLocalRepository(session.getLocalRepository()) +<a class="jxr_linenumber" name="L185" href="#L185">185</a> .setOffline(session.isOffline()) +<a class="jxr_linenumber" name="L186" href="#L186">186</a> .setFilter(filter) +<a class="jxr_linenumber" name="L187" href="#L187">187</a> .setAskForDefaultPropertyValues(askForDefaultPropertyValues); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (interactiveMode.booleanValue()) { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> getLog().info(<span class="jxr_string">"Generating project in Interactive mode"</span>); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> getLog().info(<span class="jxr_string">"Generating project in Batch mode"</span>); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> } +<a class="jxr_linenumber" name="L195" href="#L195">195</a> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> selector.selectArchetype(request, interactiveMode, archetypeCatalog); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(request.getArchetypeArtifactId())) { +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_comment">// no archetype found: stopping</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } +<a class="jxr_linenumber" name="L202" href="#L202">202</a> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> configurator.configureArchetype(request, interactiveMode, executionProperties); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> ArchetypeGenerationResult generationResult = manager.generateProjectFromArchetype(request); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (generationResult.getCause() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(generationResult.getCause().getMessage(), generationResult.getCause()); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> } +<a class="jxr_linenumber" name="L210" href="#L210">210</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) { +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(ex.getMessage(), ex); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> } +<a class="jxr_linenumber" name="L213" href="#L213">213</a> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> String artifactId = request.getArtifactId(); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> String postArchetypeGenerationGoals = request.getArchetypeGoals(); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (postArchetypeGenerationGoals == <strong class="jxr_keyword">null</strong> || postArchetypeGenerationGoals.isEmpty()) { +<a class="jxr_linenumber" name="L219" href="#L219">219</a> postArchetypeGenerationGoals = goals; +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } <a class="jxr_linenumber" name="L221" href="#L221">221</a> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">if</strong> (projectBasedir.exists()) { -<a class="jxr_linenumber" name="L223" href="#L223">223</a> InvocationRequest request = <strong class="jxr_keyword">new</strong> DefaultInvocationRequest() -<a class="jxr_linenumber" name="L224" href="#L224">224</a> .setBaseDirectory(projectBasedir) -<a class="jxr_linenumber" name="L225" href="#L225">225</a> .setGoals(Arrays.asList(StringUtils.split(goals, <span class="jxr_string">","</span>))); +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">if</strong> (postArchetypeGenerationGoals != <strong class="jxr_keyword">null</strong> && !postArchetypeGenerationGoals.isEmpty()) { +<a class="jxr_linenumber" name="L223" href="#L223">223</a> invokePostArchetypeGenerationGoals(postArchetypeGenerationGoals, artifactId); +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } <a class="jxr_linenumber" name="L226" href="#L226">226</a> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L228" href="#L228">228</a> InvocationResult result = invoker.execute(request); +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> invokePostArchetypeGenerationGoals(String goals, String artifactId) <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L228" href="#L228">228</a> getLog().info(<span class="jxr_string">"Invoking post-archetype-generation goals: "</span> + goals); <a class="jxr_linenumber" name="L229" href="#L229">229</a> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">if</strong> (result.getExitCode() != 0) { -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to invoke goals"</span>, result.getExecutionException()); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> } -<a class="jxr_linenumber" name="L233" href="#L233">233</a> } <strong class="jxr_keyword">catch</strong> (MavenInvocationException e) { -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot run additions goals."</span>, e); -<a class="jxr_linenumber" name="L235" href="#L235">235</a> } -<a class="jxr_linenumber" name="L236" href="#L236">236</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L237" href="#L237">237</a> getLog().info(<span class="jxr_string">"Post-archetype-generation goals aborted: unavailable basedir "</span> + projectBasedir); -<a class="jxr_linenumber" name="L238" href="#L238">238</a> } -<a class="jxr_linenumber" name="L239" href="#L239">239</a> } -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } +<a class="jxr_linenumber" name="L230" href="#L230">230</a> File projectBasedir = <strong class="jxr_keyword">new</strong> File(outputDirectory, artifactId); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (projectBasedir.exists()) { +<a class="jxr_linenumber" name="L233" href="#L233">233</a> InvocationRequest request = <strong class="jxr_keyword">new</strong> DefaultInvocationRequest() +<a class="jxr_linenumber" name="L234" href="#L234">234</a> .setBaseDirectory(projectBasedir) +<a class="jxr_linenumber" name="L235" href="#L235">235</a> .setGoals(Arrays.asList(StringUtils.split(goals, <span class="jxr_string">","</span>))); +<a class="jxr_linenumber" name="L236" href="#L236">236</a> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L238" href="#L238">238</a> InvocationResult result = invoker.execute(request); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (result.getExitCode() != 0) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Failed to invoke goals"</span>, result.getExecutionException()); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> } +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } <strong class="jxr_keyword">catch</strong> (MavenInvocationException e) { +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot run additions goals."</span>, e); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> } +<a class="jxr_linenumber" name="L246" href="#L246">246</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L247" href="#L247">247</a> getLog().info(<span class="jxr_string">"Post-archetype-generation goals aborted: unavailable basedir "</span> + projectBasedir); +<a class="jxr_linenumber" name="L248" href="#L248">248</a> } +<a class="jxr_linenumber" name="L249" href="#L249">249</a> } +<a class="jxr_linenumber" name="L250" href="#L250">250</a> } </pre> <hr/> <div id="footer">Copyright © 2007–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/FileLogger.html ============================================================================== --- maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/FileLogger.html (original) +++ maven/website/components/archetype-archives/archetype-LATEST/maven-archetype-plugin/xref/org/apache/maven/archetype/mojos/FileLogger.html Fri Oct 25 06:12:42 2024 @@ -48,45 +48,35 @@ <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.io.File; <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.io.IOException; <a class="jxr_linenumber" name="L42" href="#L42">42</a> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.invoker.InvocationOutputHandler; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.scriptinterpreter.ExecutionLogger; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.scriptinterpreter.FileLoggerMirrorHandler; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">class</strong> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a> <strong class="jxr_keyword">extends</strong> org.apache.maven.shared.scriptinterpreter.FileLogger -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">implements</strong> InvocationOutputHandler, ExecutionLogger, FileLoggerMirrorHandler { -<a class="jxr_linenumber" name="L53" href="#L53">53</a> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> Logger logger; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Creates a new logger that writes to the specified file.</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @param outputFile The path to the output file, must not be <code>null</code>.</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException If the output file could not be created.</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a>(File outputFile) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">super</strong>(outputFile, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L63" href="#L63">63</a> } -<a class="jxr_linenumber" name="L64" href="#L64">64</a> -<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> <em class="jxr_javadoccomment"> * Creates a new logger that writes to the specified file and optionally mirrors messages to the given mojo logger.</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @param outputFile The path to the output file, must not be <code>null</code>.</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @param log The mojo logger to additionally output messages to, may be <code>null</code> if not used.</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException If the output file could not be created.</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a>(File outputFile, Logger log) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">super</strong>(outputFile); -<a class="jxr_linenumber" name="L74" href="#L74">74</a> logger = log; -<a class="jxr_linenumber" name="L75" href="#L75">75</a> } -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> @Override -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> consumeOutput(String message) { -<a class="jxr_linenumber" name="L79" href="#L79">79</a> logger.info(message); -<a class="jxr_linenumber" name="L80" href="#L80">80</a> } -<a class="jxr_linenumber" name="L81" href="#L81">81</a> } +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.invoker.InvocationOutputHandler; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">class</strong> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a> <strong class="jxr_keyword">extends</strong> org.apache.maven.shared.scriptinterpreter.FileLogger <strong class="jxr_keyword">implements</strong> InvocationOutputHandler { +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Creates a new logger that writes to the specified file.</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @param outputFile The path to the output file, must not be <code>null</code>.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException If the output file could not be created.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a>(File outputFile) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">super</strong>(outputFile, <strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Creates a new logger that writes to the specified file and optionally mirrors messages to the given mojo logger.</em> +<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"> * @param outputFile The path to the output file, must not be <code>null</code>.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param log The mojo logger to additionally output messages to, may be <code>null</code> if not used.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException If the output file could not be created.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <a name="FileLogger" href="../../../../../org/apache/maven/archetype/mojos/FileLogger.html#FileLogger">FileLogger</a>(File outputFile, Log log) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">super</strong>(outputFile, log::info); +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } </pre> <hr/> <div id="footer">Copyright © 2007–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>