You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2009/02/09 10:53:19 UTC
svn commit: r742360 - in /maven/plugins/trunk/maven-ejb-plugin/src/site:
apt/examples/ejb-client-dependency.apt
apt/examples/generating-ejb-client.apt apt/index.apt apt/usage.apt site.xml
Author: dennisl
Date: Mon Feb 9 09:53:18 2009
New Revision: 742360
URL: http://svn.apache.org/viewvc?rev=742360&view=rev
Log:
o Minor site improvements.
Modified:
maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/ejb-client-dependency.apt
maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/generating-ejb-client.apt
maven/plugins/trunk/maven-ejb-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-ejb-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-ejb-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/ejb-client-dependency.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/ejb-client-dependency.apt?rev=742360&r1=742359&r2=742360&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/ejb-client-dependency.apt (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/ejb-client-dependency.apt Mon Feb 9 09:53:18 2009
@@ -30,14 +30,14 @@
Using the ejb-client as a dependency
The EJB Plugin is capable of generating another artifact aside from the primary one which is EJB. To choose the EJB client
- as the dependency just specify the type as <<<ejb-client>>>.
+ as the dependency just specify the type as <<<ejb-client>>>.
* Normal way of adding an EJB dependency
-
+
The following dependency declaration would include the primary EJB artifact <<<ejb-project-1.0-SNAPSHOT.jar>>> in your
project's package.
-
-+------------+
+
++------------+
<project>
[...]
<dependencies>
@@ -51,13 +51,13 @@
[...]
</project>
+------------+
-
+
* Using the ejb-client
Using the following dependency declaration would instead use the ejb-client artifact
<<<ejb-project-1.0-SNAPSHOT-client.jar>>> in your project's package.
-+------------+
++------------+
<project>
[...]
<dependencies>
@@ -71,6 +71,6 @@
[...]
</project>
+------------+
-
-
- For more details on generating the ejb client check the {{{generating-ejb-client.html}ejb-client guide}}.
+
+
+ Read more about {{{generating-ejb-client.html}Generating the EJB client}}.
Modified: maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/generating-ejb-client.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/generating-ejb-client.apt?rev=742360&r1=742359&r2=742360&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/generating-ejb-client.apt (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/apt/examples/generating-ejb-client.apt Mon Feb 9 09:53:18 2009
@@ -53,25 +53,25 @@
[...]
</build>
[...]
-+---------+
++---------+
* Client inclusions and exclusions
- The content of the ejb-client archive can also be customized using inclusions and exclusions.
-
+ The content of the ejb-client archive can also be customized using inclusions and exclusions.
+
** Default Exclusions:
- *<<<\*\*/\*Bean.class>>>
-
+ *<<<\*\*/\*Bean.class>>>
+
*<<<\*\*/\*CMP.class>>>
-
+
*<<<\*\*/\*Session.class>>>
-
+
*<<<\*\*/package.html>>>
[]
-
- To customize this, use <<<clientExcludes>>> and <<<clientIncludes>>> element:
+
+ To customize this, use the <<<clientExcludes>>> and <<<clientIncludes>>> elements:
+--------+
[...]
@@ -87,14 +87,15 @@
<clientInclude>com/foo/bar/**</clientInclude>
<!-- this will include all files and directories under com/foo/acme -->
<clientInclude>com/foo/acme/**</clientInclude>
- <!-- this will include all files under com/example -->
- <clientInclude>com/example/*</clientInclude>
+ <!-- this will include all files under com/example -->
+ <clientInclude>com/example/*</clientInclude>
</clientIncludes>
<clientExcludes>
- <!-- this will exclude all files under com/example -->
- <clientExclude>com/example/*</clientExclude>
- <!-- this will exclude all files and directories with the name sparrow under com/jack -->
- <clientExclude>com/jack/**/sparrow</clientExclude>
+ <!-- this will exclude all files under com/example -->
+ <clientExclude>com/example/*</clientExclude>
+ <!-- this will exclude all files and directories with the name
+ sparrow under com/jack -->
+ <clientExclude>com/jack/**/sparrow</clientExclude>
</clientExcludes>
</configuration>
</plugin>
@@ -104,4 +105,4 @@
[...]
+---------+
- <<Be careful when mixing excludes and includes, excludes will have a higher priority than includes.>>
+ <<Note:>> Be careful when mixing excludes and includes, excludes will have a higher priority than includes.
Modified: maven/plugins/trunk/maven-ejb-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/apt/index.apt?rev=742360&r1=742359&r2=742360&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/apt/index.apt Mon Feb 9 09:53:18 2009
@@ -36,7 +36,7 @@
* Goals Overview
{{{ejb-mojo.html}ejb:ejb}} - used by Maven for projects with ejb package type.
-
+
* Usage
General instructions on how to use the EJB Plugin can be found on the {{{usage.html}usage page}}. Some more
@@ -56,18 +56,18 @@
Of course, patches are welcome, too. Contributors can check out the project from our
{{{source-repository.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
-
+
* Examples
To provide you with better understanding on some usages of the Maven EJB Plugin,
you can take a look into the following examples:
- * {{{examples/generating-ejb-client.html}Generating an ejb client}}
-
+ * {{{examples/generating-ejb-client.html}Generating an EJB client}}
+
* {{{examples/ejb-client-dependency.html}Using the ejb-client as a dependency}}
[]
-
+
* Related Links
* {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide to manifest customization}}
Modified: maven/plugins/trunk/maven-ejb-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/apt/usage.apt?rev=742360&r1=742359&r2=742360&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/apt/usage.apt Mon Feb 9 09:53:18 2009
@@ -32,33 +32,33 @@
Usage
The EJB Plugin is used to package an EJB module. There are two ways to use the EJB Plugin:
-
+
* If the packaging type defined in the <<<pom.xml>>> is <<<ejb>>>, the <<<package>>> lifecycle phase can be used
-
+
+--------------+
mvn package
-+--------------+
-
++--------------+
+
* or using the <<<ejb:ejb>>> goal
-
+
+--------------+
mvn ejb:ejb
+--------------+
[]
-
+
The plugin doesn't do any EJB specific processing during the generation of the jar except for validating the existence
of an EJB deployment descriptor if the EJB version is 2.0+, but it provides the following customization:
* The EJB version to use
-
+
* {{{examples/generating-ejb-client.html}Generating and customizing an ejb-client}}
- <<The dependencies will not be package with the EJB jar.>>
+ <<Note:>> The dependencies will not be package with the EJB jar.
* Specifying the EJB version to use
- In EJB3, the ejb-jar.xml deployment descriptor is not mandatory anymore. By default
+ In EJB3, the <<<ejb-jar.xml>>> deployment descriptor is not mandatory anymore. By default
the plugin assumes version 2.1. To use another version, configure the plugin as follows:
+--------
Modified: maven/plugins/trunk/maven-ejb-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/site.xml?rev=742360&r1=742359&r2=742360&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/site.xml Mon Feb 9 09:53:18 2009
@@ -28,8 +28,8 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Using the ejb client as a dependency" href="examples/ejb-client-dependency.html"/>
- <item name="Generating an ejb jar client" href="examples/generating-ejb-client.html" />
+ <item name="Generating an EJB client" href="examples/generating-ejb-client.html" />
+ <item name="Using the ejb-client as a dependency" href="examples/ejb-client-dependency.html"/>
</menu>
</body>
</project>