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

## @resin-ejb Tag Reference

Resin Ejb tags

### @resin-ejb Class Level Tags

@resin-ejb.entity-bean
@resin-ejb.entity-method
@resin-ejb.message-bean

### @resin-ejb Method Level Tags

@resin-ejb.cmp-field
@resin-ejb.entity-method
@resin-ejb.relation

### @resin-ejb Field Level Tags

## @resin-ejb Class Level Tag Usage

### @resin-ejb.entity-bean (0..1)

Resin CMP Entity Bean. Requires @ejb.bean.

Applies to: CMP Entity Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
sql-table | text |  | Database table for this Entity. Deprecated, in favour of @ejb.persistence table-name parameter. | false
data-source | text |  | Entity data source | false
cache-size | int |  | Bean cache size | false
cache-timeout | text |  | Bean cache timeout; default unit is seconds (s) if none specified. | false

### @resin-ejb.entity-method (0..*)

Business method configuration; see http://caucho.com/products/resin-ejb/ejb-ref/resin-ejb-config.xtp#method

Applies to: Class or method level

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
signature | text |  | Java method signature or * (for general case); mandatory at class-level | false
resin-isolation | text |  | Caching hint for Resin; valid values are 'read-only' (read-only) and 'database' (read-write) Valid options are: read-only database | false
query-loads-bean | text |  | find or select query will load the bean rather than just the primary key; valid values are 'true', 'false' Valid options are: true false Default value(s): false | false

### @resin-ejb.message-bean (0..1)

Resin Message Driven Bean. Requires @ejb.bean.

Applies to: Message Driven Beans

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
jndi-name | text |  | JNDI name of the queue or topic for the bean. | false

## @resin-ejb Method Level Tag Usage

### @resin-ejb.cmp-field (0..1)

Specifies database column properties of a persistent field. Requires @ejb.persistent-field.

Applies to: Entity CMP field

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
sql-column | text |  | Database column name | false
sql-type | text |  | SQL column type used during table generation | false
abstract-sql-type | text |  | java.sql.Types column type which is matched with driver type map to determine physical column type during table generation | false

### @resin-ejb.entity-method (0..*)

Business method configuration; see http://caucho.com/products/resin-ejb/ejb-ref/resin-ejb-config.xtp#method

Applies to: Class or method level

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
signature | text |  | Java method signature or * (for general case); mandatory at class-level | false
resin-isolation | text |  | Caching hint for Resin; valid values are 'read-only' (read-only) and 'database' (read-write) Valid options are: read-only database | false
query-loads-bean | text |  | find or select query will load the bean rather than just the primary key; valid values are 'true', 'false' Valid options are: true false Default value(s): false | false

### @resin-ejb.relation (0..1)

Database configuration for persistent relations. Requires @ejb.relation

Applies to: CMR fields only

Parameter | Type | Applicability | Description | Mandatory
--- | --- | --- | --- | ---
sql-table | text |  | Database table for n-m relationships (only) | false
sql-column | text |  | Database column | false
order-by | text |  | Persistent field name for ordering collections in 1-n relationships (only) | false
target-sql-column | text |  | Database column of target in unidirectional relationship | false

## @resin-ejb Field Level Tag Usage