From 5b1dbf444c9b88e7803585fd069feaa072b30bfc Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 13 Sep 2000 06:29:23 +0000 Subject: [PATCH] Updated Documentation on EJB tasks. Submitted by: John Hall git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267987 13f79535-47bb-0310-9956-ffa450edef68 --- docs/ejb.html | 143 +++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 125 insertions(+), 18 deletions(-) diff --git a/docs/ejb.html b/docs/ejb.html index 243c3460f..ef38f8aa5 100644 --- a/docs/ejb.html +++ b/docs/ejb.html @@ -164,17 +164,22 @@ or are out of date, the ejbc tool is run to generate new versions.

This task is designed to support building of arbitrary EJB1.1 jar files. Support is currently provided for 'vanilla' EJB1.1 jar files - i.e. those containing only the user generated class files and the standard deployment descriptor. Nested elements provide support for vendor - specific deployment tools. Currently a nested element is provided for Weblogic 5.1 using the - weblogic.ejbc tool.

+ specific deployment tools. Currently, a nested element is provided for building Weblogic 5.1 + session/entity beans using the weblogic.ejbc tool as well as a nested element for building + TOPLink for WebLogic 2.5.1-enabled entity beans.

-

This task assumes a particular naming convention for deployment descriptor files. For an - Account bean, for example, the deployment descriptor would be named Account-ejb-jar.xml. - This naming convention allows the task to distinguish deployment descriptors without relying on - their positioning within a source tree. It is also used to derive the name of the .jar file - which is generated. For the example this would be Account.jar. Vendor specific files - are assumed to be named in a similar fashion. The deployment descriptor file which defines - additional weblogic specific information for the above bean would be - Account-weblogic-ejb-jar.xml. +

This task supports two approaches to creating ejb jar files. The first approach assumes a particular + naming convention for deployment descriptor files. For an Account bean, for example, the deployment + descriptor would be named Account-ejb-jar.xml. This naming convention allows the task to + distinguish deployment descriptors without relying on their positioning within a source tree. It is + also used to derive the name of the .jar file which is generated. For the example this would be + Account.jar. Vendor specific files are assumed to be named in a similar fashion. The + deployment descriptor file which defines additional weblogic specific information for the above bean + would be Account-weblogic-ejb-jar.xml. + The second approach does not require a naming convention. This approach uses a specified a jar name + for the resultant ejb jar. If the jar name is present, then no naming convention is required. If the + jar name is not specified, then the default naming convention is expected for the deployment descriptor + files.

The task works as a directory scanning task, and performs an action for each deployment descriptor found. As such the includes and excludes should be set to ensure that all desired EJB1.1 @@ -205,13 +210,15 @@ or are out of date, the ejbc tool is run to generate new versions. descriptordir - The base directory under which to scan for EJB deployment descriptors. - Yes + The base directory under which to scan for EJB deployment descriptors. If this + attribute is not specified, then the deployment descriptors must be located in + the directory specified by the 'srcdir' attribute. + No srcdir - The base directory containg the .class files that make up the bean. - Note that this can be the same as the descrptordir if all files are + The base directory containing the .class files that make up the bean. + Note that this can be the same as the descriptordir if all files are in the same directory tree. Yes @@ -223,6 +230,14 @@ or are out of date, the ejbc tool is run to generate new versions. deployment elements have been specified). Yes + + basejarname + The base name that is used for the generated jar files. If this attribute is specified, the + generic jar file name will use this value as the prefix (followed by the value specified in + the 'genericjarsuffix' attibute) and the resultant ejb jar file (followed by any suffix specified + in the nested element). + No + basenameterminator String value used to substring out a string from the name of each deployment descriptor found, @@ -230,7 +245,8 @@ or are out of date, the ejbc tool is run to generate new versions. For example, a basename of '.' and a deployment descriptor called 'FooBean.ejb-jar.xml' would result in a basename of 'FooBean' which would then be used to find FooBean.weblogic-ejb-jar.xml and FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create the filenames of the jar files as - FooBean-generic.jar and FooBean-wl.jar. + FooBean-generic.jar and FooBean-wl.jar. This attribute is not used if the 'basejarname' attribute + is specified. No, defaults to '-'. @@ -255,8 +271,9 @@ EJB container. The parameters for each supported deployment element are detailed destdir - The base directory into which the generated weblogic ready jar files are deposited. Jar files are deposited in - directories correpsonding to their location within the descriptordir namespace. + The base directory into which the generated weblogic ready jar files are deposited. + Jar files are deposited in directories correpsonding to their location within the + descriptordir namespace. Yes @@ -287,9 +304,65 @@ EJB container. The parameters for each supported deployment element are detailed +

