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

## @websphere Tag Reference

IBM's WebSphere

Applies to: EJBs

### @websphere Class Level Tags

@websphere.bean
@websphere.bean-cache
@websphere.cmp
@websphere.finder-query
@websphere.local-transaction
@websphere.mapping
@websphere.mapping-constraint
@websphere.mdb
@websphere.resource-ref

### @websphere Method Level Tags

@websphere.resource-ref

### @websphere Field Level Tags

@websphere.resource-ref

## @websphere Class Level Tag Usage

### @websphere.bean (0..1)

WebSphere specific extension properties for Session Beans

Applies to: Session Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
timeout | text |  | Equivalent to the WebSphere Extension property "Session Timeout" | false

### @websphere.bean-cache (0..1)

WebSphere specific cache settings for EJBs

Applies to: Entity Beans and Stateful Session Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
activate-at | text |  | Specifies the point at which an EJB is activated and placed in the cache. Removal from the cache and passivation is also governed by this setting. Valid options are: ONCE ACTIVITY_SESSION TRANSACTION | false
load-at | text | Entity Beans | Specifies when the EJB loads its state from the database. The value of this setting implies whether the container has exclusive or shared access to the database. Valid options are: ACTIVATION TRANSACTION | false
pinned-for | text | Entity Beans | Defines how long the bean should be maintained in the cache Valid options are: ACTIVATION_PERIOD ACTIVITY_SESSION TRANSACTION BUSINESS_METHOD_ONLY | false

### @websphere.cmp (0..1)

WebSphere specific extension properties for CMP Entity Beans

Applies to: CMP Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
datasource | text |  | The jndi-name used by this CMP bean to lookup the datasource. Note that the datasource-attribute on the websphere ant task can be used to set a default datasource for all CMP beans. | false

### @websphere.finder-query (0..1)

DEPRECATED. Use EJB QL Queries instead.

Applies to: CMP Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
name | text |  |  | true
parms | text |  |  | true
where-clause | text |  |  | true
home | text |  |  | true

### @websphere.local-transaction (0..1)

WebSphere specific extension properties for local transactions. For more information, see the WebSphere Application Server documentation.

Applies to: EJBs

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
boundary | text |  | Copied from IBM RAD on-line help: In the Boundary field, select one of the following values to specify the duration of a local transaction context: BeanMethod: Specifies that the local transaction begins when the method begins, and ends when the method ends. ActivitySession: Specifies that the local transaction must be resolved within the scope of any ActivitySession in which it was started or, if no ActivitySession context is present, within the same bean method in which it was started. Valid options are: BeanMethod ActivitySession | false
resolver | text |  | Copied from IBM RAD on-line help: In the Resolver field, select one of the following values to specify how the local transaction is to be resolved before the local transaction context ends: Application: When you use this setting your code must either commit or roll back the local transaction. If this does not occur, the runtime environment logs a warning and automatically commits or rolls back the connection as specified by the Unresolved action setting. ContainerAtBoundary: When you use this setting, the container takes responsibility for resolving each local transaction. Valid options are: Application ContainerAtBoundary | false
unresolvedAction | text |  | Copied from IBM RAD on-line help: In the Unresolver action field, select one of the following values to specify the action that the EJB container must take if resources are uncommitted by an application in a local transaction: Commit: At the end of the local transaction context, the container instructs all unresolved local transactions to commit. Rollback: (Default) At the end of the local transaction context, the container instructs all unresolved local transactions to roll back. Valid options are: Commit Rollback | false

### @websphere.mapping (0..1)

DEPRECATED. Use the CMP OR-mapping in the WebSphere deploymentment tool for a default mapping or the CMP OR-mapping tool in WSAD for more advanced mapping.

Applies to: EJBs

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

### @websphere.mapping-constraint (0..1)

DEPRECATED. Use the CMP OR-mapping in the WebSphere deploymentment tool for a default mapping or the CMP OR-mapping tool in WSAD for more advanced mapping.

Applies to: EJBs

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
constraint-name | text |  |  | true
constraint-type | text |  |  | true

### @websphere.mdb (0..1)

WebSphere specific extension properties for Message Driven Beans

Applies to: Message Driven Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
listenerPort | text |  | The listener port to be used by this Message Driven Bean for consuming messages. | true

### @websphere.resource-ref (0..*)

WebSphere specific extension properties for Resource References.

Applies to: EJBs and Servlet

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
res-ref-name | text | Only for class level tags. | The name of the resource reference | true
connection-management-policy | text |  | The connection management policy Valid options are: Default Aggressive Normal | false
isolation-level | text |  | The transaction isolation level Valid options are: TRANSACTION_NONE TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE | false

## @websphere Method Level Tag Usage

### @websphere.resource-ref (0..*)

WebSphere specific extension properties for Resource References.

Applies to: EJBs and Servlet

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
res-ref-name | text | Only for class level tags. | The name of the resource reference | true
connection-management-policy | text |  | The connection management policy Valid options are: Default Aggressive Normal | false
isolation-level | text |  | The transaction isolation level Valid options are: TRANSACTION_NONE TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE | false

## @websphere Field Level Tag Usage

### @websphere.resource-ref (0..*)

WebSphere specific extension properties for Resource References.

Applies to: EJBs and Servlet

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
res-ref-name | text | Only for class level tags. | The name of the resource reference | true
connection-management-policy | text |  | The connection management policy Valid options are: Default Aggressive Normal | false
isolation-level | text |  | The transaction isolation level Valid options are: TRANSACTION_NONE TRANSACTION_READ_UNCOMMITTED TRANSACTION_READ_COMMITTED TRANSACTION_REPEATABLE_READ TRANSACTION_SERIALIZABLE | false