Editing a Deployment Descriptor

See Also

A deployment descriptor identifies the elements belonging to a particular web module, such as servlets and JSP files. The deployment descriptor also provides configuration information for that web module's deployment. In its native state, the deployment descriptor takes the form of a plain text file, called web.xml, written in Extensible Markup Language, that is, XML, syntax.

The web.xml property sheet makes it easy to edit the various elements that make up a deployment descriptor, that is, the web.xml, file. These elements appear on three tabs:

Tip Note that this feature might not be included in your version of the IDE.

To edit the web.xml file of an existing web module:

  1. In the Explorer, locate the web module directory and open its WEB_INF subdirectory.
  2. Right-click the web.xml node, and choose Properties.
  3. In the web.xml properties sheet, select the category of information you want to edit, for instance, servlet mappings.
  4. Click the ellipses button (...) in the value field of the category of interest to display its property editor.
  5. In the property editor, make your changes.
  6. When you have completed your changes, close the web.xml properties sheet.

Expert users can edit the web.xml file directly by double-clicking the web.xml icon. You can also edit it using an external text editor. When you save your changes, the IDE automatically parses the file and displays any errors in the Output window on the XML Parser pane.

Troubleshooting

If the port number of the server changes, the changes to the deployment descriptor do not take effect until you restart the web module.

See Also
  Web Modules (Concepts)
File Location in a Web Module
Editing Web Module Deployment Properties
Editing Web Module Security Properties
Editing Web Module References Properties

Legal Notices