deploymentdescriptor

Subtask for generating standard EJB deployment descriptor.

Implementing Class

xdoclet.modules.ejb.dd.EjbDotXmlSubTask

Attributes

Attribute Description Required
smallicon Sets the Smallicon attribute of the EjbDotXmlSubTask object No.
largeicon Sets the Largeicon attribute of the EjbDotXmlSubTask object No.
displayname Sets the Displayname attribute of the EjbDotXmlSubTask object No.
description Sets the Description attribute of the EjbDotXmlSubTask object No.
clientjar Sets the Clientjar attribute of the EjbDotXmlSubTask object 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
session-beans.xml An XML unparsed entity containing session elements for beans you wish to include which aren't processed by XDoclet. ejb-jar.xml
entity-beans.xml An XML unparsed entity containing entity elements for beans you wish to include which aren't processed by XDoclet. ejb-jar.xml
message-driven-beans.xml An XML unparsed entity containing message-driven elements for beans you wish to include which aren't processed by XDoclet. ejb-jar.xml
ejb-env-entries-{0}.xml An XML unparsed entity containing env-entry elements for a bean, to use instead of generating them from ejb.env-entry tags. ejb-jar.xml
ejb-ejbrefs-{0}.xml An XML unparsed entity containing (ejb-ref*, ejb-local-ref*) elements for a bean, to use instead of generating them from ejb.ejb-ref and ejb.ejb-external-ref tags. ejb-jar.xml
ejb-sec-rolerefs-{0}.xml An XML unparsed entity containing security-role-ref elements for a bean, to use instead of generating them from ejb.security-role-ref tags. ejb-jar.xml
ejb-resourcerefs-{0}.xml An XML unparsed entity containing resource-ref elements for a bean, to use instead of generating them from ejb.resource-ref tags. ejb-jar.xml
ejb-resource-env-refs-{0}.xml An XML unparsed entity containing resource-env-ref elements for a bean, to use instead of generating them from ejb.resource-env-ref tags. ejb-jar.xml
ejb-finders-{0}.xml An XML unparsed entity containing query elements for a bean, for additional finder and select methods not defined in the bean class or its tags. ejb-jar.xml
assembly-descriptor.xml An XML document containing assembly-descriptor markup, to use instead of generating it. ejb-jar.xml
ejb-security-roles.xml An XML unparsed entity containing any additional security-role elements not generated by XDoclet. ejb-jar.xml
ejb-method-permissions.ent An XML unparsed entity containing any additional method-permission elements not generated by XDoclet. ejb-jar.xml
ejb-container-transactions.ent An XML unparsed entity containing any additional container-transaction elements not generated by XDoclet. ejb-jar.xml
ejb-message-destinations.ent An XML document containing message-destination elements. Only used with EJB 2.1+ ejb-jar.xml
ejb-exclude-list.xml An XML document containing any exclude-list element. Only used with EJB 2.0+ ejb-jar.xml
relationships.xml AN XML unparsed entity containing ejb-relationship elements to add additional relationships that were not generated through Xdoclet. ejb-jar.xml

Nested Elements

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