XDoclet Overview News and Status Download/Installation Using XDoclet Best Practices FAQ License Ant Task Reference <ejbdoclet .. /> <webdoclet .. /> <hibernatedoclet .. /> <mockdoclet .. /> <jdodoclet .. /> <jmxdoclet .. /> <doclet .. /> Tag Reference apache (@soap @struts) bea (@weblogic) borland (@bes) caucho (@resin) ejb (@ejb @dao) exolab (@castor) hp (@hpas) hibernate (@hibernate) ibm (@websphere) java (@javabean) jboss (@jboss) jdo (@jdo) jmx (@jmx) macromedia (@jrun) mockobjects (@mock) mvcsoft (@mvcsoft) mx4j (@mx4j) objectweb (@jonas) oracle (@oc4j) orion (@orion) pramati (@pramati) sybase (@easerver) web (@web @jsp) webwork (@webwork) xdoclet (@xdoclet @doc) Feature Documentation Using Value Objects Advanced Maven Plug-in Merge Points Log4J Configuration IDE Integration Migration from EJBDoclet Ant 1.5 Troubleshooting Community Feedback Resources Tools Development Developer Guide Javadoc (API) Template Language (*.xdt) XJavaDoc Site Project Documentation Front Page Project Info Project Reports Development Process | ### Tag Reference for @jonas 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.cmp-field-jdbc-mapping Field Level Tags ### Tag Usage, Class Level (@jonas) #### @jonas.bean (0..1) 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
#### @jonas.resource (0..*) 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
#### @jonas.resource-env (0..*) 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
#### @jonas.ejb-ref (0..*) 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
#### @jonas.session-timeout (0..1) 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
#### @jonas.is-modified-method-name (0..1) 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
#### @jonas.shared (0..1) 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
#### @jonas.passivation-timeout (0..1) 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
#### @jonas.max-cache-size (0..1) The jonas.max-cache-size element defines the max number of instances that can be hold in memory. The default value is infinite. This tag has only been present since version 2.4.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
max-cache-size | int |  | The max number of instances that can be hold in memory. The default value is infinite. | true
#### @jonas.min-pool-size (0..1) 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.
Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
min-pool-size | int |  | 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. | true
#### @jonas.jdbc-mapping (0..1) 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
#### @jonas.finder-method-jdbc-mapping (0..1) 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
#### @jonas.message-driven-destination (0..1) 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
### Tag Usage, Method Level (@jonas) #### @jonas.cmp-field-jdbc-mapping (0..1) 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
### Tag Usage, Field Level (@jonas)