XDoclet: Attribute-Oriented Programming - Tag Reference

##### XDoclet

- Overview
- News and Status
- Download/Installation
- Using XDoclet
- Best Practices
- FAQ
- License

##### Ant Task Reference

- <doclet .. />
- <ejbdoclet .. />
- <hibernatedoclet .. />
- <jdodoclet .. />
- <jmxdoclet .. />
- <mockdoclet .. />
- <portletdoclet .. />
- <springdoclet .. />
- <tapestrydoclet .. />
- <webdoclet .. />
- <wseedoclet .. />

##### Tag Reference

- apache (@soap @struts @axis @tapestry)
- 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)
- jsf (@jsf)
- macromedia (@jrun)
- mockobjects (@mock)
- mvcsoft (@mvcsoft)
- mx4j (@mx4j)
- objectweb (@jonas)
- oracle (@oc4j)
- orion (@orion)
- portlet (@portlet)
- pramati (@pramati)
- spring (@spring)
- sun (@sunone)
- sybase (@easerver)
- tjdo (@tjdo)
- web (@web @jsp)
- webwork (@webwork)
- wsee (@wsee)
- xdoclet (@xdoclet @doc @msg)

##### Feature Documentation

- Using Value Objects
- EJB Environment Handling

##### Advanced

- Maven Plug-in
- Merge Points
- IDE Integration
- Migration from EJBDoclet
- Ant 1.5 Troubleshooting

##### Community

- Feedback
- Resources
- Tools

##### Development

- Developer Guide
- Javadoc (API)
- Template Language (*.xdt)
- XJavaDoc Site

##### Search XDoclet

##### Project Documentation

- About XDoclet
- Project Info
- Project Reports
- Development Process

## @jrun Tag Reference

Macromedia JRun J2EE Server

Applies to: EJB

### @jrun Class Level Tags

@jrun.always-dirty
@jrun.cluster-home
@jrun.cluster-object
@jrun.commit-option
@jrun.ejb-local-ref
@jrun.ejb-ref
@jrun.instance-pool
@jrun.jdbc-mappings
@jrun.jndi-name
@jrun.message-driven-destination
@jrun.message-driven-subscription
@jrun.resource-env-ref
@jrun.resource-ref
@jrun.timeout
@jrun.tx-domain

### @jrun Method Level Tags

### @jrun Field Level Tags

## @jrun Class Level Tag Usage

### @jrun.always-dirty (0..1)

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

Applies to: Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | bool |  | Default value(s): false | true

### @jrun.cluster-home (0..1)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | text |  |  | true

### @jrun.cluster-object (0..1)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | text |  |  | true

### @jrun.commit-option (0..1)

The commit-option element specifies the the commit option from Section 10.5.9 and 12.1.9 of the EJB 2.0 specification

Applies to: Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | text |  | A or B or C | true

### @jrun.ejb-local-ref (0..*)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ejb-ref-name | text |  | The ejb-ref-name element gives the name of an EJB from the ejb-jar.xml file. The bean developer this information | true
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound | true

### @jrun.ejb-ref (0..*)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
ejb-ref-name | text |  | The ejb-ref-name element gives the name of an EJB from the ejb-jar.xml file. The bean developer this information | true
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound | true

### @jrun.instance-pool (0..1)

The instance-pool element contains the maximum and minimum size parameters for StatelessSessionBean instance pools

Applies to: Session Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
maximum-size | int |  | The maximum-size element specifies the maximum size for StatelessSessionBean instance pools | true
minimum-size | int |  | The minimum-size element specifies the minimum size for StatelessSessionBean instance pools | true

### @jrun.jdbc-mappings (0..1)

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

Applies to: Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
create-table | bool |  | Whether JRun will attempt to create database tables | true
delete-table | bool |  | Whether JRun will attempt to delete database tables | true

### @jrun.jndi-name (0..1)

The jndi-name element gives the JNDI name where the bean or resource will be bound

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  |  | true

### @jrun.message-driven-destination (0..1)

The message-driven-destination element provides the destination that the Message driven container uses

Applies to: MD Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  | The name element defines the parameter name | true

### @jrun.message-driven-subscription (0..1)

The message-driven-destination element provides the destination that the Message driven container uses

Applies to: MD Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
client-id | text |  | The client-id element provides client id for DurableSubscription setup and sign on | true

### @jrun.resource-env-ref (0..1)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
resource-env-ref-name | text |  | The resource-env-ref-name element gives the name of a resource env from EJB view. The bean developer provides this information | true
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound | true
mdb-destination | text |  | The mdb-destination element specifies a message-driven bean destination | true

### @jrun.resource-ref (0..1)

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

Applies to: EJB Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
resource-ref-name | text |  | The res-ref-name element gives the name of a resource from EJB view. The bean developer provides this information | true
jndi-name | text |  | The jndi-name element gives the JNDI name where the bean or resource will be bound | true
user | text |  | The user element assigns a user identity to be used with a specified resource | true
password | text |  | The password element provides user credentials to be used with user element to identify and authenticate a specified resource | true

### @jrun.timeout (0..1)

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

Applies to: Stateful Session Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | text |  |  | true

### @jrun.tx-domain (0..1)

The tx-domain-name element gives the transaction domain name in which the bean's transactions will take place

Applies to: Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
value | text |  |  | true

## @jrun Method Level Tag Usage

## @jrun Field Level Tag Usage