You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ol...@apache.org on 2012/01/10 14:27:12 UTC
svn commit: r1229532 - in /tomcat/maven-plugin/trunk/src/site/apt:
index.apt.vm run-mojo-features.apt.vm
Author: olamy
Date: Tue Jan 10 13:27:11 2012
New Revision: 1229532
URL: http://svn.apache.org/viewvc?rev=1229532&view=rev
Log:
documentation on run mojo
Added:
tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm (with props)
Modified:
tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm
Modified: tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm?rev=1229532&r1=1229531&r2=1229532&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm (original)
+++ tomcat/maven-plugin/trunk/src/site/apt/index.apt.vm Tue Jan 10 13:27:11 2012
@@ -42,6 +42,9 @@ Apache Tomcat Maven Plugin
The Tomcat Maven Plugin provides goals to manipulate WAR projects within the {{{http://tomcat.apache.org/}Apache Tomcat}} servlet container.
+ Or to run your war project in an embeded Apache Tomcat. The run goal give you the opportunity to develop quickly your application without any
+ huge install to do manually. More details and features: {{{./run-mojo-features.html}see documentation}}.
+
* groupId and Mojo name change
Since version 2.0-beta-1 tomcat mojos has been renamed to tomcat6 and tomcat7 with the same goals.
@@ -89,9 +92,9 @@ Apache Tomcat Maven Plugin
* Know limitations
- Some goals are not yet available in tomcat7 mojo. Those {{{./container-goals.html}contains goals}} are available with
+ Some goals are not yet available in tomcat7 mojo. Those {{{./container-goals.html}container goals}} are available with
the tomcat6 mojo, you only need to update the manager url in your pom.
- Use <<<http://localhost:8080/manager/html>>> rather than the default tomcat6 url.
+ Use <<<http://localhost:8080/manager/html>>> rather than the default tomcat6 url.
Added: tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm
URL: http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm?rev=1229532&view=auto
==============================================================================
--- tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm (added)
+++ tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm Tue Jan 10 13:27:11 2012
@@ -0,0 +1,142 @@
+ ---
+ Run Mojo
+ ---
+ Oliver Lamy
+ ---
+ 2011-01-10
+ ---
+
+ ~~ 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Run Mojo: run your Maven war project quickly !
+
+ When developping a war project, you usually build your war and deploy it to an installed Tomcat instance.
+ This is time and resources consuming and take time to install locally the instance.
+
+ The run mojo give you the opportunity to save that by simply running your war inside an embeded Tomcat instance in your Maven build.
+
+ <<<NOTE>>> If you have a multi module Maven projects and use Maven3, you don't need to install all modules before use the run goal,
+ just use tomcat6/7:run from the root module and the plugin will auto detect build output directory from various modules and replace
+ dependencies with those directories in the webapp classloader.
+
+* Run an embeded Tomcat
+
+ Configure your pom with the plugin version (for other mojo parameters see each mojo documentation details).
+
+ And use: mvn tomcat6/7:run
+
++---------------------
+ <plugin>
+ <groupId>org.apache.tomcat.maven</groupId>
+ <artifactId>tomcat7-maven-plugin</artifactId>
+ <!-- or if you want to use tomcat 6.x
+ <artifactId>tomcat6-maven-plugin</artifactId>
+ -->
+ <version>${project.version}</version>
+ <configuration>
+ <!-- http port -->
+ <port>9090</port>
+ <!-- application path always starts with /-->
+ <path>/</path>
+ <!-- optionnal path to a context file -->
+ <contextFile>${tomcatContextXml}</contextFile>
+ <!-- optionnal system propoerties you want to add -->
+ <systemProperties>
+ <appserver.base>${project.build.directory}/appserver-base</appserver.base>
+ <appserver.home>${project.build.directory}/appserver-home</appserver.home>
+ <derby.system.home>${project.build.directory}/appserver-base/logs</derby.system.home>
+ <java.io.tmpdir>${project.build.directory}</java.io.tmpdir>
+ </systemProperties>
+ <!-- if you want to use test dependencies rather than only runtime -->
+ <useTestClasspath>false</useTestClasspath>
+ <!-- optionnal if you want to add some extra directories in the class loader -->
+ <additionalClasspathDirs>
+ <additionalClasspathDir></additionalClasspathDir>
+ </additionalClasspathDirs>
+ </configuration>
+ <!-- if you need some extra dependencies only for running the embeded tomcat add them in the plugin dependencies -->
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.derby</groupId>
+ <artifactId>derby</artifactId>
+ <version>${derbyVersion}</version>
+ </dependency>
+ <dependency>
+ <groupId>javax.mail</groupId>
+ <artifactId>mail</artifactId>
+ <version>1.4</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+
++---------------------
+
+* Maven project structure
+
++---------------------
+ pom.xml (top level pom with packaging pom)
+ my-api/pom.xml (api project with packaging jar)
+ my-api-impl/pom.xml (api implementation project with packaging jar)
+ my-webapp/pom.xml (webapp project with packaging war)
+
++---------------------
+
+ With a such structure, from the top level directory use mvn tomcat6/7:run -pl :my-webapp -am.
+
+* Use it with selenium mojo
+
+ You can use the mojo, to start your application in a Tomcat instance and run you selenium test against this instance.
+
+ The following configuration will start an emdeded tomcat in pre-integration-test and stop it in post-integration-test.
+
++---------------------
+
+ <plugin>
+ <groupId>org.apache.tomcat.maven</groupId>
+ <artifactId>tomcat7-maven-plugin</artifactId>
+ <!-- or if you want to use tomcat 6.x
+ <artifactId>tomcat6-maven-plugin</artifactId>
+ -->
+ <version>${project.version}</version>
+ <executions>
+ <execution>
+ <id>tomcat-run</id>
+ <goals>
+ <goal>run-war-only</goal>
+ </goals>
+ <phase>pre-integration-test</phase>
+ <configuration>
+ ....
+ <fork>true</fork>
+ ....
+ </configuration>
+ </execution>
+ <execution>
+ <id>tomcat-shutdown</id>
+ <goals>
+ <goal>shutdown</goal>
+ </goals>
+ <phase>post-integration-test</phase>
+ </execution>
+ </executions>
+ </plugin>
+
++---------------------
Propchange: tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/maven-plugin/trunk/src/site/apt/run-mojo-features.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org