conor 00/10/16 05:43:16
Modified: docs ejb.html
Log:
Add documentation for wlrun and wlstop tasks
Revision Changes Path
1.6 +233 -132 jakarta-ant/docs/ejb.html
Index: ejb.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/ejb.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ejb.html 2000/09/13 06:29:23 1.5
+++ ejb.html 2000/10/16 12:43:16 1.6
@@ -36,10 +36,10 @@
<h2><a name="ejbtasks">EJB Tasks</a></h2>
<table border="1" cellpadding="5">
<tr><td>Task</td><td>Application Servers</td></tr>
- <tr><td><a href="#ddcreator">ddcreator</a></td><td>Weblogic 4.5</td></tr>
- <tr><td><a href="#ejbc">ejbc</a></td><td>Weblogic 4.5</td></tr>
- <tr><td><a href="#wlrun">wlrun</a></td><td>Weblogic 4.5</td></tr>
- <tr><td><a href="#wlstop">wlstop</a></td><td>Weblogic 4.5</td></tr>
+ <tr><td><a href="#ddcreator">ddcreator</a></td><td>Weblogic 4.5.1</td></tr>
+ <tr><td><a href="#ejbc">ejbc</a></td><td>Weblogic 4.5.1</td></tr>
+ <tr><td><a href="#wlrun">wlrun</a></td><td>Weblogic 4.5.1 and 5.1</td></tr>
+ <tr><td><a href="#wlstop">wlstop</a></td><td>Weblogic 4.5.1 and
5.1</td></tr>
<tr><td><a href="#ejbjar">ejbjar</a></td><td>Weblogic 5.1</td></tr>
</table>
@@ -151,35 +151,136 @@
<hr>
<h2><a name="wlrun">wlrun</a></h2>
<h3><b>Description:</b></h3>
-<p>This is an experimental task and is not currently documented.
+<p>The <code>wlrun</code> task is used to start a weblogic server. The task
runs
+a weblogic instance in a separate Java Virtual Machine. A number of
parameters
+are used to control the operation of the weblogic instance. Note that the
task,
+and hence ant, will not complete until the weblogic instance is stopped.
+<h3>Parameters:</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">home</td>
+ <td valign="top">The location of the weblogic home that is to be used.
This is the location
+ where weblogic is installed.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">classpath</td>
+ <td valign="top">The classpath to be used with the Java Virtual Machine
that runs the Weblogic
+ Server. This is typically set to the Weblogic boot
classpath.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">wlclasspath</td>
+ <td valign="top">The weblogic classpath used by the Weblogic Server.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">properties</td>
+ <td valign="top">The name of the server's properties file within the
weblogic home directory
+ used to control the weblogic instance.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">name</td>
+ <td valign="top">The name of the weblogic server within the weblogic
home which is to be run.
+ This defaults to "myserver"</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">policy</td>
+ <td valign="top">The name of the security policy file within the
weblogic home directory that
+ is to be used. If not specified, the default policy
file <code>weblogic.policy</code>
+ is used.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">jvmargs</td>
+ <td valign="top">Additional argument string passed to the Java Virtual
Machine used to run the
+ Weblogic instance.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">args</td>
+ <td valign="top">Additional argument string passed to the Weblogic
instance.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+</table>
+
+
<hr>
<h2><a name="wlstop">wlstop</a></h2>
<h3><b>Description:</b></h3>
-<p>This is an experimental task and is not currently documented.
+<p>The <code>wlstop</code> task is used to stop a weblogic instance which is
currently running.
+To shut down an instance you must supply both a username and a password.
These will be stored
+in the clear in the build script used to stop the instance. For security
reasons, this task is
+therefore only appropriate in a development environment.
+
+<h3>Parameters:</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">classpath</td>
+ <td valign="top">The classpath to be used with the Java Virtual Machine
that runs the Weblogic
+ Shutdown comment.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">user</td>
+ <td valign="top">The username of the account which will be used to
shutdown the server</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">password</td>
+ <td valign="top">The password for the account specified in the user
parameter.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">url</td>
+ <td valign="top">The URL which describes the port to which the server is
listening for T3 connections.
+ For example, t3://localhost:7001</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">delay</td>
+ <td valign="top">The delay in seconds after which the server will stop.
This defaults to an
+ immediate shutdown.</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+</table>
+
<hr>
<h2><a name="ejbjar">ejbjar</a></h2>
<h3><b>Description:</b></h3>
<p>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
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.</p>
-
-<p>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 <code>Account-ejb-jar.xml</code>. 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
- <code>Account.jar</code>. 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 <code>Account-weblogic-ejb-jar.xml</code>.
- 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.
+ 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.</p>
+
+<p>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 <code>Account-ejb-jar.xml</code>. 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
+ <code>Account.jar</code>. 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 <code>Account-weblogic-ejb-jar.xml</code>.
+ 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.
<p>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
@@ -210,15 +311,15 @@
</tr>
<tr>
<td valign="top">descriptordir</td>
- <td valign="top">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.</td>
- <td valign="top" align="center">No</td>
+ <td valign="top">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.</td>
+ <td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">srcdir</td>
- <td valign="top">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
+ <td valign="top">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.</td>
<td valign="top" align="center">Yes</td>
</tr>
@@ -230,23 +331,23 @@
deployment elements have been specified).</td>
<td valign="top" align="center">Yes</td>
</tr>
+ <tr>
+ <td valign="top">basejarname</td>
+ <td valign="top">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).</td>
+ <td valign="top" align="center">No</td>
+ </tr>
<tr>
- <td valign="top">basejarname</td>
- <td valign="top">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).</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
<td valign="top">basenameterminator</td>
<td valign="top">String value used to substring out a string from the
name of each deployment descriptor found,
which is then used to locate related deployment
descriptors (e.g. the WebLogic descriptors).
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. This attribute
is not used if the 'basejarname' attribute
- is specified.</td>
+ FooBean-generic.jar and FooBean-wl.jar. This attribute
is not used if the 'basejarname' attribute
+ is specified.</td>
<td valign="top" align="center">No, defaults to '-'.</td>
</tr>
<tr>
@@ -271,9 +372,9 @@
</tr>
<tr>
<td valign="top">destdir</td>
- <td valign="top">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. </td>
+ <td valign="top">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. </td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
@@ -304,65 +405,65 @@
</tr>
</table>
-<h3>TOPLink for Weblogic element</h3>
-<table border="1" cellpadding="2" cellspacing="0">
- <tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
- </tr>
- <tr>
- <td valign="top">destdir</td>
- <td valign="top">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. </td>
- <td valign="top" align="center">Yes</td>
- </tr>
- <tr>
- <td valign="top">genericjarsuffix</td>
- <td valign="top">A 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.</td>
- <td valign="top" align="center">No, defaults to '-generic.jar'.</td>
- </tr>
- <tr>
- <td valign="top">suffix</td>
- <td valign="top">String value appended to the basename of the deployment
descriptor to create the filename of the
- WebLogic EJB jar file.</td>
- <td valign="top" align="center">No, defaults to '.jar'.</td>
- </tr>
- <tr>
- <td valign="top">classpath</td>
- <td valign="top">The 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 VM</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">keepgeneric</td>
- <td valign="top">This controls whether the generic file used as input to
ejbc is retained.</td>
- <td valign="top" align="center">No, defaults to false</td>
- </tr>
- <tr>
- <td valign="top">toplinkdescriptor</td>
- <td valign="top">This specifes the name of the TOPLink deployment
descriptor file contained in the
- 'descriptordir' directory.</td>
- <td valign="top" align="center">Yes</td>
- </tr>
- <tr>
- <td valign="top">toplinkdtd</td>
- <td valign="top">This 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.</td>
- <td valign="top" align="center">No, defaults to dtd file at
www.objectpeople.com.</td>
- </tr>
-</table>
-
+<h3>TOPLink for Weblogic element</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+ <tr>
+ <td valign="top"><b>Attribute</b></td>
+ <td valign="top"><b>Description</b></td>
+ <td align="center" valign="top"><b>Required</b></td>
+ </tr>
+ <tr>
+ <td valign="top">destdir</td>
+ <td valign="top">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. </td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">genericjarsuffix</td>
+ <td valign="top">A 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.</td>
+ <td valign="top" align="center">No, defaults to '-generic.jar'.</td>
+ </tr>
+ <tr>
+ <td valign="top">suffix</td>
+ <td valign="top">String value appended to the basename of the deployment
descriptor to create the filename of the
+ WebLogic EJB jar file.</td>
+ <td valign="top" align="center">No, defaults to '.jar'.</td>
+ </tr>
+ <tr>
+ <td valign="top">classpath</td>
+ <td valign="top">The 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 VM</td>
+ <td valign="top" align="center">No</td>
+ </tr>
+ <tr>
+ <td valign="top">keepgeneric</td>
+ <td valign="top">This controls whether the generic file used as input to
ejbc is retained.</td>
+ <td valign="top" align="center">No, defaults to false</td>
+ </tr>
+ <tr>
+ <td valign="top">toplinkdescriptor</td>
+ <td valign="top">This specifes the name of the TOPLink deployment
descriptor file contained in the
+ 'descriptordir' directory.</td>
+ <td valign="top" align="center">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">toplinkdtd</td>
+ <td valign="top">This 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.</td>
+ <td valign="top" align="center">No, defaults to dtd file at
www.objectpeople.com.</td>
+ </tr>
+</table>
+
<h3>Examples</h3>
-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.
+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.
<pre>
<ejbjar srcdir="${build.classes}"
descriptordir="${descriptor.dir}">
@@ -371,41 +472,41 @@
<include name="**/*-ejb-jar.xml"/>
<exclude name="**/*weblogic*.xml"/>
</ejbjar>
+</pre>
+
+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'.
+<pre>
+ <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>
</pre>
-
-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'.
-<pre>
- <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>
-</pre>
-
-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'.
-<pre>
- <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>
-</pre>
-
+
+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'.
+<pre>
+ <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>
+</pre>
+
</body>
</html>
