jboss

Creates jboss.xml, jaws.xml and/or jbosscmp-jdbc.xml deployment descriptors for JBoss. The destinationFile attribute is ignored because this subtask creates multiple deployment descriptor files.

Implementing Class

xdoclet.modules.jboss.ejb.JBossSubTask

Attributes

AttributeDescriptionRequired
webServiceContextRootSet the web service context root. No.
jbossTemplateFileSets the template file for jboss.xml. No.
jawsTemplateFileSets the template file for jaws.xml. No.
jbosscmpTemplateFileSets the template file for jbosscmp-jdbc.xml. No.
debugDebug flag for jaws.xml. No.
versionThe version of JBoss. Supported versions are 2.4, 3.0, 3.0.1, 3.0.2, 3.0.3, 3.2 and 4.0.

Valid values: 2.4, 3.0, 3.0.1, 3.0.2, 3.0.3, 3.2, 4.0
No, default is "2.4".
securityDomainThe security domain to use. No.
unauthenticatedPrincipalThe unauthenticated principal name to use. No.
datasourceSets the Datasource attribute of the JBossSubTask object No.
datasourceMapping No.
typemapping No.
generateRelations No.
preferredRelationMapping No.
createTable No.
alterTable No.
removeTable 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-security.xmlAn XML unparsed entity containing the optional enforce-ejb-restrictions, security-domain and/or unauthenticated-principal elements for jboss.xmljboss.xml
jboss-beans.xmlAn XML unparsed entity containing the session, entity and message-driven elements for beans you wish to include which aren't processed by XDoclet.jboss.xml
jboss-{0}.xmlAn XML document containing the session, entity or message-driven element for a bean, to be used instead of generating it from the bean's tags.jboss.xml
jboss-resource-managers.xmlAn XML document containing the resource-managers element, to use instead of generating it from jboss.resource-manager tags.jboss.xml
jboss-container.xmlAn XML document containing the optional container-configurations element for jboss.xmljboss.xml
jbosscmp-jdbc-defaults.xmlAn XML document containing the defaults element for jbosscmp-jdbc.xmljbosscmp-jdbc.xml
jbosscmp-jdbc-beans.xmlAn XML unparsed entity containing entity elements for any beans you wish to include which aren't processed by XDoclet.jbosscmp-jdbc.xml
jbosscmp-jdbc-db-settings-{0}.xmlAn XML unparsed entity containing various database settings for a bean. The contents should consist of (ejb-name, (datasource, datasource-mapping)?, create-table?, alter-table?, remove-table?, read-only?, read-time-out?, row-locking?, pk-constraint?, read-ahead?, list-cache-max?, fetch-size?, table-name?) elements.jbosscmp-jdbc.xml
jbosscmp-jdbc-{0}.xmlAn XML unparsed entity containing various other settings for a bean. Should consist of the (cmp-field*, load-groups?, eager-load-group?, lazy-load-groups?, query*) elements.jbosscmp-jdbc.xml
jbosscmp-jdbc-dvc.xmlAn XML unparsed entity containing any additional dependent-value-class elements not generated from jboss.dvc tags.jbosscmp-jdbc.xml
jbosscmp-jdbc-typemappings.xmlAn XML document containing the optional type-mappings element.jbosscmp-jdbc.xml
jbosscmp-jdbc-entity-commands.xmlAn XML document containing the optional entity-commands element.jbosscmp-jdbc.xml
jaws-db-settings-{0}.xmlAn XML unparsed entity containing various database settings for a bean. The contents should consist of (ejb-name , datasource?) elements.jboss-jaws.xml
jaws-{0}.xmlAn XML unparsed entity containing (cmp-field* , finder*) elements for a bean.jboss-jaws.xml
jaws-db-more-settings-{0}.xmlAn XML unparsed entity containing various database settings for a bean. The contents should consist of (read-only? , table-name? , tuned-updates? , create-table? , remove-table? , row-locking? , time-out? , pk-constraint?) elements.jboss-jaws.xml
jboss-webservices.entAn XML unparsed entity containing markup for webservices-description and webservice-context-root elements. This is a Jboss 4 feature and might work with patched >=3.2.6 version.jboss.xml

Nested Elements

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