Modified: maven/website/content/guides/getting-started/maven-in-five-minutes.html ============================================================================== --- maven/website/content/guides/getting-started/maven-in-five-minutes.html (original) +++ maven/website/content/guides/getting-started/maven-in-five-minutes.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/getting-started/maven-in-five-minutes.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/getting-started/maven-in-five-minutes.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Maven in 5 Minutes <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/getting-started/maven-in-five-minutes.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Maven in 5 Minutes <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/getting-started/maven-in-five-minutes.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -137,57 +137,35 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Maven in 5 Minutes</h2><section> -<h3>Prerequisites</h3> +<section> +<h1>Maven in 5 Minutes</h1><section> +<h2>Prerequisites</h2> <p>You must understand how to install software on your computer. If you do not know how to do this, please ask someone at your office, school, etc. or pay someone to explain this to you. The Maven mailing lists are not the best place to ask for this advice.</p></section><section> -<h3>Installation</h3> -<p><em>Maven is a Java tool, so you must have <a href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"; class="externalLink">Java</a> installed in order to proceed.</em></p> +<h2>Installation</h2> +<p><i>Maven is a Java tool, so you must have <a class="externalLink" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html";>Java</a> installed in order to proceed.</i></p> <p>First, <a href="../../download.html">download Maven</a> and follow the <a href="../../install.html">installation instructions</a>. After that, type the following in a terminal or in a command prompt:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn --version -</code></pre></div> +<div> +<pre>mvn --version</pre></div> <p>It should print out your installed version of Maven, for example:</p> - -<div class="source"><pre class="prettyprint linenums"><code>Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f) +<div> +<pre>Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f) Maven home: D:\apache-maven-3.6.3\apache-maven\bin\.. Java version: 1.8.0_232, vendor: AdoptOpenJDK, runtime: C:\Program Files\AdoptOpenJDK\jdk-8.0.232.09-hotspot\jre Default locale: en_US, platform encoding: Cp1250 -OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows" -</code></pre></div> +OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"</pre></div> <p>Depending upon your network setup, you may require extra configuration. Check out the <a href="../mini/guide-configuring-maven.html">Guide to Configuring Maven</a> if necessary.</p> -<p><strong>If you are using Windows, you should look at</strong> <a href="./windows-prerequisites.html">Windows Prerequisites</a> <strong>to ensure that you are prepared to use Maven on Windows.</strong></p></section><section> -<h3>Creating a Project</h3> +<p><b>If you are using Windows, you should look at</b> <a href="./windows-prerequisites.html">Windows Prerequisites</a> <b>to ensure that you are prepared to use Maven on Windows.</b></p></section><section> +<h2>Creating a Project</h2> <p>You need somewhere for your project to reside. Create a directory somewhere and start a shell in that directory. On your command line, execute the following Maven goal:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false -</code></pre></div> -<p><em>If you have just installed Maven, it may take a while on the first run. This is because Maven is downloading the most recent artifacts (plugin jars and other files) into your local repository. You may also need to execute the command a couple of times before it succeeds. This is because the remote server may time out before your downloads are complete. Don't worry, there are ways to fix that.</em></p> -<p>You will notice that the <em>generate</em> goal created a directory with the same name given as the artifactId. Change into that directory.</p> - -<div class="source"><pre class="prettyprint linenums"><code>cd my-app -</code></pre></div> +<div> +<pre>mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false</pre></div> +<p><i>If you have just installed Maven, it may take a while on the first run. This is because Maven is downloading the most recent artifacts (plugin jars and other files) into your local repository. You may also need to execute the command a couple of times before it succeeds. This is because the remote server may time out before your downloads are complete. Don't worry, there are ways to fix that.</i></p> +<p>You will notice that the <i>generate</i> goal created a directory with the same name given as the artifactId. Change into that directory.</p> +<div> +<pre>cd my-app</pre></div> <p>Under this directory you will notice the following <a href="../introduction/introduction-to-the-standard-directory-layout.html">standard project structure</a>.</p> - -<div class="source"><pre class="prettyprint linenums"><code>my-app +<div> +<pre>my-app |-- pom.xml `-- src |-- main @@ -201,13 +179,11 @@ OS name: "windows 10", version `-- com `-- mycompany `-- app - `-- AppTest.java -</code></pre></div> + `-- AppTest.java</pre></div> <p>The <code>src/main/java</code> directory contains the project source code, the <code>src/test/java</code> directory contains the test source, and the <code>pom.xml</code> file is the project's Project Object Model, or POM.</p><section> -<h4>The POM</h4> +<h3>The POM</h3> <p>The <code>pom.xml</code> file is the core of a project's configuration in Maven. It is a single configuration file that contains the majority of information required to build a project in just the way you want. The POM is huge and can be daunting in its complexity, but it is not necessary to understand all of the intricacies just yet to use it effectively. This project's POM is:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +<div class="source"><pre class="prettyprint linenums"><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -228,44 +204,39 @@ OS name: "windows 10", version <scope>test</scope> </dependency> </dependencies> -</project> -</code></pre></div></section><section> -<h4>What did I just do?</h4> -<p>You executed the Maven goal <em>archetype:generate</em>, and passed in various parameters to that goal. The prefix <em>archetype</em> is the <a href="../../plugins/index.html">plugin</a> that provides the goal. If you are familiar with <a href="http://ant.apache.org"; class="externalLink">Ant</a>, you may conceive of this as similar to a task. This <em>archetype:generate</em> goal created a simple project based upon a <a href="/archetypes/maven-archetype-quickstart/">maven-archetype-quickstart</a> archetype. Suffice it to say for now that a <em>plugin</em> is a collection of <em>goals</em> with a general common purpose. For example the jboss-maven-plugin, whose purpose is “deal with various jboss items”.</p></section><section> -<h4>Build the Project</h4> - -<div class="source"><pre class="prettyprint linenums"><code>mvn package -</code></pre></div> +</project></pre></div></section><section> +<h3>What did I just do?</h3> +<p>You executed the Maven goal <i>archetype:generate</i>, and passed in various parameters to that goal. The prefix <i>archetype</i> is the <a href="../../plugins/index.html">plugin</a> that provides the goal. If you are familiar with <a class="externalLink" href="http://ant.apache.org";>Ant</a>, you may conceive of this as similar to a task. This <i>archetype:generate</i> goal created a simple project based upon a <a href="/archetypes/maven-archetype-quickstart/">maven-archetype-quickstart</a> archetype. Suffice it to say for now that a <i>plugin</i> is a collection of <i>goals</i> with a general common purpose. For example the jboss-maven-plugin, whose purpose is "deal with various jboss items".</p></section><section> +<h3>Build the Project</h3> +<div> +<pre>mvn package</pre></div> <p>The command line will print out various actions, and end with the following:</p> - -<div class="source"><pre class="prettyprint linenums"><code> ... +<div> +<pre> ... [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 2.953 s [INFO] Finished at: 2019-11-24T13:05:10+01:00 -[INFO] ------------------------------------------------------------------------ -</code></pre></div> -<p>Unlike the first command executed (<em>archetype:generate</em>), the second is simply a single word - <em>package</em>. Rather than a <em>goal</em>, this is a <em>phase</em>. A phase is a step in the <a href="../introduction/introduction-to-the-lifecycle.html">build lifecycle</a>, which is an ordered sequence of phases. When a phase is given, Maven executes every phase in the sequence up to and including the one defined. For example, if you execute the <em>compile</em> phase, the phases that actually get executed are:</p> -<p>1 validate</p> -<p>1 generate-sources</p> -<p>1 process-sources</p> -<p>1 generate-resources</p> -<p>1 process-resources</p> -<p>1 compile</p> +[INFO] ------------------------------------------------------------------------</pre></div> +<p>Unlike the first command executed (<i>archetype:generate</i>), the second is simply a single word - <i>package</i>. Rather than a <i>goal</i>, this is a <i>phase</i>. A phase is a step in the <a href="../introduction/introduction-to-the-lifecycle.html">build lifecycle</a>, which is an ordered sequence of phases. When a phase is given, Maven executes every phase in the sequence up to and including the one defined. For example, if you execute the <i>compile</i> phase, the phases that actually get executed are:</p> +<ol style="list-style-type: decimal"> +<li>validate</li> +<li>generate-sources</li> +<li>process-sources</li> +<li>generate-resources</li> +<li>process-resources</li> +<li>compile</li></ol> <p>You may test the newly compiled and packaged JAR with the following command:</p> - -<div class="source"><pre class="prettyprint linenums"><code>java -cp target/my-app-1.0-SNAPSHOT.jar com.mycompany.app.App -</code></pre></div> +<div> +<pre>java -cp target/my-app-1.0-SNAPSHOT.jar com.mycompany.app.App</pre></div> <p>Which will print the quintessential:</p> - -<div class="source"><pre class="prettyprint linenums"><code>Hello World! -</code></pre></div></section></section><section> -<h3>Java 9 or later</h3> +<div> +<pre>Hello World!</pre></div></section></section><section> +<h2>Java 9 or later</h2> <p>By default your version of Maven might use an old version of the <code>maven-compiler-plugin</code> that is not compatible with Java 9 or later versions. To target Java 9 or later, you should at least use version 3.6.0 of the <code>maven-compiler-plugin</code> and set the <code>maven.compiler.release</code> property to the Java release you are targetting (e.g. 9, 10, 11, 12, etc.).</p> <p>In the following example, we have configured our Maven project to use version 3.8.1 of <code>maven-compiler-plugin</code> and target Java 11:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> <properties> +<div class="source"><pre class="prettyprint linenums"> <properties> <maven.compiler.release>11</maven.compiler.release> </properties> @@ -279,52 +250,36 @@ OS name: "windows 10", version </plugin> </plugins> </pluginManagement> - </build> -</code></pre></div> -<p>To learn more about <code>javac</code>'s <code>--release</code> option, see <a href="https://openjdk.java.net/jeps/247"; class="externalLink">JEP 247</a>.</p></section><section> -<h3>Running Maven Tools</h3><section> -<h4>Maven Phases</h4> -<p>Although hardly a comprehensive list, these are the most common <em>default</em> lifecycle phases executed.</p> + </build></pre></div> +<p>To learn more about <code>javac</code>'s <code>--release</code> option, see <a class="externalLink" href="https://openjdk.java.net/jeps/247";>JEP 247</a>.</p></section><section> +<h2>Running Maven Tools</h2><section> +<h3>Maven Phases</h3> +<p>Although hardly a comprehensive list, these are the most common <i>default</i> lifecycle phases executed.</p> <ul> - -<li> -<p><strong>validate</strong>: validate the project is correct and all necessary information is available</p></li> -<li> -<p><strong>compile</strong>: compile the source code of the project</p></li> -<li> -<p><strong>test</strong>: test the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed</p></li> -<li> -<p><strong>package</strong>: take the compiled code and package it in its distributable format, such as a JAR.</p></li> -<li> -<p><strong>integration-test</strong>: process and deploy the package if necessary into an environment where integration tests can be run</p></li> -<li> -<p><strong>verify</strong>: run any checks to verify the package is valid and meets quality criteria</p></li> -<li> -<p><strong>install</strong>: install the package into the local repository, for use as a dependency in other projects locally</p></li> -<li> -<p><strong>deploy</strong>: done in an integration or release environment, copies the final package to the remote repository for sharing with other developers and projects.</p></li> -</ul> -<p>There are two other Maven lifecycles of note beyond the <em>default</em> list above. They are</p> +<li><b>validate</b>: validate the project is correct and all necessary information is available</li> +<li><b>compile</b>: compile the source code of the project</li> +<li><b>test</b>: test the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed</li> +<li><b>package</b>: take the compiled code and package it in its distributable format, such as a JAR.</li> +<li><b>integration-test</b>: process and deploy the package if necessary into an environment where integration tests can be run</li> +<li><b>verify</b>: run any checks to verify the package is valid and meets quality criteria</li> +<li><b>install</b>: install the package into the local repository, for use as a dependency in other projects locally</li> +<li><b>deploy</b>: done in an integration or release environment, copies the final package to the remote repository for sharing with other developers and projects.</li></ul> +<p>There are two other Maven lifecycles of note beyond the <i>default</i> list above. They are</p> <ul> - -<li> -<p><strong>clean</strong>: cleans up artifacts created by prior builds</p></li> -<li> -<p><strong>site</strong>: generates site documentation for this project</p></li> -</ul> -<p>Phases are actually mapped to underlying goals. The specific goals executed per phase is dependant upon the packaging type of the project. For example, <em>package</em> executes <em>jar:jar</em> if the project type is a JAR, and <em>war:war</em> if the project type is - you guessed it - a WAR.</p> +<li><b>clean</b>: cleans up artifacts created by prior builds</li></ul> +<ul> +<li><b>site</b>: generates site documentation for this project</li></ul> +<p>Phases are actually mapped to underlying goals. The specific goals executed per phase is dependant upon the packaging type of the project. For example, <i>package</i> executes <i>jar:jar</i> if the project type is a JAR, and <i>war:war</i> if the project type is - you guessed it - a WAR.</p> <p>An interesting thing to note is that phases and goals may be executed in sequence.</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn clean dependency:copy-dependencies package -</code></pre></div> -<p>This command will clean the project, copy dependencies, and package the project (executing all phases up to <em>package</em>, of course).</p></section><section> -<h4>Generating the Site</h4> - -<div class="source"><pre class="prettyprint linenums"><code>mvn site -</code></pre></div> +<div> +<pre>mvn clean dependency:copy-dependencies package</pre></div> +<p>This command will clean the project, copy dependencies, and package the project (executing all phases up to <i>package</i>, of course).</p></section><section> +<h3>Generating the Site</h3> +<div> +<pre>mvn site</pre></div> <p>This phase generates a site based upon information on the project's pom. You can look at the documentation generated under <code>target/site</code>.</p></section></section><section> -<h3>Conclusion</h3> -<p>We hope this quick overview has piqued your interest in the versatility of Maven. Note that this is a very truncated quick-start guide. Now you are ready for more comprehensive details concerning the actions you have just performed. Check out the <a href="./index.html">Maven Getting Started Guide</a>.</p></section></section></section> +<h2>Conclusion</h2> +<p>We hope this quick overview has piqued your interest in the versatility of Maven. Note that this is a very truncated quick-start guide. Now you are ready for more comprehensive details concerning the actions you have just performed. Check out the <a href="./index.html">Maven Getting Started Guide</a>.</p></section></section> </main> </div> </div>
Modified: maven/website/content/guides/getting-started/windows-prerequisites.html ============================================================================== --- maven/website/content/guides/getting-started/windows-prerequisites.html (original) +++ maven/website/content/guides/getting-started/windows-prerequisites.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/getting-started/windows-prerequisites.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/getting-started/windows-prerequisites.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Maven on Windows <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/getting-started/windows-prerequisites.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Maven on Windows <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/getting-started/windows-prerequisites.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,40 +123,21 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Maven on Windows</h2> +<section> +<h1>Maven on Windows</h1> <p>Maven is a command-line tool for building Java (and other) programs. The Maven project provides a simple ZIP file containing a precompiled version of Maven for your convenience. There is no installer. It's up to you to set up your prerequisites and environment to run Maven on Windows.</p><section> -<h3>Prerequisites</h3> -<p>Maven is written in Java (and primarily used to build Java programs). Thus, the major prerequisite is the Java SDK. You need to install the Java SDK (e.g. from <a href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"; class="externalLink">Oracle's download site</a>).</p> +<h2>Prerequisites</h2> +<p>Maven is written in Java (and primarily used to build Java programs). Thus, the major prerequisite is the Java SDK. You need to install the Java SDK (e.g. from <a class="externalLink" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html";>Oracle's download site</a>).</p> <p>Once Java is installed, you must ensure that the commands from the Java SDK are in your PATH environment variable. Running, for example,</p> - -<div class="source"><pre class="prettyprint linenums"><code>java -version -</code></pre></div> +<div> +<pre>java -version</pre></div> <p>must show the right version number.</p></section><section> -<h3>Maven Unpacked</h3> +<h2>Maven Unpacked</h2> <p>You need to unpack the Maven distribution. Don't unpack it in the middle of your source code; pick some location and unpack it there. Let's assume that the path is <code>${maven.home}</code>.</p></section><section> -<h3>Maven in PATH</h3> -<p>You run Maven by invoking a command-line tool: <code>mvn.cmd</code> from the <code>bin</code> directory of the Maven. To do this conveniently, <code>${maven.home}/bin</code> must be in your PATH, just like the Java SDK commands. You can add directories to your <code>PATH</code> in the control panel; the details vary by Windows version.</p></section><section> -<h3>Firewalls and Anti-virus</h3> -<p>Firewall and Anti-virus sometimes prevent Java from running properly, or Windows Firewall (and various other Firewalls) actively prevent Java.exe from reaching out to the Internet to “download stuff” which is a key part of Maven. You may need to configure the Firewall or Anti-virus to add exceptions to allow such actions.</p></section></section></section> +<h2>Maven in PATH</h2> +<p>You run Maven by invoking a command-line tool: <code>mvn.cmd</code> from the <code>bin</code> directory of the Maven. To do this conveniently, <code>${maven.home}\bin</code> must be in your PATH, just like the Java SDK commands. You can add directories to your <code>PATH</code> in the control panel; the details vary by Windows version.</p></section><section> +<h2>Firewalls and Anti-virus</h2> +<p>Firewall and Anti-virus sometimes prevent Java from running properly, or Windows Firewall (and various other Firewalls) actively prevent Java.exe from reaching out to the Internet to "download stuff" which is a key part of Maven. You may need to configure the Firewall or Anti-virus to add exceptions to allow such actions.</p></section></section> </main> </div> </div> Modified: maven/website/content/guides/introduction/introduction-to-archetypes.html ============================================================================== --- maven/website/content/guides/introduction/introduction-to-archetypes.html (original) +++ maven/website/content/guides/introduction/introduction-to-archetypes.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/introduction/introduction-to-archetypes.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/introduction/introduction-to-archetypes.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Introduction to Archetypes <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/introduction/introduction-to-archetypes.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Introduction to Archetypes <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/introduction/introduction-to-archetypes.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -140,81 +140,59 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Introduction to Archetypes</h2></section><section> -<h2>What is Archetype?</h2> -<p>In short, Archetype is a Maven project templating toolkit. An archetype is defined as <em>an original pattern or model from which all other things of the same kind are made</em>. The name fits as we are trying to provide a system that provides a consistent means of generating Maven projects. Archetype will help authors create Maven project templates for users, and provides users with the means to generate parameterized versions of those project templates.</p> +<section> +<h1>Introduction to Archetypes</h1></section><section> +<h1>What is Archetype?</h1> +<p>In short, Archetype is a Maven project templating toolkit. An archetype is defined as <i>an original pattern or model from which all other things of the same kind are made</i>. The name fits as we are trying to provide a system that provides a consistent means of generating Maven projects. Archetype will help authors create Maven project templates for users, and provides users with the means to generate parameterized versions of those project templates.</p> <p>Using archetypes provides a great way to enable developers quickly in a way consistent with best practices employed by your project or organization. Within the Maven project, we use archetypes to try and get our users up and running as quickly as possible by providing a sample project that demonstrates many of the features of Maven, while introducing new users to the best practices employed by Maven. In a matter of seconds, a new user can have a working Maven project to use as a jumping board for investigating more of the features in Maven. We have also tried to make the Archetype mechanism additive, and by that we mean allowing portions of a project to be captured in an archetype so that pieces or aspects of a project can be added to existing projects. A good example of this is the Maven site archetype. If, for example, you have used the quick start archetype to generate a working project, you can then quickly create a site for that project by using the site archetype within tha t existing project. You can do anything like this with archetypes.</p> <p>You may want to standardize J2EE development within your organization, so you may want to provide archetypes for EJBs, or WARs, or for your web services. Once these archetypes are created and deployed in your organization's repository, they are available for use by all developers within your organization.</p><section> -<h3>Using an Archetype</h3> +<h2>Using an Archetype</h2> <p>To create a new project based on an Archetype, you need to call <code>mvn archetype:generate</code> goal, like the following:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn archetype:generate -</code></pre></div> +<div> +<pre>mvn archetype:generate</pre></div> <p>Please refer to <a href="/archetype/maven-archetype-plugin/usage.html">Archetype Plugin page</a>.</p></section><section> -<h3>Provided Archetypes</h3> +<h2>Provided Archetypes</h2> <p>Maven provides several Archetype artifacts:</p> -<table class="table table-striped"> -<thead> +<table class="bodyTable bodyTableBorder"> <tr class="a"> <th>Archetype ArtifactIds</th> -<th>Description</th></tr></thead><tbody> +<th>Description</th></tr> <tr class="b"> -<td>maven-archetype-archetype</td> -<td>An archetype to generate a sample archetype project.</td></tr> +<td style="text-align: left;">maven-archetype-archetype</td> +<td style="text-align: left;">An archetype to generate a sample archetype project.</td></tr> <tr class="a"> -<td>maven-archetype-j2ee-simple</td> -<td>An archetype to generate a simplifed sample J2EE application.</td></tr> +<td style="text-align: left;">maven-archetype-j2ee-simple</td> +<td style="text-align: left;">An archetype to generate a simplifed sample J2EE application.</td></tr> <tr class="b"> -<td>maven-archetype-mojo</td> -<td>An archetype to generate a sample a sample Maven plugin.</td></tr> +<td style="text-align: left;">maven-archetype-mojo</td> +<td style="text-align: left;">An archetype to generate a sample a sample Maven plugin.</td></tr> <tr class="a"> -<td>maven-archetype-plugin</td> -<td>An archetype to generate a sample Maven plugin.</td></tr> +<td style="text-align: left;">maven-archetype-plugin</td> +<td style="text-align: left;">An archetype to generate a sample Maven plugin.</td></tr> <tr class="b"> -<td>maven-archetype-plugin-site</td> -<td>An archetype to generate a sample Maven plugin site.</td></tr> +<td style="text-align: left;">maven-archetype-plugin-site</td> +<td style="text-align: left;">An archetype to generate a sample Maven plugin site.</td></tr> <tr class="a"> -<td>maven-archetype-portlet</td> -<td>An archetype to generate a sample JSR-268 Portlet.</td></tr> +<td style="text-align: left;">maven-archetype-portlet</td> +<td style="text-align: left;">An archetype to generate a sample JSR-268 Portlet.</td></tr> <tr class="b"> -<td>maven-archetype-quickstart</td> -<td>An archetype to generate a sample Maven project.</td></tr> +<td style="text-align: left;">maven-archetype-quickstart</td> +<td style="text-align: left;">An archetype to generate a sample Maven project.</td></tr> <tr class="a"> -<td>maven-archetype-simple</td> -<td>An archetype to generate a simple Maven project.</td></tr> +<td style="text-align: left;">maven-archetype-simple</td> +<td style="text-align: left;">An archetype to generate a simple Maven project.</td></tr> <tr class="b"> -<td>maven-archetype-site</td> -<td>An archetype to generate a sample Maven site which demonstrates some of the supported document types like APT, XDoc, and FML and demonstrates how to i18n your site.</td></tr> +<td style="text-align: left;">maven-archetype-site</td> +<td style="text-align: left;">An archetype to generate a sample Maven site which demonstrates some of the supported document types like APT, XDoc, and FML and demonstrates how to i18n your site.</td></tr> <tr class="a"> -<td>maven-archetype-site-simple</td> -<td>An archetype to generate a sample Maven site.</td></tr> +<td style="text-align: left;">maven-archetype-site-simple</td> +<td style="text-align: left;">An archetype to generate a sample Maven site.</td></tr> <tr class="b"> -<td>maven-archetype-webapp</td> -<td>An archetype to generate a sample Maven Webapp project.</td></tr></tbody> -</table> - +<td style="text-align: left;">maven-archetype-webapp</td> +<td style="text-align: left;">An archetype to generate a sample Maven Webapp project.</td></tr></table> <p>For more information on these archetypes, please refer to the <a href="/archetypes/index.html">Maven Archetype Bundles page</a>.</p></section><section> -<h3>What makes up an Archetype?</h3> -<p>Archetypes are packaged up in a JAR and they consist of the archetype metadata which describes the contents of archetype, and a set of <a href="http://velocity.apache.org/"; class="externalLink">Velocity</a> templates which make up the prototype project. If you would like to know how to make your own archetypes, please refer to our <a href="../mini/guide-creating-archetypes.html">Guide to creating archetypes</a>.</p></section></section></section> +<h2>What makes up an Archetype?</h2> +<p>Archetypes are packaged up in a JAR and they consist of the archetype metadata which describes the contents of archetype, and a set of <a class="externalLink" href="http://velocity.apache.org/";>Velocity</a> templates which make up the prototype project. If you would like to know how to make your own archetypes, please refer to our <a href="../mini/guide-creating-archetypes.html">Guide to creating archetypes</a>.</p></section></section> </main> </div> </div> Modified: maven/website/content/guides/introduction/introduction-to-dependency-mechanism.html ============================================================================== --- maven/website/content/guides/introduction/introduction-to-dependency-mechanism.html (original) +++ maven/website/content/guides/introduction/introduction-to-dependency-mechanism.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/introduction/introduction-to-dependency-mechanism.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/introduction/introduction-to-dependency-mechanism.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,8 +10,11 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" /> - <meta name="author" content="Brett Porter, Trygve Laugstol, Karl Heinz Marbaise" /> - <meta name="date" content="2005-10-12, 2016-06-17" /> + <meta name="author" content="Brett Porter +Trygve Laugstol +Karl Heinz Marbaise" /> + <meta name="date" content="2005-10-12 +2016-06-17" /> <title>Maven – Introduction to the Dependency Mechanism</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> @@ -48,7 +51,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Introduction to the Dependency Mechanism <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/introduction/introduction-to-dependency-mechanism.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Introduction to the Dependency Mechanism <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/introduction/introduction-to-dependency-mechanism.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -148,158 +151,101 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Introduction to the Dependency Mechanism</h2> +<section> +<h1>Introduction to the Dependency Mechanism</h1> <p>Dependency management is a core feature of Maven. Managing dependencies for a single project is easy. Managing dependencies for multi-module projects and applications that consist of hundreds of modules is possible. Maven helps a great deal in defining, creating, and maintaining reproducible builds with well-defined classpaths and library versions.</p> <p>Learn more about:</p> <ul> - -<li> -<p><a href="#transitive-dependencies">Transitive Dependencies</a></p></li> -<li> -<p>Excluded/Optional Dependencies</p></li> -<li> -<p><a href="#dependency-scope">Dependency Scope</a></p></li> -<li> -<p><a href="#dependency-management">Dependency Management</a></p></li> -<li> -<p><a href="#importing-dependencies">Importing Dependencies</a></p></li> -<li> -<p><a href="#bill-of-materials-bom-poms">Bill of Materials (BOM) POMs</a></p></li> -<li> -<p><a href="#system-dependencies">System Dependencies</a></p></li> -</ul><section> -<h3>Transitive Dependencies</h3> +<li><a href="#Transitive_Dependencies">Transitive Dependencies</a> +<ul> +<li>Excluded/Optional Dependencies</li></ul></li> +<li><a href="#Dependency_Scope">Dependency Scope</a></li> +<li><a href="#Dependency_Management">Dependency Management</a> +<ul> +<li><a href="#Importing_Dependencies">Importing Dependencies</a></li> +<li><a href="#bill-of-materials-bom-poms">Bill of Materials (BOM) POMs</a></li></ul></li> +<li><a href="#System_Dependencies">System Dependencies</a></li></ul><section> +<h2><a id="Transitive_Dependencies">Transitive Dependencies</a></h2> <p>Maven avoids the need to discover and specify the libraries that your own dependencies require by including transitive dependencies automatically.</p> <p>This feature is facilitated by reading the project files of your dependencies from the remote repositories specified. In general, all dependencies of those projects are used in your project, as are any that the project inherits from its parents, or from its dependencies, and so on.</p> <p>There is no limit to the number of levels that dependencies can be gathered from. A problem arises only if a cyclic dependency is discovered.</p> <p>With transitive dependencies, the graph of included libraries can quickly grow quite large. For this reason, there are additional features that limit which dependencies are included:</p> <ul> - -<li> -<p><em>Dependency mediation</em> - this determines what version of an artifact will be chosen when multiple versions are encountered as dependencies. Maven picks the “nearest definition”. That is, it uses the version of the closest dependency to your project in the tree of dependencies. You can always guarantee a version by declaring it explicitly in your project's POM. Note that if two dependency versions are at the same depth in the dependency tree, the first declaration wins.</p></li> -<li> -<p>“nearest definition” means that the version used will be the closest one to your project in the tree of dependencies. Consider this tree of dependencies:</p></li> -</ul> - -<div class="source"><pre class="prettyprint linenums"><code> A +<li><i>Dependency mediation</i> - this determines what version of an artifact will be chosen when multiple versions are encountered as dependencies. Maven picks the "nearest definition". That is, it uses the version of the closest dependency to your project in the tree of dependencies. You can always guarantee a version by declaring it explicitly in your project's POM. Note that if two dependency versions are at the same depth in the dependency tree, the first declaration wins. +<ul> +<li>"nearest definition" means that the version used will be the closest one to your project in the tree of dependencies. Consider this tree of dependencies: +<div> +<pre> A ├── B │ └── C │ └── D 2.0 └── E - └── D 1.0 -</code></pre></div> - -<div class="source"><pre class="prettyprint linenums"><code>In text, dependencies for A, B, and C are defined as A -\> B -\> C -\> D 2.0 and A -\> E -\> D 1.0, then D 1.0 will be used when building A because the path from A to D through E is shorter. You could explicitly add a dependency to D 2.0 in A to force the use of D 2.0, as shown here: -</code></pre></div> - -<div class="source"><pre class="prettyprint linenums"><code> A + └── D 1.0</pre></div> +<p>In text, dependencies for A, B, and C are defined as A -> B -> C -> D 2.0 and A -> E -> D 1.0, then D 1.0 will be used when building A because the path from A to D through E is shorter. You could explicitly add a dependency to D 2.0 in A to force the use of D 2.0, as shown here:</p> +<div> +<pre> A ├── B │ └── C │ └── D 2.0 ├── E │ └── D 1.0 │ - └── D 2.0 -</code></pre></div> -<ul> - -<li> -<p><em>Dependency management</em> - this allows project authors to directly specify the versions of artifacts to be used when they are encountered in transitive dependencies or in dependencies where no version has been specified. In the example in the preceding section a dependency was directly added to A even though it is not directly used by A. Instead, A can include D as a dependency in its dependencyManagement section and directly control which version of D is used when, or if, it is ever referenced.</p></li> -<li> -<p><em>Dependency scope</em> - this allows you to only include dependencies appropriate for the current stage of the build. This is described in more detail below.</p></li> -<li> -<p><em>Excluded dependencies</em> - If project X depends on project Y, and project Y depends on project Z, the owner of project X can explicitly exclude project Z as a dependency, using the “exclusion” element.</p></li> -<li> -<p><em>Optional dependencies</em> - If project Y depends on project Z, the owner of project Y can mark project Z as an optional dependency, using the “optional” element. When project X depends on project Y, X will depend only on Y and not on Y's optional dependency Z. The owner of project X may then explicitly add a dependency on Z, at her option. (It may be helpful to think of optional dependencies as “excluded by default.”)</p></li> -</ul> + └── D 2.0 </pre></div></li></ul></li> +<li><i>Dependency management</i> - this allows project authors to directly specify the versions of artifacts to be used when they are encountered in transitive dependencies or in dependencies where no version has been specified. In the example in the preceding section a dependency was directly added to A even though it is not directly used by A. Instead, A can include D as a dependency in its dependencyManagement section and directly control which version of D is used when, or if, it is ever referenced.</li> +<li><i>Dependency scope</i> - this allows you to only include dependencies appropriate for the current stage of the build. This is described in more detail below.</li> +<li><i>Excluded dependencies</i> - If project X depends on project Y, and project Y depends on project Z, the owner of project X can explicitly exclude project Z as a dependency, using the "exclusion" element.</li> +<li><i>Optional dependencies</i> - If project Y depends on project Z, the owner of project Y can mark project Z as an optional dependency, using the "optional" element. When project X depends on project Y, X will depend only on Y and not on Y's optional dependency Z. The owner of project X may then explicitly add a dependency on Z, at her option. (It may be helpful to think of optional dependencies as "excluded by default.")</li></ul> <p>Although transitive dependencies can implicitly include desired dependencies, it is a good practice to explicitly specify the dependencies your source code uses directly. This best practice proves its value especially when the dependencies of your project change their dependencies.</p> <p>For example, assume that your project A specifies a dependency on another project B, and project B specifies a dependency on project C. If you are directly using components in project C, and you don't specify project C in your project A, it may cause build failure when project B suddenly updates/removes its dependency on project C.</p> -<p>Another reason to directly specify dependencies is that it provides better documentation for your project: one can learn more information by just reading the POM file in your project, or by executing <strong>mvn dependency:tree</strong>.</p> +<p>Another reason to directly specify dependencies is that it provides better documentation for your project: one can learn more information by just reading the POM file in your project, or by executing <b>mvn dependency:tree</b>.</p> <p>Maven also provides <a href="/plugins/maven-dependency-plugin/analyze-mojo.html">dependency:analyze</a> plugin goal for analyzing the dependencies: it helps making this best practice more achievable.</p></section><section> -<h3>Dependency Scope</h3> +<h2><a id="Dependency_Scope">Dependency Scope</a></h2> <p>Dependency scope is used to limit the transitivity of a dependency and to determine when a dependency is included in a classpath.</p> <p>There are 6 scopes:</p> <ul> - -<li> -<p><strong>compile</strong><br /> -This is the default scope, used if none is specified. Compile dependencies are available in all classpaths of a project. Furthermore, those dependencies are propagated to dependent projects.</p></li> -<li> -<p><strong>provided</strong><br /> -This is much like <code>compile</code>, but indicates you expect the JDK or a container to provide the dependency at runtime. For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the Servlet API and related Java EE APIs to scope <code>provided</code> because the web container provides those classes. A dependency with this scope is added to the classpath used for compilation and test, but not the runtime classpath. It is not transitive.</p></li> -<li> -<p><strong>runtime</strong><br /> -This scope indicates that the dependency is not required for compilation, but is for execution. Maven includes a dependency with this scope in the runtime and test classpaths, but not the compile classpath.</p></li> -<li> -<p><strong>test</strong><br /> -This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases. This scope is not transitive. Typically this scope is used for test libraries such as JUnit and Mockito. It is also used for non-test libraries such as Apache Commons IO if those libraries are used in unit tests (src/test/java) but not in the model code (src/main/java).</p></li> -<li> -<p><strong>system</strong><br /> -This scope is similar to <code>provided</code> except that you have to provide the JAR which contains it explicitly. The artifact is always available and is not looked up in a repository.</p></li> -<li> -<p><strong>import</strong><br /> -This scope is only supported on a dependency of type <code>pom</code> in the <code><dependencyManagement></code> section. It indicates the dependency is to be replaced with the effective list of dependencies in the specified POM's <code><dependencyManagement></code> section. Since they are replaced, dependencies with a scope of <code>import</code> do not actually participate in limiting the transitivity of a dependency.</p></li> -</ul> +<li><b>compile</b><br />This is the default scope, used if none is specified. Compile dependencies are available in all classpaths of a project. Furthermore, those dependencies are propagated to dependent projects.</li> +<li><b>provided</b><br />This is much like <code>compile</code>, but indicates you expect the JDK or a container to provide the dependency at runtime. For example, when building a web application for the Java Enterprise Edition, you would set the dependency on the Servlet API and related Java EE APIs to scope <code>provided</code> because the web container provides those classes. A dependency with this scope is added to the classpath used for compilation and test, but not the runtime classpath. It is not transitive.</li> +<li><b>runtime</b><br />This scope indicates that the dependency is not required for compilation, but is for execution. Maven includes a dependency with this scope in the runtime and test classpaths, but not the compile classpath.</li> +<li><b>test</b><br />This scope indicates that the dependency is not required for normal use of the application, and is only available for the test compilation and execution phases. This scope is not transitive. Typically this scope is used for test libraries such as JUnit and Mockito. It is also used for non-test libraries such as Apache Commons IO if those libraries are used in unit tests (src/test/java) but not in the model code (src/main/java).</li> +<li><b>system</b><br />This scope is similar to <code>provided</code> except that you have to provide the JAR which contains it explicitly. The artifact is always available and is not looked up in a repository.</li> +<li><b>import</b><br />This scope is only supported on a dependency of type <code>pom</code> in the <code><dependencyManagement></code> section. It indicates the dependency is to be replaced with the effective list of dependencies in the specified POM's <code><dependencyManagement></code> section. Since they are replaced, dependencies with a scope of <code>import</code> do not actually participate in limiting the transitivity of a dependency.</li></ul> <p>Each of the scopes (except for <code>import</code>) affects transitive dependencies in different ways, as is demonstrated in the table below. If a dependency is set to the scope in the left column, a transitive dependency of that dependency with the scope across the top row results in a dependency in the main project with the scope listed at the intersection. If no scope is listed, it means the dependency is omitted.</p> -<table class="table table-striped"> -<thead> +<table class="bodyTable bodyTableBorder"> <tr class="a"> -<th></th> -<th>compile</th> -<th>provided</th> -<th>runtime</th> -<th>test</th></tr></thead><tbody> +<td style="text-align: left;"></td> +<td style="text-align: left;">compile</td> +<td style="text-align: left;">provided</td> +<td style="text-align: left;">runtime</td> +<td style="text-align: left;">test</td></tr> <tr class="b"> -<td>compile</td> -<td>compile(*)</td> -<td>-</td> -<td>runtime</td> -<td>-</td></tr> +<td style="text-align: left;">compile</td> +<td style="text-align: left;">compile(*)</td> +<td style="text-align: left;">-</td> +<td style="text-align: left;">runtime</td> +<td style="text-align: left;">-</td></tr> <tr class="a"> -<td>provided</td> -<td>provided</td> -<td>-</td> -<td>provided</td> -<td>-</td></tr> +<td style="text-align: left;">provided</td> +<td style="text-align: left;">provided</td> +<td style="text-align: left;">-</td> +<td style="text-align: left;">provided</td> +<td style="text-align: left;">-</td></tr> <tr class="b"> -<td>runtime</td> -<td>runtime</td> -<td>-</td> -<td>runtime</td> -<td>-</td></tr> +<td style="text-align: left;">runtime</td> +<td style="text-align: left;">runtime</td> +<td style="text-align: left;">-</td> +<td style="text-align: left;">runtime</td> +<td style="text-align: left;">-</td></tr> <tr class="a"> -<td>test</td> -<td>test</td> -<td>-</td> -<td>test</td> -<td>-</td></tr></tbody> -</table> - -<p><strong>(*) Note:</strong> it is intended that this should be runtime scope instead, so that all compile dependencies must be explicitly listed. However, if a library you depend on extends a class from another library, both must be available at compile time. For this reason, compile time dependencies remain as compile scope even when they are transitive.</p></section><section> -<h3>Dependency Management</h3> +<td style="text-align: left;">test</td> +<td style="text-align: left;">test</td> +<td style="text-align: left;">-</td> +<td style="text-align: left;">test</td> +<td style="text-align: left;">-</td></tr></table> +<p><b>(*) Note:</b> it is intended that this should be runtime scope instead, so that all compile dependencies must be explicitly listed. However, if a library you depend on extends a class from another library, both must be available at compile time. For this reason, compile time dependencies remain as compile scope even when they are transitive.</p></section><section> +<h2><a id="Dependency_Management">Dependency Management</a></h2> <p>The dependency management section is a mechanism for centralizing dependency information. When you have a set of projects that inherit from a common parent, it's possible to put all information about the dependency in the common POM and have simpler references to the artifacts in the child POMs. The mechanism is best illustrated through some examples. Given these two POMs which extend the same parent:</p> <p>Project A:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -323,11 +269,9 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>Project B:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -347,11 +291,9 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>These two example POMs share a common dependency and each has one non-trivial dependency. This information can be put in the parent POM like this:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencyManagement> @@ -388,11 +330,9 @@ This scope is only supported on a depend </dependencies> </dependencyManagement> </project> - -</code></pre></div> +</pre></div> <p>Then the two child POMs become much simpler:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -409,10 +349,8 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +</pre></div> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -431,13 +369,11 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> -<p><strong>NOTE:</strong> In two of these dependency references, we had to specify the <code><type></code> element. This is because the minimal set of information for matching a dependency reference against a dependencyManagement section is actually <strong>{groupId, artifactId, type, classifier}</strong>. In many cases, these dependencies will refer to jar artifacts with no classifier. This allows us to shorthand the identity set to <strong>{groupId, artifactId}</strong>, since the default for the type field is <code>jar</code>, and the default classifier is null.</p> +</pre></div> +<p><b>NOTE:</b> In two of these dependency references, we had to specify the <type/> element. This is because the minimal set of information for matching a dependency reference against a dependencyManagement section is actually <b>{groupId, artifactId, type, classifier}</b>. In many cases, these dependencies will refer to jar artifacts with no classifier. This allows us to shorthand the identity set to <b>{groupId, artifactId}</b>, since the default for the type field is <code>jar</code>, and the default classifier is null.</p> <p>A second, and very important use of the dependency management section is to control the versions of artifacts used in transitive dependencies. As an example consider these projects:</p> <p>Project A:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <modelVersion>4.0.0</modelVersion> <groupId>maven</groupId> @@ -472,11 +408,9 @@ This scope is only supported on a depend </dependencies> </dependencyManagement> </project> - -</code></pre></div> +</pre></div> <p>Project B:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <parent> <artifactId>A</artifactId> @@ -514,24 +448,17 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>When maven is run on project B, version 1.0 of artifacts a, b, c, and d will be used regardless of the version specified in their POM.</p> <ul> - -<li> -<p>a and c both are declared as dependencies of the project so version 1.0 is used due to dependency mediation. Both also have runtime scope since it is directly specified.</p></li> -<li> -<p>b is defined in B's parent's dependency management section and since dependency management takes precedence over dependency mediation for transitive dependencies, version 1.0 will be selected should it be referenced in a or c's POM. b will also have compile scope.</p></li> -<li> -<p>Finally, since d is specified in B's dependency management section, should d be a dependency (or transitive dependency) of a or c, version 1.0 will be chosen - again because dependency management takes precedence over dependency mediation and also because the current POM's declaration takes precedence over its parent's declaration.</p></li> -</ul> +<li>a and c both are declared as dependencies of the project so version 1.0 is used due to dependency mediation. Both also have runtime scope since it is directly specified.</li> +<li>b is defined in B's parent's dependency management section and since dependency management takes precedence over dependency mediation for transitive dependencies, version 1.0 will be selected should it be referenced in a or c's POM. b will also have compile scope.</li> +<li>Finally, since d is specified in B's dependency management section, should d be a dependency (or transitive dependency) of a or c, version 1.0 will be chosen - again because dependency management takes precedence over dependency mediation and also because the current POM's declaration takes precedence over its parent's declaration.</li></ul> <p>The reference information about the dependency management tags is available from the <a href="../../ref/current/maven-model/maven.html#class_DependencyManagement">project descriptor reference</a>.</p><section> -<h4>Importing Dependencies</h4> -<p>The examples in the previous section describe how to specify managed dependencies through inheritance. However, in larger projects it may be impossible to accomplish this since a project can only inherit from a single parent. To accommodate this, projects can import managed dependencies from other projects. This is accomplished by declaring a POM artifact as a dependency with a scope of “import”.</p> +<h3><a id="Importing_Dependencies">Importing Dependencies</a></h3> +<p>The examples in the previous section describe how to specify managed dependencies through inheritance. However, in larger projects it may be impossible to accomplish this since a project can only inherit from a single parent. To accommodate this, projects can import managed dependencies from other projects. This is accomplished by declaring a POM artifact as a dependency with a scope of "import".</p> <p>Project B:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <modelVersion>4.0.0</modelVersion> <groupId>maven</groupId> @@ -571,12 +498,10 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>Assuming A is the POM defined in the preceding example, the end result would be the same. All of A's managed dependencies would be incorporated into B except for d since it is defined in this POM.</p> <p>Project X:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <modelVersion>4.0.0</modelVersion> <groupId>maven</groupId> @@ -601,11 +526,9 @@ This scope is only supported on a depend </dependencies> </dependencyManagement> </project> - -</code></pre></div> +</pre></div> <p>Project Y:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <modelVersion>4.0.0</modelVersion> <groupId>maven</groupId> @@ -630,11 +553,9 @@ This scope is only supported on a depend </dependencies> </dependencyManagement> </project> - -</code></pre></div> +</pre></div> <p>Project Z:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> <modelVersion>4.0.0</modelVersion> <groupId>maven</groupId> @@ -662,15 +583,13 @@ This scope is only supported on a depend </dependencies> </dependencyManagement> </project> - -</code></pre></div> +</pre></div> <p>In the example above Z imports the managed dependencies from both X and Y. However, both X and Y contain dependency a. Here, version 1.1 of a would be used since X is declared first and a is not declared in Z's dependencyManagement.</p> <p>This process is recursive. For example, if X imports another POM, Q, when Z is processed it will simply appear that all of Q's managed dependencies are defined in X.</p></section><section> -<h4>Bill of Materials (BOM) POMs</h4> -<p>Imports are most effective when used for defining a “library” of related artifacts that are generally part of a multiproject build. It is fairly common for one project to use one or more artifacts from these libraries. However, it has sometimes been difficult to keep the versions in the project using the artifacts in synch with the versions distributed in the library. The pattern below illustrates how a “bill of materials” (BOM) can be created for use by other projects.</p> +<h3><a id="Bill_of_Materials_BOM_POMs">Bill of Materials (BOM) POMs</a></h3> +<p>Imports are most effective when used for defining a "library" of related artifacts that are generally part of a multiproject build. It is fairly common for one project to use one or more artifacts from these libraries. However, it has sometimes been difficult to keep the versions in the project using the artifacts in synch with the versions distributed in the library. The pattern below illustrates how a "bill of materials" (BOM) can be created for use by other projects.</p> <p>The root of the project is the BOM POM. It defines the versions of all the artifacts that will be created in the library. Other projects that wish to use the library should import this POM into the dependencyManagement section of their POM.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -702,11 +621,9 @@ This scope is only supported on a depend <module>parent</module> </modules> </project> - -</code></pre></div> +</pre></div> <p>The parent subproject has the BOM POM as its parent. It is a normal multiproject pom.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -740,11 +657,9 @@ This scope is only supported on a depend <module>project2</module> </modules> </project> - -</code></pre></div> +</pre></div> <p>Next are the actual project POMs.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -786,11 +701,9 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>The project that follows shows how the library can now be used in another project without having to specify the dependent project's versions.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +<div class="source"><pre class="prettyprint linenums"><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.test</groupId> @@ -820,24 +733,17 @@ This scope is only supported on a depend </dependency> </dependencies> </project> - -</code></pre></div> +</pre></div> <p>Finally, when creating projects that import dependencies, beware of the following:</p> <ul> - -<li> -<p>Do not attempt to import a POM that is defined in a submodule of the current POM. Attempting to do that will result in the build failing since it won't be able to locate the POM.</p></li> -<li> -<p>Never declare the POM importing a POM as the parent (or grandparent, etc) of the target POM. There is no way to resolve the circularity and an exception will be thrown.</p></li> -<li> -<p>When referring to artifacts whose POMs have transitive dependencies, the project needs to specify versions of those artifacts as managed dependencies. Not doing so results in a build failure since the artifact may not have a version specified. (This should be considered a best practice in any case as it keeps the versions of artifacts from changing from one build to the next).</p></li> -</ul></section></section><section> -<h3>System Dependencies</h3> +<li>Do not attempt to import a POM that is defined in a submodule of the current POM. Attempting to do that will result in the build failing since it won't be able to locate the POM.</li> +<li>Never declare the POM importing a POM as the parent (or grandparent, etc) of the target POM. There is no way to resolve the circularity and an exception will be thrown.</li> +<li>When referring to artifacts whose POMs have transitive dependencies, the project needs to specify versions of those artifacts as managed dependencies. Not doing so results in a build failure since the artifact may not have a version specified. (This should be considered a best practice in any case as it keeps the versions of artifacts from changing from one build to the next).</li></ul></section></section><section> +<h2><a id="System_Dependencies">System Dependencies</a></h2> <p><code>Important note: This is deprecated.</code></p> -<p>Dependencies with the scope <em>system</em> are always available and are not looked up in repository. They are usually used to tell Maven about dependencies which are provided by the JDK or the VM. Thus, system dependencies are especially useful for resolving dependencies on artifacts which are now provided by the JDK, but were available as separate downloads earlier. Typical examples are the JDBC standard extensions or the Java Authentication and Authorization Service (JAAS).</p> +<p>Dependencies with the scope <i>system</i> are always available and are not looked up in repository. They are usually used to tell Maven about dependencies which are provided by the JDK or the VM. Thus, system dependencies are especially useful for resolving dependencies on artifacts which are now provided by the JDK, but were available as separate downloads earlier. Typical examples are the JDBC standard extensions or the Java Authentication and Authorization Service (JAAS).</p> <p>A simple example would be:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"> +<div class="source"><pre class="prettyprint linenums"> <project> ... <dependencies> @@ -851,11 +757,9 @@ This scope is only supported on a depend </dependencies> ... </project> - -</code></pre></div> +</pre></div> <p>If your artifact is provided by the JDK's <code>tools.jar</code>, the system path would be defined as follows:</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> ... <dependencies> <dependency> @@ -867,8 +771,7 @@ This scope is only supported on a depend </dependency> </dependencies> ... -</project> -</code></pre></div></section></section></section> +</project></pre></div></section></section> </main> </div> </div>
