Creates JRun-specific deployment descriptor (jrun-ejb-jar.xml) for EJB beans.
Only JRun 4.0 is supported.
Most comments have been copied from the JRun DTD:
http://jrun.macromedia.com/dtd/jrun-ejb-jar.dtd
Dan Schaffer (dschaffer@macromedia.com)
| Attribute | Description | Required |
| xmlencoding | The encoding of the jrun-ejb-jar.xml file. | No, default is "UTF-8" |
| destdir | Destination directory for output JRun-specific deployment descriptor files. | No, default is destdir parameter of ejbdoclet task |
| source | Overrides the values of @jrun:jdbc-mapping source for Entity Beans. | No. Only if at least one of the Entity Beans have not specified the @jrun:jdbc-mapping source. |
| validateXml | Validates the generated xml file according to the DTD file contained inside xdoclet.jar. | No, default is false |
The always-dirty element can be used to force synchronization with the data source at the ends of transactions even when there has been no change to the entity bean's fields. Valid values: true|false Used in: entity
The cluster-home element denotes whether the EJBHome should be clustered for this bean. If clustering is enabled in jrun.xml, this value is true by default. You can use this element to override this behavior on a bean-by-bean basis. Valid values: true | false Used in: session, entity
The cluster-object element denotes whether the EJBObject should be clustered for this bean. If clustering is enabled in jrun.xml, this value is true by default. You can use this element to override this behavior on a bean-by-bean basis. Valid values: true | false Used in: session, entity
The commit-option element specifies the the commit option from Section 10.5.9 and 12.1.9 of the EJB 2.0 specification. Valid values: A | B | C Used in: entity
The ejb-local-ref element describes a mapping between the ejb-ref-name that the bean developer provides and its JNDI name. The deployer provides the actual JNDI name. Used in: entity, message-driven, session
| Parameter | Usage | Applies to | Mandatory |
| [ejb-ref-name]: String | The ejb-ref-name element gives the name of an EJB from the ejb-jar.xml file. The bean developer this information. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [jndi-name]: String | The jndi-name element gives the JNDI name where the bean or resource will be bound. | Entity Beans, Session Beans, Message Driven Beans | Yes |
The ejb-ref element describes a mapping between the ejb-ref-name that the bean developer provides and its JNDI name. The deployer provides the actual JNDI name. Used in: entity, message-driven, session
| Parameter | Usage | Applies to | Mandatory |
| [ejb-ref-name]: String | The ejb-ref-name element gives the name of an EJB from the ejb-jar.xml file. The bean developer this information. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [jndi-name]: String | The jndi-name element gives the JNDI name where the bean or resource will be bound. | Entity Beans, Session Beans, Message Driven Beans | Yes |
The instance-pool element contains the maximum and minimum size parameters for StatelessSessionBean instance pools.
| Parameter | Usage | Applies to | Mandatory |
| [maximum-size]: int | The maximum-size element specifies the maximum size for StatelessSessionBean instance pools. | Stateless Session Beans | Yes |
| [minimum-size]: int | The minimum-size element specifies the minimum size for StatelessSessionBean instance pools. | Stateless Session Beans | Yes |
The jdbc-mappings element holds information specific to JRun and not declared in the ejb-jar.xml file about the CMP mappings for an entity bean. jdbc-mappings are used to specify the SQL used to create, load, store, find and remove entity beans.
| Parameter | Usage | Applies to | Mandatory |
| [create-table]: Boolean | Whether JRun will attempt to create database tables. | Entity Beans | No |
| [delete-table]: Boolean | Whether JRun will attempt to delete database tables. | Entity Beans | No |
The jndi-name element gives the JNDI name where the bean or resource will be bound. Used in: entity, message-driven, resource-ref, resource-env-ref, session
The message-driven-destination element provides the destination that the Message driven container uses.
| Parameter | Usage | Applies to | Mandatory |
| [name]: String | The name element defines the parameter name. | Message Driven Beans | Yes |
The message-driven-subscription element provides the user ID that the message-driven container uses for durable subscription handling
| Parameter | Usage | Applies to | Mandatory |
| [client-id]: int | The client-id element provides client id for DurableSubscription setup and sign on. | Message Driven Beans | Yes |
The resource-env-ref element describes a mapping between the resource-env-name that the bean developer provides and its JNDI name. The deployer provides the actual JNDI name. Used in: session, entity, message-driven
| Parameter | Usage | Applies to | Mandatory |
| [resource-env-ref-name]: String | The resource-env-ref-name element gives the name of a resource env from EJB view. The bean developer provides this information. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [jndi-name]: String | The jndi-name element gives the JNDI name where the bean or resource will be bound. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [mdb-destination]: String | The mdb-destination element specifies a message-driven bean destination. | Message Driven Beans | No |
The resource-ref element describes a mapping between the resource name that the bean developer provides and its JNDI name. The deployer provides the actual JNDI name. Used in: session, entity, message-driven
| Parameter | Usage | Applies to | Mandatory |
| [resource-ref-name]: String | The res-ref-name element gives the name of a resource from EJB view. The bean developer provides this information. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [jndi-name]: String | The jndi-name element gives the JNDI name where the bean or resource will be bound. | Entity Beans, Session Beans, Message Driven Beans | Yes |
| [user]: String | The user element assigns a user identity to be used with a specified resource. | Entity Beans, Session Beans, Message Driven Beans | No |
| [password]: String | The password element provides user credentials to be used with user element to identify and authenticate a specified resource. | Entity Beans, Session Beans, Message Driven Beans | No |
The timeout element specifies the timeout value, in seconds, of a stateful session bean. The bean will be passivated if left idle for this duration. Used in: session
The tx-domain-name element gives the transaction domain name in which the bean's transactions will take place. Used in: entity, message-driven, session
The jdbc-mapping element holds information specific to CMP operation, such as create, load, etc.
| Parameter | Usage | Applies to | Mandatory |
| [name]: String | the name of the jdbc-mapping e.g. create,load,store,remove,find | Entity beans | Yes |
| [action]: String | the sql statements to perform the operation e.g. select id from table where id=? | Entity beans | Yes |
| [source]: String | the name of the jdbc datasource to perform the statement | Entity beans | No |
A field corresponding to a column returned by a SELECT statement
The parameter name and type corresponding to a ? in the prepared statement.
| Parameter | Usage | Applies to | Mandatory |
| [name]: String | the name sql column | Entity beans | Yes |
| [type]: String | the sql datatype e.g. VARCHAR | Entity beans | Yes |