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: bbb51e6d34
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bbb51e6d34'
${ noResults }
ant/docs/manual/OptionalTasks/ejb.html

1733 lines
72 KiB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

  4. <meta http-equiv="Content-Language" content="en-us">

  5. <title>EJB Tasks</title>

  6. 

  7. </head>

  8. 

  9. <body>

  10. 

  11. <h1>Ant EJB Tasks User Manual</h1>

  12. <p>by</p>

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

  14. <ul>

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

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

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

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

  19.   <li>Conor MacNeill</li>

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

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

  22. </ul>

  23. 

  24. <p>Version @VERSION@<br>

  25. $Id$

  26. </p>

  27. <hr>

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

  29. <ul>

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

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

  32. </ul>

  33. 

  34. <hr>

  35. <h2><a name="introduction">Introduction</a></h2>

  36. <p>Ant provides a number of optional tasks for developing

  37. <a href="http://java.sun.com/products/ejb" target="_top">Enterprise Java Beans (EJBs)</a>.

  38. In general these tasks are specific to the particular vendor's EJB Server.</p>

  39. 

  40. <p> At present the tasks support:<br>

  41. 

  42. <ul>

  43.   <li><a href="http://www.borland.com">Borland </a>

  44.   Application Server 4.5</li>

  45.   <li><a href="http://www.iplanet.com">iPlanet </a>

  46.   Application Server 6.0</li>

  47.   <li><a href="http://www.jboss.org/" target="_top">

  48.   JBoss 2.1</a> and above EJB servers</li>

  49.   <li><a href="http://www.bea.com" target="_top">Weblogic</a>

  50.    4.5.1 through to 7.0 EJB servers</li>

  51.   <li><a href="http://www.objectweb.org/jonas/" target="_top">JOnAS</a>

  52.    2.4.x and 2.5 Open Source EJB server</li>

  53.   <li><a href="http://www.ibm.com/websphere">IBM WebSphere</a> 4.0</li>

  54. </ul>

  55.   Over time we expect further optional tasks  to support additional EJB Servers.

  56. </p>

  57. 

  58. <hr>

  59. <h2><a name="ejbtasks">EJB Tasks</a></h2>

  60. <table border="1" cellpadding="5">

  61.  <tr><td>Task</td><td colspan="2">Application Servers</td></tr>

  62.  <tr><td><a href="BorlandGenerateClient.html">blgenclient</a></td><td colspan="2">Borland Application Server 4.5</td></tr>

  63.  <tr><td><a href="#ddcreator">ddcreator</a></td><td colspan="2">Weblogic 4.5.1</td></tr>

  64.  <tr><td><a href="#ejbc">ejbc</a></td><td colspan="2">Weblogic 4.5.1</td></tr>

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

  66.  <tr><td rowspan="7"><a href="#ejbjar">ejbjar</a></td><td colspan="2" align="center"><b>Nested Elements</b></td></tr>

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

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

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

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

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

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

  73.  <tr><td><a href="#wlrun">wlrun</a></td><td colspan="2">Weblogic 4.5.1 to 7.0</td></tr>

  74.  <tr><td><a href="#wlstop">wlstop</a></td><td colspan="2">Weblogic 4.5.1 to 7.0</td></tr>

  75. 

  76. </table>

  77. 

  78. <hr>

  79. <h2><a name="ddcreator">ddcreator</a></h2>

  80. <h3><b>Description:</b></h3>

  81. <p>ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized

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

  83. is based on the standard Ant include and exclude selection mechanisms.

  84. </p>

  85. 

  86. <h3>Parameters:</h3>

  87. <table border="1" cellpadding="2" cellspacing="0">

  88.   <tr>

  89.     <td valign="top"><b>Attribute</b></td>

  90.     <td valign="top"><b>Description</b></td>

  91.     <td align="center" valign="top"><b>Required</b></td>

  92.   </tr>

  93.   <tr>

  94.     <td valign="top">descriptors</td>

  95.     <td valign="top">This is the base directory from which descriptors are selected.</td>

  96.     <td valign="top" align="center">Yes</td>

  97.   </tr>

  98.   <tr>

  99.     <td valign="top">dest</td>

  100.     <td valign="top">The directory where the serialized deployment descriptors will be written</td>

  101.     <td valign="top" align="center">Yes</td>

  102.   </tr>

  103.   <tr>

  104.     <td valign="top">classpath</td>

  105.     <td valign="top">This is the classpath to use to run the underlying weblogic ddcreator tool.

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

  107.     <td valign="top" align="center">No</td>

  108.   </tr>

  109. </table>

  110. <h3>Examples</h3>

  111. <pre>&lt;ddcreator descriptors=&quot;${dd.dir}&quot;

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

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

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

  115. &lt;/ddcreator&gt;

  116. </pre>

  117. 

  118. <hr>

  119. <h2><a name="ejbc">ejbc</a></h2>

  120. <h3><b>Description:</b></h3>

  121. <p>The ejbc task will run Weblogic's ejbc tool. This tool will take a serialized deployment descriptor,

  122. examine the various EJB interfaces and bean classes and then generate the required support classes

  123. necessary to deploy the bean in a Weblogic EJB container. This will include the RMI stubs and skeletons

  124. as well as the classes which implement the bean's home and remote interfaces.</p>

  125. <p>

  126. The ant task which runs this tool is able to compile several beans in a single operation. The beans to be

  127. compiled are selected by including their serialized deployment descriptors. The standard ant

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

  129. to be included. </p>

  130. <p>

  131. Each descriptor is examined to determine whether the generated classes are out of date and need to be

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

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

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

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

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

  137. <h3>Parameters:</h3>

  138. <table border="1" cellpadding="2" cellspacing="0">

  139.   <tr>

  140.     <td valign="top"><b>Attribute</b></td>

  141.     <td valign="top"><b>Description</b></td>

  142.     <td align="center" valign="top"><b>Required</b></td>

  143.   </tr>

  144.   <tr>

  145.     <td valign="top">descriptors</td>

  146.     <td valign="top">This is the base directory from which the serialized deployment descriptors are selected.</td>

  147.     <td valign="top" align="center">Yes</td>

  148.   </tr>

  149.   <tr>

  150.     <td valign="top">dest</td>

  151.     <td valign="top">The base directory where the generated classes, RIM stubs and RMI skeletons are written</td>

  152.     <td valign="top" align="center">Yes</td>

  153.   </tr>

  154.   <tr>

  155.     <td valign="top">manifest</td>

  156.     <td valign="top">The name of a manifest file to be written. This manifest will contain an entry for each EJB processed</td>

  157.     <td valign="top" align="center">Yes</td>

  158.   </tr>

  159.   <tr>

  160.     <td valign="top">src</td>

  161.     <td valign="top">The base directory of the source tree containing the source files of the home interface,

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

  163.     <td valign="top" align="center">Yes</td>

  164.   </tr>

  165.   <tr>

  166.     <td valign="top">classpath</td>

  167.     <td valign="top">This classpath must include both the <code>weblogic.ejbc</code> class and the

  168.                      class files of the bean, home interface, remote interface, etc of the bean being

  169.                      processed.</td>

  170.     <td valign="top" align="center">No</td>

  171.   </tr>

  172.   <tr>

  173.     <td valign="top">keepgenerated</td>

  174.     <td>Controls whether ejbc will keep the

  175.         intermediate Java files used to build the class files. This can be

  176.         useful when debugging.</td>

  177.     <td>No, defaults to false.</td>

  178.   </tr>

  179. </table>

  180. <h3>Examples</h3>

  181. <pre>&lt;ejbc descriptors=&quot;${gen.classes}&quot;

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

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

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

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

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

  187. &lt;/ejbc&gt;

  188. </pre>

  189. 

  190. <hr>

  191. <h2>

  192. <a NAME="iplanet-ejbc"></a>iplanet-ejbc</h2>

  193. 

  194. <h3>

  195. <b>Description:</b></h3>

  196. Task to compile EJB stubs and skeletons for the iPlanet Application Server

  197. 6.0.  Given a standard EJB 1.1 XML descriptor as well as an iAS-specific

  198. EJB descriptor, this task will generate the stubs and skeletons required

  199. to deploy the EJB to iAS.  Since the XML descriptors can include multiple

  200. EJBs, this is a convenient way of specifying many EJBs in a single Ant

  201. task.

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

  203. comprise the EJB in the destination directory.  If these class files

  204. cannot be located in the destination directory, the task will fail. The

  205. task will also attempt to locate the EJB stubs and skeletons in this directory.

  206. If found, the timestamps on the stubs and skeletons will be checked to

  207. ensure they are up to date. Only if these files cannot be found or if they

  208. are out of date will the iAS ejbc utility be called to generate new stubs

  209. and skeletons.</p>

  210. <h3>

  211. Parameters:</h3>

  212. 

  213. <table BORDER CELLSPACING=0 CELLPADDING=2 >

  214. <tr>

  215. <td VALIGN=TOP><b>Attribute</b></td>

  216. 

  217. <td VALIGN=TOP><b>Description</b></td>

  218. 

  219. <td ALIGN=CENTER VALIGN=TOP><b>Required</b></td>

  220. </tr>

  221. 

  222. <tr>

  223. <td VALIGN=TOP>ejbdescriptor</td>

  224. 

  225. <td VALIGN=TOP>Standard EJB 1.1 XML descriptor (typically titled "ejb-jar.xml").</td>

  226. 

  227. <td ALIGN=CENTER VALIGN=TOP>Yes</td>

  228. </tr>

  229. 

  230. <tr>

  231. <td VALIGN=TOP>iasdescriptor</td>

  232. 

  233. <td VALIGN=TOP>iAS-specific EJB XML descriptor (typically titled "ias-ejb-jar.xml").</td>

  234. 

  235. <td ALIGN=CENTER VALIGN=TOP>Yes</td>

  236. </tr>

  237. 

  238. <tr>

  239. <td VALIGN=TOP>dest</td>

  240. 

  241. <td VALIGN=TOP>The is the base directory where the RMI stubs and skeletons

  242. are written. In addition, the class files for each bean (home interface,

  243. remote interface, and EJB implementation) must be found in this directory.</td>

  244. 

  245. <td ALIGN=CENTER VALIGN=TOP>Yes</td>

  246. </tr>

  247. 

  248. <tr>

  249. <td VALIGN=TOP>classpath</td>

  250. 

  251. <td VALIGN=TOP>The classpath used when generating EJB stubs and skeletons.

  252. If omitted, the classpath specified when Ant was started will be used.

  253. Nested "classpath" elements may also be used.</td>

  254. 

  255. <td ALIGN=CENTER VALIGN=TOP>No</td>

  256. </tr>

  257. 

  258. <tr>

  259. <td VALIGN=TOP>keepgenerated</td>

  260. 

  261. <td VALIGN=TOP>Indicates whether or not the Java source files which are

  262. generated by ejbc will be saved or automatically deleted. If "yes", the

  263. source files will be retained. If omitted, it defaults to "no". </td>

  264. 

  265. <td ALIGN=CENTER VALIGN=TOP>No</td>

  266. </tr>

  267. 

  268. <tr>

  269. <td VALIGN=TOP>debug</td>

  270. 

  271. <td>Indicates whether or not the ejbc utility should log additional debugging

  272. statements to the standard output. If "yes", the additional debugging statements

  273. will be generated.  If omitted, it defaults to "no". </td>

  274. 

  275. <td ALIGN=CENTER VALIGN=TOP>

  276. <center>No</center>

  277. </td>

  278. </tr>

  279. 

  280. <tr>

  281. <td VALIGN=TOP>iashome</td>

  282. 

  283. <td>May be used to specify the "home" directory for this iAS installation.

  284. This is used to find the ejbc utility if it isn't included in the user's

  285. system path. If specified, it should refer to the "[install-location]/iplanet/ias6/ias"

  286. directory. If omitted, the ejbc utility must be on the user's system path. </td>

  287. 

  288. <td ALIGN=CENTER VALIGN=TOP>No</td>

  289. </tr>

  290. </table>

  291. 

  292. <h3>

  293. Examples</h3>

  294. 

  295. <pre>&lt;iplanet-ejbc ejbdescriptor="ejb-jar.xml"

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

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

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

  299. 

  300. 

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

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

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

  304.               keepgenerated="yes"

  305.               debug="yes"

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

  307.               &lt;classpath&gt;

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

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

  310.               &lt;/classpath&gt;

  311. &lt;/iplanet-ejbc&gt;

  312. 

  313. 

  314. </pre>

  315. 

  316. <hr>

  317. <h2><a name="wlrun">wlrun</a></h2>

  318. <h3><b>Description:</b></h3>

  319. 

  320. <p>The <code>wlrun</code> task is used to start a weblogic server. The task runs

  321. a weblogic instance in a separate Java Virtual Machine. A number of parameters

  322. are used to control the operation of the weblogic instance. Note that the task,

  323. and hence ant, will not complete until the weblogic instance is stopped.</p>

  324. 

  325. <h3>Parameters:</h3>

  326. <table border="1" cellpadding="2" cellspacing="0">

  327.   <tr>

  328.     <td valign="top"><b>Attribute</b></td>

  329.     <td valign="top"><b>Description</b></td>

  330.     <td align="center" valign="top"><b>Required for 4.5.1 and 5.1</b></td>

  331.     <td align="center" valign="top"><b>Required for 6.0</b></td>

  332.   </tr>

  333.   <tr>

  334.     <td valign="top">BEA Home</td>

  335.     <td valign="top">The location of the BEA Home where the server's config is defined.

  336.                      If this attribute is present, wlrun assumes that the server will

  337.                      be running under Weblogic 6.0</td>

  338.     <td valign="top" align="center">N/A</td>

  339.     <td valign="top" align="center">Yes</td>

  340.   </tr>

  341.   <tr>

  342.     <td valign="top">home</td>

  343.     <td valign="top">The location of the weblogic home that is to be used. This is the location

  344.                      where weblogic is installed.</td>

  345.     <td valign="top" align="center">Yes</td>

  346.     <td valign="top" align="center">Yes. Note this is the absolute location, not relative to

  347.                                     BEA home.</td>

  348.   </tr>

  349.   <tr>

  350.     <td valign="top">Domain</td>

  351.     <td valign="top">The domain to which the server belongs.</td>

  352.     <td valign="top" align="center">N/A</td>

  353.     <td valign="top" align="center">Yes</td>

  354.   </tr>

  355.   <tr>

  356.     <td valign="top">classpath</td>

  357.     <td valign="top">The classpath to be used with the Java Virtual Machine that runs the Weblogic

  358.                      Server. Prior to Weblogic 6.0, this is typically set to the Weblogic

  359.                      boot classpath. Under Weblogic 6.0 this should include all the

  360.                      weblogic jars</td>

  361.     <td valign="top" align="center">Yes</td>

  362.     <td valign="top" align="center">Yes</td>

  363.   </tr>

  364.   <tr>

  365.     <td valign="top">wlclasspath</td>

  366.     <td valign="top">The weblogic classpath used by the Weblogic Server.</td>

  367.     <td valign="top" align="center">No</td>

  368.     <td valign="top" align="center">N/A</td>

  369.   </tr>

  370.   <tr>

  371.     <td valign="top">properties</td>

  372.     <td valign="top">The name of the server's properties file within the weblogic home directory

  373.                      used to control the weblogic instance.</td>

  374.     <td valign="top" align="center">Yes</td>

  375.     <td valign="top" align="center">N/A</td>

  376.   </tr>

  377.   <tr>

  378.     <td valign="top">name</td>

  379.     <td valign="top">The name of the weblogic server within the weblogic home which is to be run.

  380.                      This defaults to &quot;myserver&quot;</td>

  381.     <td valign="top" align="center">No</td>

  382.     <td valign="top" align="center">No</td>

  383.   </tr>

  384.   <tr>

  385.     <td valign="top">policy</td>

  386.     <td valign="top">The name of the security policy file within the weblogic home directory that

  387.                      is to be used. If not specified, the default policy file <code>weblogic.policy</code>

  388.                      is used.</td>

  389.     <td valign="top" align="center">No</td>

  390.     <td valign="top" align="center">No</td>

  391.   </tr>

  392.   <tr>

  393.     <td valign="top">username</td>

  394.     <td valign="top">The management username used to manage the server</td>

  395.     <td valign="top" align="center">N/A</td>

  396.     <td valign="top" align="center">No</td>

  397.   </tr>

  398.   <tr>

  399.     <td valign="top">password</td>

  400.     <td valign="top">The server's management password</td>

  401.     <td valign="top" align="center">N/A</td>

  402.     <td valign="top" align="center">Yes</td>

  403.   </tr>

  404.   <tr>

  405.     <td valign="top">pkPassword</td>

  406.     <td valign="top">The private key password so the server can decrypt the SSL

  407.                      private key file</td>

  408.     <td valign="top" align="center">N/A</td>

  409.     <td valign="top" align="center">No</td>

  410.   </tr>

  411.   <tr>

  412.     <td valign="top">jvmargs</td>

  413.     <td valign="top">Additional argument string passed to the Java Virtual Machine used to run the

  414.                      Weblogic instance.</td>

  415.     <td valign="top" align="center">No</td>

  416.     <td valign="top" align="center">No</td>

  417.   </tr>

  418.   <tr>

  419.     <td valign="top">weblogicMainClass</td>

  420.     <td valign="top">name of the main class for weblogic</td>

  421.     <td valign="top" align="center">No</td>

  422.     <td valign="top" align="center">No</td>

  423.   </tr>

  424. </table>

  425. 

  426. <h3>Nested Elements</h3>

  427. 

  428. <p>The wlrun task supports nested &lt;classpath&gt; and &lt;wlclasspath&gt;

  429. elements to set the repsective classpaths.</p>

  430. 

  431. <h3>Examples</h3>

  432. 

  433. <p>This example shows the use of wlrun to run a server under Weblogic 5.1</p>

  434. 

  435. <pre>

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

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

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

  439.            name=&quot;myserver&quot;

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

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

  442. </pre>

  443. 

  444. <p>This example shows wlrun being used to run the petstore server under

  445. Weblogic 6.0</p>

  446. 

  447. <pre>

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

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

  450.            name=&quot;petstoreServer&quot;

  451.            domain=&quot;petstore&quot;

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

  453.            password=&quot;petstorePassword&quot;

  454.            beahome=&quot;${bea.home}&quot;/&gt;

  455. </pre>

  456. 

  457. <hr>

  458. <h2><a name="wlstop">wlstop</a></h2>

  459. <h3><b>Description:</b></h3>

  460. 

  461. <p>The <code>wlstop</code> task is used to stop a weblogic instance which is

  462. currently running. To shut down an instance you must supply both a username and

  463. a password. These will be stored in the clear in the build script used to stop

  464. the instance. For security reasons, this task is therefore only appropriate in a

  465. development environment. </p>

  466. 

  467. <p>This task works for most version of Weblogic, including 6.0. You need to

  468. specify the BEA Home to have this task work correctly under 6.0</p>

  469. 

  470. <h3>Parameters:</h3>

  471. <table border="1" cellpadding="2" cellspacing="0">

  472.   <tr>

  473.     <td valign="top"><b>Attribute</b></td>

  474.     <td valign="top"><b>Description</b></td>

  475.     <td align="center" valign="top"><b>Required</b></td>

  476.   </tr>

  477.   <tr>

  478.     <td valign="top">BEAHome</td>

  479.     <td valign="top">This attribute selects Weblogic 6.0 shutdown.</td>

  480.     <td valign="top" align="center">No</td>

  481.   </tr>

  482.   <tr>

  483.     <td valign="top">classpath</td>

  484.     <td valign="top">The classpath to be used with the Java Virtual Machine that runs the Weblogic

  485.                      Shutdown command.</td>

  486.     <td valign="top" align="center">Yes</td>

  487.   </tr>

  488.   <tr>

  489.     <td valign="top">user</td>

  490.     <td valign="top">The username of the account which will be used to shutdown the server</td>

  491.     <td valign="top" align="center">Yes</td>

  492.   </tr>

  493.   <tr>

  494.     <td valign="top">password</td>

  495.     <td valign="top">The password for the account specified in the user parameter.</td>

  496.     <td valign="top" align="center">Yes</td>

  497.   </tr>

  498.   <tr>

  499.     <td valign="top">url</td>

  500.     <td valign="top">The URL which describes the port to which the server is listening for T3 connections.

  501.                      For example, t3://localhost:7001</td>

  502.     <td valign="top" align="center">Yes</td>

  503.   </tr>

  504.   <tr>

  505.     <td valign="top">delay</td>

  506.     <td valign="top">The delay in seconds after which the server will stop. This defaults to an

  507.                      immediate shutdown.</td>

  508.     <td valign="top" align="center">No</td>

  509.   </tr>

  510. </table>

  511. 

  512. <h3>Nested Element</h3>

  513. 

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

  515. 

  516. <h3>Examples</h3>

  517. 

  518. <p>This example show the shutdown for a Weblogic 6.0 server</p>

  519. 

  520. <pre>

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

  522.             user=&quot;system&quot;

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

  524.             password=&quot;foobar&quot;

  525.             beahome=&quot;${bea.home}&quot;/&gt;

  526. </pre>

  527. 

  528. <hr>

  529. 

  530. <h2><a name="ejbjar">ejbjar</a></h2>

  531. <h3><b>Description:</b></h3>

  532. 

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

  534. Support is currently provided for 'vanilla' EJB jar files - i.e. those containing only

  535. the user generated class files and the standard deployment descriptor. Nested

  536. elements provide support for vendor specific deployment tools. These currently

  537. include: </p>

  538. <ul>

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

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

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

  542.   <li>Weblogic 5.1/6.0 session/entity beans using the weblogic.ejbc tool</li>

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

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

  545.   <li><a href="http://www.objectweb.org/jonas/">JOnAS</a> 2.4.x and 2.5 Open Source EJB server</li>

  546. </ul>

  547. 

  548. 

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

  550. deployment descriptor found. As such the includes and excludes should be set

  551. to ensure that all desired EJB descriptors are found, but no application

  552. server descriptors are found. For each descriptor found, ejbjar will parse the

  553. deployment descriptor to determine the necessary class files which implement the

  554. bean. These files are assembled along with the deployment descriptors into a

  555. well formed EJB jar file. Any support files which need to be included in the

  556. generated jar can be added with the &lt;support&gt; nested element. For each

  557. class included in the jar, ejbjar will scan for any super classes or super

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

  559. 

  560. <p>If no nested vendor-specific deployment elements are present, the task will

  561. simply generate a generic EJB jar. Such jars are typically used as the input to

  562. vendor-specific deployment tools. For each nested deployment element, a vendor

  563. specific deployment tool is run to generate a jar file ready for deployment in

  564. that vendor's EJB container. </p>

  565. 

  566. <p>The jar files are only built if they are out of date.  Each deployment tool

  567. element will examine its target jar file and determine if it is out of date with

  568. respect to the class files and deployment descriptors that make up the bean. If

  569. any of these files are newer than the jar file the jar will be rebuilt otherwise

  570. a message is logged that the jar file is up to date.</p>

  571. 

  572. <p>The task uses the

  573. <a href="http://jakarta.apache.org/bcel"> jakarta-BCEL </a> framework

  574. to extract all dependent classes. This

  575. means that, in addition to the classes that are mentioned in the

  576. deployment descriptor, any classes that these depend on are also

  577. automatically included in the jar file.</p>

  578. 

  579. 

  580. <h3>Naming Convention</h3>

  581. 

  582. Ejbjar handles the processing of multiple beans, and it uses a set of naming

  583. conventions to determine the name of the generated EJB jars. The naming convention

  584. that is used is controlled by the &quot;naming&quot; attribute. It supports the

  585. following values

  586. <ul>

  587. 

  588. <li>descriptor</li>

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

  590. name of the deployment descriptor.  For an Account bean, for example, the deployment

  591. descriptor would be named <code>Account-ejb-jar.xml</code>. Vendor specific descriptors are

  592. located using the same naming convention. The weblogic bean, for example, would be named

  593. <code>Account-weblogic-ejb-jar.xml</code>. Under this arrangement, the deployment descriptors

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

  595. is deployed in separate beans.

  596. </p>

  597. 

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

  599. deploying the same bean classes in different beans, with different deployment characteristics.

  600. 

  601. <li>ejb-name</li>

  602. <p> This naming scheme uses the &lt;ejb-name&gt; element from the deployment descriptor to

  603. determine the bean name. In this situation, the descriptors normally use the generic

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

  605. names. For example, If the value of the &lt;ejb-name&gt; were to be given in the deployment descriptor

  606. as follows:

  607. <pre>

  608. &lt;ejb-jar&gt;

  609.     &lt;enterprise-beans&gt;

  610.         &lt;entity&gt;

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

  612.             &lt;home&gt;org.apache.ant.ejbsample.SampleHome&lt;/home&gt;

  613. </pre>

  614. 

  615. then the name of the generated bean would be <code>Sample.jar</code>

  616. </p>

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

  618. compatible with other EJB tools. This scheme must have one bean per jar.

  619. </p>

  620. <li>directory</li>

  621. <p>

  622. In this mode, the name of the generated bean jar is derived from the directory

  623. containing the deployment descriptors. Again the deployment descriptors typically use

  624. the standard filenames. For example, if the path to the deployment descriptor is

  625. <code>/home/user/dev/appserver/dd/sample</code>, then the generated

  626. bean will be named <code>sample.jar</code>

  627. </p>

  628. <p>

  629. This scheme is also useful when you want to use standard style descriptor names. It is often

  630. most useful when the  descriptors are located in the same directory as the bean source code,

  631. although that is not mandatory. This scheme can handle multiple beans per jar.

  632. </p>

  633. 

  634. <li>basejarname</li>

  635. <p>

  636. The final scheme supported by the &lt;ejbjar&gt; task is used when you want to specify the generated

  637. bean jar name directly. In this case the name of the generated jar is specified by the

  638. &quot;basejarname&quot; attribute. Since all generated beans will have the same name, this task should

  639. be only used when each descriptor is in its own directory.

  640. </p>

  641. 

  642. <p>

  643. This scheme is most appropriate when you are using multiple beans per jar and only process a single

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

  645. beans in the jar.

  646. </p>

  647. 

  648. </ul>

  649. 

  650. <a name="ejbjar_deps"><h3>Dependencies</h3></a>

  651. <p>In addition to the bean classes, ejbjar is able to ad additional classes to the generated

  652. ejbjar. These classes are typically the support classes which are used by the bean's classes or as

  653. parameters to the bean's methods.</p>

  654. 

  655. <p>In versions of Ant prior to 1.5, ejbjar used reflection and attempted to add the super

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

  657. classes had to be loaded into Ant's JVM. This was not always possible due to class dependencies.

  658. </p>

  659. 

  660. <p>The ejbjar task in Ant releases 1.5 and later uses the

  661. <a href="http://jakarta.apache.org/bcel"> jakarta-BCEL </a> library

  662. to analyze the bean's class

  663. files directly, rather than loading them into the JVM. This also allows ejbjar to add all

  664. of the required support classes for a bean and not just super classes.

  665. </p>

  666. 

  667. <p>In Ant 1.5, a new attribute, <code>dependency</code> has been introduced to allow the

  668. buildfile to control what additional classes are added to the generated jar. It takes three

  669. possible values</p>

  670. <ul>

  671. <li><code>none</code> - only the bean classes and interfaces described in the bean's

  672. descriptor are added to the jar.</li>

  673. <li><code>super</code> - this is the default value and replicates the original ejbjar

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

  675. <li><code>full</code> - In this mode all classes used by the bean's classes and interfaces

  676. are added to the jar</li>

  677. </ul>

  678. <p>The <code>super</code> and <code>full</code> values require the

  679. <a href="http://jakarta.apache.org/bcel"> jakarta-BCEL </a> library

  680. to be available. If it is not, ejbjar will drop back to the behaviour corresponding to

  681. the value <code>none</code>.</p>

  682. 

  683. <h3>Parameters:</h3>

  684. <table border="1" cellpadding="2" cellspacing="0">

  685.   <tr>

  686.     <td valign="top"><b>Attribute</b></td>

  687.     <td valign="top"><b>Description</b></td>

  688.     <td align="center" valign="top"><b>Required</b></td>

  689.   </tr>

  690.   <tr>

  691.     <td valign="top">descriptordir</td>

  692.     <td valign="top">The base directory under which to scan for EJB

  693.                      deployment descriptors. If this attribute is not

  694.                      specified, then the deployment descriptors must be

  695.                      located in the directory specified by the 'srcdir'

  696.                      attribute.</td>

  697.     <td valign="top" align="center">No</td>

  698.   </tr>

  699.   <tr>

  700.     <td valign="top">srcdir</td>

  701.     <td valign="top">The base directory containing the .class files that

  702.                      make up the bean. Included are the home- remote- pk-

  703.                      and implementation- classes and all classes, that these

  704.                      depend on. Note that this can be the same as the

  705.                      descriptordir if all files are in the same directory

  706.                      tree.</td>

  707.     <td valign="top" align="center">Yes</td>

  708.   </tr>

  709.   <tr>

  710.     <td valign="top">destdir</td>

  711.     <td valign="top">The base directory into which generated jar files are

  712.                      deposited. Jar files are deposited in directories

  713.                      corresponding to their location within the descriptordir

  714.                      namespace. Note that this attribute is only used if the

  715.                      task is generating generic jars (i.e. no vendor-specific

  716.                      deployment elements have been specified).</td>

  717.     <td valign="top" align="center">Yes</td>

  718.   </tr>

  719.   <tr>

  720.     <td valign="top">naming</td>

  721.     <td valign="top">Controls the naming convention used to name generated

  722.                      EJB jars. Please refer to the description above.</td>

  723.     <td valign="top" align="center">No</td>

  724.   </tr>

  725.   <tr>

  726.     <td valign="top">basejarname</td>

  727.     <td valign="top">The base name that is used for the generated jar files.

  728.                      If this attribute is specified, the generic jar file name

  729.                      will use this value as the prefix (followed by the value

  730.                      specified in the 'genericjarsuffix' attribute) and the

  731.                      resultant ejb jar file (followed by any suffix specified

  732.                      in the nested element).</td>

  733.     <td valign="top" align="center">No</td>

  734.   </tr>

  735.   <tr>

  736.     <td valign="top">basenameterminator</td>

  737.     <td valign="top">String value used to substring out a string from the name

  738.                      of each deployment descriptor found, which is then used to

  739.                      locate related deployment descriptors (e.g. the WebLogic

  740.                      descriptors). For example, a basename of '.' and a

  741.                      deployment descriptor called 'FooBean.ejb-jar.xml' would

  742.                      result in a basename of 'FooBean' which would then be used

  743.                      to find FooBean.weblogic-ejb-jar.xml and

  744.                      FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create

  745.                      the filenames of the jar files as FooBean-generic.jar and

  746.                      FooBean-wl.jar. This attribute is not used if the

  747.                      'basejarname' attribute is specified.</td>

  748.     <td valign="top" align="center">No, defaults to '-'.</td>

  749.   </tr>

  750.   <tr>

  751.     <td valign="top">genericjarsuffix</td>

  752.     <td valign="top">String value appended to the basename of the deployment

  753.                      descriptor to create the filename of the generic EJB jar

  754.                      file.</td>

  755.     <td valign="top" align="center">No, defaults to '-generic.jar'.</td>

  756.   </tr>

  757.   <tr>

  758.     <td valign="top">classpath</td>

  759.     <td valign="top">This classpath is used when resolving classes which

  760.                      are to be added to the jar. Typically nested deployment

  761.                      tool elements will also support a classpath which

  762.                      will be combined with this classpath when resolving

  763.                      classes</td>

  764.     <td valign="top" align="center">No.</td>

  765.   </tr>

  766.   <tr>

  767.     <td valign="top">flatdestdir</td>

  768.     <td valign="top">Set this attribute to true if you want all generated jars

  769.                      to be placed in the root of the destdir, rather than

  770.                      according to the location of the deployment descriptor

  771.                      within the descriptor dir hierarchy.</td>

  772.     <td valign="top" align="center">No.</td>

  773.   </tr>

  774.   <tr>

  775.     <td valign="top">dependency</td>

  776.     <td valign="top">This attribute controls which additional classes and interfaces

  777.                      are added to the jar. Please refer to the description

  778.                      <a href="#ejbjar_deps">above</a></td>

  779.     <td valign="top" align="center">No.</td>

  780.   </tr>

  781. </table>

  782. 

  783. <h3>Nested Elements</h3>

  784. 

  785. <p>In addition to the vendor specific nested elements, the ejbjar task provides

  786. three nested elements. </p>

  787. 

  788. <h4>Classpath</h4>

  789. 

  790. <p>The &lt;classpath&gt; nested element allows the classpath

  791. to be set. It is useful when setting the classpath from a reference path. In all

  792. other respects the behaviour is the same as the classpath attribute.</p>

  793. 

  794. <a name="ejbjar-dtd"><h4>dtd</h4></a>

  795. 

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

  797. used when parsing the EJB deployment descriptor. Using a local DTD is much

  798. faster than loading the DTD across the net. If you are running ejbjar behind a

  799. firewall you may not even be able to access the remote DTD. The supported

  800. vendor-specific nested elements know the location of the required DTDs within

  801. the vendor class hierarchy and, in general, this means &lt;dtd&gt; elements are

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

  803. available in the classpath when Ant is started. If your want to run Ant without

  804. requiring the vendor classes in the classpath, you would need to use a

  805. &lt;dtd&gt; element.</p>

  806. 

  807. <table border="1" cellpadding="2" cellspacing="0">

  808.   <tr>

  809.     <td valign="top"><b>Attribute</b></td>

  810.     <td valign="top"><b>Description</b></td>

  811.     <td align="center" valign="top"><b>Required</b></td>

  812.   </tr>

  813.   <tr>

  814.     <td valign="top">publicId</td>

  815.     <td valign="top">The public Id of the DTD for which the location is being provided</td>

  816.     <td align="center" valign="top">Yes</td>

  817.   </tr>

  818.   <tr>

  819.     <td valign="top">location</td>

  820.     <td valign="top">The location of the local copy of the DTD. This can either be a

  821.                      file or a resource loadable from the classpath.</td>

  822.     <td align="center" valign="top">Yes</td>

  823.   </tr>

  824. </table>

  825. 

  826. <h4>support</h4>

  827. 

  828. <p>The &lt;support&gt; nested element is used to supply additional classes

  829. (files) to be included in the generated jars. The &lt;support&gt; element is a

  830. <a href="../CoreTypes/fileset.html">FileSet</a>, so it can either reference a fileset declared elsewhere or it can be

  831. defined in-place with the appropriate &lt;include&gt; and &lt;exclude&gt; nested

  832. elements. The files in the support fileset are added into the generated EJB jar

  833. in the same relative location as their location within the support fileset. Note

  834. that when ejbjar generates more than one jar file, the support files are added

  835. to each one.</p>

  836. 

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

  838. 

  839. Each vendor-specific nested element controls the generation of a deployable jar

  840. specific to that vendor's EJB container. The parameters for each supported

  841. deployment element are detailed here.

  842. 

  843. 

  844. <h3><a name="ejbjar_jboss">Jboss element</a></h3>

  845. 

  846. <p>The jboss element searches for the JBoss specific deployment descriptors and adds them

  847. to the final ejb jar file. JBoss has two deployment descriptors jboss.xml and jaws.xml

  848. (for container manager persistence only). The JBoss server uses hot deployment and does

  849. not require compilation of additional stubs and skeletons.</p>

  850. 

  851. <table border="1" cellpadding="2" cellspacing="0">

  852.   <tr>

  853.     <td valign="top"><b>Attribute</b></td>

  854.     <td valign="top"><b>Description</b></td>

  855.     <td align="center" valign="top"><b>Required</b></td>

  856.   </tr>

  857.   <tr>

  858.     <td valign="top">destdir</td>

  859.     <td valign="top">The base directory into which the generated weblogic ready

  860.                      jar files are deposited. Jar files are deposited in

  861.                      directories corresponding to their location within the

  862.                      descriptordir namespace. </td>

  863.     <td valign="top" align="center">Yes</td>

  864.   </tr>

  865.   <tr>

  866.     <td valign="top">genericjarsuffix</td>

  867.     <td valign="top">A generic jar is generated as an intermediate step in

  868.                      build the weblogic deployment jar. The suffix used to

  869.                      generate the generic jar file is not particularly

  870.                      important unless it is desired to keep the generic

  871.                      jar file. It should not, however, be the same

  872.                      as the suffix setting.</td>

  873.     <td valign="top" align="center">No, defaults to '-generic.jar'.</td>

  874.   </tr>

  875.   <tr>

  876.     <td valign="top">suffix</td>

  877.     <td valign="top">String value appended to the basename of the deployment

  878.                      descriptor to create the filename of the JBoss EJB

  879.                      jar file.</td>

  880.     <td valign="top" align="center">No, defaults to '.jar'.</td>

  881.   </tr>

  882.   <tr>

  883.     <td valign="top">keepgeneric</td>

  884.     <td valign="top">This controls whether the generic file used as input to

  885.                      ejbc is retained.</td>

  886.     <td valign="top" align="center">No, defaults to false</td>

  887.   </tr>

  888. </table>

  889. 

  890. 

  891. <h3><a name="ejbjar_weblogic">Weblogic element</a></h3>

  892. 

  893. <p>The weblogic element is used to control the weblogic.ejbc compiler for

  894. generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP

  895. descriptors was to use the ejbjar naming convention. So if your ejb-jar was

  896. called, Customer-ejb-jar.xml, your weblogic descriptor was called Customer-

  897. weblogic-ejb-jar.xml and your CMP descriptor had to be Customer-weblogic-cmp-

  898. rdbms-jar.xml. In addition, the &lt;type-storage&gt; element in the weblogic

  899. descriptor had to be set to the standard name META-INF/weblogic-cmp-rdbms-

  900. jar.xml, as that is where the CMP descriptor was mapped to in the generated

  901. jar.</p>

  902. 

  903. <p>There are a few problems with this scheme. It does not allow for more than

  904. one CMP descriptor to be defined in a jar and it is not compatible with the

  905. deployment descriptors generated by some tools.</p>

  906. 

  907. <p>In Ant 1.3, ejbjar parses the weblogic deployment descriptor to discover the

  908. CMP descriptors, which are then included automatically. This behaviour is

  909. controlled by the newCMP attribute. Note that if you move to the new method of

  910. determining CMP descriptors, you will need to update your weblogic deployment

  911. descriptor's &lt;type-storage&gt; element. In the above example, you would

  912. define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.</p>

  913. 

  914. <table border="1" cellpadding="2" cellspacing="0">

  915.   <tr>

  916.     <td valign="top"><b>Attribute</b></td>

  917.     <td valign="top"><b>Description</b></td>

  918.     <td align="center" valign="top"><b>Required</b></td>

  919.   </tr>

  920.   <tr>

  921.     <td valign="top">destdir</td>

  922.     <td valign="top">The base directory into which the generated weblogic ready

  923.                      jar files are deposited. Jar files are deposited in

  924.                      directories corresponding to their location within the

  925.                      descriptordir namespace. </td>

  926.     <td valign="top" align="center">Yes</td>

  927.   </tr>

  928.   <tr>

  929.     <td valign="top">genericjarsuffix</td>

  930.     <td valign="top">A generic jar is generated as an intermediate step in

  931.                      build the weblogic deployment jar. The suffix used to

  932.                      generate the generic jar file is not particularly

  933.                      important unless it is desired to keep the generic

  934.                      jar file. It should not, however, be the same

  935.                      as the suffix setting.</td>

  936.     <td valign="top" align="center">No, defaults to '-generic.jar'.</td>

  937.   </tr>

  938.   <tr>

  939.     <td valign="top">suffix</td>

  940.     <td valign="top">String value appended to the basename of the deployment

  941.                      descriptor to create the filename of the WebLogic EJB

  942.                      jar file.</td>

  943.     <td valign="top" align="center">No, defaults to '.jar'.</td>

  944.   </tr>

  945.   <tr>

  946.     <td valign="top">classpath</td>

  947.     <td valign="top">The classpath to be used when running the weblogic ejbc

  948.                      tool. Note that this tool typically requires the classes

  949.                      that make up the bean to be available on the classpath.

  950.                      Currently, however, this will cause the ejbc tool to be

  951.                      run in a separate VM</td>

  952.     <td valign="top" align="center">No</td>

  953.   </tr>

  954.   <tr>

  955.     <td valign="top">wlclasspath</td>

  956.     <td valign="top">Weblogic 6.0 will give a warning if the home and remote interfaces

  957.                      of a bean are on the system classpath used to run weblogic.ejbc.

  958.                      In that case, the standard weblogic classes should be set with

  959.                      this attribute (or equivalent nested element) and the

  960.                      home and remote interfaces located with the standard classpath

  961.                      attribute</td>

  962.     <td valign="top" align="center">No</td>

  963.   </tr>

  964.   <tr>

  965.     <td valign="top">keepgeneric</td>

  966.     <td valign="top">This controls whether the generic file used as input to

  967.                      ejbc is retained.</td>

  968.     <td valign="top" align="center">No, defaults to false</td>

  969.   </tr>

  970.   <tr>

  971.     <td valign="top">compiler</td>

  972.     <td valign="top">This allows for the selection of a different compiler

  973.                      to be used for the compilation of the generated Java

  974.                      files. This could be set, for example, to Jikes to

  975.                      compile with the Jikes compiler. If this is not set

  976.                      and the <code>build.compiler</code> property is set

  977.                      to jikes, the Jikes compiler will be used. If this

  978.                      is not desired, the value &quot;<code>default</code>&quot;

  979.                      may be given to use the default compiler</td>

  980.     <td valign="top" align="center">No</td>

  981.   </tr>

  982.   <tr>

  983.     <td valign="top">rebuild</td>

  984.     <td valign="top">This flag controls whether weblogic.ejbc is always

  985.                      invoked to build the jar file. In certain circumstances,

  986.                      such as when only a bean class has been changed, the jar

  987.                      can be generated by merely replacing the changed classes

  988.                      and not rerunning ejbc. Setting this to false will reduce

  989.                      the time to run ejbjar.

  990.                      </td>

  991.     <td valign="top" align="center">No, defaults to true.</td>

  992.   </tr>

  993.   <tr>

  994.     <td valign="top">keepgenerated</td>

  995.     <td valign="top">Controls whether weblogic will keep the generated Java

  996.                      files used to build the class files added to the

  997.                      jar. This can be useful when debugging

  998.                      </td>

  999.     <td valign="top" align="center">No, defaults to false.</td>

  1000.   </tr>

  1001.   <tr>

  1002.     <td valign="top">args</td>

  1003.     <td valign="top">Any additional arguments to be passed to the weblogic.ejbc

  1004.                      tool.

  1005.                      </td>

  1006.     <td valign="top" align="center">No.</td>

  1007.   </tr>

  1008.   <tr>

  1009.     <td valign="top">weblogicdtd</td>

  1010.     <td valign="top"><b>Deprecated</b>. Defines the location of the ejb-jar DTD in

  1011.                      the weblogic class hierarchy. This should not be necessary if you

  1012.                      have weblogic in your classpath. If you do not, you should use a

  1013.                      nested &lt;dtd&gt; element, described above. If you do choose

  1014.                      to use an attribute, you should use a

  1015.                      nested &lt;dtd&gt; element.

  1016.                      </td>

  1017.     <td valign="top" align="center">No.</td>

  1018.   </tr>

  1019.   <tr>

  1020.     <td valign="top">wldtd</td>

  1021.     <td valign="top"><b>Deprecated</b>. Defines the location of the weblogic-ejb-jar

  1022.                      DTD which covers the Weblogic specific deployment descriptors.

  1023.                      This should not be necessary if you have weblogic in your

  1024.                      classpath. If you do not, you should use a nested &lt;dtd&gt;

  1025.                      element, described above.

  1026.                      </td>

  1027.     <td valign="top" align="center">No.</td>

  1028.   </tr>

  1029.   <tr>

  1030.     <td valign="top">ejbdtd</td>

  1031.     <td valign="top"><b>Deprecated</b>. Defines the location of the ejb-jar DTD in

  1032.                      the weblogic class hierarchy. This should not be necessary if you

  1033.                      have weblogic in your classpath. If you do not, you should use a

  1034.                      nested &lt;dtd&gt; element, described above.

  1035.                      </td>

  1036.     <td valign="top" align="center">No.</td>

  1037.   </tr>

  1038.   <tr>

  1039.     <td valign="top">newCMP</td>

  1040.     <td valign="top">If this is set to true, the new method for locating

  1041.                      CMP descriptors will be used.</td>

  1042.     <td valign="top" align="center">No. Defaults to false</td>

  1043.   </tr>

  1044.   <tr>

  1045.     <td valign="top">oldCMP</td>

  1046.     <td valign="top"><b>Deprecated</b> This is an antonym for newCMP which should be used instead.</td>

  1047.     <td valign="top" align="center">No.</td>

  1048.   </tr>

  1049.   <tr>

  1050.     <td valign="top">noEJBC</td>

  1051.     <td valign="top">If this attribute is set to true, Weblogic's ejbc will not be run on the EJB jar.

  1052.                      Use this if you prefer to run ejbc at deployment time.</td>

  1053.     <td valign="top" align="center">No.</td>

  1054.   </tr>

  1055.   <tr>

  1056.     <td valign="top">ejbcclass</td>

  1057.     <td valign="top">Specifies the classname of the ejbc compiler. Normally ejbjar determines

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

  1059.                      featured in weblogic 6 has, however, been deprecated in version 7. When

  1060.                      using with version 7 this attribute should be set to

  1061.                      &quot;weblogic.ejbc&quot; to avoid the deprecation warning.</td>

  1062.     <td valign="top" align="center">No.</td>

  1063.   </tr>

  1064.   <tr>

  1065.     <td valign="top">jvmargs</td>

  1066.     <td valign="top">Any additional arguments to be passed to the Virtual Machine

  1067.                      running weblogic.ejbc tool. For example to set the memory size,

  1068.                      this could be jvmargs=&quot;-Xmx128m&quot;

  1069.                      </td>

  1070.     <td valign="top" align="center">No.</td>

  1071.   </tr>

  1072.   <tr>

  1073.     <td valign="top">jvmdebuglevel</td>

  1074.     <td valign="top">Sets the weblogic.StdoutSeverityLevel to use when running

  1075.                      the Virtual Machine that executes ejbc. Set to 16 to avoid

  1076.                      the warnings about EJB Home and Remotes being in the classpath

  1077.                      </td>

  1078.     <td valign="top" align="center">No.</td>

  1079.   </tr>

  1080.   <tr>

  1081.     <td valign="top">outputdir</td>

  1082.     <td valign="top">If set ejbc will be given this directory as the output

  1083.                      destination rather than a jar file. This allows for the

  1084.                      generation of &quot;exploded&quot; jars.

  1085.                      </td>

  1086.     <td valign="top" align="center">No.</td>

  1087.   </tr>

  1088. </table>

  1089. 

  1090. <p>The weblogic nested element supports three nested elements. The

  1091. first two, &lt;classpath&gt; and &lt;wlclasspath&gt;, are used to set the

  1092. respective classpaths. These nested elements are useful when setting up

  1093. class paths using reference Ids. The last, &lt;sysproperty&gt;, allows

  1094. Java system properties to be set during the compiler run. This turns out

  1095. to be necessary for supporting CMP EJB compilation in all environments.

  1096. </p>

  1097. 

  1098. <h3>TOPLink for Weblogic element</h3>

  1099. 

  1100. <p><b><i>Deprecated</i></b></p>

  1101. 

  1102. <p>The toplink element is no longer required. Toplink beans can now be built with the standard

  1103. weblogic element, as long as the newCMP attribute is set to &quot;true&quot;

  1104. </p>

  1105. 

  1106. <p>The TopLink element is used to handle beans which use Toplink for the CMP operations. It

  1107. is derived from the standard weblogic element so it supports the same set of attributes plus these

  1108. additional attributes</p>

  1109. 

  1110. <table border="1" cellpadding="2" cellspacing="0">

  1111.   <tr>

  1112.     <td valign="top"><b>Attribute</b></td>

  1113.     <td valign="top"><b>Description</b></td>

  1114.     <td align="center" valign="top"><b>Required</b></td>

  1115.   </tr>

  1116.   <tr>

  1117.     <td valign="top">toplinkdescriptor</td>

  1118.     <td valign="top">This specifies the name of the TOPLink deployment descriptor file contained in the

  1119.                      'descriptordir' directory.</td>

  1120.     <td valign="top" align="center">Yes</td>

  1121.   </tr>

  1122.   <tr>

  1123.     <td valign="top">toplinkdtd</td>

  1124.     <td valign="top">This specifies the location of the TOPLink DTD file. This can be a file path or

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

  1126.     <td valign="top" align="center">No, defaults to dtd file at www.objectpeople.com.</td>

  1127.   </tr>

  1128. </table>

  1129. 

  1130. 

  1131. <h3>Examples</h3>

  1132. 

  1133. <p>This example shows ejbjar being used to generate deployment jars using a

  1134. Weblogic EJB container. This example requires the naming standard to be used for

  1135. the deployment descriptors. Using this format will create a ejb jar file for

  1136. each variation of '*-ejb-jar.xml' that is found in the deployment descriptor

  1137. directory.</p>

  1138. 

  1139. <pre>

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

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

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

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

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

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

  1146.     &lt;/ejbjar&gt;

  1147. </pre>

  1148. 

  1149. <p>If weblogic is not in the Ant classpath, the following example

  1150. shows how to specify the location of the weblogic DTDs. This

  1151. example also show the use of a nested classpath element.</p>

  1152. 

  1153. <pre>

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

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

  1156.                  keepgeneric=&quot;true&quot;

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

  1158.                  suffix=&quot;.jar&quot;

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

  1160.          &lt;classpath&gt;

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

  1162.          &lt;/classpath&gt;

  1163.        &lt;/weblogic&gt;

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

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

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

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

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

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

  1170.     &lt;/ejbjar&gt;

  1171. </pre>

  1172. 

  1173. 

  1174. <p>This example shows ejbjar being used to generate a single deployment jar

  1175. using a Weblogic EJB container. This example does not require the deployment

  1176. descriptors to use the naming standard. This will create only one ejb jar file -

  1177. 'TheEJBJar.jar'.</p>

  1178. 

  1179. 

  1180. <pre>

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

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

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

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

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

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

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

  1188.     &lt;/ejbjar&gt;

  1189. </pre>

  1190. 

  1191. <p>This example shows ejbjar being used to generate deployment jars for a TOPLink-enabled entity bean using a

  1192. Weblogic EJB container. This example does not require the deployment descriptors to use the naming standard.

  1193. This will create only one TOPLink-enabled ejb jar file - 'Address.jar'.</p>

  1194. 

  1195. <pre>

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

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

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

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

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

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

  1202.                     keepgeneric=&quot;false&quot;

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

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

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

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

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

  1208.     &lt;/ejbjar&gt;

  1209. </pre>

  1210. 

  1211. <p>This final example shows how you would set-up ejbjar under Weblogic 6.0. It also shows the use of the

  1212. &lt;support&gt; element to add support files</p>

  1213. 

  1214. <pre>

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

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

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

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

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

  1220.        &lt;/support&gt;

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

  1222.                  keepgeneric=&quot;true&quot;

  1223.                  suffix=&quot;.jar&quot;

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

  1225.          &lt;classpath&gt;

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

  1227.          &lt;/classpath&gt;

  1228.          &lt;wlclasspath&gt;

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

  1230.          &lt;/wlclasspath&gt;

  1231.        &lt;/weblogic&gt;

  1232.     &lt;/ejbjar&gt;

  1233. </pre>

  1234. 

  1235. 

  1236. <h3><a name="ejbjar_websphere">WebSphere element</a></h3>

  1237. 

  1238. <p>The websphere element searches for the websphere specific deployment descriptors and

  1239. adds them to the final ejb jar file. Websphere has two specific descriptors for session

  1240. beans:

  1241. <ul>

  1242.    <li>ibm-ejb-jar-bnd.xmi</li>

  1243.    <li>ibm-ejb-jar-ext.xmi</li>

  1244. </ul>

  1245. and another two for container managed entity beans:

  1246. <ul>

  1247.    <li>Map.mapxmi</li>

  1248.    <li>Schema.dbxmi</li>

  1249. </ul>

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

  1251. This step can be performed by the websphere element as part of the jar generation process. If the

  1252. switch <code>ejbdeploy</code> is on, the ejbdeploy tool from the websphere toolset is called for

  1253. every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic

  1254. (called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with

  1255. sun jdk.

  1256. </p>

  1257. 

  1258. <p>

  1259. For the websphere element to work, you have to provide a complete classpath, that contains all

  1260. classes, that are required to reflect the bean classes. For ejbdeploy to work, you must also provide

  1261. the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property (look at the examples below).

  1262. </p>

  1263. 

  1264. <table border="1" cellpadding="2" cellspacing="0">

  1265.   <tr>

  1266.     <td valign="top"><b>Attribute</b></td>

  1267.     <td valign="top"><b>Description</b></td>

  1268.     <td align="center" valign="top"><b>Required</b></td>

  1269.   </tr>

  1270.   <tr>

  1271.     <td valign="top">destdir</td>

  1272.     <td valign="top">The base directory into which the generated weblogic ready

  1273.                      jar files are deposited. Jar files are deposited in

  1274.                      directories corresponding to their location within the

  1275.                      descriptordir namespace. </td>

  1276.     <td valign="top" align="center">Yes</td>

  1277.   </tr>

  1278.   <tr>

  1279.     <td valign="top">ejbdeploy</td>

  1280.     <td valign="top">Decides wether ejbdeploy is called. When you set this to true,

  1281.                      be sure, to run ant with the ibm jdk.</td>

  1282.     <td valign="top" align="center">No, defaults to true</td>

  1283.   </tr>

  1284.   <tr>

  1285.     <td valign="top">suffix</td>

  1286.     <td valign="top">String value appended to the basename of the deployment

  1287.                      descriptor to create the filename of the WebLogic EJB

  1288.                      jar file.</td>

  1289.     <td valign="top" align="center">No, defaults to '.jar'.</td>

  1290.   </tr>

  1291.   <tr>

  1292.     <td valign="top">keepgeneric</td>

  1293.     <td valign="top">This controls whether the generic file used as input to

  1294.                      ejbdeploy is retained.</td>

  1295.     <td valign="top" align="center">No, defaults to false</td>

  1296.   </tr>

  1297.   <tr>

  1298.     <td valign="top">rebuild</td>

  1299.     <td valign="top">This controls whether ejbdeploy is called although no changes

  1300.                      have occurred.</td>

  1301.     <td valign="top" align="center">No, defaults to false</td>

  1302.   </tr>

  1303.   <tr>

  1304.     <td valign="top">tempdir</td>

  1305.     <td valign="top">A directory, where ejbdeploy will write temporary files</td>

  1306.     <td valign="top" align="center">No, defaults to '_ejbdeploy_temp'.</td>

  1307.   </tr>

  1308.   <tr>

  1309.     <td valign="top">dbName<br>dbSchema</td>

  1310.     <td valign="top">These options are passed to ejbdeploy.</td>

  1311.     <td valign="top" align="center">No</td>

  1312.   </tr>

  1313.   <tr>

  1314.     <td valign="top">dbVendor</td>

  1315.     <td valign="top">This option is passed to ejbdeploy. Valid options are for example:

  1316.                      <ul>

  1317.                      <li>SQL92</li> <li>SQL99</li> <li>DB2UDBWIN_V71</li>

  1318.                      <li>DB2UDBOS390_V6</li> <li>DB2UDBAS400_V4R5</li> <li>ORACLE_V8</li>

  1319.                      <li>INFORMIX_V92</li> <li>SYBASE_V1192</li> <li>MYSQL_V323</li>

  1320.                      <li>MSSQLSERVER_V7</li>

  1321.                      </ul>

  1322.                      This is also used to determine the name of the Map.mapxmi and

  1323.                      Schema.dbxmi files, for example Account-DB2UDBWIN_V71-Map.mapxmi

  1324.                      and Account-DB2UDBWIN_V71-Schema.dbxmi.

  1325.                      </td>

  1326.     <td valign="top" align="center">No</td>

  1327.   </tr>

  1328.   <tr>

  1329.     <td valign="top">codegen<br>quiet<br>novalidate<br>noinform<br>trace<br>

  1330.                      use35MappingRules</td>

  1331.     <td valign="top">These options are all passed to ejbdeploy. All options

  1332.                      except 'quiet' default to false.</td>

  1333.     <td valign="top" align="center">No</td>

  1334.   </tr>

  1335.   <tr>

  1336.     <td valign="top">rmicOptions</td>

  1337.     <td valign="top">This option is passed to ejbdeploy and will be passed

  1338.                      on to rmic.</td>

  1339.     <td valign="top" align="center">No</td>

  1340.   </tr>

  1341. </table>

  1342. 

  1343. <p>This example shows ejbjar being used to generate deployment jars for all deployment descriptors

  1344. in the descriptor dir:</p>

  1345. 

  1346. <pre>

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

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

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

  1350.       &lt;websphere dbvendor="DB2UDBOS390_V6"

  1351.                  ejbdeploy="true"

  1352.                  oldCMP="false"

  1353.                  tempdir="/tmp"

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

  1355.         &lt;wasclasspath&gt;

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

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

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

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

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

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

  1362.         &lt;/wasclasspath&gt;

  1363.       &lt;classpath&gt;

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

  1365.       &lt;/classpath&gt;

  1366.       &lt;/websphere&gt;

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

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

  1369.     &lt;/ejbjar&gt;

  1370. </pre>

  1371. 

  1372. <h3><a name="ejbjar_iplanet">iPlanet Application Server (iAS) element</a></h3>

  1373. 

  1374. The &lt;iplanet&lt; nested element is used to build iAS-specific stubs and

  1375. 

  1376. skeletons and construct a JAR file which may be deployed to the iPlanet

  1377. Application Server 6.0.  The build process will always determine if

  1378. the EJB stubs/skeletons and the EJB-JAR file are up to date, and it will

  1379. do the minimum amount of work required.

  1380. <p>Like the WebLogic element, a naming convention for the EJB descriptors

  1381. is most commonly used to specify the name for the completed JAR file.

  1382. For example, if the EJB descriptor ejb/Account-ejb-jar.xml is found in

  1383. the descriptor directory, the iplanet element will search for an iAS-specific

  1384. EJB descriptor file named ejb/Account-ias-ejb-jar.xml (if it isn't found,

  1385. the task will fail) and a JAR file named ejb/Account.jar will be written

  1386. in the destination directory.  Note that when the EJB descriptors

  1387. are added to the JAR file, they are automatically renamed META-INF/ejb-jar.xml

  1388. and META-INF/ias-ejb-jar.xml.</p>

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

  1390. in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir)

  1391. as well as the iplanet element (for example, suffix).  Refer to the

  1392. appropriate documentation for more details.</p>

  1393. <h3>

  1394. Parameters:</h3>

  1395. 

  1396. <table BORDER CELLSPACING=0 CELLPADDING=2 >

  1397. <tr>

  1398. <td VALIGN=TOP><b>Attribute</b></td>

  1399. 

  1400. <td VALIGN=TOP><b>Description</b></td>

  1401. 

  1402. <td ALIGN=CENTER VALIGN=TOP><b>Required</b></td>

  1403. </tr>

  1404. 

  1405. <tr>

  1406. <td VALIGN=TOP>destdir</td>

  1407. 

  1408. <td VALIGN=TOP>The base directory into which the generated JAR files will

  1409. be written. Each JAR file is written in directories which correspond to

  1410. their location within the "descriptordir" namespace.</td>

  1411. 

  1412. <td ALIGN=CENTER VALIGN=TOP>Yes</td>

  1413. </tr>

  1414. 

  1415. <tr>

  1416. <td VALIGN=TOP>classpath</td>

  1417. 

  1418. <td VALIGN=TOP>The classpath used when generating EJB stubs and skeletons.

  1419. If omitted, the classpath specified in the "ejbjar" parent task will be

  1420. used.  If specified, the classpath elements will be prepended to the

  1421. classpath specified in the parent "ejbjar" task. Note that nested "classpath"

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

  1423. 

  1424. <td ALIGN=CENTER VALIGN=TOP>No</td>

  1425. </tr>

  1426. 

  1427. <tr>

  1428. <td VALIGN=TOP>keepgenerated</td>

  1429. 

  1430. <td VALIGN=TOP>Indicates whether or not the Java source files which are

  1431. generated by ejbc will be saved or automatically deleted. If "yes", the

  1432. source files will be retained.  If omitted, it defaults to "no". </td>

  1433. 

  1434. <td ALIGN=CENTER VALIGN=TOP>No</td>

  1435. </tr>

  1436. 

  1437. <tr>

  1438. <td VALIGN=TOP>debug</td>

  1439. 

  1440. <td>Indicates whether or not the ejbc utility should log additional debugging

  1441. statements to the standard output. If "yes", the additional debugging statements

  1442. will be generated.  If omitted, it defaults to "no". </td>

  1443. 

  1444. <td ALIGN=CENTER VALIGN=TOP>No</td>

  1445. </tr>

  1446. 

  1447. <tr>

  1448. <td VALIGN=TOP>iashome</td>

  1449. 

  1450. <td>May be used to specify the "home" directory for this iAS installation.

  1451. This is used to find the ejbc utility if it isn't included in the user's

  1452. system path.  If specified, it should refer to the [install-location]/iplanet/ias6/ias

  1453. directory.  If omitted, the ejbc utility must be on the user's system

  1454. path. </td>

  1455. 

  1456. <td ALIGN=CENTER VALIGN=TOP>No</td>

  1457. </tr>

  1458. 

  1459. <tr>

  1460. <td VALIGN=TOP>suffix</td>

  1461. 

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

  1463. If omitted, it defaults to ".jar". </td>

  1464. 

  1465. <td ALIGN=CENTER VALIGN=TOP>No</td>

  1466. </tr>

  1467. </table>

  1468. 

  1469. <p>As noted above, the iplanet element supports additional &lt;classpath&gt;

  1470. nested elements.</p>

  1471. <h3>

  1472. Examples</h3>

  1473. This example demonstrates the typical use of the &lt;iplanet&gt; nested element.

  1474. It will name each EJB-JAR using the "basename" prepended to each standard

  1475. EJB descriptor.  For example, if the descriptor named "Account-ejb-jar.xml"

  1476. is processed, the EJB-JAR will be named "Account.jar"

  1477. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

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

  1479. 

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

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

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

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

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

  1485. 

  1486. This example demonstrates the use of a nested classpath element as well

  1487. as some of the other optional attributes.

  1488. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

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

  1490. 

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

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

  1493.                      debug="yes"

  1494.                      keepgenerated="yes"&gt;

  1495.                      &lt;classpath&gt;

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

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

  1498.                      &lt;/classpath&gt;

  1499.             &lt;/iplanet&gt;

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

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

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

  1503. 

  1504. This example demonstrates the use of basejarname attribute.  In this

  1505. case, the completed EJB-JAR will be named "HelloWorld.jar"  If multiple

  1506. EJB descriptors might be found, care must be taken to ensure that the completed

  1507. JAR files don't overwrite each other.

  1508. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

  1509.             descriptordir="${src}"

  1510.             basejarname="HelloWorld"&gt;

  1511. 

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

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

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

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

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

  1517. This example demonstrates the use of the dtd nested element. If the local

  1518. copies of the DTDs are included in the classpath, they will be automatically

  1519. referenced without the nested elements.  In iAS 6.0 SP2, these local DTDs are

  1520. found in the [iAS-install-directory]/APPS directory.  In iAS 6.0 SP3, these

  1521. local DTDs are found in the [iAS-install-directory]/dtd directory.

  1522. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

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

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

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

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

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

  1528. 

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

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

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

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

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

  1534. 

  1535. <h3><a name="ejbjar_jonas">JOnAS (Java Open Application Server) element</a></h3>

  1536. 

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

  1538. skeletons thanks to the <code>GenIC</code> specific tool, and construct a JAR

  1539. file which may be deployed to the JOnAS Application Server. The build process

  1540. will always determine if the EJB stubs/skeletons and the EJB-JAR file are up to

  1541. date, and it will do the minimum amount of work required.</p>

  1542. 

  1543. <p>Like the WebLogic element, a naming convention for the EJB descriptors is

  1544. most commonly used to specify the name for the completed JAR file. For example,

  1545. if the EJB descriptor <code>ejb/Account-ejb-jar.xml</code> is found in the

  1546. descriptor directory, the &lt;jonas&gt; element will search for a JOnAS-specific

  1547. EJB descriptor file named <code>ejb/Account-jonas-ejb-jar.xml</code> and a JAR

  1548. file named <code>ejb/Account.jar</code> will be written in the destination

  1549. directory. But the &lt;jonas&gt; element can also use the JOnAS naming

  1550. convention. With the same example as below, the EJB descriptor can also be named

  1551. <code>ejb/Account.xml</code> (no base name terminator here) in the descriptor

  1552. directory. Then the &lt;jonas&gt; element will search for a JOnAS-specific EJB

  1553. descriptor file called <code>ejb/jonas-Account.xml</code>. This convention do

  1554. not follow strictly the ejb-jar naming convention recommendation but is

  1555. supported for backward compatibility with previous version of JOnAS.</p>

  1556. 

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

  1558. automatically renamed <code>META-INF/ejb-jar.xml</code> and

  1559. <code>META-INF/jonas-ejb-jar.xml</code>.</p>

  1560. 

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

  1562. the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir)

  1563. as well as the iplanet element (for example, suffix). Refer to the appropriate

  1564. documentation for more details.</p>

  1565. 

  1566. <h3> Parameters:</h3>

  1567. 

  1568. <table border="1" cellspacing="0" cellpadding="2">

  1569.   <tbody>

  1570.     <tr>

  1571.       <td valign="Top"><b>Attribute</b></td>

  1572.       <td valign="Top"><b>Description</b></td>

  1573.       <td align="Center" valign="Top"><b>Required</b></td>

  1574.     </tr>

  1575.     <tr>

  1576.       <td valign="Top">destdir</td>

  1577.       <td valign="Top">The base directory into which the generated JAR files

  1578.       will be written. Each JAR file is written in directories which correspond

  1579.       to their location within the "<code>descriptordir</code>" namespace.</td>

  1580.       <td align="Center" valign="Top">Yes</td>

  1581.     </tr>

  1582.     <tr>

  1583.       <td valign="Top">jonasroot</td>

  1584.       <td valign="Top">The root directory for JOnAS.</td>

  1585.       <td valign="Top" align="Center">Yes</td>

  1586.     </tr>

  1587.     <tr>

  1588.       <td valign="Top">classpath</td>

  1589.       <td valign="Top">The classpath used when generating EJB stubs and

  1590.       skeletons. If omitted, the classpath specified in the "ejbjar" parent

  1591.       task will be used. If specified, the classpath elements will be prepended

  1592.       to the classpath specified in the parent "ejbjar" task (see also the ORB

  1593.       attribute documentation below). Note that nested "classpath" elements may

  1594.       also be used.</td>

  1595.       <td valign="Top" align="Center">No</td>

  1596.     </tr>

  1597.     <tr>

  1598.       <td valign="Top">keepgenerated</td>

  1599.       <td valign="Top"><code>true</code> if the intermediate Java

  1600.       source files generated by GenIC must be deleted or not. If

  1601.       omitted, it defaults to <code>false</code>.</td>

  1602.       <td align="Center" valign="Top">No</td>

  1603.     </tr>

  1604.     <tr>

  1605.       <td valign="Top">nocompil</td>

  1606.       <td valign="Top"><code>true</code> if the generated source files

  1607.       must not be compiled via the java and rmi compilers. If omitted,

  1608.       it defaults to <code>false</code>.</td>

  1609.       <td align="Center" valign="Top">No</td>

  1610.     </tr>

  1611.     <tr>

  1612.       <td valign="Top">novalidation</td>

  1613.       <td valign="Top"><code>true</code> if the XML deployment descriptors must

  1614.       be parsed without validation. If omitted, it defaults to <code>false</code>.</td>

  1615.       <td align="Center" valign="Top">No</td>

  1616.     </tr>

  1617.     <tr>

  1618.       <td valign="Top">javac</td>

  1619.       <td valign="Top">Java compiler to use. If omitted, it defaults

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

  1621.       <td align="Center" valign="Top">No</td>

  1622.     </tr>

  1623.     <tr>

  1624.       <td valign="Top">javacopts</td>

  1625.       <td valign="Top">Options to pass to the java compiler.</td>

  1626.       <td align="Center" valign="Top">No</td>

  1627.     </tr>

  1628.     <tr>

  1629.       <td valign="Top">rmicopts</td>

  1630.       <td valign="Top">Options to pass to the rmi compiler.</td>

  1631.       <td align="Center" valign="Top">No</td>

  1632.     </tr>

  1633.     <tr>

  1634.       <td valign="top">secpropag</td>

  1635.       <td valign="top"><code>true</code> if the RMI Skel. and

  1636.       Stub. must be modified to implement the implicit propagation of

  1637.       the security context (the transactional context is always

  1638.       provided). If omitted, it defaults to <code>false</code>.</td>

  1639.       <td valign="top" align="center">No</td>

  1640.     </tr>

  1641.     <tr>

  1642.       <td valign="Top">verbose</td>

  1643.       <td valign="Top">Indicates whether or not to use -verbose switch. If

  1644.       omitted, it defaults to <code>false</code>.</td>

  1645.       <td align="Center" valign="Top">No</td>

  1646.     </tr>

  1647.       <td valign="Top">additionalargs</td>

  1648.       <td valign="Top">Add additional args to GenIC.</td>

  1649.       <td align="Center" valign="Top">No</td>

  1650.     </tr>

  1651.     <tr>

  1652.       <td valign="Top">keepgeneric</td>

  1653.       <td valign="Top"><code>true</code> if the generic JAR file used as input

  1654.       to GenIC must be retained. If omitted, it defaults to <code>false</code>.</td>

  1655.       <td align="Center" valign="Top">No</td>

  1656.     </tr>

  1657.     <tr>

  1658.       <td valign="Top">suffix</td>

  1659.       <td>String value appended to the JAR filename when creating each JAR.  If

  1660.       omitted, it defaults to ".jar". </td>

  1661.       <td align="Center" valign="Top">No</td>

  1662.     </tr>

  1663.     <tr>

  1664.       <td valign="Top">orb</td>

  1665.       <td>Choose your ORB : RMI, JEREMIE, DAVID. If omitted, it defaults to the

  1666.       one present in classpath. If specified, the corresponding JOnAS JAR is

  1667.       automatically added to the classpath.</td>

  1668.       <td align="Center" valign="Top">No</td>

  1669.     </tr>

  1670.     <tr>

  1671.       <td valign="Top">nogenic</td>

  1672.       <td valign="Top">If this attribute is set to <code>true</code>,

  1673.       JOnAS's GenIC will not be run on the EJB JAR. Use this if you

  1674.       prefer to run GenIC at deployment time. If omitted, it defaults

  1675.       to <code>false</code>.</td>

  1676.       <td align="Center" valign="Top">No</td>

  1677.     </tr>

  1678.     <tr>

  1679.   </tbody>

  1680. </table>

  1681. 

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

  1683. nested elements.</p>

  1684. 

  1685. <h3>Examples</h3>

  1686. 

  1687. <p>This example shows ejbjar being used to generate deployment jars using a

  1688. JOnAS EJB container. This example requires the naming standard to be used for

  1689. the deployment descriptors. Using this format will create a EJB JAR file for

  1690. each variation of &nbsp;'*-jar.xml' that is found in the deployment descriptor

  1691. directory.&nbsp;</p>

  1692. 

  1693. <pre>

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

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

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

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

  1698.              orb="RMI"/&gt;

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

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

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

  1702.              &lt;include name="**/*.class"/&gt;

  1703.         &lt;/support&gt;

  1704.       &lt;/ejbjar&gt;

  1705. </pre>

  1706. 

  1707. <p>This example shows ejbjar being used to generate a single deployment jar

  1708. using a JOnAS EJB container. This example does require the deployment

  1709. descriptors to use the naming standard. This will create only one ejb jar file -

  1710. 'TheEJBJar.jar'.</p>

  1711. 

  1712. <pre>

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

  1714.               descriptordir="${descriptor.dir}"

  1715.               basejarname="TheEJBJar"&gt;

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

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

  1718.                   suffix=".jar"

  1719.                   classpath="${descriptorbuild.classpath}"/&gt;

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

  1721.         &lt;exclude name="**/jonas-ejb-jar.xml"/&gt;

  1722.       &lt;/ejbjar&gt;

  1723. </pre>

  1724. 

  1725. <hr>

  1726. <p align="center">Copyright &copy; 2000-2003 Apache Software Foundation. All rights

  1727. Reserved.</p>

  1728. 

  1729. 

  1730. </body>

  1731. 

  1732. </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