XDoclet: Attribute-Oriented Programming - ejbdoclet
Author: XDoclet Team

##### 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

## ejbdoclet

This task executes various EJB-specific sub-tasks. Make sure to include the jar file containing Sun's javax.ejb.* classes on the taskdef's classpath.

### Implementing Class

xdoclet.modules.ejb.EjbDocletTask

### Attributes

Attribute | Description | Required
--- | --- | ---
ejbSpec | The version of EJB spec ejbdoclet should adhere, currently "1.1", "2.0" and "2.1" defined. If, for example, "2.0" specified, then ejbdoclet will generate EJB 2.0-compatible ejb-jar.xml file. Valid values: 1.1, 2.0, 2.1 | No. Default is "2.0"
ejbClassNameSuffix | A comma-separated list of endings which should be removed from the bean class name to generate a bean's name if no name parameter is specified in the ejb.bean tag. | No, Default is "Bean,EJB,Ejb"
excludedTags | Specify tags that should not be automatically written to output files. The normal behaviour is to include all @ tags from the source file to the output files. This may cause trouble if you use cvs-like tag like $Revision: 1.5 $ that will be overwritten at each build and causes a difference for CVS even if the code himself is not changed. Example: excludedtags="@ version" For excluded tags, ejbdoclet will generate an hardcoded tag. Example: @ version XDOCLET 1.0 | No.
destDir | Destination directory for output files | Only if it's not specified for a subtask.
mergeDir | Directory where subtasks will look for files to be merged with generated files. | No, but should be set if you want to use the merge feature.
force | Specify if the generation of files should be forced. In normal cases, the timestamp of generated file is checked against the timestamps of the class (and its super classes) we generate from. When this timestamp checking should be bypassed (for example after the installtion of a new xdoclet version) then the user should force the regeneration. The easiest way is to run the Ant build file with a parameter "-Dxdoclet.force=true" and add the option "force=${xdoclet.force}" to the doclet call. | No.
verbose | Sets the Verbose attribute of the DocletTask object. | No.
addedTags | Add some JavaDoc tags (or comments) to the generated classes. A special case @ xdoclet-generated. If this is included, ejbdoclet will not consider the file if it is by error in the fileset of the ejbdoclet task. | No.

### Nested Elements

Element | Description
--- | ---
apachesoap |
axisdeploy | Generates an Axis deployment document for deploying a web service.
axisundeploy | Generates an Axis deployment document for undeploying a web service.
borland |
castormapping | Generates mapping.xml deployment descriptor.
configParam | Allows to set configuration parameters that will be included in the element as attribute value pair.
dao |
dataobject | Creates "data objects" for Entity EJBs.
deploymentdescriptor | Subtask for generating standard EJB deployment descriptor.
easerver | Generates configuration files for EJB jars in EAServer 4.1+
entitybmp | Creates "entity bean classes" for BMP entity EJBs.
entitycmp |
entityfacade |
entitypk | Generates primary key classes for entity EJBs.
fileset | Ant's <fileset> definition. To define the files to parse.
homeinterface | Generates remote home interfaces for EJBs.
hpas | Creates hp-ejb-jar.xml deployment descriptor for HPAS.
jboss | Creates jboss.xml, jaws.xml and/or jbosscmp-jdbc.xml deployment descriptors for JBoss.
jonas | Generates the deployment descriptor for JOnAS.
jrun |
localhomeinterface | Generates local home interfaces for EJBs.
localinterface | Generates local interfaces for EJBs.
mdb |
mvcsoft | Generates MVCSoft's xml.
oc4j | Generates OC4J specific deployment descriptor (orion-ejb-jar.xml).
openejb | Creates openejb-jar.xml deployment descriptors for OpenEJB.
orion | Generates Orion's orion-ejb-jar.xml.
packageSubstitution | Substitutes the package of the generated files.
pramati | Generates Pramati deployment files
remotefacade | this subtask is stage 2 of remote facade generation.
remoteinterface | Generates remote interfaces for EJBs.
resin-ejb-xml | Subtask for generation of resin-ejb.
service-endpoint | Generates service endpoint interfaces for JAXPRC beans.
session |
strutsform | Generates a Struts ActionForm, based on an entity EJB.
subTask | Generic subtask.
sunone | Generates configuration files for EJB jars in iPlanet/SunONE
template | Generic subtask for processing a user-supplied template.
utilobject |
valueobject | Creates "value objects" for Entity EJBs.
weblogic | This task can generate deployment descriptors for WLS 6.0, 6.1, 7.0 and 8.1.
websphere | Generates WebSphere specific deployment descriptors for EJB modules.
xmlTemplate | Generic subtask for processing a user-supplied template, to generate an XML document.