maven-plugins/ear/xdocs/properties.xml
bwalding bd1e2aa537 Ensure ear files are correctly versioned for validating j2ee containers.
PR: MAVEN-613
Submitted by:	Thomas Christensen


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113725 13f79535-47bb-0310-9956-ffa450edef68
2003-07-25 14:59:16 +00:00

131 lines
3.6 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Properties</title>
<author email="nathan.coast@blueyonder.co.uk">Nathan Coast</author>
</properties>
<body>
<section name="ejb jar settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
<tr>
<td>maven.ear.manifest</td>
<td>Yes</td>
<td>
Location of the manifest file to be used within the ear file.
</td>
<td>
src/application/META-INF/MANIFEST.MF
</td>
</tr>
<tr>
<td>maven.ear.appxml</td>
<td>Yes</td>
<td>
Location of the application.xml file
to be used within the ear file.
</td>
<td>
src/application/META-INF/application.xml
</td>
</tr>
<tr>
<td>maven.ear.appxml.generate</td>
<td>Yes</td>
<td>
Indicates if application.xml files should
be autogenerated
</td>
<td>
false
</td>
</tr>
<tr>
<td>maven.ear.appxml.version</td>
<td>Yes</td>
<td>
Inserts the doctype header depending on the specified version. Default is 1.3
</td>
<td>
false
</td>
</tr>
<tr>
<td>maven.ear.displayname</td>
<td>Yes</td>
<td>
Display name of the application to be used
when application.xml file is autogenerated
</td>
<td>
${pom.id}
</td>
</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/target/docs/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}.ear</code></td>
<td>
<A href="../../../java/target/docs/properties.html#Other Settings">maven.final.name</A>
</td>
</tr>
</table>
</section>
<section name="Including artifacts in the ear file">
<p>
You must tell Maven what artifact you want to include in the ear.
This operation is type sensitive.
Maven can bundle in ear artifacts of following types: jar, war, ejb.
Artifacts of other types are ignored.
This is achieved by specifying meta-information in the POM, using the
following syntax:
</p>
<source><![CDATA[
<dependency>
<id>id</id>
<version>aversion</version>
<type>jar<type>
<properties>
<ear.bundle>true</ear.bundle>
</properties>
</dependency>
]]></source>
<p>
Those artifact will be also "visible" during generation
of application.xml file. In case of war artifacts you can also
specify context root which will be set in application.xml file:
</p>
<source><![CDATA[
<dependency>
<id>your_war</id>
<version>your_version</version>
<type>war<type>
<properties>
<ear.bundle>true</ear.bundle>
<ear.appxml.war.context-root>webapp</ear.appxml.war.context-root>
</properties>
</dependency>
]]></source>
</section>
</body>
</document>