You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ep...@apache.org on 2006/08/02 03:38:21 UTC
svn commit: r427848 - in /maven/plugins/trunk/maven-ear-plugin/src/site:
apt/modules.apt fml/faq.fml
Author: epunzalan
Date: Tue Aug 1 18:38:20 2006
New Revision: 427848
URL: http://svn.apache.org/viewvc?rev=427848&view=rev
Log:
PR: MEAR-32
Applying review comments by Stephane Nicole:
- modules should start with lower case letters
- proper way of handling faq entry #2
- added mini-guide for the solution to faq entry #2
- fixed copy/paste errors in modules configuration page
Modified:
maven/plugins/trunk/maven-ear-plugin/src/site/apt/modules.apt
maven/plugins/trunk/maven-ear-plugin/src/site/fml/faq.fml
Modified: maven/plugins/trunk/maven-ear-plugin/src/site/apt/modules.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ear-plugin/src/site/apt/modules.apt?rev=427848&r1=427847&r2=427848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ear-plugin/src/site/apt/modules.apt (original)
+++ maven/plugins/trunk/maven-ear-plugin/src/site/apt/modules.apt Tue Aug 1 18:38:20 2006
@@ -28,28 +28,32 @@
The EAR Plugin supports additional configurations of the following modules:
- * {{{#Ejb3Module}Ejb3Module}}
+ * {{{#ejb3Module}ejb3Module}}
- * {{{#EjbClientModule}EjbClientModule}}
+ * {{{#ejbClientModule}ejbClientModule}}
- * {{{#EjbModule}EjbModule}}
+ * {{{#ejbModule}ejbModule}}
- * {{{#JavaModule}JavaModule}}
+ * {{{#javaModule}javaModule}}
- * {{{#ParModule}ParModule}}
+ * {{{#parModule}parModule}}
- * {{{#RarModule}RarModule}}
+ * {{{#rarModule}rarModule}}
- * {{{#SarModule}SarModule}}
+ * {{{#sarModule}sarModule}}
- * {{{#WebModule}WebModule}}
+ * {{{#webModule}webModule}}
- * {{{#WsrModule}WsrModule}}
+ * {{{#wsrModule}wsrModule}}
- * {{{#HarModule}HarModule}}
+ * {{{#harModule}harModule}}
[]
+ If the artifact you want to configure is not listed above, you can create your
+ own custom artifact configuration by following the
+ {{{#Custom Artifact Types}adding custom artifact types}} guide below this page.
+
These module names go into the <<<modules>>> parameter of the EAR Plugin. For
example, to configure the properties of an EjbModule, the EAR Plugin
configuration for <<<modules>>> would look like:
@@ -65,9 +69,9 @@
<artifactId>maven-ear-plugin</artifactId>
<configuration>
<modules>
- <EjbModule>
+ <ejbModule>
<!-- property configurations goes here -->
- </EjbModule>
+ </ejbModule>
</modules>
</configuration>
</plugin>
@@ -75,7 +79,7 @@
</project>
+-----
-* {Ejb3Module} Properties
+* {ejb3Module} Properties
The following configuration options are available for Ejb3Module:
@@ -97,7 +101,7 @@
Automatically determined when not set.
-* {EjbClientModule} Properties
+* {ejbClientModule} Properties
The following configuration options are available for EjbClientModule:
@@ -120,7 +124,7 @@
Automatically determined when not set.
-* {EjbModule} Properties
+* {ejbModule} Properties
The following configuration options are available for EjbModule:
@@ -143,14 +147,14 @@
Automatically determined when not set.
-* {JavaModule} Properties
+* {javaModule} Properties
The following configuration options are available for JavaModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the java artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the java artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -169,14 +173,14 @@
of this module in <<<application.xml>>>. Default is false.
-* {ParModule} Properties
+* {parModule} Properties
The following configuration options are available for ParModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the par artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the par artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -192,14 +196,14 @@
Automatically determined when not set.
-* {RarModule} Properties
+* {rarModule} Properties
The following configuration options are available for RarModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the rar artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the rar artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -215,14 +219,14 @@
Automatically determined when not set.
-* {SarModule} Properties
+* {sarModule} Properties
The following configuration options are available for SarModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the sar artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the sar artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -238,14 +242,14 @@
Automatically determined when not set.
-* {WebModule} Properties
+* {webModule} Properties
The following configuration options are available for WebModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the web artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the web artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -263,14 +267,14 @@
* <<contextRoot>> - sets the context root of this web artifact.
-* {WsrModule} Properties
+* {wsrModule} Properties
The following configuration options are available for WsrModule:
- * <<groupId>> - sets the groupId of the ejb artifact you want to
+ * <<groupId>> - sets the groupId of the wsr artifact you want to
configure.
- * <<artifactId>> - sets the artifactId of the ejb artifact you want to
+ * <<artifactId>> - sets the artifactId of the wsr artifact you want to
configure.
* <<bundleDir>> - sets the location of this artifact inside the ear archive.
@@ -286,7 +290,7 @@
Automatically determined when not set.
-* {HarModule} Properties
+* {harModule} Properties
The following configuration options are available for HarModule:
@@ -308,3 +312,26 @@
* <<uri>> - sets the uri path of this artifact within the ear archive.
Automatically determined when not set.
+* Adding {Custom Artifact Types}
+
+ If you need to map a custom artifact type to one of those types, use the
+ <<<customArtifactTypeMappings>>>.
+
+ For instance, to map a custom 'my-rar' to the 'rar' standard artifact's type,
+ add the following to the pom's configuration:
+
++--------
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-ear-plugin</artifactId>
+ <configuration>
+ <artifactTypeMappings>
+ <artifactTypeMapping type="my-rar" mapping="rar"/>
+ </artifactTypeMappings>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
++---------
Modified: maven/plugins/trunk/maven-ear-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-ear-plugin/src/site/fml/faq.fml?rev=427848&r1=427847&r2=427848&view=diff
==============================================================================
--- maven/plugins/trunk/maven-ear-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-ear-plugin/src/site/fml/faq.fml Tue Aug 1 18:38:20 2006
@@ -29,16 +29,16 @@
</faq>
<faq id="har-files">
<question>
- The EAR Plugin throws an exception when encountering artifact files it is unfamiliar with, i.e. JBoss' har files.
- How does one handle this?
+ The EAR Plugin throws an exception when encountering artifact types it is unfamiliar with. Is this a bug?
</question>
<answer>
<p>
- Apparently, the EAR Plugin must be able to recognize an artifact in order to configure it. If you know archives
- which are not supported by the EAR Plugin, please file an issue in
- <a href="http://jira.codehaus.org/browse/MEAR">jira</a>.
+ The exception can be prevented by adding your custom artifact type to the artifactTypeMappings configuration.
+ There is a mini-guide on how to do that in the <a href="modules.html#Custom Artifact Types">modules
+ configuration</a> section.
</p>
</answer>
</faq>
</part>
</faqs>
+