40.3. Xdoclet tags

40.3.1. Field-Level Tags

40.3.1.1. jonas.bean

The jonas.bean element declares the JOnAS-specific information for an enterprise bean.

ParameterTypeApplicabilityDescriptionMandatory
ejb-nametext The enterprise bean's name specified in the standard EJB deployment descriptor.true
jndi-nametext The JNDI name of the enterprise bean's home. Concerns only the Entity and Session beans. Mandatory if version < 2.5, but optional for Session beans for 2.5 onwards.false
cleanuptext Determines the jonas-specific behavior for table management at deploy time.false
lock-policytext Determine the jonas-specific lock policy for database access.false
automatic-pk-field-nametext The jdbc column name for automatic primary key; auto-generated.false
inactivity-timeouttext Optional inactivity-timeout value (integer value)false
prefetchtext Optional prefetch (boolean value)false

40.3.1.2. jonas.resource

The jonas.resource element declares the JOnAS-specific information for an external resource referenced by a bean.

ParameterTypeApplicabilityDescriptionMandatory
res-ref-nametext The name of the resource reference specified in the standard EJB deployment descriptor.true
jndi-nametext The JNDI name of the resource.true

40.3.1.3. jonas.resource-env

The jonas.resource-env element declares the JOnAS-specific information for an external resource environment referenced by a bean.

ParameterTypeApplicabilityDescriptionMandatory
resource-env-ref-nametext The name of the resource environment reference specified in the standard EJB deployment descriptor.true
jndi-nametext The JNDI name of the resource environment.true

40.3.1.4. jonas.ejb-ref

The jonas.ejb-ref element declares the JOnAS-specific information for a reference to another enterprise bean's home.

ParameterTypeApplicabilityDescriptionMandatory
ejb-ref-nametext The name of the EJB reference specified in the standard EJB deployment descriptor.true
jndi-nametext The JNDI name of the ejb.true

40.3.1.5. jonas.ejb-ref

The jonas.ejb-ref element specifies the value of timeout in seconds for expiration of session instances.

ParameterTypeApplicabilityDescriptionMandatory
session-timeoutint The value of timeout in seconds for expiration of session instances.true

40.3.1.6. jonas.is-modified-method-name

The jonas.is-modified-method-name element specifies the name of the is-modified method of an entity.

ParameterTypeApplicabilityDescriptionMandatory
is-modified-method-nametext The name of the is-modified method of an entity.true

40.3.1.7. jonas.shared

The jonas.shared element specifies whether the bean state can be accessed outside JOnAS. This tag was introduced in version 2.4.

ParameterTypeApplicabilityDescriptionMandatory
sharedbool True if the bean state can be accessed outside JOnAS. The default is False.true

40.3.1.8. jonas.passivation-timeout

The jonas.passivation-timeout element specifies the value of timeout in seconds for passivation of entity instances when no transaction are used.

ParameterTypeApplicabilityDescriptionMandatory
passivation-timeoutint The value of timeout in seconds for passivation of entity instances when no transaction are used.true

40.3.1.9. jonas.max-cache-size

The jonas.max-cache-size element defines the max number of instances (int value) that can be held in memory. The default value is infinite. This tag was introduced in version 2.4.

40.3.1.10. jonas.min-pool-size

The jonas.min-pool-size element specifies the number of instances that will be created to populate the pool when the bean is loaded for the first time. The default value is 0. This tag was introduced in version 2.4.

40.3.1.11. jonas.jdbc-mapping

The jonas.jdbc-mapping element declares the mapping of an entity with container-managed persistence to the underlying database.

ParameterTypeApplicabilityDescriptionMandatory
jndi-nametext The JNDI name of the datasource.true
automatic-pkbool True or False for use automatic generation of primary key.false
jdbc-table-nametext The name of the relational table.true

40.3.1.12. jonas.finder-method-jdbc-mapping

The jonas.finder-method-jdbc-mapping element declares the SQL WHERE clause associated to a finder method of a container-managed persistence entity.

ParameterTypeApplicabilityDescriptionMandatory
method-nametext The method's name.true
method-paramstext Identifies a single method among multiple methods with an overloaded method name.false
jdbc-where-clausetext The SQL WHERE clause.true

40.3.1.13. jonas.jonas-message-driven-destination

The jonas.jonas-message-driven-destination element declares the JOnAS-specific information for a the message-driven bean destination.

ParameterTypeApplicabilityDescriptionMandatory
jndi-nametext The JNDI name of the message driven destination.true

40.3.2. Method Level tags

40.3.2.1. jonas.ejb-relation

The jonas.ejb-relation element declares the CMR fields Mapping to primary-key-fields to the underlying database.

ParameterTypeApplicabilityDescriptionMandatory
pk-compositetext true if the pk is composite (default value = false)false
ejb-relation-nametext The name of the relationship.true
jdbc-table-nametext The optional name of the relation joint table.false
ejb-relationship-role-name1text The name of the first relationship role.true
foreign-key-jdbc-name1text The column(s) name(s) of the foreign keytrue
ejb-relationship-role-name2text The name of the second (if the relation is bi-directional) relationship role.false
foreign-key-jdbc-name2text The column names of the foreign keyfalse

40.3.2.2. jonas.cmp-field-jdbc-mapping

The jonas.cmp-field-jdbc-mapping element declares the mapping of a container-managed field of an entity to a column of a relational table.

ParameterTypeApplicabilityDescriptionMandatory
field-nametext The field's name.true
jdbc-field-nametext The column name of the relational table.true
sql-typetext The sql-type element specifies the SQL type (CMP2 only)false
key-jdbc-nametext The column name of the primary key composite of this fieldfalse