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.

ParameterTypeApplicabilityDescriptionMandatory
ejb-nametextThe enterprise bean's name specified in the standard EJB deployment descriptor.true
jndi-nametextThe 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. You can use standart @ejb.bean jndi-name attribut instead of this specific tagfalse
cleanuptextDetermine the jonas-specific behavior for table management at deploy time.false
lock-policytextDetermine the jonas-specific lock policy fro database access.false
automatic-pk-field-nametextThe jdbc column name for automatic primary key auto generaredfalse

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

ParameterTypeApplicabilityDescriptionMandatory
res-ref-nametextThe name of the resource reference specified in the standard EJB deployment descriptor.true
jndi-nametextThe 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.

ParameterTypeApplicabilityDescriptionMandatory
resource-env-ref-nametextThe name of the resource environment reference specified in the standard EJB deployment descriptor.true
jndi-nametextThe 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.

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

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

ParameterTypeApplicabilityDescriptionMandatory
session-timeoutintThe 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.

ParameterTypeApplicabilityDescriptionMandatory
is-modified-method-nametextThe 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.

ParameterTypeApplicabilityDescriptionMandatory
sharedboolTrue 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.

ParameterTypeApplicabilityDescriptionMandatory
passivation-timeoutintThe 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.

ParameterTypeApplicabilityDescriptionMandatory
jndi-nametextThe JNDI name of the datasource.true
automatic-pkboolTrue or False for use automatic generation of primary key.false
jdbc-table-nametextThe 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.

ParameterTypeApplicabilityDescriptionMandatory
method-nametextThe method's name.true
method-paramstextIdentifies a single method among multiple methods with an overloaded method name.false
jdbc-where-clausetextThe SQL WHERE clause.true

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

ParameterTypeApplicabilityDescriptionMandatory
jndi-nametextThe 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).

ParameterTypeApplicabilityDescriptionMandatory
ejb-relation-nametextThe name of the relationship.true
jdbc-table-nametextThe optional name of the relation joint table.false
ejb-relationship-role-name1textThe name of the first relationship role.true
foreign-key-jdbc-name1textThe column(s) name(s) of the foreign keytrue
ejb-relationship-role-name2textThe name of the second (if the relation is bi-directionnal) relationship role.false
foreign-key-jdbc-name2textThe column(s) name(s) of the foreign keyfalse

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-nametextThe field's name.true
jdbc-field-nametextThe column name of the relational table.true
sql-typetextThe sql-type element specifies the SQL type (CMP2 only)false
key-jdbc-name1textThe column name of the primary key composite of this fieldfalse