User: stevensa
Date: 02/03/03 16:59:54
Modified: core/docs ejbdoclet.html ejbdoclet_toc.html
Added: core/docs bluestone.html
Log:
Added DAO and Bluestone subtasks
Revision Changes Path
1.36 +172 -5 xdoclet/core/docs/ejbdoclet.html
Index: ejbdoclet.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/ejbdoclet.html,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -w -r1.35 -r1.36
--- ejbdoclet.html 23 Feb 2002 11:55:54 -0000 1.35
+++ ejbdoclet.html 4 Mar 2002 00:59:54 -0000 1.36
@@ -2,13 +2,12 @@
<HEAD>
<TITLE>XDoclet - EJB</TITLE>
-<META NAME="GENERATOR" CONTENT="Microsoft FrontPage 4.0">
-<META NAME="ProgId" CONTENT="FrontPage.Editor.Document">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2><ejbdoclet/> Task</H2>
+
<P>This task allows you to generate various EJB-related files using nested
subtasks and template files.</P>
<P>You no longer view EJBeans as a bunch of interfaces and deployment descriptor
@@ -78,6 +77,7 @@
<TD ALIGN="center" VALIGN="top">Yes</TD>
</TR>
</TABLE>
+
<H3><A NAME="subtask_dataobject">dataobject</A></H3>
<P>Creates "data objects" for EJB beans.
<H4>Parameters</H4>
@@ -129,6 +129,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_remoteinterface">remoteinterface - localinterface</A></H3>
<P>Creates "remote / local interfaces" for EJB beans.
<H4>Parameters</H4>
@@ -180,6 +181,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_homeinterface">homeinterface - localhomeinterface</A></H3>
<P>Creates "home / local home interfaces" for EJB beans.
<H4>Parameters</H4>
@@ -216,6 +218,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_entitypk">entitypk</A></H3>
<P>Creates "primary key classes" for entity EJB beans.
<H4>Parameters</H4>
@@ -252,6 +255,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_entitybmp">entitybmp</A></H3>
<P>Creates "entity bean classes" for BMP entity EJB beans. The classes
are derived from the abstract entity bean class.</P>
@@ -311,6 +315,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_entitycmp">entitycmp</A></H3>
<P>Creates "entity bean classes" for CMP entity EJB beans. The classes
are derived from the abstract entity bean class.
@@ -368,6 +373,68 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
+<H3><A NAME="subtask_dao">dao</A></H3>
+<P>Creates abstract data access object (DAO) interfaces for EJBs.</P>
+<P>The DAO interfaces will contain any methods flagged as using a DAO call (with
+a <A HREF="#dao-call">@dao:call</A> method-level tag). Currently, only BMP entity
+beans are supported (support for DAOs with the other EJB types is planned e.g. for
+accessing a database directly with JDBC in a session bean). In addition to
+the flagged methods, the DAO will contain methods for use by the ejbLoad,
+ejbStore and ejbRemove methods in the generated BMP class.</P>
+<P>To use the generated DAOs, you must supply your own implementation class
+with the specific JDBC (or other) code. The generated BMP class will contain
+code for obtaining a DAO instance, and calling its methods.</P>
+<H4>Parameters</H4>
+<TABLE BORDER="1" CELLPADDING="7" CELLSPACING="0" WIDTH="100%">
+ <TR VALIGN="top">
+ <TD WIDTH="12%"><B>Attribute</B></TD>
+ <TD WIDTH="78%"><B>Description</B></TD>
+ <TD WIDTH="10%"><B>Required</B></TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD>pattern</TD>
+ <TD>The pattern by which the DAO classes are named. {0}designates
+ the EJB name.</TD>
+ <TD>No, default is "{0}DAO"</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD>destdir</TD>
+ <TD>Destination directory for output DAO class files.</TD>
+ <TD>No, default is destdir parameter of ejbdoclet task</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD>templatefile</TD>
+ <TD>The template file by which the DAO classes are generated.</TD>
+ <TD>No, default is "dao.j" in jar file of ejbdoclet itself</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD>mergedir</TD>
+ <TD>Merge directory where ejbdoclet looks for files to be merged with
+ generated files.</TD>
+ <TD>No, required, if the merge feature used</TD>
+ </TR>
+</TABLE>
+<H4>Merge Points</H4>
+<DIV ALIGN="left">
+ <TABLE BORDER="1" WIDTH="100%" CELLSPACING="0" CELLPADDING="7">
+ <TR VALIGN="top">
+ <TH WIDTH="20%" ALIGN="left"><B>Merge File Name</B></TH>
+ <TH ALIGN="left"><B>Description</B></TH>
+ <TD><B>Required</B></TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD>dao-custom.j</TD>
+ <TD>The file where custom code can be included.</TD>
+ <TD>No</TD>
+ </TR>
+ </TABLE>
+</DIV>
+<H4>Nested Elements</H4>
+<UL>
+ <LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
+</UL>
+
<H3><A NAME="subtask_session">session</A></H3>
<P>Creates "session bean classes" for Session EJB beans. The classes
are derived from the (abstract) session bean class. This has less importance
@@ -421,6 +488,7 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="subtask_deploymentdescriptor">deploymentdescriptor</A></H3>
<P>Creates "EJB standard-compliant deployment descriptors (ejb-jar.xml
file)" for EJB beans.
@@ -498,6 +566,7 @@
<P>Remember you should preserve the package directory structure in mergedir. If
the bean is test.bank.AccountBean then ejb-env-entries-Account.xml should be
located at test/bank directory in mergedir.</P>
+
<H3><A NAME="subtask_utilobject">utilobject</A></H3>
<P>Cretes utility classes for EJBs. Currently utility classes can be used for
convenient home/local home interface lookups. The generated util classes can be
@@ -537,13 +606,16 @@
<UL>
<LI><A NAME="subtask_packageSubstitution"
HREF="#subtask_packageSubstitution">packageSubstitution</A></LI>
</UL>
+
<H3><A NAME="class-level-tags">Class level Tags</A></H3>
+
<P>With only one attribute, you don't have to remember the name of the property,
but because the value can have spaces in it, it makes more sense to use the
"quoted" format.</P>
<P>With multiple attributes, it would be difficult to remember the order in
which you have to put the values, that's why using the "name-value
pairs" format is the unique format.</P>
+
<H4><A NAME="bean">@ejb:bean</A></H4>
<P>The <CODE>ejb:bean</CODE> tag provides information about the EJB. It is the
one compulsory tag for all EJBs, however not all parameters are applicable for
@@ -688,6 +760,7 @@
RemoteException in the throws clause.</TD>
</TR>
</TABLE>
+
<H4><A NAME="home">@ejb:home</A></H4>
<P>The <CODE>@ejb:home</CODE> tag provides information about an Entity or
Session Bean's home interface. It is not applicable for Message-driven beans.
@@ -757,6 +830,7 @@
to configure which package the interface should end up in.</TD>
</TR>
</TABLE>
+
<H4><A NAME="interface">@ejb:interface</A></H4>
<P>The <CODE>@ejb:interface</CODE> tag provides information about an Entity or
Session Bean's component interfaces (remote and/or local). It is not applicable
@@ -826,6 +900,7 @@
to configure which package the interface should end up in.</TD>
</TR>
</TABLE>
+
<H4><A NAME="finder">@ejb:finder</A></H4>
<P>Defines a finder method for the home interface. Applicable only to Entity
beans. An entity bean may have zero or more <CODE>ejb:finder</CODE> tags.</P>
@@ -865,6 +940,7 @@
interfaces, this parameter should not be specified.</TD>
</TR>
</TABLE>
+
<H4><A NAME="select">@ejb:select</A></H4>
<P>Defines a select method for the home interface. An entity bean may have zero
or more <CODE>ejb:select</CODE> tags. Applicable to EJB2.0 CMP only.</P>
@@ -888,6 +964,7 @@
<TD>Result type mapping for the select method.</TD>
</TR>
</TABLE>
+
<H4><A NAME="util">@ejb:util</A></H4>
<P>This tag is optional, and lets you define whether or not a util class should
be generated, and whether to use the logical component name (java:comp/env) or
@@ -907,6 +984,7 @@
Default is logical.</TD>
</TR>
</TABLE>
+
<H4><A NAME="pk">@ejb:pk</A></H4>
<P>Defines the primary key of an entity bean. If the <A
HREF="#subtask_entitypk"><CODE><entitypk/></CODE></A>
subtask is included, then primary key classes will be generated for all entity
@@ -971,6 +1049,7 @@
LocalHome interfaces, this parameter should not be specified.</TD>
</TR>
</TABLE>
+
<H4><A NAME="data-object">@ejb:data-object</A></H4>
<P>Defines configuration attributes used for data object generation. Applicable
only for Entity beans.</P>
@@ -1033,6 +1112,60 @@
super.hashCode().</TD>
</TR>
</TABLE>
+
+<H4><A NAME="dao">@ejb:dao</A></H4>
+<P>Defines the data access object of an entity bean. If the
+<A HREF="#subtask_dao"><CODE><dao/></CODE></A> subtask is included, then
+DAO interfaces will be generated for any entity beans containing this tag,
+unless a generate="false" parameter is present.</P>
+<TABLE BORDER="1" CELLPADDING="7">
+ <TR VALIGN="top">
+ <TD>Parameter</TD>
+ <TD>Usage</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[class]</I>: String</TD>
+ <TD>The fully qualified name of the DAO interface. If absent the interface
+ name will be determined using the <I>pattern</I> and <I>package</I>
+ parameters.</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[pattern]</I>: String</TD>
+ <TD>Define the pattern (using {0} for the EJB name) to be used for
+ constructing the unqualified (package specific) name of the DAO
+ interface.</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[package]</I>: String</TD>
+ <TD>Define the package the DAO interface is in (generated or not). Use
+ <A HREF="#subtask_packageSubstitution"><packageSubstitution/></A>
+ to configure which package the interface should end up in.</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[generate]</I>: boolean</TD>
+ <TD>Indicate if the DAO interface should be generated. Defaults to true.</TD>
+ </TR>
+<!-- <TR VALIGN="top">
+ <TD><I>[extends]</I>: String</TD>
+ <TD>Define which class the generated pk must extend.</TD>
+ </TR> -->
+ <TR VALIGN="top">
+ <TD><I>[impl-class]</I>: String</TD>
+ <TD>The fully qualified name of a class which implements the DAO interface.
+ If present, then generated code for obtaining a DAO will just create a
+ new instance of this class.</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[impl-jndi]</I>: String</TD>
+ <TD>Indicates a JNDI environment reference which will contain a String
+ that is the fully qualified name of a class implementing the DAO
+ interface. If present, then generated code for obtaining a DAO will look
+ up this reference, then create a new instance of the class whose name is
+ found there. This allows the actual implementation class to be determined
+ at runtime.</TD>
+ </TR>
+</TABLE>
+
<H4><A NAME="env-entry">@ejb:env-entry</A></H4>
<P>Defines an environment entry for an EJB. Applicable to all EJB types.</P>
<I>name</I> of java type <I>type</I> that has the<BR>
@@ -1055,6 +1188,7 @@
<TD>The value of the env-entry.</TD>
</TR>
</TABLE>
+
<H4><A NAME="ejb-ref">@ejb:ejb-ref</A></H4>
<P>Defines an EJB-reference. Applicable to all EJB types. <B>Attention</B> You
have to import the referred class (the ejbdoclet one) even your EJB does not
@@ -1082,6 +1216,7 @@
the referenced bean (Customer) prefixed by "ejb/".</TD>
</TR>
</TABLE>
+
<H4><A NAME="ejb-external-ref">@ejb:ejb-external-ref</A></H4>
<P>Defines an EJB-reference to a bean in another application.of type <I>type</I>,
name of reference bean's home interface <I>home</I>, name of<BR>
@@ -1122,6 +1257,7 @@
bean.</TD>
</TR>
</TABLE>
+
<H4><A NAME="resource-ref">@ejb:resource-ref</A></H4>
<P>Defines a resource reference with the name <I>res-name</I> to a resource of
type <I>res-type</I>, and the authentication is done by the one specified in
<I>res-auth</I>.
@@ -1144,6 +1280,7 @@
<TD>The resource authentication type.</TD>
</TR>
</TABLE>
+
<H4><A NAME="resource-env-ref">@ejb:resource-env-ref</A></H4>
<P>Defines a resource environment reference with the name <I>name</I> to a
resource of type <I>type</I>. Applicable to all EJB types.
@@ -1161,6 +1298,7 @@
<TD>The type of the resource.</TD>
</TR>
</TABLE>
+
<H4><A NAME="security-role-ref">@ejb:security-role-ref</A></H4>
<P>Defines a security role reference with the name <I>role-name</I> to a
security role link named <I>role-link</I>. Applicable to Entity and Session
@@ -1179,6 +1317,7 @@
<TD>The name of the role link.</TD>
</TR>
</TABLE>
+
<H4><A NAME="transaction">@ejb:transaction</A></H4>
<P>Defines the transactional behaviour for all methods in remote and home
interfaces of this bean with transaction type of <I>type</I>. Can be overridden
@@ -1195,6 +1334,7 @@
<TD>The transactional type for the bean's methods.</TD>
</TR>
</TABLE>
+
<H4><A NAME="permission">@ejb:permission</A></H4>
<P>Allow the role <I>role-name</I> to call all methods in remote and home
interfaces of this bean. Applicable to Entity and Session beans.</P>
@@ -1213,6 +1353,7 @@
<TD>Declare the methods in the bean as unchecked. EJB2.0 only.</TD>
</TR>
</TABLE>
+
<H4><A NAME="security-identity">@ejb:security-identity</A></H4>
<P>The security-identity element specifies whether the caller’s security
identity is to be used for the execution of the methods of the enterprise bean
@@ -1242,7 +1383,9 @@
description, and the name of a security role.</TD>
</TR>
</TABLE>
+
<H3><A NAME="method-level-tags">Method level Tags</A></H3>
+
<H4><A NAME="relation">@ejb:relation</A></H4>
<P>Define a relationship for an Entity bean. Applicable only to EJB2.0 CMP2.x
beans.</P>
@@ -1290,6 +1433,7 @@
is unidirectional.</TD>
</TR>
</TABLE>
+
<H4><A NAME="interface-method">@ejb:interface-method</A></H4>
<P>Declare in which interface (local/remote) this method must appear. If the
view-type parameter is absent then the method will be added to whatever
@@ -1307,6 +1451,7 @@
beans.</TD>
</TR>
</TABLE>
+
<H4><A NAME="home-method">@ejb:home-method</A></H4>
<P>Define this method as a home method (e.g. its name is "ejbHomefoo",
and the corresponding home method should be defined in the home interface).
@@ -1321,11 +1466,11 @@
<TD>Optionally specify which view-type the method will be exposed in.</TD>
</TR>
</TABLE>
+
<H4><A NAME="create-method">@ejb:create-method</A></H4>
<P>The method is an ejbCreate method and will be included in the home interface.
It is applicable to Session and Entity beans. In Stateless Session beans the
-ejbCreate will be created if it is not in the code.<BR>
-
+ejbCreate will be created if it is not in the code.</P>
<TABLE BORDER="1" CELLPADDING="7">
<TR VALIGN="top">
<TD>Parameter</TD>
@@ -1336,6 +1481,7 @@
<TD>Optionally specify which view-type the method will be exposed in.</TD>
</TR>
</TABLE>
+
<H4><A NAME="persistent-field">@ejb:persistent-field</A></H4>
<P>Use this for methods with the following patterns:</P>
<UL>
@@ -1353,12 +1499,14 @@
1.x). This is useful for cases where for example nothing is set programmatically
but via external sources such as a stored procedure. Applicable for entity
beans.</P>
+
<H4><A NAME="pk-field">@ejb:pk-field</A></H4>
<P>Use this for methods with the following pattern: public abstract Foo getX().
This will denote the persistent field "X" as a primary key field,
which will be included in the generated primary key class. Must be used with the
persistent-field tag. This tag is only valid for EntityBeans. It has no
parameters.</P>
+
<H4><A NAME="aggregate">@ejb:aggregate</A></H4>
<P>Mark a persistent field containing a reference to another entity bean as
being aggregated in this bean. The data object will contain accessor methods for
@@ -1366,6 +1514,7 @@
The aggregated entity will also be removed when this entity is removed. For
example, aggregates are useful for sending graphs of data to the client. This is
only applicable to entity beans and has no parameters.</P>
+
<H4><A NAME="transaction">@ejb:transaction</A></H4>
<P>Defines the transactional behavior for this method. Applicable to methods
with <A HREF="#create-method">@ejb:create-method</A> and <A
HREF="#interface-method">@ejb:interface-method</A>
@@ -1382,6 +1531,7 @@
<TD>Define the type of transactional behaviour.</TD>
</TR>
</TABLE>
+
<H4><A NAME="permission">@ejb:permission</A></H4>
<P>Define a method's premission. Used with a method with an <A
HREF="#interface-method">@ejb:interface-method</A>
or <A HREF="#create-method">@ejb:create-method</A> tag.</P>
@@ -1396,6 +1546,23 @@
</TR>
</TABLE>
-</BODY>
+<H4><A NAME="dao-call">@dao:call</A></H4>
+<P>The method is a call to a data access object; the method will be included
+in the DAO interface, and the EJB's generated subclass will contain a call to
+the DAO's method.</P>
+<TABLE BORDER="1" CELLPADDING="7">
+ <TR VALIGN="top">
+ <TD>Parameter</TD>
+ <TD>Usage</TD>
+ </TR>
+ <TR VALIGN="top">
+ <TD><I>[name]</I>: String</TD>
+ <TD>Optionally specify the method's name in the DAO (it need not be the
+ same as the calling method in the EJB). If not specified, the default is
+ the usual interface equivalent of the method's name (i.e. generally the
+ same, but ejbFindByX becomes findByX etc.)</TD>
+ </TR>
+</TABLE>
+</BODY>
</HTML>
1.19 +11 -3 xdoclet/core/docs/ejbdoclet_toc.html
Index: ejbdoclet_toc.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/ejbdoclet_toc.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -w -r1.18 -r1.19
--- ejbdoclet_toc.html 23 Feb 2002 11:55:54 -0000 1.18
+++ ejbdoclet_toc.html 4 Mar 2002 00:59:54 -0000 1.19
@@ -12,6 +12,7 @@
<A TARGET="_self" HREF="toc.html">Up</A><BR>
<H3>Standard Subtasks</H3>
<UL>
+ <LI><A HREF="ejbdoclet.html#subtask_dao">dao</A>
<LI><A HREF="ejbdoclet.html#subtask_dataobject">dataobject</A>
<LI><A HREF="ejbdoclet.html#subtask_deploymentdescriptor">deploymentdescriptor</A>
<LI><A HREF="ejbdoclet.html#subtask_entitybmp">entitybmp</A>
@@ -28,6 +29,7 @@
<H3>Vendor Subtasks</H3>
<UL>
<LI><A HREF="apachesoap.html">apachesoap</A>
+ <LI><A HREF="bluestone.html">bluestone</A>
<LI><A HREF="castor.html">castormapping</A>
<LI><A HREF="jboss.html">jboss</A>
<LI><A HREF="mvcsoft.html">mvcsoft</A>
@@ -63,6 +65,7 @@
<LI><A HREF="ejbdoclet.html#select">@ejb:select</A>
<LI><A HREF="ejbdoclet.html#transaction">@ejb:transaction</A>
<LI><A HREF="ejbdoclet.html#util">@ejb:util</A>
+ <LI><A HREF="ejbdoclet.html#dao-call">@dao:call</A>
</UL>
<H3>Vendor tags</H3>
<H4>Apache SOAP</H4>
@@ -70,6 +73,12 @@
<LI><A HREF="apachesoap.html#method">@soap:method</A>
<LI><A HREF="apachesoap.html#service">@soap:service</A>
</UL>
+<H4>Bluestone</H4>
+<UL>
+ <LI><A HREF="bluestone.html#bean">@bluestone:bean</A>
+ <LI><A HREF="bluestone.html#pool">@bluestone:pool</A>
+ <LI><A HREF="bluestone.html#ejb-ref">@bluestone:ejb-ref</A>
+</UL>
<H4>Castor</H4>
<UL>
<LI><A HREF="castor.html#class">@castor:class</A>
@@ -81,7 +90,7 @@
<UL>
<LI><A HREF="jboss.html#cmp-field">@jboss:cmp-field</A>
<LI><A HREF="jboss.html#column-name">@jboss:column-name</A>
- <LI><A
HREF="jboss.html#container-configuration">@jboss:container-configuration</A>
+ <LI><A
HREF="jboss.html#container-configuration">@jboos:container-configuration</A>
<LI><A HREF="jboss.html#create-table">@jboss:create-table</A>
<LI><A HREF="jboss.html#destination-jndi-name">@jboss:destination-jndi-name</A>
<LI><A HREF="jboss.html#ejb-ref-jndi">@jboss:ejb-ref-jndi</A>
@@ -183,5 +192,4 @@
</UL>
</BODY>
-
</HTML>
1.1 xdoclet/core/docs/bluestone.html
Index: bluestone.html
===================================================================
<html>
<head>
<title>XDoclet - Bluestone</title>
</head>
<body>
<h2><bluestone/> subtask</h2>
<h3><a name="bluestone">Bluestone</a></h3>
<p>Creates HPAS-specific deployment descriptors (hp-ejb-jar.xml)
for EJB beans.</p>
<h4>Parameters</h4>
<table border="1" cellpadding="2" cellspacing="0" width="100%">
<tr>
<td width="12%" valign="top"><b>Attribute</b></td>
<td width="78%" valign="top"><b>Description</b></td>
<td width="10%" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">xmlencoding</td>
<td valign="top">The encoding of the hp-ejb-jar.xml file.</td>
<td align="center" valign="top">No, default is "UTF-8"</td>
</tr>
<tr>
<td valign="top">destdir</td>
<td valign="top">Destination directory for output Bluestone-specific
deployment descriptor files.</td>
<td align="center" valign="top">No, default is destdir parameter of
ejbdoclet task</td>
</tr>
<tr>
<td valign="top">mergedir</td>
<td valign="top">Merge directory where ejbdoclet looks for files to be
merged with generated files.</td>
<td align="center" valign="top">No, required, if the merge feature used</td>
</tr>
<tr>
<td valign="top">validateXml</td>
<td valign="top">Validates the generated xml file according to the DTD file
contained inside xdoclet.jar.</td>
<td align="center" valign="top">No, default is false</td>
</tr>
<tr>
<td valign="top">sfsbPassivationRoot</td>
<td valign="top">This attribute is the path to a local directory indicating
where the container should passivate Stateful Session Bean instances.</td>
<td align="center" valign="top">No, only if @bluestone:bean passivation="true"
used on a stateful session bean. Default is ""</td>
</tr>
<tr>
<td valign="top">persistenceProduct</td>
<td valign="top">Only applies when using CMP. This attribute specifies the
name of a third party persistence manager product.</td>
<td align="center" valign="top">No, default is "VXML"</td>
</tr>
<tr>
<td valign="top">persistenceVersion</td>
<td valign="top">Only applies when using CMP. This attribute specifies the
version of the third party product.</td>
<td align="center" valign="top">No, default is ""</td>
</tr>
<tr>
<td valign="top">persistenceClass</td>
<td valign="top">Only applies when using CMP. This attribute specifies the
class that implements the persistence manager interface.</td>
<td align="center" valign="top">No, default is
com.hp.mwlabs.j2ee.containers.ejb.persistence.vxml.CMPPersistenceManager</td>
</tr>
<tr>
<td valign="top">persistenceSuffix</td>
<td valign="top">Only applies when using CMP. This attribute specifies a
suffix to be appended to the abstract bean class name to obtain the generated
bean class name.</td>
<td align="center" valign="top">No, default is ""</td>
</tr>
</table>
<h4>Merge Points</h4>
<div align="left">
<table border="1" width="100%" cellspacing="0" cellpadding="2">
<tr>
<td width="20%" align="left"><b>Merge File Name</b></td>
<td align="left"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td colspan=3>None at present (TODO).</td>
</tr>
</table>
</div>
<h3><a name="class-level-tags">Class level Tags</a></h3>
<h4><a name="bean">@bluestone:bean</a></h4>
<p>Most of the class-level Bluestone options are specified in parameters of this
tag.</p>
<table border="1" cellpadding="7">
<tr valign="top">
<td>Parameter</td>
<td>Usage</td>
</tr>
<tr>
<td><i>[read-only]</i>: Boolean</td>
<td>Optional. Specifies whether the bean is marked as read only.
Applicable only to entity beans.</td>
</tr>
<tr>
<td><i>[passivation]</i>: Boolean</td>
<td>Determines whether the container can manage the passivation behaviour
of beans; indicates whether passivation is enabled for the bean.
Applicable to stateful session beans and entity beans. For stateful
session beans, if this parameter is used then the passivate-threshold
parameter must also be present.</td>
</tr>
<tr>
<td><i>[passivate-threshold]</i>: Integer</td>
<td>Specifies the number of beans for a deployed EJB above which the container
will attempt to passivate instances. Applicable to stateful session beans
only, when the passivation parameter has been used.</td>
</tr>
<tr>
<td><i>[session-timeout]</i>: duration</td>
<td>Indicates the timeout for the session.</td>
</tr>
<tr>
<td><i>[concurrent-message-processing]</i>: Boolean</td>
<td>Specifies whether concurrent message processing is enabled. Applicable
to message driven beans only.</td>
</tr>
<tr>
<td><i>[max-messages]</i>: Integer</td>
<td>Specifies the maximum number of messages assigned to a single session.
This value is passed to the JMS server. Applicable to message driven
beans only.</td>
</tr>
<tr>
<td><i>[max-message-threads]</i>: Integer</td>
<td>Specifies the maximum number of separate server sessions (threads) that
will be created to handle messages. Applicable to message driven
beans only.</td>
</tr>
<tr>
<td><i>[message-thread-timeout]</i>: duration</td>
<td>Specifies the amount of time after which an idle server session will be
available to be removed from the pool. Applicable to message driven
beans only.</td>
</tr>
<tr>
<td><i>[connection-retry]</i>: Boolean</td>
<td>Specifies whether an exception listener is registered for the connection.
If no exception listener is established, there will be no connection
failover. Applicable to message driven beans only.</td>
</tr>
<tr>
<td><i>[jndi-factory]</i>: String</td>
<td>Specifies the lookup string used to obtain the factory that will be
used to create the connection used by the MDB. Applicable to message
driven beans.</td>
</tr>
<tr>
<td><i>[jndi-destination]</i>: String</td>
<td>Specifies the lookup string for the destination topic or queue for
which the bean is registered as a listener. Applicable to message driven
beans.</td>
</tr>
</table>
<h4><a name="pool">@bluestone:pool</a></h4>
<p>Contains the information required to setup an object pool.</p>
<table border="1" cellpadding="7">
<tr valign="top">
<td>Parameter</td>
<td>Usage</td>
</tr>
<tr>
<td><i>initial-size</i>: Integer</td>
<td>Specifies the initial size of the pool.</td>
</tr>
<tr>
<td><i>cache-limit</i>: Integer or "unlimited"</td>
<td>Specifies the maximum size of the pool. When the cache-limit is reached,
pooled entries that are returned to the pool will be discarded; if the
cache-limit is reached, new objects may still be created.</td>
</tr>
<tr>
<td><i>idle-timeout</i>: duration</td>
<td>Specifies the idle timeout for the pool.</td>
</tr>
<td><i>use-reaper</i>: Boolean</td>
<td>Specifies whether the pool should enforce the cache-limit. The reaper
can be disabled to optimize pool performance.</td>
</tr>
<tr>
<td><i>reap-asynch</i>: Boolean</td>
<td>Specifies whether pool reaping should occur asynchronously with respect
to inserting or removing objects from the pool. Setting this to true makes
pool accesses faster but consumes more system resources.</td>
</tr>
</table>
<h4><a name="ejb-ref">@bluestone:ejb-ref</a></h4>
<p>A mapping of EJB references to deployed beans.</p>
<p>NB This is likely to be refactored in the future, to use extra parameters
on the @ejb:ejb-ref and @ejb:ejb-external-ref tags instead of the
@bluestone:ejb-ref tag.</p>
<table border="1" cellpadding="7">
<tr valign="top">
<td>Parameter</td>
<td>Usage</td>
</tr>
<tr>
<td><i>type</i>: "co-located" or "distributed"</td>
<td>Use "co-located" for references to EJBs in the same application, and
"distributed" for references to EJBs in other applications.</td>
</tr>
<tr>
<td><i>ref-name</i>: String</td>
<td>Specifies the mapping into the ejb-ref entry in the standard deployment
descriptor.</td>
</tr>
<tr>
<td><i>jndi-name</i>: String</td>
<td>Specifies the actual name under which the bean is registered in the
name service.</td>
</tr>
<tr>
<td><i>[application]</i>: String</td>
<td>Specifies the name of the application in which the EJB component is
deployed. Only applies when type="distributed".</td>
</tr>
<tr>
<td><i>[host]</i>: String</td>
<td>Specifies the host name for the name server. Only applies when
type="distributed".</td>
</tr>
<tr>
<td><i>[port]</i>: String</td>
<td>Specifies the port number for the name server. Only applies when
type="distributed".</td>
</tr>
</table>
<h3><a name="method-level-tags">Method level Tags</a></h3>
None at present.
</body>
</html>
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
