dion 02/05/23 02:04:31
Modified: xdocs/ref/j2ee properties.xml build-file.xml
Log:
Docs for ejb-jar patch as provided by Kevin O'Neill <[EMAIL PROTECTED]>
Revision Changes Path
1.5 +135 -0 jakarta-turbine-maven/xdocs/ref/j2ee/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/j2ee/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- properties.xml 15 May 2002 19:17:45 -0000 1.4
+++ properties.xml 23 May 2002 09:04:31 -0000 1.5
@@ -3,6 +3,7 @@
<properties>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
+ <author email="[EMAIL PROTECTED]">Kevin O'Neill</author>
<title>Maven J2EE Plug-in Properties Documentation</title>
</properties>
@@ -32,6 +33,13 @@
</td>
</tr>
<tr>
+ <td><a href="#EJB Settings">EJB</a></td>
+ <td>
+ These properties specify various settings that control the build
+ of a ejb jar by the J2EE Plug-in.
+ </td>
+ </tr>
+ <tr>
<td><a href="#Ear Settings">Ear</a></td>
<td>
These properties specify various settings that control the build
@@ -132,6 +140,93 @@
</tr>
</table>
</section>
+
+ <section name="EJB Settings">
+ <table>
+ <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
+ <tr>
+ <td><a name="maven.j2ee.ejb.name">maven.j2ee.ejb.name</a></td>
+ <td>No</td>
+ <td>
+ Specifies the name of the ejb jar to be built.
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.ejb.ejb-xml">maven.j2ee.ejb.ejb-xml</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the deployment descriptor to be used when building the ejb
jar.
+ It will be placed in <code>META-INF</code> directory of the resulting
+ ejb jar. It defaults to
+ <code><a href="../properties.html#Directory Layout
Settings">${maven.conf.dir}</a>/<a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>/ejb-jar.xml</code>
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.ejb.includes">maven.j2ee.ejb.includes</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the pattern of files in the
+ <a href="../properties.html#Directory Layout
Settings">${maven.build.dest}</a>
+ directory to be included in the generated ejb jar. Defaults to
<code>**/*</code>.
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.ejb.excludes">maven.j2ee.ejb.includes</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the pattern of compiled class files to be
<strong>excluded</strong>
+ from the generated ejb jar. Defaults to <code>**/package.html</code>.
+ </td>
+ </tr>
+ <tr>
+ <td><a
name="maven.j2ee.ejb.meta-inf-includes">maven.j2ee.ejb.meta-inf-includes</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the a pattern of files to be included in the
<code>META-INF</code>
+ directory of the generated ejb jar. This can be used to include
container
+ specific files, for example <code>mvcsoft-pm.xml</code>.
+ </td>
+ </tr>
+ <tr>
+ <td><a
name="maven.j2ee.ejb.local.includes">maven.j2ee.ejb.local.includes</a></td>
+ <td>Yes</td>
+ <td>
+ If this property exists then a jar file with the name
+ <code><a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-local.jar</code>
+ containing the matching files will be generated in
+ <code><a href="../properties.html#Directory Layout
Settings">${maven.build.dir}</a>/ejb</code>.
+ </td>
+ </tr>
+ <tr>
+ <td><a
name="maven.j2ee.ejb.local.excludes">maven.j2ee.ejb.local.excludes</a></td>
+ <td>Yes</td>
+ <td>
+ Files to be <strong>excluded</strong> from the
+ <code><a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-local.jar</code>
+ </td>
+ </tr>
+ <tr>
+ <td><a
name="maven.j2ee.ejb.remote.includes">maven.j2ee.ejb.remote.includes</a></td>
+ <td>Yes</td>
+ <td>
+ If this property exists then a jar file with the name
+ <code><a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-remote.jar</code>
+ containing the matching files will be generated in
+ <code><a href="../properties.html#Directory Layout
Settings">${maven.build.dir}</a>/ejb</code>.
+ </td>
+ </tr>
+ <tr>
+ <td><a
name="maven.j2ee.ejb.remote.excludes">maven.j2ee.ejb.remote.excludes</a></td>
+ <td>Yes</td>
+ <td>
+ Files to be <strong>excluded</strong> from the
+ <code><a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-remote.jar</code>
+ </td>
+ </tr>
+ </table>
+ </section>
+
+
<section name="Ear Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
@@ -214,6 +309,46 @@
There is no default for this property.
</td>
</tr>
+
+ <tr>
+ <td><a name="maven.j2ee.callback.pre-ejb.buildFile">
+ maven.j2ee.callback.pre-ejb.buildFile</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the build file containing the target to call immediately
+ before building the ejb jar.
+ There is no default for this property.
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.callback.pre-ejb.buildTarget">
+ maven.j2ee.callback.pre-ejb.buildFile</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the target to call immediately before building the ejb jar.
+ There is no default for this property.
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.callback.post-ejb.buildFile">
+ maven.j2ee.callback.post-ejb.buildFile</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the build file containing the target to call immediately
+ after building the ejb jar.
+ There is no default for this property.
+ </td>
+ </tr>
+ <tr>
+ <td><a name="maven.j2ee.callback.post-ejb.buildTarget">
+ maven.j2ee.callback.post-ejb.buildTarget</a></td>
+ <td>Yes</td>
+ <td>
+ Specifies the target to call immediately after building the ejb jar.
+ There is no default for this property.
+ </td>
+ </tr>
+
<tr>
<td><a name="maven.j2ee.callback.pre-ear.buildFile">
maven.j2ee.callback.pre-ear.buildFile</a></td>
1.11 +65 -3 jakarta-turbine-maven/xdocs/ref/j2ee/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/j2ee/build-file.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- build-file.xml 21 May 2002 01:20:33 -0000 1.10
+++ build-file.xml 23 May 2002 09:04:31 -0000 1.11
@@ -3,6 +3,7 @@
<properties>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
+ <author email="[EMAIL PROTECTED]">Kevin O'Neill</author>
<title>Maven J2EE Plug-in Build File Documentation</title>
</properties>
@@ -44,8 +45,8 @@
<tr>
<td><a href="#j2ee/build.xml">j2ee-build.xml</a></td>
<td>
- Contains targets to create and validate J2EE <code>WAR</code> and
- <code>EAR</code> files
+ Contains targets to create and validate J2EE <code>WAR</code>
+ and <code>EAR</code> files. Creates <code>EJB</code> jar files.
</td>
</tr>
</table>
@@ -71,6 +72,10 @@
<td>Validate a <code>WAR</code> file.</td>
</tr>
<tr>
+ <td><a href="#maven:ejb">maven:ejb</a></td>
+ <td>Creates an <code>EJB</code>jar file.</td>
+ </tr>
+ <tr>
<td><a href="#maven:ear">maven:ear</a></td>
<td>Creates an <code>EAR</code> file.</td>
</tr>
@@ -164,7 +169,64 @@
<li>Login and error pages specified in the
<code><form-login-config
></code> element must exist in the war file</li>
</ol>
+ </p>
+ </subsection>
+ <subsection name="maven:ejb">
+ <p>
+ The <code>maven:ejb</code> target generates the <code>ejb</code> jar file
+ for the project. Optionally it can also create jars containing the local
+ and remote interfaces. The files are produced in the
+ <code><a href="../properties.html#Directory Layout
Settings">${maven.build.dir}</a>/ejb</code>
+ directory and have a name based on the
+ <code><a
href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a></code>
+ property.
+ </p>
+ <p>The files generated are:
+ <ul>
+ <li><code>${maven.j2ee.ejb.name}.jar</code></li>
+ <li><code>${maven.j2ee.ejb.name}-remote.jar</code>
<emp>(optional)</emp></li>
+ <li><code>${maven.j2ee.ejb.name}-local.jar</code>
<emp>(optional)</emp></li>
+ </ul>
</p>
+ <p>
+ Maven also includes the license file, LICENSE.txt, if it exists, in
+ the META-INF directory.
+ </p>
+ <p>
+ The contents of the ejb file include:
+ </p>
+ <table>
+ <tr><th>Item</th><th>Description</th></tr>
+ <tr>
+ <td>ejb-jar.xml</td>
+ <td>
+ A J2EE enterprise bean deployment descriptor, which
+ is placed in the root of the resulting ear file.
+ The <code><a
href="properties.html#maven.j2ee.ejb.ejb-xml">${maven.j2ee.ejb.ejb-xml}</a></code>
+ property defines the location of this file.
+ </td>
+ </tr>
+ <tr>
+ <td>Classes</td>
+ <td>
+ The files in the <code><a href="../properties.html#Directory Layout
Settings">${maven.build.dest}</a></code>
+ directory to be included is specified using the
+ <code><a
href="properties.html#maven.j2ee.ejb.includes">${maven.j2ee.ejb.includes}</a></code>
+ and <code><a
href="properties.html#maven.j2ee.ejb.excludes">${maven.j2ee.ejb.excludes}</a></code>
+ properties.
+ </td>
+ </tr>
+ <tr>
+ <td>Meta-Inf</td>
+ <td>
+ Files to be included the <code>META-INF</code> directory of the ejb
+ jar file may be specified using the
+ <code><a
href="properties.html#maven.j2ee.ejb.meta-inf-includes">${maven.j2ee.ejb.meta-inf-includes}</a></code>
+ and <code><a
href="properties.html#maven.j2ee.ejb.meta-inf-excludes">${maven.j2ee.ejb.meta-inf-excludes}</a></code>
+ properties.
+ </td>
+ </tr>
+ </table>
</subsection>
<subsection name="maven:ear">
<p>
@@ -185,7 +247,7 @@
the directory META-INF.
</p>
<p>
- The contents of the war file include:
+ The contents of the ear file include:
</p>
<table>
<tr><th>Item</th><th>Description</th></tr>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