TOPLink for Weblogic element

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated weblogic ready jar files are deposited. + Jar files are deposited in directories correpsonding to their location within the + descriptordir namespace. Yes
genericjarsuffixA generic jar is generated as an intermeditate step in build the weblogic deployment + jar. The suffix used to generate the generic jar file is not particularly important + unless it is desired to keep the generic jar file. It should not, however, be the same + as the suffix setting.No, defaults to '-generic.jar'.
suffixString value appended to the basename of the deployment descriptor to create the filename of the + WebLogic EJB jar file.No, defaults to '.jar'.
classpathThe classpath to be used when running the weblogic ejbc tool. Note that this tool + typically requires the classes that make up the bean to be available on the classpath. + Currently, however, this will cause the ejbc tool to be run in a separate VMNo
keepgenericThis controls whether the generic file used as input to ejbc is retained.No, defaults to false
toplinkdescriptorThis specifes the name of the TOPLink deployment descriptor file contained in the + 'descriptordir' directory.Yes
toplinkdtdThis specifies the location of the TOPLink DTD file. This can be a file path or + a file URL. This attribute is not required, but using a local DTD is recommended.No, defaults to dtd file at www.objectpeople.com.
+

Examples

-This example shows ejbjar being used to generate deployment jars for a Weblogic EJB container. +This example shows ejbjar being used to generate deployment jars using a Weblogic EJB container. This example +requires the naming standard to be used for the deployment descriptors. Using this format will create a ejb +jar file for each variation of '*-ejb-jar.xml' that is found in the deployment descriptor directory. 
     <ejbjar srcdir="${build.classes}"
             descriptordir="${descriptor.dir}">
@@ -299,6 +372,40 @@ This example shows ejbjar being used to generate deployment jars for a Weblogic
       <exclude name="**/*weblogic*.xml"/>
     </ejbjar>
+ +This example shows ejbjar being used to generate a single deployment jar using a Weblogic EJB container. This example +does not require the deployment descriptors to use the naming standard. This will create only one ejb jar file - +'TheEJBJar.jar'. +
+    <ejbjar srcdir="${build.classes}"
+            descriptordir="${descriptor.dir}"
+            basejarname="TheEJBJar">
+      <weblogic destdir="${deploymentjars.dir}"
+                classpath="${descriptorbuild.classpath}"/>
+      <include name="**/ejb-jar.xml"/>
+      <exclude name="**/weblogic*.xml"/>
+    </ejbjar>
+
+ +This example shows ejbjar being used to generate deployment jars for a TOPLink-enabled entity bean using a +Weblogic EJB container. This example does not require the deployment descriptors to use the naming standard. +This will create only one TOPLink-enabled ejb jar file - 'Address.jar'. +
+    <ejbjar srcdir="${build.dir}"
+            destdir="${solant.ejb.dir}"
+            descriptordir="${descriptor.dir}"
+            basejarname="Address">
+            <weblogictoplink destdir="${solant.ejb.dir}"
+                    classpath="${java.class.path}"
+                    keepgeneric="false"
+                    toplinkdescriptor="Address.xml"
+                    toplinkdtd="file:///dtdfiles/toplink-cmp_2_5_1.dtd"
+                    suffix=".jar"/>
+            <include name="**/ejb-jar.xml"/>
+            <exclude name="**/weblogic-ejb-jar.xml"/>
+    </ejbjar>
+
+