youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 3a4980e3c4
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3a4980e3c4'
${ noResults }
ant/manual/Tasks/ejb.html

1605 lines
68 KiB
Raw Blame History 

  1. <!DOCTYPE html>

  2. <!--

  3.    Licensed to the Apache Software Foundation (ASF) under one or more

  4.    contributor license agreements.  See the NOTICE file distributed with

  5.    this work for additional information regarding copyright ownership.

  6.    The ASF licenses this file to You under the Apache License, Version 2.0

  7.    (the "License"); you may not use this file except in compliance with

  8.    the License.  You may obtain a copy of the License at

  9. 

  10.        https://www.apache.org/licenses/LICENSE-2.0

  11. 

  12.    Unless required by applicable law or agreed to in writing, software

  13.    distributed under the License is distributed on an "AS IS" BASIS,

  14.    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  15.    See the License for the specific language governing permissions and

  16.    limitations under the License.

  17. -->

  18. <html lang="en">

  19. 

  20. <head>

  21. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">

  22. <title>EJB Tasks</title>

  23. 

  24. </head>

  25. 

  26. <body>

  27. 

  28. <h1>Apache Ant EJB Tasks User Manual</h1>

  29. <p>by</p>

  30. <!-- Names are in alphabetical order, on last name -->

  31. <ul>

  32.   <li>Paul Austin (<a href="mailto:p_d_austin@yahoo.com">p_d_austin@yahoo.com</a>)</li>

  33.   <li>Holger Engels (<a href="mailto:hengels@innovidata.com">hengels@innovidata.com</a>)</li>

  34.   <li>Tim Fennell (<a href="mailto:tfenne@rcn.com">tfenne@rcn.com</a>)</li>

  35.   <li>Martin Gee (<a href="mailto:martin.gee@icsynergy.com">martin.gee@icsynergy.com</a>)</li>

  36.   <li>Conor MacNeill</li>

  37.   <li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li>

  38.   <li>Greg Nelson (<a href="mailto:gn@sun.com">gn@sun.com</a>)</li>

  39.   <li>Rob van Oostrum (<a href="mailto:rob@springwellfarms.ca">rob@springwellfarms.ca</a>)</li>

  40. </ul>

  41. 

  42. <hr/>

  43. <h2>Table of Contents</h2>

  44. <ul>

  45.   <li><a href="#introduction">Introduction</a></li>

  46.   <li><a href="#ejbtasks">EJB Tasks</a></li>

  47. </ul>

  48. 

  49. <hr/>

  50. <h2 id="introduction">Introduction</h2>

  51. <p>Ant provides a number of optional tasks for developing 1.x and

  52. 2.x <a href="https://www.oracle.com/technetwork/java/index-jsp-140203.html" target="_top">Enterprise

  53. Java Beans (EJBs)</a>.  In general these tasks are specific to the particular vendor's EJB

  54. Server.</p>

  55. 

  56. <p>The tasks support:</p>

  57. 

  58. <ul>

  59.   <li><a href="http://www.borland.com" target="_top">Borland</a>Application Server 4.5</li>

  60.   <li><a href="https://web.archive.org/web/20020202082841/http://www.iplanet.com/products/iplanet_application/home_ias.html"

  61.          target="_top">iPlanet</a> Application Server 6.0</li>

  62.   <li><a href="https://www.jboss.org/" target="_top">JBoss 2.1</a> and above EJB servers</li>

  63.   <li><a href="https://web.archive.org/web/20080516210506/http://www.ironflare.com/"

  64.          target="_top">Orion Application Server</a> 2.0 (<em>since Ant 1.10.2</em>)</li>

  65.   <li><a href="http://www.bea.com" target="_top">WebLogic</a> 4.5.1 through to 7.0 EJB servers</li>

  66.   <li><a href="https://jonas.ow2.org/" target="_top">JOnAS</a> 2.4.x and 2.5 Open Source EJB server</li>

  67.   <li><a href="https://www.ibm.com/websphere" target="_top">IBM WebSphere</a> 4.0</li>

  68. </ul>

  69. <p>Vendors such as BEA and IBM now provide custom Ant tasks to work with their particular

  70. products. More importantly, EJB 3.0 renders this whole process obsolete.  Accordingly, development

  71. of these tasks is effectively frozen. Bug reports and especially patches are welcome, but there is

  72. no pressing need to add support for new application servers. Nobody should be writing new EJB 2.x

  73. applications and definitely not new EJB 2.x servers.</p>

  74. 

  75. <hr/>

  76. <h2 id="ejbtasks">EJB Tasks</h2>

  77. <table>

  78.   <tr><th scope="col">Task</th><th scope="col" colspan="2">Application Servers</th></tr>

  79.   <tr><td><a href="BorlandGenerateClient.html">blgenclient</a></td><td colspan="2">Borland

  80.     Application Server 4.5 and 5.x</td></tr>

  81.   <tr><td><a href="#iplanet-ejbc">iplanet-ejbc</a></td><td colspan="2">iPlanet Application Server

  82.     6.0</td></tr>

  83.   <tr><td rowspan="8"><a href="#ejbjar">ejbjar</a></td><th scope="col" colspan="2">Nested Elements</th></tr>

  84.   <tr><td><a href="BorlandEJBTasks.html">borland</a></td><td>Borland Application Server 4.5 and

  85.     5.x</td></tr>

  86.   <tr><td><a href="#ejbjar_iplanet">iPlanet</a></td><td>iPlanet Application Server 6.0</td></tr>

  87.   <tr><td><a href="#ejbjar_jboss">jboss</a></td><td>JBoss</td></tr>

  88.   <tr><td><a href="#ejbjar_jonas">jonas</a></td><td>JOnAS 2.4.x and 2.5</td></tr>

  89.   <tr><td><a href="#ejbjar_weblogic">weblogic</a></td><td>WebLogic 5.1 to 7.0</td></tr>

  90.   <tr><td><a href="#ejbjar_websphere">websphere</a></td><td>IBM WebSphere 4.0</td></tr>

  91.   <tr><td><a href="#ejbjar_orion">orion</a></td><td>IronFlare (Oracle) Orion Application Server

  92.     2.0.6</td></tr>

  93. </table>

  94. 

  95. <hr/>

  96. 

  97. <h2 id="ddcreator">ddcreator</h2>

  98. <h3>Description</h3>

  99. <p><code>ddcreator</code> will compile a set of WebLogic text-based deployment descriptors into a

  100. serialized EJB deployment descriptor. The selection of which of the text-based descriptors are to be

  101. compiled is based on the standard Ant <code>include</code> and <code>exclude</code> selection

  102. mechanisms.</p>

  103. 

  104. <h3>Parameters</h3>

  105. <table class="attr">

  106.   <tr>

  107.     <th scope="col">Attribute</th>

  108.     <th scope="col">Description</th>

  109.     <th scope="col">Required</th>

  110.   </tr>

  111.   <tr>

  112.     <td>descriptors</td>

  113.     <td>This is the base directory from which descriptors are selected.</td>

  114.     <td>Yes</td>

  115.   </tr>

  116.   <tr>

  117.     <td>dest</td>

  118.     <td>The directory where the serialized deployment descriptors will be written</td>

  119.     <td>Yes</td>

  120.   </tr>

  121.   <tr>

  122.     <td>classpath</td>

  123.     <td>This is the classpath to use to run the underlying WebLogic <code>ddcreator</code> tool.

  124.       This must include the <code>weblogic.ejb.utils.DDCreator</code> class</td>

  125.     <td>No</td>

  126.   </tr>

  127. </table>

  128. <h3>Examples</h3>

  129. <pre>

  130. &lt;ddcreator descriptors=&quot;${dd.dir}&quot;

  131.            dest=&quot;${gen.classes}&quot;

  132.            classpath=&quot;${descriptorbuild.classpath}&quot;&gt;

  133.   &lt;include name=&quot;*.txt&quot;/&gt;

  134. &lt;/ddcreator&gt;</pre>

  135. 

  136. <hr/>

  137. <h2 id="ejbc">ejbc</h2>

  138. <h3>Description</h3>

  139. <p>The <code>ejbc</code> task will run WebLogic's <kbd>ejbc</kbd> tool. This tool will take a

  140. serialized deployment descriptor, examine the various EJB interfaces and bean classes and then

  141. generate the required support classes necessary to deploy the bean in a WebLogic EJB container. This

  142. will include the RMI stubs and skeletons as well as the classes which implement the bean's home and

  143. remote interfaces.</p>

  144. <p>The Ant task which runs this tool is able to compile several beans in a single operation. The

  145. beans to be compiled are selected by including their serialized deployment descriptors. The standard

  146. Ant <code>include</code> and <code>exclude</code> constructs can be used to select the deployment

  147. descriptors to be included.</p>

  148. <p>Each descriptor is examined to determine whether the generated classes are out of date and need

  149. to be regenerated. The deployment descriptor is de-serialized to discover the home, remote and

  150. implementation classes. The corresponding source files are determined and checked to see their

  151. modification times. These times and the modification time of the serialized descriptor itself are

  152. compared with the modification time of the generated classes. If the generated classes are not

  153. present or are out of date, the <kbd>ejbc</kbd> tool is run to generate new versions.</p>

  154. <h3>Parameters</h3>

  155. <table class="attr">

  156.   <tr>

  157.     <th scope="col">Attribute</th>

  158.     <th scope="col">Description</th>

  159.     <th scope="col">Required</th>

  160.   </tr>

  161.   <tr>

  162.     <td>descriptors</td>

  163.     <td>This is the base directory from which the serialized deployment descriptors are

  164.       selected.</td>

  165.     <td>Yes</td>

  166.   </tr>

  167.   <tr>

  168.     <td>dest</td>

  169.     <td>The base directory where the generated classes, RIM stubs and RMI skeletons are written</td>

  170.     <td>Yes</td>

  171.   </tr>

  172.   <tr>

  173.     <td>manifest</td>

  174.     <td>The name of a manifest file to be written. This manifest will contain an entry for each EJB

  175.       processed</td>

  176.     <td>Yes</td>

  177.   </tr>

  178.   <tr>

  179.     <td>src</td>

  180.     <td>The base directory of the source tree containing the source files of the home interface,

  181.       remote interface and bean implementation classes.</td>

  182.     <td>Yes</td>

  183.   </tr>

  184.   <tr>

  185.     <td>classpath</td>

  186.     <td>This classpath must include both the <code>weblogic.ejbc</code> class and the class files of

  187.       the bean, home interface, remote interface, etc of the bean being processed.</td>

  188.     <td>No</td>

  189.   </tr>

  190.   <tr>

  191.     <td>keepgenerated</td>

  192.     <td>Controls whether <kbd>ejbc</kbd> will keep the intermediate java files used to build the

  193.       class files. This can be useful when debugging.</td>

  194.     <td>No; defaults to <q>false</q></td>

  195.   </tr>

  196. </table>

  197. <h3>Examples</h3>

  198. <pre>

  199. &lt;ejbc descriptors=&quot;${gen.classes}&quot;

  200.            src=&quot;${src.dir}&quot;

  201.            dest=&quot;${gen.classes}&quot;

  202.            manifest=&quot;${build.manifest}&quot;

  203.            classpath=&quot;${descriptorbuild.classpath}&quot;&gt;

  204.   &lt;include name=&quot;*.ser&quot;/&gt;

  205. &lt;/ejbc&gt;</pre>

  206. 

  207. <hr/>

  208. <h2 id="iplanet-ejbc">iplanet-ejbc</h2>

  209. 

  210. <h3>Description</h3>

  211. <p>Task to compile EJB stubs and skeletons for the iPlanet Application Server 6.0.  Given a standard

  212. EJB 1.1 XML descriptor as well as an iAS-specific EJB descriptor, this task will generate the stubs

  213. and skeletons required to deploy the EJB to iAS.  Since the XML descriptors can include multiple

  214. EJBs, this is a convenient way of specifying many EJBs in a single Ant task.</p>

  215. <p>For each EJB specified, the task will locate the three classes that comprise the EJB in the

  216. destination directory.  If these class files cannot be located in the destination directory, the

  217. task will fail. The task will also attempt to locate the EJB stubs and skeletons in this directory.

  218. If found, the timestamps on the stubs and skeletons will be checked to ensure they are up to

  219. date. Only if these files cannot be found or if they are out of date will the iAS <kbd>ejbc</kbd>

  220. utility be called to generate new stubs and skeletons.</p>

  221. <h3>Parameters</h3>

  222. 

  223. <table class="attr">

  224.   <tr>

  225.     <th scope="col">Attribute</th>

  226.     <th scope="col">Description</th>

  227.     <th scope="col">Required</th>

  228.   </tr>

  229. 

  230.   <tr>

  231.     <td>ejbdescriptor</td>

  232.     <td>Standard EJB 1.1 XML descriptor (typically titled <q>ejb-jar.xml</q>).</td>

  233.     <td>Yes</td>

  234.   </tr>

  235. 

  236.   <tr>

  237.     <td>iasdescriptor</td>

  238.     <td>iAS-specific EJB XML descriptor (typically titled <q>ias-ejb-jar.xml</q>).</td>

  239.     <td>Yes</td>

  240.   </tr>

  241. 

  242.   <tr>

  243.     <td>dest</td>

  244.     <td>The is the base directory where the RMI stubs and skeletons are written. In addition, the

  245.       class files for each bean (home interface, remote interface, and EJB implementation) must be

  246.       found in this directory.</td>

  247.     <td>Yes</td>

  248.   </tr>

  249. 

  250.   <tr>

  251.     <td>classpath</td>

  252.     <td>The classpath used when generating EJB stubs and skeletons.  Nested <code>classpath</code>

  253.       elements may also be used.</td>

  254.     <td>No; defaults to the classpath specified when Ant was started</td>

  255.   </tr>

  256. 

  257.   <tr>

  258.     <td>keepgenerated</td>

  259.     <td>Indicates whether or not the Java source files which are generated by <kbd>ejbc</kbd> will

  260.       be saved or automatically deleted. If <q>yes</q>, the source files will be retained.</td>

  261.     <td>No; defaults to <q>no</q></td>

  262.   </tr>

  263. 

  264.   <tr>

  265.     <td>debug</td>

  266.     <td>Indicates whether or not the <kbd>ejbc</kbd> utility should log additional debugging

  267.       statements to the standard output. If <q>yes</q>, the additional debugging statements will be

  268.       generated.</td>

  269.     <td>No; defaults to <q>no</q></td>

  270.   </tr>

  271. 

  272.   <tr>

  273.     <td>iashome</td>

  274.     <td>May be used to specify the "home" directory for this iAS installation.  This is used to find

  275.       the <kbd>ejbc</kbd> utility if it isn't included in the user's system path. If specified, it

  276.       should refer to the <samp>[install-location]/iplanet/ias6/ias</samp> directory.</td>

  277.     <td>No; by default the <kbd>ejbc</kbd> utility must be on the user's system path</td>

  278.   </tr>

  279. </table>

  280. 

  281. <h3>Examples</h3>

  282. 

  283. <pre>

  284. &lt;iplanet-ejbc ejbdescriptor="ejb-jar.xml"

  285.               iasdescriptor="ias-ejb-jar.xml"

  286.               dest="${build.classesdir}"

  287.               classpath="${ias.ejbc.cpath}"/&gt;

  288. 

  289. 

  290. &lt;iplanet-ejbc ejbdescriptor="ejb-jar.xml"

  291.               iasdescriptor="ias-ejb-jar.xml"

  292.               dest="${build.classesdir}"

  293.               keepgenerated="yes"

  294.               debug="yes"

  295.               iashome="${ias.home}"&gt;

  296.               &lt;classpath&gt;

  297.                   &lt;pathelement path="."/&gt;

  298.                   &lt;pathelement path="${build.classpath}"/&gt;

  299.               &lt;/classpath&gt;

  300. &lt;/iplanet-ejbc&gt;</pre>

  301. 

  302. <hr/>

  303. <h2 id="wlrun">wlrun</h2>

  304. <h3>Description</h3>

  305. 

  306. <p>The <code>wlrun</code> task is used to start a WebLogic server. The task runs a WebLogic instance

  307. in a separate JVM. A number of parameters are used to control the operation of the WebLogic

  308. instance. Note that the task, and hence Ant, will not complete until the WebLogic instance is

  309. stopped.</p>

  310. 

  311. <h3>Parameters</h3>

  312. <table class="attr">

  313.   <tr>

  314.     <th scope="col">Attribute</th>

  315.     <th scope="col">Description</th>

  316.     <th scope="col">Required for 4.5.1 and 5.1</th>

  317.     <th scope="col">Required for 6.0</th>

  318.   </tr>

  319.   <tr>

  320.     <td>BEAhome</td>

  321.     <td>The location of the <var>BEAhome</var> where the server's config is stored.  If this

  322.       attribute is present, <code>wlrun</code> assumes that the server will be running under

  323.       WebLogic 6.0</td>

  324.     <td class="center">N/A</td>

  325.     <td>Yes</td>

  326.   </tr>

  327.   <tr>

  328.     <td>home</td>

  329.     <td>The location of the WebLogic "home" where WebLogic is installed.</td>

  330.     <td class="center">Yes</td>

  331.     <td>Yes. Note this is the absolute location, not relative to <var>BEAhome</var>.</td>

  332.   </tr>

  333.   <tr>

  334.     <td>Domain</td>

  335.     <td>The domain to which the server belongs.</td>

  336.     <td class="center">N/A</td>

  337.     <td>Yes</td>

  338.   </tr>

  339.   <tr>

  340.     <td>classpath</td>

  341.     <td>The classpath to be used with the JVM that runs the WebLogic Server. Prior to WebLogic 6.0,

  342.       this is typically set to the WebLogic boot classpath. Under WebLogic 6.0 this should include

  343.       all the WebLogic jars</td>

  344.     <td colspan="2">Yes</td>

  345.   </tr>

  346.   <tr>

  347.     <td>wlclasspath</td>

  348.     <td>The WebLogic classpath used by the WebLogic Server.</td>

  349.     <td class="center">No</td>

  350.     <td rowspan="2">N/A</td>

  351.   </tr>

  352.   <tr>

  353.     <td>properties</td>

  354.     <td>The name of the server's properties file within the WebLogic home directory used to control

  355.       the WebLogic instance.</td>

  356.     <td class="center">Yes</td>

  357.   </tr>

  358.   <tr>

  359.     <td>name</td>

  360.     <td>The name of the WebLogic server within the WebLogic home which is to be run.</td>

  361.     <td colspan="2">No; defaults to <q>myserver</q></td>

  362.   </tr>

  363.   <tr>

  364.     <td>policy</td>

  365.     <td>The name of the security policy file within the WebLogic home directory that is to be

  366.       used.</td>

  367.     <td colspan="2">No; defaults to <q>weblogic.policy</q></td>

  368.   </tr>

  369.   <tr>

  370.     <td>username</td>

  371.     <td>The management username used to manage the server</td>

  372.     <td class="center" rowspan="3">N/A</td>

  373.     <td>No</td>

  374.   </tr>

  375.   <tr>

  376.     <td>password</td>

  377.     <td>The server's management password</td>

  378.     <td>Yes</td>

  379.   </tr>

  380.   <tr>

  381.     <td>pkPassword</td>

  382.     <td>The private key password so the server can decrypt the SSL private key file</td>

  383.     <td>No</td>

  384.   </tr>

  385.   <tr>

  386.     <td>jvmargs</td>

  387.     <td>Additional argument string passed to the JVM used to run the WebLogic instance.</td>

  388.     <td colspan="2">No</td>

  389.   </tr>

  390.   <tr>

  391.     <td>weblogicMainClass</td>

  392.     <td>The name of the main class for WebLogic</td>

  393.     <td colspan="2">No</td>

  394.   </tr>

  395. </table>

  396. 

  397. <h3>Parameters specified as nested elements</h3>

  398. 

  399. <p>The <code>wlrun</code> task supports nested <code>&lt;classpath&gt;</code>

  400. and <code>&lt;wlclasspath&gt;</code> elements to set the respective classpaths.</p>

  401. 

  402. <h3>Examples</h3>

  403. 

  404. <p>This example shows the use of <code>wlrun</code> to run a server under WebLogic 5.1</p>

  405. 

  406. <pre>

  407.     &lt;wlrun taskname=&quot;myserver&quot;

  408.            classpath=&quot;${weblogic.boot.classpath}&quot;

  409.            wlclasspath=&quot;${weblogic.classes}:${code.jars}&quot;

  410.            name=&quot;myserver&quot;

  411.            home=&quot;${weblogic.home}&quot;

  412.            properties=&quot;myserver/myserver.properties&quot;/&gt;

  413. </pre>

  414. 

  415. <p>This example shows <code>wlrun</code> being used to run the <samp>petstore</samp> server under

  416. WebLogic 6.0</p>

  417. 

  418. <pre>

  419. &lt;wlrun taskname=&quot;petstore&quot;

  420.        classpath=&quot;${weblogic.classes}&quot;

  421.        name=&quot;petstoreServer&quot;

  422.        domain=&quot;petstore&quot;

  423.        home=&quot;${weblogic.home}&quot;

  424.        password=&quot;petstorePassword&quot;

  425.        beahome=&quot;${bea.home}&quot;/&gt;</pre>

  426. 

  427. <hr/>

  428. <h2 id="wlstop">wlstop</h2>

  429. <h3>Description</h3>

  430. 

  431. <p>The <code>wlstop</code> task is used to stop a WebLogic instance which is currently running. To

  432. shut down an instance you must supply both a username and a password. These will be stored in the

  433. clear in the build script used to stop the instance. For security reasons, this task is therefore

  434. only appropriate in a development environment.</p>

  435. 

  436. <p>This task works for most versions of WebLogic, including 6.0. You need to specify

  437. the <var>BEAHome</var> to have this task work correctly under 6.0</p>

  438. 

  439. <h3>Parameters</h3>

  440. <table class="attr">

  441.   <tr>

  442.     <th scope="col">Attribute</th>

  443.     <th scope="col">Description</th>

  444.     <th scope="col">Required</th>

  445.   </tr>

  446.   <tr>

  447.     <td>BEAHome</td>

  448.     <td>This attribute selects WebLogic 6.0 shutdown.</td>

  449.     <td>No</td>

  450.   </tr>

  451.   <tr>

  452.     <td>classpath</td>

  453.     <td>The classpath to be used with the JVM that runs the WebLogic Shutdown command.</td>

  454.     <td>Yes</td>

  455.   </tr>

  456.   <tr>

  457.     <td>user</td>

  458.     <td>The username of the account which will be used to shutdown the server</td>

  459.     <td>Yes</td>

  460.   </tr>

  461.   <tr>

  462.     <td>password</td>

  463.     <td>The password for the account specified in the user parameter.</td>

  464.     <td>Yes</td>

  465.   </tr>

  466.   <tr>

  467.     <td>url</td>

  468.     <td>The URL which describes the port to which the server is listening for T3 connections.  For

  469.       example, <samp>t3://localhost:7001</samp></td>

  470.     <td>Yes</td>

  471.   </tr>

  472.   <tr>

  473.     <td>delay</td>

  474.     <td>The delay in seconds after which the server will stop.</td>

  475.     <td>No; default is <q>0</q> (immediate shutdown)</td>

  476.   </tr>

  477. </table>

  478. 

  479. <h3>Parameters specified as nested elements</h3>

  480. 

  481. <p>The classpath of the <code>wlstop</code> task can be set by a <code>&lt;classpath&gt;</code>

  482. nested element.</p>

  483. 

  484. <h3>Examples</h3>

  485. 

  486. <p>This example show the shutdown for a WebLogic 6.0 server</p>

  487. 

  488. <pre>

  489. &lt;wlstop classpath=&quot;${weblogic.classes}&quot;

  490.         user=&quot;system&quot;

  491.         url=&quot;t3://localhost:7001&quot;

  492.         password=&quot;foobar&quot;

  493.         beahome=&quot;${bea.home}&quot;/&gt;</pre>

  494. 

  495. <hr/>

  496. <h2 id="ejbjar">ejbjar</h2>

  497. <h3>Description</h3>

  498. 

  499. <p>This task is designed to support building of EJB jar files (EJB 1.1 &amp; 2.0).  Support is

  500. currently provided for 'vanilla' EJB jar files&mdash;i.e. those containing only the user generated

  501. class files and the standard deployment descriptor. Nested elements provide support for vendor

  502. specific deployment tools. These currently include:</p>

  503. <ul>

  504.   <li>Borland Application Server 4.5</li>

  505.   <li>iPlanet Application Server 6.0</li>

  506.   <li>JBoss 2.1 and above</li>

  507.   <li>WebLogic 5.1/6.0 session/entity beans using the <code>weblogic.ejbc</code> tool</li>

  508.   <li>IBM WebSphere 4.0</li>

  509.   <li>TOPLink for WebLogic 2.5.1-enabled entity beans</li>

  510.   <li><a href="https://jonas.ow2.org/" target="_top">JOnAS</a> 2.4.x and 2.5 Open Source EJB

  511.     server</li>

  512.   <li>IronFlare Orion Application Server 2.0</li>

  513. </ul>

  514. 

  515. <p>The task works as a directory scanning task, and performs an action for each deployment

  516. descriptor found. As such the <code>includes</code> and <code>excludes</code> should be set to

  517. ensure that all desired EJB descriptors are found, but no application server descriptors are

  518. found. For each descriptor found, <code>ejbjar</code> will parse the deployment descriptor to

  519. determine the necessary class files which implement the bean. These files are assembled along with

  520. the deployment descriptors into a well formed EJB jar file. Any support files which need to be

  521. included in the generated jar can be added with the <code>&lt;support&gt;</code> nested element. For

  522. each class included in the jar, <code>ejbjar</code> will scan for any super classes or super

  523. interfaces. These will be added to the generated jar.</p>

  524. 

  525. <p>If no nested vendor-specific deployment elements are present, the task will simply generate a

  526. generic EJB jar. Such jars are typically used as the input to vendor-specific deployment tools. For

  527. each nested deployment element, a vendor specific deployment tool is run to generate a jar file

  528. ready for deployment in that vendor's EJB container.</p>

  529. 

  530. <p>The jar files are only built if they are out of date.  Each deployment tool element will examine

  531. its target jar file and determine if it is out of date with respect to the class files and

  532. deployment descriptors that make up the bean. If any of these files are newer than the jar file the

  533. jar will be rebuilt otherwise a message is logged that the jar file is up to date.</p>

  534. 

  535. <p>The task uses the <a href="https://commons.apache.org/bcel/"

  536. target="_top">BCEL</a> <a href="../install.html#librarydependencies">library</a> to extract all

  537. dependent classes. This means that, in addition to the classes that are mentioned in the deployment

  538. descriptor, any classes that these depend on are also automatically included in the jar file.</p>

  539. 

  540. <h3 id="naming">Naming convention</h3>

  541. 

  542. <code>Ejbjar</code> handles the processing of multiple beans, and it uses a set of naming

  543. conventions to determine the name of the generated EJB jars. The naming convention that is used is

  544. controlled by the <var>naming</var> attribute. It supports the following values

  545. <dl>

  546. <dt><q>descriptor</q></dt>

  547. <dd><p>This is the default naming scheme. The name of the generated bean is derived from the name of

  548. the deployment descriptor.  For an <samp>Account</samp> bean, for example, the deployment descriptor

  549. would be named <samp>Account-ejb-jar.xml</samp>. Vendor specific descriptors are located using the

  550. same naming convention. The WebLogic bean, for example, would be

  551. named <samp>Account-weblogic-ejb-jar.xml</samp>. Under this arrangement, the deployment descriptors

  552. can be separated from the code implementing the beans, which can be useful when the same bean code

  553. is deployed in separate beans.</p>

  554. <p>This scheme is useful when you are using one bean per EJB jar and where you may be deploying the

  555. same bean classes in different beans, with different deployment characteristics.</p></dd>

  556. 

  557. <dt><q>ejb-name</q></dt>

  558. <dd><p>This naming scheme uses the <code>&lt;ejb-name&gt;</code> element from the deployment

  559. descriptor to determine the bean name. In this situation, the descriptors normally use the generic

  560. descriptor names, such as <samp>ejb-jar.xml</samp> along with any associated vendor specific

  561. descriptor names. For example, If the value of the <code>&lt;ejb-name&gt;</code> were to be given in

  562. the deployment descriptor as follows:</p>

  563. <pre>

  564. &lt;ejb-jar&gt;

  565.     &lt;enterprise-beans&gt;

  566.         &lt;entity&gt;

  567.             &lt;ejb-name&gt;Sample&lt;/ejb-name&gt;

  568.             &lt;home&gt;org.apache.ant.ejbsample.SampleHome&lt;/home&gt;</pre>

  569. <p>then the name of the generated bean would be <samp>Sample.jar</samp></p>

  570. <p>This scheme is useful where you want to use the standard deployment descriptor names, which may

  571. be more compatible with other EJB tools. This scheme must have one bean per jar.</p></dd>

  572. <dt><q>directory</q></dt>

  573. <dd><p>In this mode, the name of the generated bean jar is derived from the directory containing the

  574. deployment descriptors. Again the deployment descriptors typically use the standard filenames. For

  575. example, if the path to the deployment descriptor

  576. is <samp>/home/user/dev/appserver/dd/sample</samp>, then the generated bean will be

  577. named <samp>sample.jar</samp></p>

  578. <p>This scheme is also useful when you want to use standard style descriptor names. It is often most

  579. useful when the descriptors are located in the same directory as the bean source code, although that

  580. is not mandatory. This scheme can handle multiple beans per jar.</p></dd>

  581. 

  582. <dt><q>basejarname</q></dt>

  583. <dd><p>The final scheme supported by the <code>&lt;ejbjar&gt;</code> task is used when you want to

  584. specify the generated bean jar name directly. In this case the name of the generated jar is

  585. specified by the <var>basejarname</var> attribute. Since all generated beans will have the same

  586. name, this task should be only used when each descriptor is in its own directory.</p>

  587. 

  588. <p>This scheme is most appropriate when you are using multiple beans per jar and only process a

  589. single deployment descriptor. You typically want to specify the name of the jar and not derive it

  590. from the beans in the jar.</p></dd>

  591. </dl>

  592. 

  593. <h3 id="ejbjar_deps">Dependencies</h3>

  594. <p>In addition to the bean classes, <code>ejbjar</code> is able to ad additional classes to the

  595. generated EJB jar. These classes are typically the support classes which are used by the bean's

  596. classes or as parameters to the bean's methods.</p>

  597. 

  598. <p>In versions of Ant prior to 1.5, <code>ejbjar</code> used reflection and attempted to add the

  599. super classes and super interfaces of the bean classes. For this technique to work the bean classes

  600. had to be loaded into Ant's JVM. This was not always possible due to class dependencies.</p>

  601. 

  602. <p><em>Since Ant 1.5</em> the task uses the <a href="https://commons.apache.org/bcel/"

  603. target="_top">BCEL</a> library to analyze the bean's class files directly, rather than loading them

  604. into the JVM. This also allows <code>ejbjar</code> to add all of the required support classes for a

  605. bean and not just super classes.</p>

  606. 

  607. <p><em>Since Ant 1.5</em>, a <var>dependency</var> attribute allows the buildfile to control what

  608. additional classes are added to the generated jar. It takes three possible values</p>

  609. <ul>

  610.   <li><q>none</q>&mdash;only the bean classes and interfaces described in the bean's descriptor are

  611.     added to the jar.</li>

  612.   <li><q>super</q>&mdash;this is the default value and replicates the original <code>ejbjar</code>

  613.     behaviour where super classes and super interfaces are added to the jar</li>

  614.   <li><q>full</q>&mdash;In this mode all classes used by the bean's classes and interfaces are added

  615.     to the jar</li>

  616. </ul>

  617. <p>The <q>super</q> and <q>full</q> values require the <a href="https://commons.apache.org/bcel/"

  618. target="_top">BCEL</a> library to be available. If it is not, <code>ejbjar</code> will drop back to

  619. the behaviour corresponding to the value <q>none</q>.</p>

  620. 

  621. <h3>Parameters</h3>

  622. <table class="attr">

  623.   <tr>

  624.     <th scope="col">Attribute</th>

  625.     <th scope="col">Description</th>

  626.     <th scope="col">Required</th>

  627.   </tr>

  628.   <tr>

  629.     <td>descriptordir</td>

  630.     <td>The base directory under which to scan for EJB deployment descriptors. If this attribute is

  631.       not specified, then the deployment descriptors must be located in the directory specified by

  632.       the <var>srcdir</var> attribute.</td>

  633.     <td>No</td>

  634.   </tr>

  635.   <tr>

  636.     <td>srcdir</td>

  637.     <td>The base directory containing the .class files that make up the bean. Included are

  638.       the <samp>home-</samp>, <samp>remote-</samp>, <samp>pk-</samp>

  639.       and <samp>implementation-</samp> classes and all classes that these depend on. Note that this

  640.       can be the same as the <var>descriptordir</var> if all files are in the same directory

  641.       tree.</td>

  642.     <td>Yes</td>

  643.   </tr>

  644.   <tr>

  645.     <td>destdir</td>

  646.     <td>The base directory into which generated jar files are deposited. Jar files are deposited in

  647.       directories corresponding to their location within the <var>descriptordir</var>

  648.       namespace. Note that this attribute is only used if the task is generating generic jars

  649.       (i.e. no vendor-specific deployment elements have been specified).</td>

  650.     <td>Yes, unless vendor-specific deployment elements have been specified.</td>

  651.   </tr>

  652.   <tr>

  653.     <td>cmpversion</td>

  654.     <td>Either <q>1.0</q> or <q>2.0</q>.<br/>A CMP 2.0 implementation exists currently only for

  655.     JBoss.</td>

  656.     <td>No; default is <q>1.0</q></td>

  657.   </tr>

  658.   <tr>

  659.     <td>naming</td>

  660.     <td>Controls the naming convention used to name generated EJB jars. Please refer to the

  661.       description <a href="#naming">above</a>.</td>

  662.     <td>No</td>

  663.   </tr>

  664.   <tr>

  665.     <td>basejarname</td>

  666.     <td>The base name that is used for the generated jar files.  If this attribute is specified, the

  667.       generic jar file name will use this value as the prefix (followed by the value specified in

  668.       the <var>genericjarsuffix</var> attribute) and the resultant EJB jar file (followed by any

  669.       suffix specified in the nested element).</td>

  670.     <td>No</td>

  671.   </tr>

  672.   <tr>

  673.     <td>basenameterminator</td>

  674.     <td>String value used to substring out a string from the name of each deployment descriptor

  675.       found, which is then used to locate related deployment descriptors (e.g. the WebLogic

  676.       descriptors). For example, a basename of <q>.</q> and a deployment descriptor

  677.       called <samp>FooBean.ejb-jar.xml</samp> would result in a basename of <q>FooBean</q> which

  678.       would then be used to find <samp>FooBean.weblogic-ejb-jar.xml</samp>

  679.       and <samp>FooBean.weblogic-cmp-rdbms-jar.xml</samp>, as well as to create the filenames of the

  680.       jar files as <samp>FooBean-generic.jar</samp> and <samp>FooBean-wl.jar</samp>. This attribute

  681.       is not used if the <var>basejarname</var> attribute is specified.</td>

  682.     <td>No; defaults to <q>-</q></td>

  683.   </tr>

  684.   <tr>

  685.     <td>genericjarsuffix</td>

  686.     <td>String value appended to the basename of the deployment descriptor to create the filename of

  687.       the generic EJB jar file.</td>

  688.     <td>No; defaults to <q class="no-break">-generic.jar</q></td>

  689.   </tr>

  690.   <tr>

  691.     <td>classpath</td>

  692.     <td>This classpath is used when resolving classes which are to be added to the jar. Typically

  693.       nested deployment tool elements will also support a classpath which will be combined with this

  694.       classpath when resolving classes</td>

  695.     <td>No</td>

  696.   </tr>

  697.   <tr>

  698.     <td>flatdestdir</td>

  699.       <td>Set this attribute to <q>true</q> if you want all generated jars to be placed in the root

  700.         of the <var>destdir</var>, rather than according to the location of the deployment

  701.         descriptor within the <var>descriptordir</var> hierarchy.</td>

  702.     <td>No</td>

  703.   </tr>

  704.   <tr>

  705.     <td>dependency</td>

  706.     <td>This attribute controls which additional classes and interfaces are added to the jar. Please

  707.       refer to the description <a href="#ejbjar_deps">above</a></td>

  708.     <td>No</td>

  709.   </tr>

  710.   <tr>

  711.     <td>manifest</td>

  712.     <td>the manifest file to use, if any.</td>

  713.     <td>No</td>

  714.   </tr>

  715. </table>

  716. 

  717. <h3>Parameters specified as nested elements</h3>

  718. 

  719. <p>In addition to the vendor specific nested elements, the <code>ejbjar</code> task provides three

  720. nested elements.</p>

  721. 

  722. <h4>classpath</h4>

  723. 

  724. <p>The <code>&lt;classpath&gt;</code> nested element allows the classpath to be set. It is useful

  725. when setting the classpath from a reference path. In all other respects the behaviour is the same as

  726. the classpath attribute.</p>

  727. 

  728. <h4 id="ejbjar-dtd">dtd</h4>

  729. 

  730. <p>The <code>&lt;dtd&gt;</code> element is used to specify the local location of DTDs to be used

  731. when parsing the EJB deployment descriptor. Using a local DTD is much faster than loading the DTD

  732. across the net. If you are running <code>ejbjar</code> behind a firewall you may not even be able to

  733. access the remote DTD. The supported vendor-specific nested elements know the location of the

  734. required DTDs within the vendor class hierarchy and, in general, this means <code>&lt;dtd&gt;</code>

  735. elements are not required. It does mean, however, that the vendor's class hierarchy must be

  736. available in the classpath when Ant is started. If your want to run Ant without requiring the vendor

  737. classes in the classpath, you would need to use a <code>&lt;dtd&gt;</code> element.</p>

  738. 

  739. <table class="attr">

  740.   <tr>

  741.     <th scope="col">Attribute</th>

  742.     <th scope="col">Description</th>

  743.     <th scope="col">Required</th>

  744.   </tr>

  745.   <tr>

  746.     <td>publicId</td>

  747.     <td>The public Id of the DTD for which the location is being provided</td>

  748.     <td>Yes</td>

  749.   </tr>

  750.   <tr>

  751.     <td>location</td>

  752.     <td>The location of the local copy of the DTD. This can either be a file or a resource loadable

  753.       from the classpath.</td>

  754.     <td>Yes</td>

  755.   </tr>

  756. </table>

  757. 

  758. <h4>support</h4>

  759. 

  760. <p>The <code>&lt;support&gt;</code> nested element is used to supply additional classes (files) to

  761. be included in the generated jars. The <code>&lt;support&gt;</code> element is

  762. a <a href="../Types/fileset.html">FileSet</a>, so it can either reference a fileset declared

  763. elsewhere or it can be defined in-place with the appropriate <code>&lt;include&gt;</code>

  764. and <code>&lt;exclude&gt;</code> nested elements. The files in the support fileset are added into

  765. the generated EJB jar in the same relative location as their location within the support

  766. fileset. Note that when <code>ejbjar</code> generates more than one jar file, the support files are

  767. added to each one.</p>

  768. 

  769. <h3>Vendor-specific deployment elements</h3>

  770. 

  771. <p>Each vendor-specific nested element controls the generation of a deployable jar specific to that

  772. vendor's EJB container. The parameters for each supported deployment element are detailed here.</p>

  773. 

  774. <h3 id="ejbjar_jboss">Jboss element</h3>

  775. 

  776. <p>The <code>jboss</code> element searches for the JBoss specific deployment descriptors and adds

  777. them to the final EJB jar file. JBoss has two deployment descriptors:</p>

  778. <ul>

  779.   <li><samp>jboss.xml</samp></li>

  780.   <li>for container manager persistence:

  781.     <table>

  782.       <tr><th scope="col">CMP version</th><th scope="col">File name</th></tr>

  783.       <tr><td>CMP 1.0</td><td><samp>jaws.xml</samp></td></tr>

  784.       <tr><td>CMP 2.0</td><td><samp>jbosscmp-jdbc.xml</samp></td></tr>

  785.     </table>

  786.   </li>

  787. </ul>

  788. <p>The JBoss server uses hot deployment and does not require compilation of additional stubs and

  789. skeletons.</p>

  790. 

  791. <table class="attr">

  792.   <tr>

  793.     <th scope="col">Attribute</th>

  794.     <th scope="col">Description</th>

  795.     <th scope="col">Required</th>

  796.   </tr>

  797.   <tr>

  798.     <td>destdir</td>

  799.     <td>The base directory into which the generated JBoss ready jar files are deposited. Jar files

  800.       are deposited in directories corresponding to their location within

  801.       the <var>descriptordir</var> namespace.</td>

  802.     <td>Yes</td>

  803.   </tr>

  804.   <tr>

  805.     <td>genericjarsuffix</td>

  806.     <td>A generic jar is generated as an intermediate step in build the JBoss deployment jar. The

  807.       suffix used to generate the generic jar file is not particularly important unless it is

  808.       desired to keep the generic jar file. It should not, however, be the same as the suffix

  809.       setting.</td>

  810.     <td>No; defaults to <q class="no-break">-generic.jar</q></td>

  811.   </tr>

  812.   <tr>

  813.     <td>suffix</td>

  814.     <td>String value appended to the basename of the deployment descriptor to create the filename of

  815.       the JBoss EJB jar file.</td>

  816.     <td>No; defaults to <q>.jar</q></td>

  817.   </tr>

  818.   <tr>

  819.     <td>keepgeneric</td>

  820.     <td>This controls whether the generic file used as input to <kbd>ejbc</kbd> is retained.</td>

  821.     <td>No; defaults to <q>false</q></td>

  822.   </tr>

  823. </table>

  824. 

  825. <h3 id="ejbjar_weblogic">WebLogic element</h3>

  826. 

  827. <p>The <code>weblogic</code> element is used to control the <code>weblogic.ejbc</code> compiler for

  828. generating WebLogic EJB jars. Prior to Ant 1.3, the method of locating CMP descriptors was to use

  829. the <code>ejbjar</code> naming convention. So if your EJB jar was

  830. called, <samp>Customer-ejb-jar.xml</samp>, your WebLogic descriptor was

  831. called <samp>Customer-weblogic-ejb-jar.xml</samp> and your CMP descriptor had to

  832. be <samp>Customer-weblogic-cmp-rdbms-jar.xml</samp>. In addition,

  833. the <code>&lt;type-storage&gt;</code> element in the WebLogic descriptor had to be set to the

  834. standard name <samp>META-INF/weblogic-cmp-rdbms-jar.xml</samp>, as that is where the CMP descriptor

  835. was mapped to in the generated jar.</p>

  836. 

  837. <p>There are a few problems with this scheme. It does not allow for more than one CMP descriptor to

  838. be defined in a jar and it is not compatible with the deployment descriptors generated by some

  839. tools.</p>

  840. 

  841. <p>In Ant 1.3, <code>ejbjar</code> parses the WebLogic deployment descriptor to discover the CMP

  842. descriptors, which are then included automatically. This behaviour is controlled by

  843. the <var>newCMP</var> attribute. Note that if you move to the new method of determining CMP

  844. descriptors, you will need to update your WebLogic deployment

  845. descriptor's <code>&lt;type-storage&gt;</code> element. In the above example, you would define this

  846. as <samp>META-INF/Customer-weblogic-cmp-rdbms-jar.xml</samp>.</p>

  847. 

  848. <table class="attr">

  849.   <tr>

  850.     <th scope="col">Attribute</th>

  851.     <th scope="col">Description</th>

  852.     <th scope="col">Required</th>

  853.   </tr>

  854.   <tr>

  855.     <td>destdir</td>

  856.     <td>The base directory into which the generated WebLogic ready jar files are deposited. Jar

  857.       files are deposited in directories corresponding to their location within

  858.       the <var>descriptordir</var> namespace.</td>

  859.     <td>Yes</td>

  860.   </tr>

  861.   <tr>

  862.     <td>genericjarsuffix</td>

  863.     <td>A generic jar is generated as an intermediate step in build the WebLogic deployment jar. The

  864.       suffix used to generate the generic jar file is not particularly important unless it is

  865.       desired to keep the generic jar file. It should not, however, be the same as the suffix

  866.       setting.</td>

  867.     <td>No; defaults to <q class="no-break">-generic.jar</q></td>

  868.   </tr>

  869.   <tr>

  870.     <td>suffix</td>

  871.     <td>String value appended to the basename of the deployment descriptor to create the filename of

  872.       the WebLogic EJB jar file.</td>

  873.     <td>No; defaults to <q>.jar</q></td>

  874.   </tr>

  875.   <tr>

  876.     <td>classpath</td>

  877.       <td>The classpath to be used when running the WebLogic <kbd>ejbc</kbd> tool. Note that this

  878.         tool typically requires the classes that make up the bean to be available on the classpath.

  879.         Currently, however, this will cause the <kbd>ejbc</kbd> tool to be run in a separate

  880.         JVM</td>

  881.     <td>No</td>

  882.   </tr>

  883.   <tr>

  884.     <td>wlclasspath</td>

  885.     <td>WebLogic 6.0 will give a warning if the home and remote interfaces of a bean are on the

  886.       system classpath used to run <code>weblogic.ejbc</code>.  In that case, the standard WebLogic

  887.       classes should be set with this attribute (or equivalent nested element) and the home and

  888.       remote interfaces located with the standard classpath attribute</td>

  889.     <td>No</td>

  890.   </tr>

  891.   <tr>

  892.     <td>keepgeneric</td>

  893.     <td>This controls whether the generic file used as input to <kbd>ejbc</kbd> is retained.</td>

  894.     <td>No; defaults to <q>false</q></td>

  895.   </tr>

  896.   <tr>

  897.     <td>compiler</td>

  898.     <td>This allows for the selection of a different compiler to be used for the compilation of the

  899.       generated Java files. This could be set, for example, to <q>jikes</q> to compile with the

  900.       Jikes compiler. If this is not set and the <code>build.compiler</code> property is set

  901.       to <q>jikes</q>, the Jikes compiler will be used. If this is not desired, the

  902.       value <q>default</q> may be given to use the default compiler</td>

  903.     <td>No</td>

  904.   </tr>

  905.   <tr>

  906.     <td>rebuild</td>

  907.     <td>This flag controls whether <code>weblogic.ejbc</code> is always invoked to build the jar

  908.       file. In certain circumstances, such as when only a bean class has been changed, the jar can

  909.       be generated by merely replacing the changed classes and not

  910.       rerunning <kbd>ejbc</kbd>. Setting this to <q>false</q> will reduce the time to

  911.       run <code>ejbjar</code>.</td>

  912.     <td>No; defaults to <q>true</q></td>

  913.   </tr>

  914.   <tr>

  915.     <td>keepgenerated</td>

  916.     <td>Controls whether WebLogic will keep the generated Java files used to build the class files

  917.       added to the jar. This can be useful when debugging</td>

  918.     <td>No; defaults to <q>false</q></td>

  919.   </tr>

  920.   <tr>

  921.     <td>args</td>

  922.     <td>Any additional arguments to be passed to the <code>weblogic.ejbc</code> tool.</td>

  923.     <td>No</td>

  924.   </tr>

  925.   <tr>

  926.     <td>weblogicdtd</td>

  927.     <td><em><u>Deprecated</u></em>. Defines the location of the ejb-jar DTD in the WebLogic class

  928.       hierarchy. This should not be necessary if you have WebLogic in your classpath. If you do not,

  929.       you should use a nested <code>&lt;dtd&gt;</code> element, described above. If you do choose to

  930.       use an attribute, you should use a nested <code>&lt;dtd&gt;</code> element.</td>

  931.     <td>No</td>

  932.   </tr>

  933.   <tr>

  934.     <td>wldtd</td>

  935.     <td><em><u>Deprecated</u></em>. Defines the location of the weblogic-ejb-jar DTD which covers

  936.       the WebLogic specific deployment descriptors.  This should not be necessary if you have

  937.       WebLogic in your classpath. If you do not, you should use a nested <code>&lt;dtd&gt;</code>

  938.       element, described above.</td>

  939.     <td>No</td>

  940.   </tr>

  941.   <tr>

  942.     <td>ejbdtd</td>

  943.     <td><em><u>Deprecated</u></em>. Defines the location of the ejb-jar DTD in the WebLogic class

  944.       hierarchy. This should not be necessary if you have WebLogic in your classpath. If you do not,

  945.       you should use a nested <code>&lt;dtd&gt;</code> element, described above.</td>

  946.     <td>No</td>

  947.   </tr>

  948.   <tr>

  949.     <td>newCMP</td>

  950.     <td>If this is set to <q>true</q>, the new method for locating CMP descriptors will be

  951.       used.</td>

  952.     <td>No; defaults to <q>false</q></td>

  953.   </tr>

  954.   <tr>

  955.     <td>oldCMP</td>

  956.     <td><em><u>Deprecated</u></em> This is an antonym for <var>newCMP</var> which should be used

  957.       instead.</td>

  958.     <td>No</td>

  959.   </tr>

  960.   <tr>

  961.     <td>noEJBC</td>

  962.     <td>If this attribute is set to <q>true</q>, WebLogic's <kbd>ejbc</kbd> will not be run on the

  963.       EJB jar.  Use this if you prefer to run <kbd>ejbc</kbd> at deployment time.</td>

  964.     <td>No</td>

  965.   </tr>

  966.   <tr>

  967.     <td>ejbcclass</td>

  968.     <td>Specifies the classname of the <kbd>ejbc</kbd> compiler. Normally <code>ejbjar</code>

  969.       determines the appropriate class based on the DTD used for the EJB. The EJB 2.0 compiler

  970.       featured in WebLogic 6 has, however, been deprecated in version 7. When using with version 7

  971.       this attribute should be set to <q>weblogic.ejbc</q> to avoid the deprecation warning.</td>

  972.     <td>No</td>

  973.   </tr>

  974.   <tr>

  975.     <td>jvmargs</td>

  976.     <td>Any additional arguments to be passed to the JVM running <code>weblogic.ejbc</code>

  977.       tool. For example to set the memory size, this could

  978.       be <var>jvmargs</var>=<q>-Xmx128m</q></td>

  979.     <td>No</td>

  980.   </tr>

  981.   <tr>

  982.     <td>jvmdebuglevel</td>

  983.     <td>Sets the <code>weblogic.StdoutSeverityLevel</code> to use when running the JVM that

  984.       executes <kbd>ejbc</kbd>. Set to <q>16</q> to avoid the warnings about EJB Home and Remotes

  985.       being in the classpath</td>

  986.     <td>No</td>

  987.   </tr>

  988.   <tr>

  989.     <td>outputdir</td>

  990.     <td>If set <kbd>ejbc</kbd> will be given this directory as the output destination rather than a

  991.       jar file. This allows for the generation of &quot;exploded&quot; jars.</td>

  992.     <td>No</td>

  993.   </tr>

  994. </table>

  995. 

  996. <p>The <code>weblogic</code> nested element supports three nested elements. The first

  997. two, <code>&lt;classpath&gt;</code> and <code>&lt;wlclasspath&gt;</code>, are used to set the

  998. respective classpaths. These nested elements are useful when setting up classpaths using reference

  999. Ids. The last, <code>&lt;sysproperty&gt;</code>, allows Java system properties to be set during the

  1000. compiler run. This turns out to be necessary for supporting CMP EJB compilation in all

  1001. environments.</p>

  1002. 

  1003. <h3>TOPLink for WebLogic element</h3>

  1004. 

  1005. <p><em><u>Deprecated</u></em></p>

  1006. 

  1007. <p>The <code>toplink</code> element is no longer required. Toplink beans can now be built with the

  1008. standard <code>weblogic</code> element, as long as the <var>newCMP</var> attribute is set

  1009. to <q>true</q></p>

  1010. 

  1011. <p>The <code>TopLink</code> element is used to handle beans which use Toplink for the CMP

  1012. operations. It is derived from the standard <code>weblogic</code> element so it supports the same

  1013. set of attributes plus these additional attributes</p>

  1014. 

  1015. <table class="attr">

  1016.   <tr>

  1017.     <th scope="col">Attribute</th>

  1018.     <th scope="col">Description</th>

  1019.     <th scope="col">Required</th>

  1020.   </tr>

  1021.   <tr>

  1022.     <td>toplinkdescriptor</td>

  1023.     <td>This specifies the name of the TOPLink deployment descriptor file contained in

  1024.     the <var>descriptordir</var> directory.</td>

  1025.     <td>Yes</td>

  1026.   </tr>

  1027.   <tr>

  1028.     <td>toplinkdtd</td>

  1029.     <td>This specifies the location of the TOPLink DTD file. This can be a file path or a file

  1030.       URL. This attribute is not required, but using a local DTD is recommended.</td>

  1031.     <td>No; defaults to DTD file at <samp>www.objectpeople.com</samp>.</td>

  1032.   </tr>

  1033. </table>

  1034. 

  1035. <h3>Examples</h3>

  1036. 

  1037. <p>This example shows <code>ejbjar</code> being used to generate deployment jars using a WebLogic

  1038. EJB container. This example requires the naming standard to be used for the deployment

  1039. descriptors. Using this format will create a EJB jar file for each variation

  1040. of <samp>*-ejb-jar.xml</samp> that is found in the deployment descriptor directory.</p>

  1041. 

  1042. <pre>

  1043. &lt;ejbjar srcdir=&quot;${build.classes}&quot;

  1044.         descriptordir=&quot;${descriptor.dir}&quot;&gt;

  1045.   &lt;weblogic destdir=&quot;${deploymentjars.dir}&quot;

  1046.             classpath=&quot;${descriptorbuild.classpath}&quot;/&gt;

  1047.   &lt;include name=&quot;**/*-ejb-jar.xml&quot;/&gt;

  1048.   &lt;exclude name=&quot;**/*weblogic*.xml&quot;/&gt;

  1049. &lt;/ejbjar&gt;</pre>

  1050. 

  1051. <p>If WebLogic is not in the Ant classpath, the following example shows how to specify the location

  1052. of the WebLogic DTDs. This example also show the use of a nested <code>classpath</code> element.</p>

  1053. 

  1054. <pre>

  1055. &lt;ejbjar descriptordir=&quot;${src.dir}&quot; srcdir=&quot;${build.classes}&quot;&gt;

  1056.    &lt;weblogic destdir=&quot;${deployment.webshop.dir}&quot;

  1057.              keepgeneric=&quot;true&quot;

  1058.              args=&quot;-g -keepgenerated ${ejbc.compiler}&quot;

  1059.              suffix=&quot;.jar&quot;

  1060.              oldCMP=&quot;false&quot;&gt;

  1061.      &lt;classpath&gt;

  1062.        &lt;pathelement path=&quot;${descriptorbuild.classpath}&quot;/&gt;

  1063.      &lt;/classpath&gt;

  1064.    &lt;/weblogic&gt;

  1065.    &lt;include name=&quot;**/*-ejb-jar.xml&quot;/&gt;

  1066.    &lt;exclude name=&quot;**/*-weblogic-ejb-jar.xml&quot;/&gt;

  1067.    &lt;dtd publicId=&quot;-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN&quot;

  1068.         location=&quot;${weblogic.home}/classes/weblogic/ejb/deployment/xml/ejb-jar.dtd&quot;/&gt;

  1069.    &lt;dtd publicId=&quot;-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN&quot;

  1070.         location=&quot;${weblogic.home}/classes/weblogic/ejb/deployment/xml/weblogic-ejb-jar.dtd&quot;/&gt;

  1071. &lt;/ejbjar&gt;</pre>

  1072. 

  1073. <p>This example shows <code>ejbjar</code> being used to generate a single deployment jar using a

  1074. WebLogic EJB container. This example does not require the deployment descriptors to use the naming

  1075. standard. This will create only one EJB jar file&mdash;<samp>TheEJBJar.jar</samp>.</p>

  1076. 

  1077. <pre>

  1078. &lt;ejbjar srcdir=&quot;${build.classes}&quot;

  1079.         descriptordir=&quot;${descriptor.dir}&quot;

  1080.         basejarname=&quot;TheEJBJar&quot;&gt;

  1081.   &lt;weblogic destdir=&quot;${deploymentjars.dir}&quot;

  1082.             classpath=&quot;${descriptorbuild.classpath}&quot;/&gt;

  1083.   &lt;include name=&quot;**/ejb-jar.xml&quot;/&gt;

  1084.   &lt;exclude name=&quot;**/weblogic*.xml&quot;/&gt;

  1085. &lt;/ejbjar&gt;</pre>

  1086. 

  1087. <p>This example shows <code>ejbjar</code> being used to generate deployment jars for a

  1088. TOPLink-enabled entity bean using a WebLogic EJB container. This example does not require the

  1089. deployment descriptors to use the naming standard.  This will create only one TOPLink-enabled EJB

  1090. jar file&mdash;<samp>Address.jar</samp>.</p>

  1091. 

  1092. <pre>

  1093. &lt;ejbjar srcdir=&quot;${build.dir}&quot;

  1094.         destdir=&quot;${solant.ejb.dir}&quot;

  1095.         descriptordir=&quot;${descriptor.dir}&quot;

  1096.         basejarname=&quot;Address&quot;&gt;

  1097.         &lt;weblogictoplink destdir=&quot;${solant.ejb.dir}&quot;

  1098.                 classpath=&quot;${java.class.path}&quot;

  1099.                 keepgeneric=&quot;false&quot;

  1100.                 toplinkdescriptor=&quot;Address.xml&quot;

  1101.                 toplinkdtd=&quot;file:///dtdfiles/toplink-cmp_2_5_1.dtd&quot;

  1102.                 suffix=&quot;.jar&quot;/&gt;

  1103.         &lt;include name=&quot;**/ejb-jar.xml&quot;/&gt;

  1104.         &lt;exclude name=&quot;**/weblogic-ejb-jar.xml&quot;/&gt;

  1105. &lt;/ejbjar&gt;</pre>

  1106. 

  1107. <p>This final example shows how you would set-up <code>ejbjar</code> under WebLogic 6.0. It also

  1108. shows the use of the <code>&lt;support&gt;</code> element to add support files</p>

  1109. 

  1110. <pre>

  1111. &lt;ejbjar descriptordir=&quot;${dd.dir}&quot; srcdir=&quot;${build.classes.server}&quot;&gt;

  1112.    &lt;include name=&quot;**/*-ejb-jar.xml&quot;/&gt;

  1113.    &lt;exclude name=&quot;**/*-weblogic-ejb-jar.xml&quot;/&gt;

  1114.    &lt;support dir=&quot;${build.classes.server}&quot;&gt;

  1115.         &lt;include name=&quot;**/*.class&quot;/&gt;

  1116.    &lt;/support&gt;

  1117.    &lt;weblogic destdir=&quot;${deployment.dir}&quot;

  1118.              keepgeneric=&quot;true&quot;

  1119.              suffix=&quot;.jar&quot;

  1120.              rebuild=&quot;false&quot;&gt;

  1121.      &lt;classpath&gt;

  1122.         &lt;pathelement path=&quot;${build.classes.server}&quot;/&gt;

  1123.      &lt;/classpath&gt;

  1124.      &lt;wlclasspath&gt;

  1125.         &lt;pathelement path=&quot;${weblogic.classes}&quot;/&gt;

  1126.      &lt;/wlclasspath&gt;

  1127.    &lt;/weblogic&gt;

  1128. &lt;/ejbjar&gt;</pre>

  1129. 

  1130. <h3 id="ejbjar_websphere">WebSphere element</h3>

  1131. 

  1132. <p>The <code>websphere</code> element searches for the WebSphere specific deployment descriptors and

  1133. adds them to the final EJB jar file. WebSphere has two specific descriptors for session beans:</p>

  1134. <ul>

  1135.   <li><samp>ibm-ejb-jar-bnd.xmi</samp></li>

  1136.   <li><samp>ibm-ejb-jar-ext.xmi</samp></li>

  1137. </ul>

  1138. <p>and another two for container managed entity beans:</p>

  1139. <ul>

  1140.   <li><samp>Map.mapxmi</samp></li>

  1141.   <li><samp>Schema.dbxmi</samp></li>

  1142. </ul>

  1143. <p>In terms of WebSphere, the generation of container code and stubs is called <em>deployment</em>.

  1144. This step can be performed by the <code>websphere</code> element as part of the jar generation

  1145. process. If the switch <var>ejbdeploy</var> is on, the <kbd>ejbdeploy</kbd> tool from the

  1146. WebSphere toolset is called for every EJB jar. Unfortunately, this step only works, if you use the

  1147. IBM JDK. Otherwise, the <kbd>rmic</kbd> (called by <kbd>ejbdeploy</kbd>) throws

  1148. a <code>ClassFormatError</code>. Be sure to switch <var>ejbdeploy</var> off, if Ant runs with Oracle

  1149. JDK or OpenJDK.</p>

  1150. 

  1151. <p>For the <code>websphere</code> element to work, you have to provide a complete classpath, that

  1152. contains all classes, that are required to reflect the bean classes. For <kbd>ejbdeploy</kbd> to

  1153. work, you must also provide the classpath of the <kbd>ejbdeploy</kbd> tool and set

  1154. the <code>websphere.home</code> property (look at the examples below).</p>

  1155. 

  1156. <table class="attr">

  1157.   <tr>

  1158.     <th scope="col">Attribute</th>

  1159.     <th scope="col">Description</th>

  1160.     <th scope="col">Required</th>

  1161.   </tr>

  1162.   <tr>

  1163.     <td>destdir</td>

  1164.     <td>The base directory into which the generated WebSphere ready jar files are deposited. Jar

  1165.       files are deposited in directories corresponding to their location within

  1166.       the <var>descriptordir</var> namespace.</td>

  1167.     <td>Yes</td>

  1168.   </tr>

  1169.   <tr>

  1170.     <td>ejbdeploy</td>

  1171.       <td>Decides whether <kbd>ejbdeploy</kbd> is called. When you set this to <q>true</q>, be sure

  1172.         to run Ant with the IBM JDK.</td>

  1173.     <td>No; defaults to <q>true</q></td>

  1174.   </tr>

  1175.   <tr>

  1176.     <td>suffix</td>

  1177.     <td>String value appended to the basename of the deployment descriptor to create the filename of

  1178.       the WebSphere EJB jar file.</td>

  1179.     <td>No; defaults to <q>.jar</q></td>

  1180.   </tr>

  1181.   <tr>

  1182.     <td>keepgeneric</td>

  1183.     <td>This controls whether the generic file used as input to <kbd>ejbdeploy</kbd> is

  1184.       retained.</td>

  1185.     <td>No; defaults to <q>false</q></td>

  1186.   </tr>

  1187.   <tr>

  1188.     <td>rebuild</td>

  1189.     <td>This controls whether <kbd>ejbdeploy</kbd> is called although no changes have occurred.</td>

  1190.     <td>No; defaults to <q>false</q></td>

  1191.   </tr>

  1192.   <tr>

  1193.     <td>tempdir</td>

  1194.     <td>A directory, where <kbd>ejbdeploy</kbd> will write temporary files</td>

  1195.     <td>No; defaults to <q>_ejbdeploy_temp</q></td>

  1196.   </tr>

  1197.   <tr>

  1198.     <td>dbName<br/>dbSchema</td>

  1199.     <td>These options are passed to <kbd>ejbdeploy</kbd>.</td>

  1200.     <td>No</td>

  1201.   </tr>

  1202.   <tr>

  1203.     <td>dbVendor</td>

  1204.     <td>This option is passed to <kbd>ejbdeploy</kbd>.  Valid options can be obtained by running the

  1205.       following command: <pre>&lt;WAS_HOME&gt;/bin/EJBDeploy.[sh/bat] -help</pre> This is also used

  1206.       to determine the name of the <code>Map.mapxmi</code> and <code>Schema.dbxmi</code> files, for

  1207.       example <samp>Account-DB2UDBWIN_V71-Map.mapxmi</samp>

  1208.       and <samp>Account-DB2UDBWIN_V71-Schema.dbxmi</samp>.</td>

  1209.     <td>No</td>

  1210.   </tr>

  1211.   <tr>

  1212.     <td>codegen<br/>quiet<br/>novalidate<br/>noinform<br/>trace<br/>use35MappingRules</td>

  1213.     <td>These options are all passed to <kbd>ejbdeploy</kbd>.</td>

  1214.     <td>No; default is <q>false</q> (except for <var>quiet</var>)</td>

  1215.   </tr>

  1216.   <tr>

  1217.     <td>rmicOptions</td>

  1218.       <td>This option is passed to <kbd>ejbdeploy</kbd> and will be passed on

  1219.         to <kbd>rmic</kbd>.</td>

  1220.     <td>No</td>

  1221.   </tr>

  1222. </table>

  1223. 

  1224. <p>This example shows <code>ejbjar</code> being used to generate deployment jars for all deployment

  1225. descriptors in the <var>descriptordir</var>:</p>

  1226. 

  1227. <pre>

  1228. &lt;property name=&quot;websphere.home&quot; value=&quot;${was4.home}&quot;/&gt;

  1229. &lt;ejbjar srcdir="${build.class}" descriptordir="etc/ejb"&gt;

  1230.   &lt;include name="*-ejb-jar.xml"/&gt;

  1231.   &lt;websphere dbvendor="DB2UDBOS390_V6"

  1232.              ejbdeploy="true"

  1233.              oldCMP="false"

  1234.              tempdir="/tmp"

  1235.              destdir="${dist.server}"&gt;

  1236.     &lt;wasclasspath&gt;

  1237.       &lt;pathelement location="${was4.home}/deploytool/itp/plugins/org.eclipse.core.boot/boot.jar"/&gt;

  1238.       &lt;pathelement location="${was4.home}/deploytool/itp/plugins/com.ibm.etools.ejbdeploy/runtime/batch.jar"/&gt;

  1239.       &lt;pathelement location="${was4.home}/lib/xerces.jar"/&gt;

  1240.       &lt;pathelement location="${was4.home}/lib/ivjejb35.jar"/&gt;

  1241.       &lt;pathelement location="${was4.home}/lib/j2ee.jar"/&gt;

  1242.       &lt;pathelement location="${was4.home}/lib/vaprt.jar"/&gt;

  1243.     &lt;/wasclasspath&gt;

  1244.     &lt;classpath&gt;

  1245.       &lt;path refid="build.classpath"/&gt;

  1246.     &lt;/classpath&gt;

  1247.   &lt;/websphere&gt;

  1248.   &lt;dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"

  1249.        location="${lib}/dtd/ejb-jar_1_1.dtd"/&gt;

  1250. &lt;/ejbjar&gt;</pre>

  1251. 

  1252. <h3 id="ejbjar_iplanet">iPlanet Application Server (iAS) element</h3>

  1253. 

  1254. <p>The <code>&lt;iplanet&gt;</code> nested element is used to build iAS-specific stubs and skeletons

  1255. and construct a JAR file which may be deployed to the iPlanet Application Server 6.0.  The build

  1256. process will always determine if the EJB stubs/skeletons and the EJB jar file are up to date, and it

  1257. will do the minimum amount of work required.</p>

  1258. <p>Like the <code>weblogic</code> element, a naming convention for the EJB descriptors is most

  1259. commonly used to specify the name for the completed JAR file.  For example, if the EJB

  1260. descriptor <samp>ejb/Account-ejb-jar.xml</samp> is found in the descriptor directory,

  1261. the <code>iplanet</code> element will search for an iAS-specific EJB descriptor file

  1262. named <samp>ejb/Account-ias-ejb-jar.xml</samp> (if it isn't found, the task will fail) and a JAR

  1263. file named <samp>ejb/Account.jar</samp> will be written in the destination directory.  Note that

  1264. when the EJB descriptors are added to the JAR file, they are automatically

  1265. renamed <samp>META-INF/ejb-jar.xml</samp> and <samp>META-INF/ias-ejb-jar.xml</samp>.</p>

  1266. <p>Of course, this naming behaviour can be modified by specifying attributes in

  1267. the <code>ejbjar</code> task (for example, <var>basejarname</var>, <var>basenameterminator</var>,

  1268. and <var>flatdestdir</var>) as well as the <code>iplanet</code> element (for

  1269. example, <var>suffix</var>).  Refer to the appropriate documentation for more details.</p>

  1270. 

  1271. <h3>Parameters</h3>

  1272. 

  1273. <table class="attr">

  1274.   <tr>

  1275.     <th scope="col">Attribute</th>

  1276.     <th scope="col">Description</th>

  1277.     <th scope="col">Required</th>

  1278.   </tr>

  1279. 

  1280.   <tr>

  1281.     <td>destdir</td>

  1282.     <td>The base directory into which the generated JAR files will be written. Each JAR file is

  1283.       written in directories which correspond to their location within the <var>descriptordir</var>

  1284.       namespace.</td>

  1285.     <td>Yes</td>

  1286.   </tr>

  1287. 

  1288.   <tr>

  1289.     <td>classpath</td>

  1290.     <td>The classpath used when generating EJB stubs and skeletons.  If

  1291.       specified, <var>classpath</var> will be prepended to the classpath specified in the

  1292.       parent <code>ejbjar</code> task. Note that nested <code>classpath</code> elements may also be

  1293.       used.</td>

  1294.     <td>No; defaults to the classpath specified in the <code>ejbjar</code> parent task</td>

  1295.   </tr>

  1296. 

  1297.   <tr>

  1298.     <td>keepgenerated</td>

  1299.     <td>Indicates whether or not the Java source files which are generated by <kbd>ejbc</kbd> will

  1300.       be saved or automatically deleted. If <q>yes</q>, the source files will be retained.</td>

  1301.     <td>No; defaults to <q>no</q></td>

  1302.   </tr>

  1303. 

  1304.   <tr>

  1305.     <td>debug</td>

  1306.     <td>Indicates whether or not the <kbd>ejbc</kbd> utility should log additional debugging

  1307.       statements to the standard output. If <q>yes</q>, the additional debugging statements will be

  1308.       generated.</td>

  1309.     <td>No; defaults to <q>no</q></td>

  1310.   </tr>

  1311. 

  1312.   <tr>

  1313.     <td>iashome</td>

  1314.     <td>May be used to specify the "home" directory for this iAS installation.  This is used to find

  1315.       the <kbd>ejbc</kbd> utility if it isn't included in the user's system path.  If specified, it

  1316.       should refer to the <samp>[install-location]/iplanet/ias6/ias</samp> directory.</td>

  1317.     <td>No; by default, the <kbd>ejbc</kbd> utility must be on the user's system path.</td>

  1318.   </tr>

  1319. 

  1320.   <tr>

  1321.     <td>suffix</td>

  1322.     <td>String value appended to the JAR filename when creating each JAR.</td>

  1323.     <td>No; defaults to <q>.jar</q></td>

  1324.   </tr>

  1325. </table>

  1326. 

  1327. <p>As noted above, the <code>iplanet</code> element supports

  1328. additional <code>&lt;classpath&gt;</code> nested elements.</p>

  1329. <h3>Examples</h3>

  1330. <p>This example demonstrates the typical use of the <code>&lt;iplanet&gt;</code> nested element.  It

  1331. will name each EJB jar using the "basename" prepended to each standard EJB descriptor.  For example,

  1332. if the descriptor named <samp>Account-ejb-jar.xml</samp> is processed, the EJB-JAR will be

  1333. named <samp>Account.jar</samp></p>

  1334. <pre>

  1335. &lt;ejbjar srcdir="${build.classesdir}"

  1336.         descriptordir="${src}"&gt;

  1337. 

  1338.     &lt;iplanet destdir="${assemble.ejbjar}"

  1339.              classpath="${ias.ejbc.cpath}"/&gt;

  1340.     &lt;include name="**/*-ejb-jar.xml"/&gt;

  1341.     &lt;exclude name="**/*ias-*.xml"/&gt;

  1342. &lt;/ejbjar&gt;</pre>

  1343. 

  1344. <p>This example demonstrates the use of a nested <code>classpath</code> element as well as some of

  1345. the other optional attributes.</p>

  1346. <pre>

  1347. &lt;ejbjar srcdir="${build.classesdir}"

  1348.         descriptordir="${src}"&gt;

  1349. 

  1350.     &lt;iplanet destdir="${assemble.ejbjar}"

  1351.              iashome="${ias.home}"

  1352.              debug="yes"

  1353.              keepgenerated="yes"&gt;

  1354.         &lt;classpath&gt;

  1355.             &lt;pathelement path="."/&gt;

  1356.             &lt;pathelement path="${build.classpath}"/&gt;

  1357.         &lt;/classpath&gt;

  1358.     &lt;/iplanet&gt;

  1359.     &lt;include name="**/*-ejb-jar.xml"/&gt;

  1360.     &lt;exclude name="**/*ias-*.xml"/&gt;

  1361. &lt;/ejbjar&gt;</pre>

  1362. 

  1363. <p>This example demonstrates the use of <var>basejarname</var> attribute.  In this case, the

  1364. completed EJB jar will be named <samp>HelloWorld.jar</samp>.  If multiple EJB descriptors might be

  1365. found, care must be taken to ensure that the completed JAR files don't overwrite each other.</p>

  1366. 

  1367. <pre>

  1368. &lt;ejbjar srcdir="${build.classesdir}"

  1369.         descriptordir="${src}"

  1370.         basejarname="HelloWorld"&gt;

  1371. 

  1372.     &lt;iplanet destdir="${assemble.ejbjar}"

  1373.              classpath="${ias.ejbc.cpath}"/&gt;

  1374.     &lt;include name="**/*-ejb-jar.xml"/&gt;

  1375.     &lt;exclude name="**/*ias-*.xml"/&gt;

  1376. &lt;/ejbjar&gt;</pre>

  1377. 

  1378. <p>This example demonstrates the use of the <code>dtd</code> nested element. If the local copies of

  1379. the DTDs are included in the classpath, they will be automatically referenced without the nested

  1380. elements.  In iAS 6.0 SP2, these local DTDs are found in

  1381. the <samp>[iAS-install-directory]/APPS</samp> directory.  In iAS 6.0 SP3, these local DTDs are found

  1382. in the <samp>[iAS-install-directory]/dtd</samp> directory.</p>

  1383. 

  1384. <pre>

  1385. &lt;ejbjar srcdir="${build.classesdir}"

  1386.         descriptordir="${src}"&gt;

  1387.     &lt;iplanet destdir="${assemble.ejbjar}"&gt;

  1388.              classpath="${ias.ejbc.cpath}"/&gt;

  1389.     &lt;include name="**/*-ejb-jar.xml"/&gt;

  1390.     &lt;exclude name="**/*ias-*.xml"/&gt;

  1391. 

  1392.     &lt;dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"

  1393.          location="${ias.home}/APPS/ejb-jar_1_1.dtd"/&gt;

  1394.     &lt;dtd publicId="-//Sun Microsystems, Inc.//DTD iAS Enterprise JavaBeans 1.0//EN"

  1395.          location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/&gt;

  1396. &lt;/ejbjar&gt;</pre>

  1397. 

  1398. <h3 id="ejbjar_jonas">JOnAS (Java Open Application Server) element</h3>

  1399. 

  1400. <p>The <code>&lt;jonas&gt;</code> nested element is used to build JOnAS-specific stubs and skeletons

  1401. thanks to the <code>GenIC</code> specific tool, and construct a JAR file which may be deployed to

  1402. the JOnAS Application Server. The build process will always determine if the EJB stubs/skeletons and

  1403. the EJB jar file are up to date, and it will do the minimum amount of work required.</p>

  1404. 

  1405. <p>Like the WebLogic element, a naming convention for the EJB descriptors is most commonly used to

  1406. specify the name for the completed JAR file. For example, if the EJB

  1407. descriptor <samp>ejb/Account-ejb-jar.xml</samp> is found in the descriptor directory,

  1408. the <code>&lt;jonas&gt;</code> element will search for a JOnAS-specific EJB descriptor file

  1409. named <samp>ejb/Account-jonas-ejb-jar.xml</samp> and a JAR file named <samp>ejb/Account.jar</samp>

  1410. will be written in the destination directory. But the <code>&lt;jonas&gt;</code> element can also

  1411. use the JOnAS naming convention. With the same example as below, the EJB descriptor can also be

  1412. named <samp>ejb/Account.xml</samp> (no base name terminator here) in the descriptor directory. Then

  1413. the <code>&lt;jonas&gt;</code> element will search for a JOnAS-specific EJB descriptor file

  1414. called <samp>ejb/jonas-Account.xml</samp>. This convention do not follow strictly the EJB jar naming

  1415. convention recommendation but is supported for backward compatibility with previous version of

  1416. JOnAS.</p>

  1417. 

  1418. <p>Note that when the EJB descriptors are added to the JAR file, they are automatically

  1419. renamed <samp>META-INF/ejb-jar.xml</samp> and <samp>META-INF/jonas-ejb-jar.xml</samp>.</p>

  1420. 

  1421. <p>Of course, this naming behavior can be modified by specifying attributes in

  1422. the <code>ejbjar</code> task (for example, <var>basejarname</var>, <var>basenameterminator</var>,

  1423. and <var>flatdestdir</var>) as well as the <code>iplanet</code> element (for

  1424. example, <var>suffix</var>). Refer to the appropriate documentation for more details.</p>

  1425. 

  1426. <h3>Parameters</h3>

  1427. 

  1428. <table class="attr">

  1429.   <tbody>

  1430.     <tr>

  1431.       <th scope="col">Attribute</th>

  1432.       <th scope="col">Description</th>

  1433.       <th scope="col">Required</th>

  1434.     </tr>

  1435.     <tr>

  1436.       <td>destdir</td>

  1437.       <td>The base directory into which the generated JAR files will be written. Each JAR file is

  1438.         written in directories which correspond to their location within

  1439.         the <var>descriptordir</var> namespace.</td>

  1440.       <td>Yes</td>

  1441.     </tr>

  1442.     <tr>

  1443.       <td>jonasroot</td>

  1444.       <td>The root directory for JOnAS.</td>

  1445.       <td>Yes</td>

  1446.     </tr>

  1447.     <tr>

  1448.       <td>classpath</td>

  1449.       <td>The classpath used when generating EJB stubs and skeletons. If

  1450.         specified, <var>classpath</var> will be prepended to the classpath specified in the

  1451.         parent <code>ejbjar</code> task (see also the ORB attribute documentation below). Note that

  1452.         nested <code>classpath</code> elements may also be used.</td>

  1453.       <td>No; defaults to the classpath specified in the <code>ejbjar</code> parent task</td>

  1454.     </tr>

  1455.     <tr>

  1456.       <td>keepgenerated</td>

  1457.       <td><q>true</q> if the intermediate Java source files generated by GenIC must be deleted or

  1458.       not.</td>

  1459.       <td>No; defaults to <q>false</q></td>

  1460.     </tr>

  1461.     <tr>

  1462.       <td>nocompil</td>

  1463.       <td><q>true</q> if the generated source files must not be compiled via the Java and RMI

  1464.       compilers.</td>

  1465.       <td>No; defaults to <q>false</q></td>

  1466.     </tr>

  1467.     <tr>

  1468.       <td>novalidation</td>

  1469.       <td><q>true</q> if the XML deployment descriptors must be parsed without validation.</td>

  1470.       <td>No; defaults to <q>false</q></td>

  1471.     </tr>

  1472.     <tr>

  1473.       <td>javac</td>

  1474.       <td>Java compiler to use.</td>

  1475.       <td>No; defaults

  1476.       to the value of <code>build.compiler</code> property</td>

  1477.     </tr>

  1478.     <tr>

  1479.       <td>javacopts</td>

  1480.       <td>Options to pass to the Java compiler.</td>

  1481.       <td>No</td>

  1482.     </tr>

  1483.     <tr>

  1484.       <td>rmicopts</td>

  1485.       <td>Options to pass to the RMI compiler.</td>

  1486.       <td>No</td>

  1487.     </tr>

  1488.     <tr>

  1489.       <td>secpropag</td>

  1490.       <td><q>true</q> if the RMI skeletons and stubs must be modified to implement the implicit

  1491.         propagation of the security context (the transactional context is always provided).</td>

  1492.       <td>No; defaults to <q>false</q></td>

  1493.     </tr>

  1494.     <tr>

  1495.       <td>verbose</td>

  1496.       <td>Indicates whether or not to use <kbd>-verbose</kbd> switch.</td>

  1497.       <td>No; defaults to <q>false</q></td>

  1498.     </tr>

  1499.     <tr>

  1500.       <td>additionalargs</td>

  1501.       <td>Add additional args to GenIC.</td>

  1502.       <td>No</td>

  1503.     </tr>

  1504.     <tr>

  1505.       <td>keepgeneric</td>

  1506.       <td><q>true</q> if the generic JAR file used as input to GenIC must be retained.</td>

  1507.       <td>No; defaults to <q>false</q></td>

  1508.     </tr>

  1509.     <tr>

  1510.       <td>jarsuffix</td>

  1511.       <td>String value appended to the JAR filename when creating each JAR.</td>

  1512.       <td>No; defaults to <q>.jar</q></td>

  1513.     </tr>

  1514.     <tr>

  1515.       <td>orb</td>

  1516.       <td>Choose your ORB: <q>RMI</q>, <q>JEREMIE</q>, <q>DAVID</q>.  If specified, the

  1517.         corresponding JOnAS JAR is automatically added to the classpath.</td>

  1518.       <td>No; defaults to the one present in classpath</td>

  1519.     </tr>

  1520.     <tr>

  1521.       <td>nogenic</td>

  1522.       <td>If this attribute is set to <q>true</q>, JOnAS's GenIC will not be run on the EJB jar. Use

  1523.       this if you prefer to run GenIC at deployment time.</td>

  1524.       <td>No; defaults to <q>false</q></td>

  1525.     </tr>

  1526.   </tbody>

  1527. </table>

  1528. 

  1529. <p>As noted above, the <code>jonas</code> element supports additional <code>&lt;classpath&gt;</code>

  1530. nested elements.</p>

  1531. 

  1532. <h3>Examples</h3>

  1533. 

  1534. <p>This example shows <code>ejbjar</code> being used to generate deployment jars using a JOnAS EJB

  1535. container. This example requires the naming standard to be used for the deployment

  1536. descriptors. Using this format will create a EJB jar file for each variation

  1537. of <samp>*-jar.xml</samp> that is found in the deployment descriptor directory.</p>

  1538. 

  1539. <pre>

  1540. &lt;ejbjar srcdir="${build.classes}"

  1541.         descriptordir="${descriptor.dir}"&gt;

  1542.   &lt;jonas destdir="${deploymentjars.dir}"

  1543.        jonasroot="${jonas.root}"

  1544.        orb="RMI"/&gt;

  1545.   &lt;include name="**/*.xml"/&gt;

  1546.   &lt;exclude name="**/jonas-*.xml"/&gt;

  1547.   &lt;support dir="${build.classes}"&gt;

  1548.        &lt;include name="**/*.class"/&gt;

  1549.   &lt;/support&gt;

  1550. &lt;/ejbjar&gt;</pre>

  1551. 

  1552. <p>This example shows <code>ejbjar</code> being used to generate a single deployment jar using a

  1553. JOnAS EJB container. This example does require the deployment descriptors to use the naming

  1554. standard. This will create only one EJB jar file&mdash;<samp>TheEJBJar.jar</samp>.</p>

  1555. 

  1556. <pre>

  1557. &lt;ejbjar srcdir="${build.classes}"

  1558.         descriptordir="${descriptor.dir}"

  1559.         basejarname="TheEJBJar"&gt;

  1560.   &lt;jonas destdir="${deploymentjars.dir}"

  1561.             jonasroot="${jonas.root}"

  1562.             suffix=".jar"

  1563.             classpath="${descriptorbuild.classpath}"/&gt;

  1564.   &lt;include name="**/ejb-jar.xml"/&gt;

  1565.   &lt;exclude name="**/jonas-ejb-jar.xml"/&gt;

  1566. &lt;/ejbjar&gt;</pre>

  1567. 

  1568. <h3 id="ejbjar_orion">Orion element</h3>

  1569. 

  1570. <p>The <code>orion</code> element searches for the Orion Application Server specific deployment

  1571. descriptors and adds them to the final EJB jar file. Orion has one deployment descriptor:</p>

  1572. <ul>

  1573.   <li><samp>orion-ejb-jar.xml</samp></li>

  1574. </ul>

  1575. <table class="attr">

  1576.   <tr>

  1577.     <th scope="col">Attribute</th>

  1578.     <th scope="col">Description</th>

  1579.     <th scope="col">Required</th>

  1580.   </tr>

  1581.   <tr>

  1582.     <td>destdir</td>

  1583.     <td>The base directory into which the generated jar files are deposited. Jar files are deposited

  1584.       in directories corresponding to their location within the <var>descriptordir</var>

  1585.       namespace.</td>

  1586.     <td>Yes</td>

  1587.   </tr>

  1588. </table>

  1589. 

  1590. <h3>Example</h3>

  1591. 

  1592. <pre>

  1593. &lt;ejbjar srcdir="${build.classes}"

  1594.         descriptordir="${descriptor.dir}"

  1595.         basejarname="TheEJBJar"

  1596.         flatdestdir="true"

  1597.         dependency="super"

  1598.         genericjarsuffix=".jar"&gt;

  1599.   &lt;include name="**/*-ejb-jar.xml"/&gt;

  1600.   &lt;orion destdir="${deploymentjars.dir}"\&gt;

  1601. &lt;/ejbjar&gt;</pre>

  1602. 

  1603. </body>

  1604. </html>
Please read the following content carefully:

Dear OpenI User

Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.

For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》

Agree and continue
Disagree, exit