XDoclet: Attribute-Oriented Programming - weblogic
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

## weblogic

This task can generate deployment descriptors for WLS 6.0, 6.1, 7.0 and 8.1. The destinationFile attribute is ignored because this subtask creates multiple deployment descriptor files.

### Implementing Class

xdoclet.modules.bea.wls.ejb.WebLogicSubTask

### Attributes

Attribute | Description | Required
--- | --- | ---
templateFile | Sets the template file for generation of weblogic-ejb-jar.xml. | No.
cmpTemplateFile | Sets the template file for generation of weblogic-cmp-rdbms-jar.xml. | Yes if its a nested element.
orderDatabaseOperations |  | No.
enableBatchOperations |  | No.
enableBeanClassRedeploy |  | No.
databaseType | Sets the database type specified in the weblogic-cmp-rdbms-jar.xml deployment descriptor. This is a WLS 7.0 and higher feature. Possible values: DB2 INFORMIX ORACLE SQL_SERVER SYBASE POINTBASE Valid values: DB2, INFORMIX, ORACLE, SQL_SERVER, SYBASE, POINTBASE | No, only used with 7.0 upwards, and optional even then.
poolname | Specifies a default value for the pool-name element in the CMP descriptor, to use if no weblogic.pool-name tag appears on a bean (only applies when ejbspec=1.1) | No.
datasource | Specifies a default value for the data-source-name element in the CMP descriptor, to use if no weblogic.data-source-name tag appears on a bean. | No.
version | Sets the target WebLogic version to generate for. Possible values are 6.1, 7.0 and 8.1 Valid values: 6.0, 6.1, 7.0, 8.1 | No, default is 6.1
persistence | Sets the persistence type to use. Useful if you're using a different persistence manager like MVCSoft | No, default is "weblogic"
createtables | If "True" or "CreateOnly", then at deployment time if there is no Table in the Database for a CMP Bean, the Container will attempt to CREATE the Table (based on information found in the deployment files and in the Bean Class). Valid values are "True" and "False" for WLS Servers < Version 8.1 and "CreateOnly", "DropAndCreate", "DropAndCreateAlways", "AlterOrCreate" and "Disabled" for WLS Servers >= 8.1. Valid values: False, True, Disabled, CreateOnly, DropAndCreate, DropAndCreateAlways, AlterOrCreate | No, default is "False" for WLS Servers < Version 8.1 and "Disabled" for WLS Servers >= 8.1
validateDbSchemaWith | The CMP subsystem checks that beans have been mapped to a valid database schema at deployment time. A value of 'MetaData' means that JDBC metadata is used to validate the schema. A value of 'TableQuery' means that tables are queried directly to ascertain that they have the schema expected by the CMP runtime. Valid values: MetaData, TableQuery | 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.
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
--- | --- | ---
weblogic-cmp-rdbms-beans.xml | An XML unparsed entity containing weblogic-rdbms-bean for any CMP entity beans not processed by XDoclet. | weblogic-cmp-rdbms-jar.xml
weblogic-cmp-rdbms-relationships.xml | An XML unparsed entity containing weblogic-rdbms-relation for any CMR relationships of CMP entity beans not processed by XDoclet. | weblogic-cmp-rdbms-jar.xml
weblogic-enterprise-beans.xml | An XML unparsed entity containing weblogic-enterprise-bean elements for any beans not processed by XDoclet. | weblogic-ejb-jar.xml
weblogic-security-role-assignment.xml | An XML unparsed entity containing security-role-assignment elements. | weblogic-ejb-jar.xml
weblogic-run-as-role-assignment.xml | An XML unparsed entity containing run-as-role-assignment elements. | weblogic-ejb-jar.xml

### Nested Elements

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