Ant EJB Tasks User Manual

by

Version 1.1 - 2000/07/18


Table of Contents


Introduction

Ant provides a number of optional tasks for developing Enterprise Java Beans (EJBs). In general these tasks are specific to the particular vendor's EJB Server. At present the tasks support Weblogic 4.5.1 and 5.1 EJB servers. Over time we expect further optional tasks to support additional EJB Servers.


EJB Tasks

TaskApplication Servers
ddcreatorWeblogic 4.5
ejbcWeblogic 4.5
wlrunWeblogic 4.5
wlstopWeblogic 4.5
ejbjarWeblogic 5.1

ddcreator

Description:

ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized EJB deployment descriptor. The selection of which of the text-based descriptors are to be compiled is based on the standard Ant include and exclude selection mechanisms.

Parameters:

Attribute Description Required
descriptors This is the base directory from which descriptors are selected. Yes
dest The directory where the serialised deployment descriptors will be written Yes
classpath This is the classpath to use to run the underlying weblogic ddcreator tool. This must include the weblogic.ejb.utils.DDCreator class No

Examples

<ddcreator descriptors="${dd.dir}" 
           dest="${gen.classes}" 
           classpath="${descriptorbuild.classpath}">
  <include name="*.txt" />
</ddcreator>

ejbc

Description:

The ejbc task will run Weblogic's ejbc tool. This tool will take a serialised deployment descriptor, examine the various EJB interfaces and bean classes and then generate the required support classes necessary to deploy the bean in a Weblogic EJB container. This will include the RMI stubs and skeletons as well as the classes which implement the bean's home and remote interfaces.

The ant task which runs this tool is able to compile several beans in a single operation. The beans to be compiled are selected by including their serialised deployment descriptors. The standard ant include and exclude constructs can be used to select the deployment descriptors to be included.

Each descriptor is examined to determiune whether the generated classes are out of date and need to be regenerated. The deployment descriptor is de-serialized to discover the home, remote and implementation classes. The corresponding source files are determined and checked to see their modification times. These times and the modification time of the serialised descriptor itself are compared with the modification time of the generated classes. If the generated classes are not present or are out of date, the ejbc tool is run to generate new versions.

Parameters:

Attribute Description Required
descriptors This is the base directory from which the serialised deployment descriptors are selected. Yes
dest The base directory where the generated classes, RIM stubs and RMI skeletons are written Yes
manifest The name of a manifest file to be written. This manifest will contain an entry for each EJB processed Yes
src The base directory of the source tree containing the source files of the home interface, remote interface and bean implementation classes. Yes
classpath This classpath must include both the weblogic.ejbc class and the classfiles of the bean, home interface, remote interface, etc of the bean being processed. No

Examples

<ejbc descriptors="${gen.classes}"
           src="${src.dir}" 
           dest="${gen.classes}"
           manifest="${build.manifest}" 
           classpath="${descriptorbuild.classpath}">
  <include name="*.ser" />
</ejbc>

wlrun

Description:

This is an experimental task and is not currently documented.


wlstop

Description:

This is an experimental task and is not currently documented.


ejbjar

Description:

Documentation is not currently available.