##### Search XDoclet

## jbossservice

Generate jboss mbean descriptor for hibernated classes

### Implementing Class

xdoclet.modules.hibernate.JBossServiceSubTask

### Attributes

Attribute | Description | Required
--- | --- | ---
autoCreate | Parameter for `hibernate.hbm2ddl.auto` property. Available since hibernate 2.1.6. Allowed values are 'create', 'create-drop' and 'update'. | No.
transactionManagerStrategy | Strategy for obtaining the JTA `TransactionManager` | Yes.
userTransactionName | The JNDI name of the JTA UserTransaction object | No.
transactionStrategy | The fully qualified class name of the Hibernate `TransactionFactory` implementation. | No.
cacheProvider | The fully qualified class name of the Hibernate `CacheProvider` implementation. For Hibernate 2.1+ only. | No.
depends | The complete name of the data source service name that this service depends on. | No.
userName | Use this user name to login to the database | No.
password | Use this password to login to the database | No.
useOuterJoin | Whether to use outer join | No. Defaults to false.
showSql | Log sql statements. | No. Defaults to false.
serviceName |  | Yes.
jndiName | JNDI name to bind to the `SessionFactory` | Yes.
dataSource | JNDI name of data source to use in the session factory. Note, that if you don't supply it here, you have to have it in a hibernate.properties file in your classpath. | No.
dialect | SQL dialect of the database. Note, that if you don't supply it here, you have to have it in a hibernate.properties file in your classpath. Use the fully-qualified class name of the dialect here. | No.
defaultSchema | Only for Hibernate 2.1+ | No.
jdbcFetchSize | Only for Hibernate 2.1+ | No.
maxFetchDepth | Only for Hibernate 2.1+ | No.
querySubstitutions | Only for Hibernate 2.1+ | No.
useQueryCache | Only for Hibernate 2.1+ | No.
version | Set the Hibernate version that the jboss service should be generated for. Values are "1.1", "2.0" and "2.1". This value normally corresponds to the setting of the `hibernate` subtask. Default is "2.1" ! | 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
--- | --- | ---
jboss-service-custom.xdt | An XML unparsed entity or XDoclet template file, for custom elements to be included in the generated jboss-service.xml | jboss-service.xml
jboss-service-custom-attributes.ent | An XML unparsed entity for custom attributes to be included within the <mbean/> block of the generated jboss-service.xml | jboss-service.xml

### Nested Elements

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