You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by pl...@apache.org on 2003/01/26 08:41:30 UTC
cvs commit: jakarta-turbine-maven/src/plugins-build/j2ee/xdocs appserver.xml changes.xml futures.xml goals.xml index.xml navigation.xml properties.xml
plynch 2003/01/25 23:41:30
Modified: src/plugins-build/j2ee/xdocs appserver.xml changes.xml
futures.xml goals.xml index.xml navigation.xml
properties.xml
Removed: src/plugins-build/j2ee plugin.properties
Log:
o removing references to the appserver plugin except a small stub that says it is now a new plugin
o removing appserver related properties from plugin.properties
Revision Changes Path
1.2 +3 -104 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/appserver.xml
Index: appserver.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/appserver.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- appserver.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ appserver.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -9,111 +9,10 @@
<body>
<section name="Maven J2EE Appserver Control">
<p>
- This page offers some general information about the appserver control
- features of the J2EE plug-in. Specific details about
- <a href="./goals.html#maven:appserver-install">related targets</a> and
- their <a href="./properties.html#Application Server" >properties</a> can be found elsewhere.
+ The Maven J2EE Plugin appserver control features have been migrated to a
+ standalone Maven appserver plugin. For more information see the appserver
+ plugin documentation.
</p>
- </section>
- <section name="Plug-in Rationale">
- <p>
- When developing a web application (or website for that matter), each developer
- working on the project needs to have an environment to run and test their
- application. Rather than store a complete application server install in source
- control, it is much more feasible to have a centralized install of that
- application server. Then, using only the minimum configuration files the
- developer can control a separate isolated instance of the application server
- on their machine.
- </p>
- <p>
- The Maven J2EE plug-in appserver features use this technique to install and control
- application server instances for your project needs. The appserver
- features <strong>are not</strong> for
- deploying webapps or war files into application servers.
- </p>
- </section>
-
- <section name="Supported Servers">
- <p>
- The following table shows the various appserver versions that are
- supported by the appserver control features of the Maven J2EE plug-in
- and what propety values are required to be set in order for the
- maven:appserver-* targets to work with those versions.
- </p>
- <table>
- <tr>
- <th>Server</th>
- <th>${maven.appserver.name}</th>
- <th>${maven.appserver.version}</th>
- <th>${maven.j2ee.version}</th>
- </tr>
- <tr>
- <td><a href="http://jakarta.apache.org/tomcat">Tomcat 4.x</a></td>
- <td><code>tomcat</code></td>
- <td><code>40</code></td>
- <td><code>12</code> or <code>13</code></td>
- </tr>
- </table>
-
- <p>The following application servers are expected to be supported soon:</p>
- <ul>
- <li><a href="http://enhydra.enhydra.org/">Enhydra</a></li>
- <li><a href="http://www.orionserver.com/">Orion</a></li>
- <li><a href="http://www.caucho.com/products/resin/">Resin</a></li>
- <li><a href="http://www.weblogic.com/">Weblogic</a></li>
- </ul>
- </section>
-
- <section name="Appserver Proxy Build File">
- <p>
- To make life even easier when using the appserver targets, the Maven J2EE
- plug-in includes a proxy build file. This means a file similar to the one
- below is copied to the directory specified by
- <a href="./properties.html#maven.appserver.dir">${maven.appserver.dir}</a>.
- </p>
- <table><tr><th>${maven.appserver.dir}/build.xml</th></tr></table>
- <source><![CDATA[
- <?xml version="1.0"?>
- <project name="Maven Application Server Plugin Proxy" default="install"
- basedir="@basedir@">
-
- <!-- ================================================================== -->
- <!-- Proxy for controlling an installed application server instance -->
- <!-- ================================================================== -->
-
- <!-- ========================================================== -->
- <!-- Give user a chance to override without editing this file -->
- <!-- (and without typing -D each time they compile) -->
- <!-- ========================================================== -->
- <!-- all ant projects specific properties -->
- <property file="${user.home}/build.properties" />
- <!-- project/user specific settings -->
- <property file="@basedir@/build.properties" />
- <!-- anything here is expected to be project defaults -->
- <property file="@basedir@/project.properties" />
- <!-- ========================================================== -->
-
- <target name="install">
- <ant antfile="${maven.home}/plugins/j2ee/build.xml"
- target="appserver-install" />
- </target>
-
- <target name="start">
- <ant antfile="${maven.home}/plugins/j2ee/build.xml"
- target="appserver-start" />
- </target>
-
- <target name="stop">
- <ant antfile="${maven.home}/plugins/j2ee/build.xml"
- target="appserver-stop" />
- </target>
-
- </project>]]>
- </source>
- <p>Using this build file, you can run the appserver related targets quickly
- from within your ${maven.appserver.dir} directory. Typing simply</p>
- <source><![CDATA[ant]]></source>
- <p>can stop, re-install, and re-start a started server instance.</p>
</section>
</body>
</document>
1.2 +6 -1 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/changes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- changes.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ changes.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -3,6 +3,7 @@
<properties>
<title>Changes</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
+ <author email="plynch@apache.org">Peter Lynch</author>
</properties>
<body>
@@ -12,10 +13,14 @@
b5
</action>
<action dev="dion" type="fix">
- Fix for jars not being included in an EAR file
+ Fix for jars not being included in an EAR file
</action>
<action dev="dion" type="add">
Added the new <a href="changes-report.html">changes report</a>.
+ </action>
+ <action dev="plynch" type="remove">
+ Removed appserver plugin from the J2EE project workspace. The Maven
+ appserver plugin is now a seperate project.
</action>
</release>
</body>
1.2 +1 -9 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/futures.xml
Index: futures.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/futures.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- futures.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ futures.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -15,7 +15,7 @@
</p>
<ol>
<li>
- We need to have Class-Path entries in generated J2EE EJB jars and
+ We need to have Class-Path entries in generated J2EE EJB jars and
such. Quite tricky as it doesn't work the same for all application
servers (and across versions of them !).
</li>
@@ -31,14 +31,6 @@
<li>
Add technology specific validators, e.g. JSP/Turbine/Velocity/Struts
etc
- </li>
- <li>
- Allow integration with a 'webserver' plugin so that application server
- requests can seamlessly be hooked into the application server.
- </li>
- <li>
- Tie where applicable the appserver instance to other Maven plugins that
- need an application server instance to do their work.
</li>
</ol>
</section>
1.2 +4 -201 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/goals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- goals.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ goals.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -11,12 +11,12 @@
<body>
<section name="Overview">
<p>
- This document describes the supplied
+ This document describes the supplied
<a href="http://jakarta.apache.org/commons/sandbox/jelly/tags.html#jelly:werkz">goals</a>
that are available when using the J2EE Plug-in with Maven.
</p>
<p>
- Please refer to the
+ Please refer to the
<a href="../../start/integrate.html">Integration</a> document for
more information on how to integrate these goals into
your project.
@@ -46,24 +46,6 @@
<td><a href="#j2ee:ear">j2ee:ear</a></td>
<td>Creates an <code>EAR</code> file.</td>
</tr>
- <tr>
- <td><a href="#j2ee:appserver-install">j2ee:appserver-install</a></td>
- <td>Installs an Application Server instance</td>
- </tr>
- <tr>
- <td><a href="#j2ee:appserver-start">j2ee:appserver-start</a></td>
- <td>Starts an Application Server instance</td>
- </tr>
- <tr>
- <td><a href="#j2ee:appserver-stop">j2ee:appserver-stop</a></td>
- <td>Stops an Application Server instance</td>
- </tr>
- <tr>
- <td><a href="#j2ee:appserver-clean">j2ee:appserver-clean</a></td>
- <td>Safely deletes the Application Server instance installation directory
- specified by the <code><a href="./properties.html">${maven.appserver.dir}</a></code>
- property.</td>
- </tr>
</table>
<p/>
<subsection name="j2ee:validate-war">
@@ -177,7 +159,7 @@
A J2EE enterprise application deployment descriptor, which
is placed in the META-INF of the resulting ear file.
The <code><a href="properties.html#maven.j2ee.ear.appxml">${maven.j2ee.ear.appxml}</a></code>
- property defines the location of this file. It defaults to
+ property defines the location of this file. It defaults to
<code>src/application.xml</code>
</td>
</tr>
@@ -185,7 +167,7 @@
<td>Other Content</td>
<td>
Any dependencies specified in your <code>project.xml</code>
- may be included by adding the ear.bundle.jar property to the
+ may be included by adding the ear.bundle.jar property to the
properties, e.g.
<source><![CDATA[
<dependency>
@@ -196,185 +178,6 @@
</properties>
</dependency>
]]></source>
- </td>
- </tr>
- </table>
- </subsection>
-
- <!-- j2ee:appserver-* targets ======================================= -->
-
- <subsection name="j2ee:appserver-install">
- <p>
- The <code>j2ee:appserver-install</code> target installs the minimum
- directory and file structure necessary for an individual application
- server instance. Once the structure is created inside the
- directory specified by <a href="properties.html#maven.appserver.dir">${maven.appserver.dir}</a>
- , configuration files are installed using the copy task and the filter
- mechanism built into <a href="http://jakarta.apache.org/ant">Ant</a>.
- The exact work done by this target is specific to the
- name and version of the application server you specify using
- <a href="properties.html#maven.appserver.name">${maven.appserver.name}</a>
- and <a href="properties.html#maven.appserver.version">${maven.appserver.version}</a>
- properties.
- </p>
- <p>
- Optionally, you can invoke the <code>install</code> target of the
- Ant build.xml file copied to ${maven.appserver.dir} instead. See the
- <a href="appserver.html#Appserver Proxy Build File">appserver proxy build file</a> for more
- information.
- </p>
- <p>
- During the configuration process, all
- <a href="./properties.html#Application Server">maven.appserver.* properties</a>
- are used as filter tokens while files in
- ${maven.conf.dir}/${maven.appserver.name}${maven.appserver.version} are
- copied to ${maven.appserver.dir}. By default, certain files are
- excluded from copying to ${maven.appserver.dir}. Files excluded are:
- </p>
- <ul>
- <li>**/web.xml/**</li>
- </ul>
- <p>
- This allows you to keep you webapp specific conf files in the same
- directory and not have them installed with this target needlessly.
- </p>
- <p>
- Your configuration files may require additional processing ( using additional
- filter tokens for example). In that case you can use the
- <a href="properties.html#maven.appserver.post-appserver-install.buildFile">maven-post-appserver-install</a>
- callback target to re-configure files.
- </p>
- <p>
- This target has different behavior
- depending on the current status of the application server. The
- behavior is defined by the following rules:
- </p>
- <table>
- <tr><th>Server Status</th><th>Behavior</th></tr>
- <tr>
- <td>Not Installed</td>
- <td>
- Install and configure the application server.
- </td>
- </tr>
- <tr>
- <td>Installed and stopped</td>
- <td>
- Re-install/re-configure the application server.
- </td>
- </tr>
- <tr>
- <td>Installed and started</td>
- <td>
- Stop, re-install/re-configure, re-start the application server.
- </td>
- </tr>
- </table>
- <p><strong>Note:</strong> In all situations, the <code>j2ee:appserver-install</code>
- target will overwrite existing appserver configuration files already
- installed. Maven does this because it cannot know if the you have changed
- your <a href="properties.html#Application Server">maven.appserver.* related properties</a>,
- so it always re-configures the configuration files. Since this
- operation has low overhead, it is considered a feature that allows dynamic
- updates to your appserver related property values.</p>
- </subsection>
-
- <subsection name="j2ee:appserver-start">
- <p>
- The <code>j2ee:appserver-start</code> target
- attempts to start the application server instance you have specified
- via properties.
- </p>
- <p>Optionally, you can invoke the <code>start</code> target of the
- Ant build.xml file copied to ${maven.appserver.dir} instead. See the
- <a href="appserver.html#Appserver Proxy Build File">appserver proxy build file</a> for more
- information.
- </p>
- <p>
- This target will cause two processes to run. One process will
- represent the running of the Ant build file for the Maven target.
- The other will be the forked JVM that actually starts the application
- server instance.
- </p>
- <p>
- If you don't want the processes to block your current terminal,
- you can execute the call to this target in the background using the
- traditional '&' directive on unix-like systems.
- </p>
- <p> For example, to run the server in the background, go to your
- ${maven.appserver.dir} directory and type:</p>
- <source><![CDATA[ant start &]]></source>
- <p>
- This target has different behavior
- depending on the current status of the application server. The
- behavior is defined by the following rules:
- </p>
- <table>
- <tr><th>Server Status</th><th>Behavior</th></tr>
- <tr>
- <td>Not Installed</td>
- <td>
- Install/configure, then start the application server.
- </td>
- </tr>
- <tr>
- <td>Installed and stopped</td>
- <td>
- Start the application server.
- </td>
- </tr>
- <tr>
- <td>Installed and started</td>
- <td>
- Stop and then re-start the application server. This is useful for
- application servers that are not set to auto-reload resources.
- </td>
- </tr>
- </table>
- </subsection>
-
- <subsection name="j2ee:appserver-stop">
- <p>
- The <code>j2ee:appserver-stop</code> target
- attempts to stop the application server instance you have specified
- via the <a href="properties.html">maven.appserver.* properties</a>.
- </p>
- <p>Optionally, you can invoke the <code>stop</code> target of the
- Ant build.xml file copied to ${maven.appserver.dir} instead. See the
- <a href="appserver.html#Appserver Proxy Build File">appserver proxy build file</a> for more
- information.
- </p>
- <p>
- This target only has relevance if the application server instance
- is actually started. All other situations do nothing.
- </p>
- </subsection>
-
-
- <subsection name="j2ee:appserver-clean">
- <p>
- The <code>j2ee:appserver-clean</code> target
- attempts to safely delete the directory specified by
- ${maven.appserver.dir}.
- </p>
- <p>
- This target has different behavior
- depending on the current status of the application server. The
- behavior is defined by the following rules:
- </p>
- <table>
- <tr><th>Server Status</th><th>Behavior</th></tr>
- <tr>
- <td>Installed and stopped</td>
- <td>
- Deletes the directory specified by ${maven.appserver.dir}.
- </td>
- </tr>
- <tr>
- <td>Installed and started</td>
- <td>
- Stop the application server instance and then delete the directory
- specified by ${maven.appserver.dir}.
</td>
</tr>
</table>
1.2 +1 -8 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ index.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -41,18 +41,11 @@
hierarchy is used for.
</td>
</tr>
- <tr><td><a href="appserver.html">Appserver Notes</a></td>
+ <tr><td><a href="appserver.html">Appserver Control</a></td>
<td>
<p>
This page contains additional reference material regarding the application server (
appserver ) control features of the Maven J2EE plugin.
- </p>
- <p>
- For additional help in understanding what the appserver features of the
- Maven J2EE plugin are, look at the
- <a href="properties.html#Application Server">J2EE plug-in properties</a>
- and <a href="./goals.html#maven:appserver-install">J2EE build file</a>
- documents.
</p>
</td>
</tr>
1.2 +1 -1 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 24 Jan 2003 03:45:31 -0000 1.1
+++ navigation.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -11,7 +11,7 @@
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
<item name="Directory Layout" href="/dirlayout.html"/>
- <item name="Appserver Notes" href="/appserver.html"/>
+ <item name="Appserver Control" href="/appserver.html"/>
<item name="Futures" href="/futures.html"/>
</menu>
</body>
1.2 +0 -184 jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/j2ee/xdocs/properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- properties.xml 24 Jan 2003 03:45:32 -0000 1.1
+++ properties.xml 26 Jan 2003 07:41:29 -0000 1.2
@@ -28,13 +28,6 @@
<table>
<tr><th>Section</th><th>Description</th></tr>
<tr>
- <td><a href="#General Settings">General Settings</a></td>
- <td>
- These properties specify various settings that may be used in any
- J2EE Plug-in target.
- </td>
- </tr>
- <tr>
<td><a href="#War Settings">War</a></td>
<td>
These properties specify various settings that control the build
@@ -55,43 +48,10 @@
of an ear file by the J2EE Plug-in.
</td>
</tr>
- <tr>
- <td><a href="#Application Server">Appserver</a></td>
- <td>
- These properties detail what application server instance you would
- like to install and control for your project and how to configure
- it.
- </td>
- </tr>
</table>
</section>
- <section name="General Settings" >
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
- <tr>
- <td><a name="maven.j2ee.version">maven.j2ee.version</a></td>
- <td>
- No for the "appserver:install" goal.
- Otherwise, Yes.
- </td>
- <td>
- Specifies the version of J2EE you are trying to use. Valid values are:
- <ul>
- <li>12</li>
- <li>13</li>
- </ul>
- The above values represent version 1.2 and 1.3 respectively.
- The value of this property is especially important for the
- <a href="appserver.html#Supported Servers">supported servers</a>
- used with the appserver control features of this plugin.
- </td>
- </tr>
- </table>
- </section>
-
-
<section name="War Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
@@ -318,150 +278,6 @@
</td>
</tr>
- </table>
- </section>
-
-
-
- <section name="Application Server">
- <p> Although application server ( appserver ) instance control is part
- of the J2EE plugin, all appserver related properties begin with
- the "maven.appserver" prefix. This is indicative of the large scope of
- functionality within the appserver targets.
- </p>
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
-
- <tr>
- <td><a name="maven.appserver.name">maven.appserver.name</a></td>
- <td>No</td>
- <td>
- Specifies the name of the application server to install and control
- for your project.
- <p />
- Please refer to the <a href="appserver.html#Supported Servers">supported servers</a>
- table for a current list of supported appservers and the ${maven.appserver.name}
- value they use use.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.version">maven.appserver.version</a></td>
- <td>No</td>
- <td>
- Specifies the version of the appserver to install and control
- for your project. Please refer to the
- <a href="appserver.html#Supported Servers">supported servers</a>
- table for a current list of supported appservers and the
- ${maven.appserver.version} value they use.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.home">maven.appserver.home</a></td>
- <td>No</td>
- <td>
- Specifies the directory where the shared installation of the appserver
- resides. This should be the home of the appserver specified by
- <a href="#maven.appserver.name">${maven.appserver.name}</a>
- and <a href="#maven.appserver.version">${maven.appserver.version}</a>.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.dir">maven.appserver.dir</a></td>
- <td>No</td>
- <td>
- Specifies the directory where the appserver instance is installed
- during the "appserver:install" goal.
- Defaults to be ${basedir}/server .
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.host">maven.appserver.host</a></td>
- <td>No</td>
- <td>
- Specifies the default host to use to access the started server
- instance. Defaults to 'localhost'.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.port.http">maven.appserver.port.http</a></td>
- <td>No</td>
- <td>
- Specifies the HTTP port number to use to access the started server
- instance. Defaults to 8080.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.url">maven.appserver.url</a></td>
- <td>No</td>
- <td>
- The URL that is used to test if your appserver instance is running.
- This URL must point to a target that will return a response code < 400
- when your appserver instance is started. Default value is
- http://${maven.appserver.host}:${maven.appserver.port.http}/index.html
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.port.https">maven.appserver.port.https</a></td>
- <td>Yes</td>
- <td>
- Specifies the HTTPS port number to use to access the started server
- instance using SSL. Defaults to 444.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.port.one">maven.appserver.port.one</a></td>
- <td>Yes</td>
- <td>
- Optional additional port you can specify when configuring appserver files during
- install.
- </td>
- </tr>
- <tr>
- <td><a name="maven.appserver.port.two">maven.appserver.port.two</a></td>
- <td>Yes</td>
- <td>
- Optional additional port you can specify when configuring appserver files during
- install.
- </td>
- </tr>
- <tr>
- <td><a name="maven.appserver.port.three">maven.appserver.port.three</a></td>
- <td>Yes</td>
- <td>
- Optional additional port you can specify when configuring appserver files during
- install.
- </td>
- </tr>
-
- <tr>
- <td><a name="maven.appserver.classpath">maven.appserver.classpath</a></td>
- <td>Yes</td>
- <td>
- A <a href="http://jakarta.apache.org/ant/manual/using.html#path">path-like</a>
- value that can specify resources to make available as
- part of the classpath of the JVM used when controlling your appserver instance.
- For example, you may have several webapps running in the same container
- that require a JDBC driver be available. Adding a reference to that
- jar here will put it in the classpath of the JVM used to start
- your appserver.
- <p/>
- An example of a valid value might be:
- <p/>
- <code>/jars/database.jar;/jars/foobar.jar</code>
- <p/>
- Path seperators are automatically converted to their system correct values.
- By default, there are no additional paths. <strong>Jars required to control an appserver
- are automatically built-in and do not need to be added here.</strong>
- </td>
- </tr>
</table>
</section>
</body>