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

1158 lines
48 KiB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

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

  5. <title>Ant 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>Tim Fennell (<a href="mailto:tfenne@rcn.com">tfenne@rcn.com</a>)</li>

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

  17.   <li>Conor MacNeill (<a href="mailto:conor@cortexebusiness.com.au">conor@cortexebusiness.com.au</a>)</li>

  18.   <li>Greg Nelson (<a href="mailto:greg@netscape.com">greg@netscape.com</a>)</li>

  19. </ul>

  20. 

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

  22. $Id$

  23. </p>

  24. <hr>

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

  26. <ul>

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

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

  29. </ul>

  30. 

  31. <hr>

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

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

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

  35. In general these tasks are specific to the particular vendor's EJB Server. At present the tasks support

  36. <a href="http://www.bea.com" target="_top">Weblogic</a> 4.5.1 and 5.1 EJB servers. Over time we expect further optional tasks 

  37. to support additional EJB Servers. 

  38. </p>

  39. <hr>

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

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

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

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

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

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

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

  47.  <tr><td rowspan="4"><a href="#ejbjar">ejbjar</a></td><td colspan="2" align="center">Nested Elements</td></tr>

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

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

  50.  <tr><td><a href="#ejbjar_weblogic">weblogic</a></td><td>Weblogic 5.1 &amp; 6.0</td></tr>

  51.  <tr><td><a href="#wlrun">wlrun</a></td><td colspan="2">Weblogic 4.5.1, 5.1 &amp; 6.0</td></tr>

  52.  <tr><td><a href="#wlstop">wlstop</a></td><td colspan="2">Weblogic 4.5.1, 5.1 &amp; 6.0</td></tr>

  53. 

  54. </table>

  55. 

  56. <hr>

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

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

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

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

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

  62. </p>

  63. 

  64. <h3>Parameters:</h3>

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

  66.   <tr>

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

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

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

  70.   </tr>

  71.   <tr>

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

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

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

  75.   </tr>

  76.   <tr>

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

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

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

  80.   </tr>

  81.   <tr>

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

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

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

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

  86.   </tr>

  87. </table>

  88. <h3>Examples</h3>

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

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

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

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

  93. &lt;/ddcreator&gt;

  94. </pre>

  95. 

  96. <hr>

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

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

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

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

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

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

  103. <p>

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

  105. compiled are selected by including their serialised deployment descriptors. The standard ant 

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

  107. to be included. </p>

  108. <p>

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

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

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

  112. modification times. These times and the modification time of the serialised descriptor itself are

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

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

  115. <h3>Parameters:</h3>

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

  117.   <tr>

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

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

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

  121.   </tr>

  122.   <tr>

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

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

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

  126.   </tr>

  127.   <tr>

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

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

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

  131.   </tr>

  132.   <tr>

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

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

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

  136.   </tr>

  137.   <tr>

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

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

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

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

  142.   </tr>

  143.   <tr>

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

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

  146.                      classfiles of the bean, home interface, remote interface, etc of the bean being

  147.                      processed.</td>

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

  149.   </tr>

  150. </table>

  151. <h3>Examples</h3>

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

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

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

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

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

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

  158. &lt;/ejbc&gt;

  159. </pre>

  160. 

  161. <hr>

  162. <h2>

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

  164. 

  165. <h3>

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

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

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

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

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

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

  172. task.

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

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

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

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

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

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

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

  180. and skeletons.

  181. <h3>

  182. Parameters:</h3>

  183.  

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

  185. <tr>

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

  187. 

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

  189. 

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

  191. </tr>

  192. 

  193. <tr>

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

  195. 

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

  197. 

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

  199. </tr>

  200. 

  201. <tr>

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

  203. 

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

  205. 

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

  207. </tr>

  208. 

  209. <tr>

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

  211. 

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

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

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

  215. 

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

  217. </tr>

  218. 

  219. <tr>

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

  221. 

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

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

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

  225. 

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

  227. </tr>

  228. 

  229. <tr>

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

  231. 

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

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

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

  235. 

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

  237. </tr>

  238. 

  239. <tr>

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

  241. 

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

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

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

  245. 

  246. <td ALIGN=CENTER VALIGN=TOP>

  247. <center>No</center>

  248. </td>

  249. </tr>

  250. 

  251. <tr>

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

  253. 

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

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

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

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

  258. 

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

  260. </tr>

  261. </table>

  262. 

  263. <h3>

  264. Examples</h3>

  265. 

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

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

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

  269.               classpath="${ias.ejbc.cpath}" />

  270. 

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

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

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

  274.               keepgenerated="yes"

  275.               debug="yes"

  276.               iashome="${ias.home}" >

  277.               &lt;classpath>

  278.                   &lt;pathelement path="." />

  279.                   &lt;pathelement path="${build.classpath}" />

  280.               &lt;/classpath>

  281. &lt;/iplanet-ejbc>

  282. 

  283. </pre>

  284. 

  285. <hr>

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

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

  288. 

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

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

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

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

  293. 

  294. <h3>Parameters:</h3>

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

  296.   <tr>

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

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

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

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

  301.   </tr>

  302.   <tr>

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

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

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

  306.                      be running under Weblogic 6.0</td>

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

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

  309.   </tr>

  310.   <tr>

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

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

  313.                      where weblogic is installed.</td>

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

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

  316.                                     BEA home.</td>

  317.   </tr>

  318.   <tr>

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

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

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

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

  323.   </tr>

  324.   <tr>

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

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

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

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

  329.                      weblogic jars</td>

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

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

  332.   </tr>

  333.   <tr>

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

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

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

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

  338.   </tr>

  339.   <tr>

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

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

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

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

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

  345.   </tr>

  346.   <tr>

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

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

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

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

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

  352.   </tr>

  353.   <tr>

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

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

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

  357.                      is used.</td>

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

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

  360.   </tr>

  361.   <tr>

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

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

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

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

  366.   </tr>

  367.   <tr>

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

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

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

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

  372.   </tr>

  373.   <tr>

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

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

  376.                      private key file</td>

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

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

  379.   </tr>

  380.   <tr>

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

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

  383.                      Weblogic instance.</td>

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

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

  386.   </tr>

  387.   <tr>

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

  389.     <td valign="top">Additional argument string passed to the Weblogic instance.</td>

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

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

  392.   </tr>

  393. </table>

  394. 

  395. <h3>Nested Elements</h3>

  396. 

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

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

  399. 

  400. <h3>Examples</h3>

  401. 

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

  403. 

  404. <pre>

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

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

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

  408.            name=&quot;myserver&quot; 

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

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

  411. </pre>

  412. 

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

  414. Weblogic 6.0</p>

  415. 

  416. <pre>

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

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

  419.            name=&quot;petstoreServer&quot; 

  420.            domain=&quot;petstore&quot; 

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

  422.            password=&quot;petstorePassword&quot;

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

  424. </pre>

  425. 

  426. <hr>

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

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

  429. 

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

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

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

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

  434. development environment. </p>

  435. 

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

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

  438. 

  439. <h3>Parameters:</h3>

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

  441.   <tr>

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

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

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

  445.   </tr>

  446.   <tr>

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

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

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

  450.   </tr>

  451.   <tr>

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

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

  454.                      Shutdown comment.</td>

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

  456.   </tr>

  457.   <tr>

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

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

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

  461.   </tr>

  462.   <tr>

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

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

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

  466.   </tr>

  467.   <tr>

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

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

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

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

  472.   </tr>

  473.   <tr>

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

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

  476.                      immediate shutdown.</td>

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

  478.   </tr>

  479. </table>

  480. 

  481. <h3>Nested Element</h3>

  482. 

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

  484. 

  485. <h3>Examples</h3>

  486. 

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

  488. 

  489. <pre>

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

  491.             user=&quot;system&quot;

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

  493.             password=&quot;foobar&quot;

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

  495. </pre>

  496. 

  497. <hr>

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

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

  500. 

  501. <p>This task is designed to support building of EJB1.1 jar files. Support is 

  502. currently provided for 'vanilla' EJB1.1 jar files - i.e. those containing only 

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

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

  505. include: </p>

  506. <ul>

  507.   <li>an element or building Weblogic 5.1/6.0 session/entity beans using the 

  508.       weblogic.ejbc tool.</li>

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

  510. </ul>

  511. 

  512. <p>This task supports two approaches to creating ejb jar files. The first 

  513. approach assumes a particular naming convention for deployment descriptor files. 

  514. For an Account bean, for example, the deployment descriptor would be named 

  515. <code>Account-ejb-jar.xml</code>. This naming convention allows the task to 

  516. distinguish deployment descriptors without relying on their positioning within a 

  517. source tree. It is also used to derive the name of the .jar file which is 

  518. generated. For the example this would be <code>Account.jar</code>. Vendor 

  519. specific files are assumed to be named in a similar fashion. The deployment 

  520. descriptor file which defines additional weblogic specific information for the 

  521. above bean would be <code>Account-weblogic-ejb-jar.xml</code>. The second 

  522. approach does not require a naming convention. This approach uses a specified a 

  523. jar name for the resultant ejb jar. If the jar name is present, then no naming 

  524. convention is required. If the jar name is not specified, then the default 

  525. naming convention is expected for the deployment descriptor files.</p>

  526. 

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

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

  529. to ensure that all desired EJB1.1 descriptors are found, but no application 

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

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

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

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

  534. generated jarcan be added with the &lt;support&gt; nested element. For each 

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

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

  537. 

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

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

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

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

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

  543. 

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

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

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

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

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

  549. 

  550. <h3>Parameters:</h3>

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

  552.   <tr>

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

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

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

  556.   </tr>

  557.   <tr>

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

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

  560.                      deployment descriptors. If this attribute is not 

  561.                      specified, then the deployment descriptors must be 

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

  563.                      attribute.</td>

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

  565.   </tr>

  566.   <tr>

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

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

  569.                      make up the bean. Note that this can be the same as 

  570.                      the descriptordir if all files are in the same directory

  571.                      tree.</td>

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

  573.   </tr>

  574.   <tr>

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

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

  577.                      deposited. Jar files are deposited in directories 

  578.                      corresponding to their location within the descriptordir

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

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

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

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

  583.   </tr>

  584.   <tr>

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

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

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

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

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

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

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

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

  593.   </tr>

  594.   <tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  608.   </tr>

  609.   <tr>

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

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

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

  613.                      file.</td>

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

  615.   </tr>

  616.   <tr>

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

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

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

  620.                      tool elements will also support a classpath which 

  621.                      will be combined with this classpath when resolving 

  622.                      classes</td>

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

  624.   </tr>

  625.   <tr>

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

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

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

  629.                      according to the location of the deployment descriptor

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

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

  632.   </tr>

  633. </table>

  634. 

  635. <h3>Nested Elements</h3>

  636. 

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

  638. three nested elements. </p>

  639. 

  640. <h4>Classpath</h4>

  641. 

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

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

  644. othe rrespects the behaviour is the same as the classpath attribute.</p>

  645. 

  646. <h4>dtd</h4>

  647. 

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

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

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

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

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

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

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

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

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

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

  658. 

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

  660.   <tr>

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

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

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

  664.   </tr>

  665.   <tr>

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

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

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

  669.   </tr>

  670.   <tr>

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

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

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

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

  675.   </tr>

  676. </table>

  677. 

  678. <h4>support</h4>

  679. 

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

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

  682. FileSet, so it can either reference a fileset declared elsewehere or it can be 

  683. defined in-place with the approrpiate &lt;include&gt; and &lt;exclude&gt; nested 

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

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

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

  687. to each one.</p>

  688. 

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

  690. 

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

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

  693. deployment element are detailed here.

  694. 

  695. <a name="ejbjar_weblogic"></a>

  696. <h3>Weblogic element</h3>

  697. 

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

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

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

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

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

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

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

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

  706. jar.</p>

  707. 

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

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

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

  711. 

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

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

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

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

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

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

  718. 

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

  720.   <tr>

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

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

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

  724.   </tr>

  725.   <tr>

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

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

  728.                      jar files are deposited. Jar files are deposited in 

  729.                      directories corresponding to their location within the 

  730.                      descriptordir namespace. </td>

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

  732.   </tr>

  733.   <tr>

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

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

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

  737.                      generate the generic jar file is not particularly 

  738.                      important unless it is desired to keep the generic 

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

  740.                      as the suffix setting.</td>

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

  742.   </tr>

  743.   <tr>

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

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

  746.                      descriptor to create the filename of the WebLogic EJB 

  747.                      jar file.</td>

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

  749.   </tr>

  750.   <tr>

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

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

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

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

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

  756.                      run in a separate VM</td>

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

  758.   </tr>

  759.   <tr>

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

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

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

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

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

  765.                      home and remote interfaces located with the standard classpath

  766.                      attribute</td>

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

  768.   </tr>

  769.   <tr>

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

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

  772.                      ejbc is retained.</td>

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

  774.   </tr>

  775.   <tr>

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

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

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

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

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

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

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

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

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

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

  786.   </tr>

  787.   <tr>

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

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

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

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

  792.                      can be generated by merely replacing the changed classes

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

  794.                      the time to run ejbjar. 

  795.                      </td>

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

  797.   </tr>

  798.   <tr>

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

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

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

  802.                      jar. This can be useful when debugging

  803.                      </td>

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

  805.   </tr>

  806.   <tr>

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

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

  809.                      tool.

  810.                      </td>

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

  812.   </tr>

  813.   <tr>

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

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

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

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

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

  819.                      to use an attribute, you should use the ejbdtd attribute in

  820.                      preference to this one, anyway.

  821.                      </td>

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

  823.   </tr>

  824.   <tr>

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

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

  827.                      DTD which covers the Weblogic specific deployment descriptors.

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

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

  830.                      element, described above.

  831.                      </td>

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

  833.   </tr>

  834.   <tr>

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

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

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

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

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

  840.                      </td>

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

  842.   </tr>

  843.   <tr>

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

  845.     <td valign="top">If this is set to true, the ne wmethod for locating

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

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

  848.   </tr>

  849.   <tr>

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

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

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

  853.   </tr>

  854.   <tr>

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

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

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

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

  859.   </tr>

  860. </table>

  861. 

  862. <p>The weblogic nested element itself supports two nested elements &lt;classpath&gt; and 

  863. &lt;wlclasspath&gt; which are used to set the respective classpaths. These nested elements

  864. are useful when setting up class paths using reference Ids.</p>

  865. 

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

  867. 

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

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

  870. additional attributes</p>

  871. 

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

  873.   <tr>

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

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

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

  877.   </tr>

  878.   <tr>

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

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

  881.                      'descriptordir' directory.</td>

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

  883.   </tr>

  884.   <tr>

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

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

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

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

  889.   </tr>

  890. </table>

  891. 

  892. 

  893. <h3>Examples</h3>

  894. 

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

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

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

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

  899. directory.</p>

  900. 

  901. <pre>

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

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

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

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

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

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

  908.     &lt;/ejbjar&gt;

  909. </pre>

  910. 

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

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

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

  914.    

  915. <pre>

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

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

  918.                  keepgeneric=&quot;true&quot;

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

  920.                  suffix=&quot;.jar&quot;

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

  922.          &lt;classpath&gt;

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

  924.          &lt;/classpath&gt;

  925.        &lt;/weblogic&gt;

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

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

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

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

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

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

  932.     &lt;/ejbjar&gt;

  933. </pre>   

  934. 

  935. 

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

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

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

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

  940. 

  941. 

  942. <pre>

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

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

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

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

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

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

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

  950.     &lt;/ejbjar&gt;

  951. </pre>

  952. 

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

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

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

  956. 

  957. <pre>

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

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

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

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

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

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

  964.                     keepgeneric=&quot;false&quot;

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

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

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

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

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

  970.     &lt;/ejbjar&gt;

  971. </pre>

  972. 

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

  974. &lt;support&gt; element to add support files

  975. 

  976. <pre>

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

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

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

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

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

  982.        &lt;/support&gt;

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

  984.                  keepgeneric=&quot;true&quot;

  985.                  suffix=&quot;.jar&quot;

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

  987.          &lt;classpath&gt;

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

  989.          &lt;/classpath&gt;

  990.          &lt;wlclasspath&gt;

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

  992.          &lt;/wlclasspath&gt;

  993.        &lt;/weblogic&gt;

  994.     &lt;/ejbjar&gt;

  995. </pre>

  996. 

  997. <a name="ejbjar_iplanet"></a>

  998. <h3>

  999. iPlanet Application Server (iAS) element</h3>

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

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

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

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

  1004. do the minimum amount of work required.

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

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

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

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

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

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

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

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

  1013. and META-INF/ias-ejb-jar.xml.

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

  1015. in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir)

  1016. as well as the iplanet element (for example, suffix).  Refer to the

  1017. appropriate documentation for more details.

  1018. <h3>

  1019. Parameters:</h3>

  1020. 

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

  1022. <tr>

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

  1024. 

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

  1026. 

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

  1028. </tr>

  1029. 

  1030. <tr>

  1031. <td VALIGN=TOP>destdir</td>

  1032. 

  1033. <td VALIGN=TOP>The base directory into which the generated JAR files will

  1034. be written. Each JAR file is written in directories which correspond to

  1035. their location within the "descriptordir" namespace.</td>

  1036. 

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

  1038. </tr>

  1039. 

  1040. <tr>

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

  1042. 

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

  1044. If omitted, the classpath specified in the "ejbjar" parent task will be

  1045. used.  If specified, the classpath elements will be prepended to the

  1046. classpath specified in the parent "ejbjar" task. Note that nested "classpath"

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

  1048. 

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

  1050. </tr>

  1051. 

  1052. <tr>

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

  1054. 

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

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

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

  1058. 

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

  1060. </tr>

  1061. 

  1062. <tr>

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

  1064. 

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

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

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

  1068. 

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

  1070. </tr>

  1071. 

  1072. <tr>

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

  1074. 

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

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

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

  1078. directory.  If omitted, the ejbc utility must be on the user's system

  1079. path. </td>

  1080. 

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

  1082. </tr>

  1083. 

  1084. <tr>

  1085. <td VALIGN=TOP>suffix</td>

  1086. 

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

  1088. If omitted, it defaults to ".jar". </td>

  1089. 

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

  1091. </tr>

  1092. </table>

  1093. 

  1094. <p>As noted above, the iplanet element supports additional &lt;classpath>

  1095. nested elements.

  1096. <h3>

  1097. Examples</h3>

  1098. This example demonstrates the typical use of the &lt;iplanet> nested element. 

  1099. It will name each EJB-JAR using the "basename" prepended to each standard

  1100. EJB descriptor.  For example, if the descriptor named "Account-ejb-jar.xml"

  1101. is processed, the EJB-JAR will be named "Account.jar"

  1102. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

  1103.             descriptordir="${src}" >

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

  1105.                      classpath="${ias.ejbc.cpath}" />

  1106.             &lt;include name="**/*-ejb-jar.xml"/>

  1107.             &lt;exclude name="**/*ias-*.xml"/>

  1108.     &lt;/ejbjar></pre>

  1109. This example demonstrates the use of a nested classpath element as well

  1110. as some of the other optional attributes.

  1111. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

  1112.             descriptordir="${src}" >

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

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

  1115.                      debug="yes" 

  1116.                      keepgenerated="yes" >

  1117.                      &lt;classpath>

  1118.                          &lt;pathelement path="." />

  1119.                          &lt;pathelement path="${build.classpath}" />

  1120.                      &lt;/classpath>

  1121.             &lt;/iplanet>

  1122.             &lt;include name="**/*-ejb-jar.xml"/>

  1123.             &lt;exclude name="**/*ias-*.xml"/>

  1124.     &lt;/ejbjar></pre>

  1125. This example demonstrates the use of basejarname attribute.  In this

  1126. case, the completed EJB-JAR will be named "HelloWorld.jar"  If multiple

  1127. EJB descriptors might be found, care must be taken to ensure that the completed

  1128. JAR files don't overwrite each other.

  1129. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

  1130.             descriptordir="${src}"

  1131.             basejarname="HelloWorld" >

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

  1133.                      classpath="${ias.ejbc.cpath}"/>

  1134.             &lt;include name="**/*-ejb-jar.xml"/>

  1135.             &lt;exclude name="**/*ias-*.xml"/>

  1136.     &lt;/ejbjar></pre>

  1137. This example demonstrates the use of the dtd nested element.  If the

  1138. [iAS-install-directory]/APPS directory is included in the classpath, these

  1139. local  DTDs will be automatically referenced even without the nested

  1140. elements.

  1141. <pre>    &lt;ejbjar srcdir="${build.classesdir}"

  1142.             descriptordir="${src}" > 

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

  1144.                      classpath="${ias.ejbc.cpath}" />

  1145.             &lt;include name="**/*-ejb-jar.xml"/>

  1146.             &lt;exclude name="**/*ias-*.xml"/>

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

  1148.                  location="${ias.home}/APPS/ejb-jar_1_1.dtd"/>

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

  1150.                  location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/>

  1151.     &lt;/ejbjar></pre>

  1152. 

  1153. </body>

  1154. 

  1155. </html>

  1156.
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