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

Attribute Description Required
webServiceContextRoot Set the web service context root. No.
jbossTemplateFile Sets the template file for jboss.xml. No.
jawsTemplateFile Sets the template file for jaws.xml. No.
jbosscmpTemplateFile Sets the template file for jbosscmp-jdbc.xml. No.
debug Debug flag for jaws.xml. No.
version The 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,defaultis "2.4".
securityDomain The security domain to use. No.
unauthenticatedPrincipal The unauthenticated principal name to use. No.
datasource Sets the Datasource attribute of the JBossSubTask object No.
datasourceMapping No.
typemapping No.
generateRelations No.
preferredRelationMapping No.
createTable No.
alterTable No.
removeTable 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,defaultis 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,defaultis determinedbythis task.
templateFile Sets the name of the template file to use for generation No,defaultis determinedbythis 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-security.xml An XML unparsed entity containing the optional enforce-ejb-restrictions, security-domain and/or unauthenticated-principal elements for jboss.xml jboss.xml
jboss-beans.xml An 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}.xml An 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.xml An XML document containing the resource-managers element, to use instead of generating it from jboss.resource-manager tags. jboss.xml
jboss-container.xml An XML document containing the optional container-configurations element for jboss.xml jboss.xml
jbosscmp-jdbc-defaults.xml An XML document containing the defaults element for jbosscmp-jdbc.xml jbosscmp-jdbc.xml
jbosscmp-jdbc-beans.xml An 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}.xml An 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}.xml An 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.xml An XML unparsed entity containing any additional dependent-value-class elements not generated from jboss.dvc tags. jbosscmp-jdbc.xml
jbosscmp-jdbc-typemappings.xml An XML document containing the optional type-mappings element. jbosscmp-jdbc.xml
jbosscmp-jdbc-entity-commands.xml An XML document containing the optional entity-commands element. jbosscmp-jdbc.xml
jaws-db-settings-{0}.xml An XML unparsed entity containing various database settings for a bean. The contents should consist of (ejb-name , datasource?) elements. jboss-jaws.xml
jaws-{0}.xml An XML unparsed entity containing (cmp-field* , finder*) elements for a bean. jboss-jaws.xml
jaws-db-more-settings-{0}.xml An 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.ent An 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

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