deploymentdescriptor

Generates web.xml deployment descriptor.

Implementing Class

xdoclet.modules.web.WebXmlSubTask

Attributes

AttributeDescriptionRequired
servletspecThe Servlet spec version to which the web application conforms.

Valid values: 2.2, 2.3, 2.4
No.
smalliconOptional relative path within the web application's war file of a small (16 x 16) icon image in either JPEG or GIF format. No.
largeiconOptional relative path within the web application's war file of a large (32 x 32) icon image in either JPEG or GIF format. No.
displaynameOptional short name for the web application that is intended to be displayed by tools. No.
descriptionOptional description of the web application. No.
distributableOptional boolean flag indicating whether this web application is programmed appropriately to be deployed into a distributed servlet container. No.
sessiontimeoutThe default session timeout interval for all sessions created in this web application. The specified timeout must be expressed in a whole number of minutes. If the timeout is 0 or less, the container ensures the default behaviour of sessions is never to time out. 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
web-settings.xmlAn XML unparsed entity containing (icon?, display-name?, description?, distributable?, context-param*) elements, to be used instead of generating them from config parameters.web.xml
filters.xmlAn XML unparsed entity containing the filter elements for any additional filters not processed by XDoclet.web.xml
filter-mappings.xmlAn XML unparsed entity containing the filter-mapping elements for any additional filters not processed by XDoclet.web.xml
listeners.xmlAn XML unparsed entity containing the listener elements for any additional listeners not processed by XDoclet.web.xml
servlets.xmlAn XML unparsed entity containing the servlet elements for any additional servlets not processed by XDoclet.web.xml
servlet-mappings.xmlAn XML unparsed entity containing the servlet-mapping elements for any additional servlets not processed by XDoclet.web.xml
web-sec-rolerefs-{0}.xmlAn XML unparsed entity containing any security-role-ref elements for a servlet, to use instead of generating from web.security-role-ref tags.web.xml
mime-mappings.xmlAn XML unparsed entity containing the mime-mapping elements for the web application.web.xml
welcomefiles.xmlXML document containing a welcome-file-list element, used instead of welcomeFiles config parameters.web.xml
error-pages.xmlAn XML unparsed entity containing the error-page elements for the web application.web.xml
taglibs.xmlAn XML unparsed entity containing taglib elements, for tag libraries not defined in tagLibs config parameters.web.xml
web-resource-env-refs.xmlAn XML unparsed entity containing resource-env-ref elements for any resources not specified by web.resource-env-ref tags.web.xml
ejb-resourcerefs.xmlAn XML unparsed entity containing resource-ref entities for any resources not specified in web.resource-ref tags.web.xml
ejb-resourcerefs-{0}.xmlAn XML unparsed entity containing resource-ref entities for any resources for a class not specified in web.resource-ref tags.web.xml
web-security.xmlAn XML unparsed entity containing the (security-constraint*, login-config?) elements for the web application.web.xml
web-sec-roles.xmlAn XML unparsed entity containing security-role entities for any roles not specified in web.security-role tags.web.xml
web-env-entries.xmlAn XML unparsed entity containing env-entry entities for any entries not specified in web.env-entry tags.web.xml
web-env-entries-{0}.xmlAn XML unparsed entity containing env-entry entities for any entries for a class not specified in web.env-entry tags.web.xml
web-ejbrefs.xmlAn XML unparsed entity containing ejb-ref entities for any EJB references not specified in web.ejb-ref tags.web.xml
web-ejbrefs-{0}.xmlAn XML unparsed entity containing ejb-ref entities for any EJB references for a class not specified in web.ejb-ref tags.web.xml
web-ejbrefs-local.xmlAn XML unparsed entity containing ejb-local-ref entities for any EJB local references not specified in web.ejb-local-ref tags.web.xml
web-ejbrefs-local-{0}.xmlAn XML unparsed entity containing ejb-local-ref entities for any EJB local references for a class not specified in web.ejb-local-ref tags.web.xml
taglib-functions.entAn XML unparsed entity containing describe functions in JSP 2.0 taglibs.taglib_tld.xml

Nested Elements

ElementDescription
configParamSpecifies a configuration parameter for the subtask.
contextparamDefines a web application context parameter. May occur multiple times.
ofType
packageSubstitutionSubstitutes the package of the generated files.
taglibDeclares a custom tag library for the web application's JSPs. May occur multiple times.
welcomefileDefines a welcome file for the web application. May occur multiple times.