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

## sunone

Generates configuration files for EJB jars in iPlanet/SunONE

### Implementing Class

xdoclet.modules.sun.sunone.ejb.SunONESubTask

### Attributes

Attribute | Description | Required
--- | --- | ---
version | The SunONE/iPlanet version. Supported versions are 6.0, 6.5 and 7.0. Valid values: 6.0, 6.5, 7.0 | No, default is "7.0".
transactionManagerType | Optional default transaction manager type for all components. Allowed values are 'local' and 'global'. | Only used for version = 6.5, and optional even then.
cmpResourceJndiName | Specifies the absolute jndi-name of the database to be used for storing CMP beans in the EJB JAR file. | Only used for version = 7.0, and optional even then.
cmpResourcePrincipalName | Specifies the default sign-on name to the resource manager. | Only used if cmpResourceJndiName parameter is specified, and optional even then.
cmpResourcePrincipalPassword | Specifies the default password to the resource manager. | Only used if the cmpResourcePrincipalName parameter is specified.
cmpSchema | Specifies the database schema filename (minus .dbschema extension), as captured using Sun's utilities. | Only used with CMP entity beans.
cmpTemplateFile | Sets the name of the sun-cmp-mappings.xml template file. | No.
cmpDestinationFile | Sets the destination filename of the CMP mappings file. | No.
useIds | If this attribute is set to true, XDoclet will generate id attributes in the XML document. Note that this is only available in some subtasks. | No. Default is "false"
xmlencoding | The encoding of the produced xml file. If your XML file uses international characters, you might want to set this to "ISO-8859-1". | No, default is "UTF-8"
schema | The XML Schema to which the generated document should conform. | No.
validateXML | If this is set to true, the generated XML will be validated against its DTD or XML Schema. | No, default is false.
acceptInterfaces | Indicates whether or not to generate for interfaces. | No, default is "true"
acceptAbstractClasses | Indicates whether or not to generate for abstract classes. | No, default is "true"
packageSubstitutions | Sets the PackageSubstitutions attribute of the TemplateSubTask object | No.
packageSubstitutionInheritanceSupported | Indicates whether or not package substitution should be inherited | No, default is "true"
prefixWithPackageStructure | Indicates whether or not to prefix with package structure. | No, default is "true"
destinationFile | The destination file name. If a {0} is found it's assumed that a per class output generation is needed, so {0} is substituted with class name; otherwise a single file is generated with the specified name. | No, default is determined by this task.
templateFile | Sets the name of the template file to use for generation | No, default is determined by this task.
havingClassTag | Sets the HavingClassTag attribute of the TemplateSubTask object | No.
ofType |  | No.
subTaskName | Sets an optional name for the subtask that will be seen in XDoclet's debug messages. | No.
destDir | Sets the directory where the generated file(s) will be written. | No.
mergeDir | Specifies the location of the merge directory. This is where XDoclet will look for merge files. | No.

### Merge Files

File name | Description | Relates to
--- | --- | ---
ejb-env-entries-{0}.xml | Same as for <deploymentdescriptor> subtask (only used for MDBs). | ias-ejb-jar.xml
mdb-ejbrefs-{0}.xml | Same as for <deploymentdescriptor> subtask, except root element name is mdb-ejb-ref rather than ejb-ref (only used for MDBs). | ias-ejb-jar.xml
mdb-resourcerefs-{0}.xml | Same as for <deploymentdescriptor> subtask, except root element name is mdb-resource-ref rather than resource-ref (only used for MDBs). | ias-ejb-jar.xml
ejb-resource-env-refs-{0}.xml | Same as for <deploymentdescriptor> subtask (only used for MDBs). | ias-ejb-jar.xml
sunone-role-mappings.ent | An Unparsed XML Entity file that contains the <role-mapping> elements. | ias-ejb-jar.xml, sun-ejb-jar.xml
sunone-pm-descriptors.xml | An XML Document containing the <pm-descriptors> element. | sun-ejb-jar.xml
sunone-ior-security-config-{0}.xml | An XML Document containing the <ior-security-config> element for a bean. | sun-ejb-jar.xml

### Nested Elements

Element | Description
--- | ---
configParam | Specifies a configuration parameter for the subtask.
ofType |
packageSubstitution | Substitutes the package of the generated files.