Tags for creation of JOnAS-specific resources

Class Level Tags

@jonas.bean
@jonas.resource
@jonas.resource-env
@jonas.ejb-ref
@jonas.session-timeout
@jonas.is-modified-method-name
@jonas.shared
@jonas.passivation-timeout
@jonas.max-cache-size
@jonas.min-pool-size
@jonas.jdbc-mapping
@jonas.finder-method-jdbc-mapping
@jonas.message-driven-destination

Method Level Tags

@jonas.ejb-relation
@jonas.cmp-field-jdbc-mapping

Field Level Tags

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

Parameter Type Applicability Description Mandatory
ejb-name text
The enterprise bean's name specified in the standard EJB deployment descriptor. true
jndi-name text
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
cleanup text
Determine the jonas-specific behavior for table management at deploy time. false
lock-policy text
Determine the jonas-specific lock policy fro database access. false
automatic-pk-field-name text
The jdbc column name for automatic primary key auto generared false
inactivity-timeout

text

Optional inactivity timeout value (integer value)
false
prefetch text

Optional prefetch boolean value
false

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

Parameter Type Applicability Description Mandatory
res-ref-name text
The name of the resource reference specified in the standard EJB deployment descriptor. true
jndi-name text
The JNDI name of the resource. true

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

Parameter Type Applicability Description Mandatory
resource-env-ref-name text
The name of the resource environment reference specified in the standard EJB deployment descriptor. true
jndi-name text
The JNDI name of the resource environment. true

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

Parameter Type Applicability Description Mandatory
ejb-ref-name text
The name of the ejb reference specified in the standard EJB deployment descriptor. true
jndi-name text
The JNDI name of the ejb. true

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

Parameter Type Applicability Description Mandatory
session-timeout int
The value of timeout in seconds for expiration of session instances. true

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

Parameter Type Applicability Description Mandatory
is-modified-method-name text
The name of the is-modified method of an entity. true

The jonas.shared element specifies if the bean state can be accessed outside JOnAS. This tag has only been present since version 2.4.

Parameter Type Applicability Description Mandatory
shared bool
True if the bean state can be accessed outside JOnAS. The default is False. true

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

Parameter Type Applicability Description Mandatory
passivation-timeout int
The value of timeout in seconds for passivation of entity instances when no transaction are used. true

The jonas.max-cache-size element defines the max number of instances (int value) that can be hold in memory. The default value is infinite. This tag has only been present since version 2.4.

The jonas.min-pool-size element specify 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 has only been present since version 2.4.

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

Parameter Type Applicability Description Mandatory
jndi-name text
The JNDI name of the datasource. true
automatic-pk bool
True or False for use automatic generation of primary key. false
jdbc-table-name text
The name of the relational table. true

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

Parameter Type Applicability Description Mandatory
method-name text
The method's name. true
method-params text
Identifies a single method among multiple methods with an overloaded method name. false
jdbc-where-clause text
The SQL WHERE clause. true

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

Parameter Type Applicability Description Mandatory
jndi-name text
The JNDI name of the message driven destination. true

The jonas.ejb-relation element declares the CMR fields Mapping to primary-key-fields to the underlying database (cf. http://jonas.objectweb.org/current/doc/CMP2.html#pks).

Parameter Type Applicability Description Mandatory
pk-composite
text

true if the pk is composite (default value = false)
false
ejb-relation-name text
The name of the relationship. true
jdbc-table-name text
The optional name of the relation joint table. false
ejb-relationship-role-name1 text
The name of the first relationship role. true
foreign-key-jdbc-name1 text
The column(s) name(s) of the foreign key true
ejb-relationship-role-name2 text
The name of the second (if the relation is bi-directionnal) relationship role. false
foreign-key-jdbc-name2 text
The column(s) name(s) of the foreign key false

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.

Parameter Type Applicability Description Mandatory
field-name text
The field's name. true
jdbc-field-name text
The column name of the relational table. true
sql-type text
The sql-type element specifies the SQL type (CMP2 only) false
key-jdbc-name text
The column name of the primary key composite of this field false