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 2008/07/07 18:32:34 UTC
svn commit: r674546 - 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
fml/faq.fml
Author: dennisl
Date: Mon Jul 7 09:32:32 2008
New Revision: 674546
URL: http://svn.apache.org/viewvc?rev=674546&view=rev
Log:
o Improve docs.
o Add missing license headers.
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/fml/faq.fml
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=674546&r1=674545&r2=674546&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 Jul 7 09:32:32 2008
@@ -3,20 +3,42 @@
------
Pete Marvin King
------
- 15 July 2006
+ 2008-07-07
------
+ ~~ 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
+
+
Using the ejb-client as a dependency
- The ejb client is capable of generating another artifact aside from the primary one which is ejb. To choose the ejb client
+ 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>>>.
-* Normal way of adding an ejb dependency
+* 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
+ The following dependency declaration would include the primary EJB artifact <<<ejb-project-1.0-SNAPSHOT.jar>>> in your
project's package.
+------------+
+<project>
[...]
<dependencies>
<dependency>
@@ -27,14 +49,16 @@
</dependency>
</dependencies>
[...]
-+------------+
+</project>
++------------+
* Using the ejb-client
- Using this dependency declaration would instead use the ejb-client artifact <<<ejb-project-1.0-SNAPSHOT-client.jar>>>
- in your project's package.
+ 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>
<dependency>
@@ -45,11 +69,8 @@
</dependency>
</dependencies>
[...]
-+------------+
+</project>
++------------+
For more details on generating the ejb client check the {{{generating-ejb-client.html}ejb-client guide}}.
-
-
-
-
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=674546&r1=674545&r2=674546&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 Jul 7 09:32:32 2008
@@ -1,17 +1,38 @@
------
- Generating an ejb client
+ Generating an EJB client
------
Stephane Nicoll
<sn...@apache.org>
Pete Marvin King
------
- 15 July 2006
+ 2008-07-07
------
-Generating an ejb client
+ ~~ 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.
- Normally a thick-client application would only need the stubs and utility classes of the ejb project.
- The ejb plugin is capable of generating an ejb jar for client use.
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Generating an EJB client
+
+ Normally a thick-client application would only need the stubs and utility classes of the EJB project.
+ The EJB Plugin is capable of generating an EJB jar for client use.
To generate the ejb-client jar, you need to set <<<generateClient>>> to <<<true>>> in the plugin's configuration:
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=674546&r1=674545&r2=674546&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 Jul 7 09:32:32 2008
@@ -5,16 +5,37 @@
<sn...@apache.org>
Pete Marvin King
------
- 15 July 2006
+ 2008-07-07
------
+ ~~ 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
+
+
Maven EJB Plugin
This plugin generates J2EE Enterprise Javabean (EJB) file as well as the associated client jar.
* Goals Overview
- {{{ejb-mojo.html}ejb:ejb}} - used by maven for projects with ejb package type.
+ {{{ejb-mojo.html}ejb:ejb}} - used by Maven for projects with ejb package type.
* Usage
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=674546&r1=674545&r2=674546&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 Jul 7 09:32:32 2008
@@ -5,14 +5,35 @@
<sn...@apache.org>
Pete Marvin King
------
- 15 July 2006
+ 2008-07-07
------
+ ~~ 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
+
+
Usage
- The EJB plugin is used to package an EJB module. There are two ways to use the ejb plugin:
+ 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
+ * If the packaging type defined in the <<<pom.xml>>> is <<<ejb>>>, the <<<package>>> lifecycle phase can be used
+--------------+
mvn package
@@ -26,16 +47,16 @@
[]
- 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 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
+ * 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.>>
+ <<The dependencies will not be package with the EJB jar.>>
-* Specifying the ejb version to use
+* Specifying the EJB version to use
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/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ejb-plugin/src/site/fml/faq.fml?rev=674546&r1=674545&r2=674546&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ejb-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-ejb-plugin/src/site/fml/faq.fml Mon Jul 7 09:32:32 2008
@@ -53,7 +53,7 @@
</answer>
</faq>
<faq id="classifieruse">
- <question>How does the classifier affect artifacts in my ejb project?</question>
+ <question>How does the classifier affect artifacts in my EJB project?</question>
<answer>
<p>When used, the copy of the artifact in your project will have the classifier appended to its
filename. This can be used to differentiate duplicate artifacts.</p>