strutsconfigxml

Generates struts-config.xml deployment descriptor.

Implementing Class

xdoclet.modules.apache.struts.StrutsConfigXmlSubTask

Attributes

AttributeDescriptionRequired
versionSets the struts version to use. Legal values are "1.0", "1.1" and "1.2".

Valid values: 1.0, 1.1, 1.2
No. Default is "1.0".
controllerSets fully qualified class to use when instantiating ActionMapping objects. 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
struts-data-sources.xmlAn XML document containing the optional data-sources element.struts-config.xml
struts-forms.xmlAn XML unparsed entity containing form-bean elements, for additional non-XDoclet forms.struts-config.xml
global-exceptions.xmlAn XML document containing the optional global-exceptions element.struts-config.xml
global-forwards.xmlAn XML document containing the optional global-forwards element.struts-config.xml
struts-actions.xmlAn XML unparsed entity containing action elements, for additional non-XDoclet actions.struts-config.xml
actions.xmlDeprecated (renamed to struts-actions.xml). Still used, but only for backwards compatibility.struts-config.xml
struts-controller.xmlAn XML document containing the optional controller element.struts-config.xml
struts-message-resources.xmlAn XML unparsed entity containing any message-resources elements.struts-config.xml
struts-plugins.xmlAn XML unparsed entity containing any plug-in elements.struts-config.xml

Nested Elements

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