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



ejbSpecThe 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"
ejbClassNameSuffixA 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"
excludedTagsSpecify 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.
destDirDestination directory for output files Only if it's not specified for a subtask.
mergeDirDirectory 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.
forceSpecify 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.
verboseSets the Verbose attribute of the DocletTask object. No.
addedTagsAdd 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

axisdeployGenerates an Axis deployment document for deploying a web service.
axisundeployGenerates an Axis deployment document for undeploying a web service.
castormappingGenerates mapping.xml deployment descriptor.
configParamAllows to set configuration parameters that will be included in the element as attribute value pair.
dataobjectCreates "data objects" for Entity EJBs.
deploymentdescriptorSubtask for generating standard EJB deployment descriptor.
easerverGenerates configuration files for EJB jars in EAServer 4.1+
entitybmpCreates "entity bean classes" for BMP entity EJBs.
entitypkGenerates primary key classes for entity EJBs.
filesetAnt's <fileset> definition. To define the files to parse.
homeinterfaceGenerates remote home interfaces for EJBs.
hpasCreates hp-ejb-jar.xml deployment descriptor for HPAS.
jbossCreates jboss.xml, jaws.xml and/or jbosscmp-jdbc.xml deployment descriptors for JBoss.
jonasGenerates the deployment descriptor for JOnAS.
localhomeinterfaceGenerates local home interfaces for EJBs.
localinterfaceGenerates local interfaces for EJBs.
mvcsoftGenerates MVCSoft's xml.
oc4jGenerates OC4J specific deployment descriptor (orion-ejb-jar.xml).
openejbCreates openejb-jar.xml deployment descriptors for OpenEJB.
orionGenerates Orion's orion-ejb-jar.xml.
packageSubstitutionSubstitutes the package of the generated files.
pramatiGenerates Pramati deployment files
remotefacadethis subtask is stage 2 of remote facade generation.
remoteinterfaceGenerates remote interfaces for EJBs.
resin-ejb-xmlSubtask for generation of resin-ejb.
service-endpointGenerates service endpoint interfaces for JAXPRC beans.
strutsformGenerates a Struts ActionForm, based on an entity EJB.
subTaskGeneric subtask.
sunoneGenerates configuration files for EJB jars in iPlanet/SunONE
templateGeneric subtask for processing a user-supplied template.
valueobjectCreates "value objects" for Entity EJBs.
weblogicThis task can generate deployment descriptors for WLS 6.0, 6.1, 7.0 and 8.1.
websphereGenerates WebSphere specific deployment descriptors for EJB modules.
xmlTemplateGeneric subtask for processing a user-supplied template, to generate an XML document.