jbossservice

Generate jboss mbean descriptor for hibernated classes

Implementing Class

xdoclet.modules.hibernate.JBossServiceSubTask

Attributes

AttributeDescriptionRequired
autoCreateParameter for hibernate.hbm2ddl.auto property. Available since hibernate 2.1.6. Allowed values are 'create', 'create-drop' and 'update'. No.
transactionManagerStrategyStrategy for obtaining the JTA TransactionManager Yes.
userTransactionNameThe JNDI name of the JTA UserTransaction object No.
transactionStrategyThe fully qualified class name of the Hibernate TransactionFactory implementation. No.
cacheProviderThe fully qualified class name of the Hibernate CacheProvider implementation. For Hibernate 2.1+ only. No.
dependsThe complete name of the data source service name that this service depends on. No.
userNameUse this user name to login to the database No.
passwordUse this password to login to the database No.
useOuterJoinWhether to use outer join No. Defaults to false.
showSqlLog sql statements. No. Defaults to false.
serviceName Yes.
jndiNameJNDI name to bind to the SessionFactory Yes.
dataSourceJNDI 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.
dialectSQL 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.
defaultSchemaOnly for Hibernate 2.1+ No.
jdbcFetchSizeOnly for Hibernate 2.1+ No.
maxFetchDepthOnly for Hibernate 2.1+ No.
querySubstitutionsOnly for Hibernate 2.1+ No.
useQueryCacheOnly for Hibernate 2.1+ No.
versionSet 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.
useIdsIf 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"
xmlencodingThe 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"
schemaThe XML Schema to which the generated document should conform. No.
validateXMLIf this is set to true, the generated XML will be validated against its DTD or XML Schema. No, default is false.
acceptInterfacesIndicates whether or not to generate for interfaces. No, default is "true"
acceptAbstractClassesIndicates whether or not to generate for abstract classes. No, default is "true"
packageSubstitutionsSets the PackageSubstitutions attribute of the TemplateSubTask object No.
packageSubstitutionInheritanceSupportedIndicates whether or not package substitution should be inherited No, default is "true"
prefixWithPackageStructureIndicates whether or not to prefix with package structure. No, default is "true"
destinationFileThe 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.
templateFileSets the name of the template file to use for generation No, default is determined by this task.
havingClassTagSets the HavingClassTag attribute of the TemplateSubTask object No.
ofType No.
subTaskNameSets an optional name for the subtask that will be seen in XDoclet's debug messages. No.
destDirSets the directory where the generated file(s) will be written. No.
mergeDirSpecifies the location of the merge directory. This is where XDoclet will look for merge files. No.

Merge Files

File nameDescriptionRelates to
jboss-service-custom.xdtAn XML unparsed entity or XDoclet template file, for custom elements to be included in the generated jboss-service.xmljboss-service.xml
jboss-service-custom-attributes.entAn XML unparsed entity for custom attributes to be included within the <mbean/> block of the generated jboss-service.xmljboss-service.xml

Nested Elements

ElementDescription
configParamSpecifies a configuration parameter for the subtask.
ofType
packageSubstitutionSubstitutes the package of the generated files.