Bommels05/maven-plugins
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Added documentation and release notes for version 1.7.1 and above.

Browse Source 
- Removed tasks.xml file as there's no pending tasks and we're now using JIRA.

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@290686 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol committed 2005-09-21 12:14:29 +00:00
1 parent eefe89fb9e
commit 8f3a2caa71
4 files changed
+77 -112
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

ejb/xdocs/goals.xml
+27 -32
View File
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,59 +22,54 @@
<title>Maven EJB Plug-in Goals</title>
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
<author email="nathan.coast@blueyonder.co.uk">Nathan Coast</author>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<goals>
<goal>
<name>ejb</name>
<description>
Build a ejb file.
This goal simply executes the <a href="ejb:ejb">ejb:ejb</a> goal
Same as <code>ejb:ejb</code>. See the documentation for the
<code>ejb:ejb</code> goal.
</description>
</goal>
<goal>
<name>ejb:init</name>
<description>Initialize the file system and attain any necessary goals</description>
</goal>
<goal>
<name>ejb:ejb</name>
<description>
Constructs the ejb-jar file from the compiled sources
and resources.
</description>
</goal>
<goal>
<name>ejb:ejb-client</name>
<description>
Constructs the ejb client jar file from the compiled sources
and resources. The maven.ejb.client.* properties are used to
determine what is excluded.
Builds the main EJB JAR file and an EJB client JAR if the
<code>maven.ejb.client.generate</code> property is set to true
(it's false by default). Note that this goal is equivalent to
<code>ejb:ejb</code>.
</description>
</goal>
<goal>
<name>ejb:install</name>
<description>Installs the generated ejb-jar file into the local repository</description>
</goal>
<goal>
<name>ejb:install-snapshot</name>
<description>Install the snapshot version of the ejb into the local repository</description>
</goal>
<goal>
<name>ejb:install-client</name>
<description>Installs the generated ejb-jar client file into the local repository</description>
<description>
Installs the generated EJB JAR file and its EJB client JAR into
the local Maven repository.
</description>
</goal>
<goal>
<name>ejb:deploy</name>
<description>Deploy the ejb to the remote repository(ies)</description>
<description>
Deploy the main EJB JAR and its EJB client JAR into the remote
Maven repository(ies).
</description>
</goal>
<goal>
<name>ejb:install-snapshot</name>
<description>
Install the snapshot version of the main EJB JAR into the local
Maven repository
</description>
</goal>
<goal>
<name>ejb:deploy-snapshot</name>
<description>Deploy the snapshot version of the ejb to the remote repository(ies)</description>
<description>
Deploy the snapshot version of the main EJB JAR into the remote
Maven repository(ies).
</description>
</goal>
<goal>
<name>ejb:deploy-client</name>
<description>Deploys the generated ejb-jar client file into the remote repository(ies)</description>
</goal>
</goals>
</body>
</document>
ejb/xdocs/index.xml
+44 -6
View File
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,12 +22,13 @@
<properties>
<title>Maven EJB Plug-in</title>
<author email="nathan.coast@blueyonder.co.uk">Nathan Coast</author>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<section name="Maven EJB Plug-in">
<p>
This plug-in provides your basic ejb jar facilities.
This plug-in provides your basic EJB JAR facilities.
</p>
<p>
For more information on the functionality provided by this plugin,
@@ -38,10 +39,47 @@
by this plugin, please see the <a href="properties.html">properties</a>
document.
</p>
<p>
Tasks and todos for future development of this plugin,
please see the <a href="tasks.html">tasks</a> document.
</p>
</section>
<section name="Version 1.7.1+ release notes">
<ul>
<li>
Version 1.7.1 and greater of the EJB plugin require Maven 1.1 beta 2
or above. The reason is that we have introduced a new
<code>ejb-client</code> dependency type and that required modifying
Maven's core.
</li>
<li>
The EJB client is now generated by the main <code>ejb:ejb</code> goal
at the same time it generates the main EJB JAR. The generation is
controlled by the <code>maven.ejb.client.generate</code> property
(see the <a href="properties.html">properties</a> page for more
details) which defaults to false.
</li>
<li>
EJB client JARs are deployed in the Maven repository in the
<code>ejbs/</code> directory alongside the main EJB JARs.
</li>
<li>
In order to reference an EJB client JAR from another project you'll need
to specify an <code>ejb-client</code> type. Here's an example:
</li>
<source><![CDATA[
<dependency>
<groupId>groupId</groupId>
<artifactId>ejbClientJarArtifactId</artifactId>
<version>aversion</version>
<type>ejb-client</type>
</dependency>
]]></source>
<li>
The following goals have been deprecated:
<code>ejb:ejb-client</code>, <code>ejb:install-client</code> and
<code>ejb:deploy-client</code>. To generate, install and deploy the
EJB client JAR use the <code>ejb:ejb</code>, <code>ejb:install</code>
and <code>ejb:deploy</code> goals respectively and set the
<code>maven.ejb.client.generate</code> to true.
</li>
</ul>
</section>
</body>
</document>
ejb/xdocs/properties.xml
+6 -27
View File
@@ -84,9 +84,8 @@
<td>maven.ejb.includes</td>
<td>Yes</td>
<td>
Files to include in ejb.
Note: Files are relative to
<code>${maven.build.dest}</code>.
Files to include in ejb.
Note: Files are relative to <code>${maven.build.dest}</code>.
</td>
<td>**</td>
</tr>
@@ -94,9 +93,8 @@
<td>maven.ejb.excludes</td>
<td>Yes</td>
<td>
Files to exclude in ejb
Note: Files are relative to
<code>${maven.build.dest}</code>.
Files to exclude in ejb.
Note: Files are relative to <code>${maven.build.dest}</code>.
</td>
<td>**/package.html</td>
</tr>
@@ -145,7 +143,7 @@
<td>maven.ejb.client.generate</td>
<td>Yes</td>
<td>
Decide wether to generate an ejb client jar or not.
Decide wether to generate an EJB client JAR or not.
</td>
<td>
false
@@ -164,26 +162,7 @@
</tr>
</table>
</section>
<section name="other settings">
<table>
<tr><th>Property</th><th>Description</th><th>See</th></tr>
<tr>
<td>maven.build.dir</td>
<td>where the component will be assembled</td>
<td>
<A href="../java/properties.html#Other Settings">maven.build.dir</A>
</td>
</tr>
<tr>
<td>maven.final.name</td>
<td>The assembled component will be <code>${maven.build.dir}/${maven.final.name}.jar</code></td>
<td>
<A href="../java/properties.html#Other Settings">maven.final.name</A>
</td>
</tr>
</table>
</section>
<section name="Including Jars in standalone ejb jars">
<section name="Including JARs in standalone EJB JARs">
<p>
You must tell Maven what jars you want included in the ejb. This is
probably only needed if you are building a standalone ejb jar. This
ejb/xdocs/tasks.xml
-47
View File
@@ -1,47 +0,0 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>Tasks</title>
<author email="nathan.coast@blueyonder.co.uk">Nathan Coast</author>
</properties>
<body>
<section name="Tasks">
<p>
Lists of todos and ideas for future versions.
</p>
<subsection name="1.0">
<p>
<ul>
<li>
utilise the ant ejbjar task to build the ejb jar.
</li>
<li>
Add code for local ejb-jars and client ejb-jars.
</li>
</ul>
</p>
</subsection>
</section>
</body>
</document>