Environment Entries Property Editor

Tip Note that this feature might not be included in your version of the IDE. If it is not available, you can edit the deployment descriptor (web.xml) file using the editor of your choice. For more information, see Java Servlet 2.3 Specification available at http://java.sun.com/products/servlet .

You can use the Environment Entries property editor to specify, edit, and remove environment entries declared in the web module. An environment entry is a variable stored in the web module's environment by a J2EE-compliant web container. The value of the environment entry can be extracted programmatically by the web module at runtime and used to configure the web module's behavior. You can define a default value for an environment entry, which can be overriden by the deployer Note that environment entries require JNDI. Each entry in this property editor corresponds to an <env-entry> element in the deployment descriptor.

To display the Environment Entries property editor:

  1. Click the References tab of the web.xml property sheet.
  2. Click the Environment Entries value field to make the ellipsis button (...) appear. By default, there are no environment entries.
  3. Then click the ellipsis button to display the property editor.

To add environment entries:

  1. From the Environment Entries property editor, click the Add button. The Add Environment Entry dialog box appears.
  2. Type the name of the environment entry in the Name text field. Environment entries are almost parallel to context parameters, but are managed by the JNDI name service. Therefore, their values can be modified after the web module is deployed. So, examples might include maximum number of sessions, database connection information, and so on.
  3. Type an optional description of the environment entry in the Description text field.
  4. Choose the appropriate type of the environment entry for the data you want to convey from the Type combo box.
  5. Type in a value for the environment entry here. This value must be of the appropriate declared type. Note that this value is optional. You do not need to supply a default value, but the deployer must make sure that a value is available at runtime.
  6. Click OK. The information you have specified is reflected in the Environment Entries property editor.

To edit environment entries:

  1. From the Environment Entries property editor, select the desired environment entry information, and click the Edit button. The Edit Environment Entry dialog box appears.
  2. Edit the name of the environment entry in the Name text field.
  3. Edit the description of the environment entry in the Description text field.
  4. Change the type of the environment entry in the Type combo box.
  5. Edit the value of the environment entry in the Value text field.
  6. Click OK. The information you have specified is reflected in appropriate entries in the Environment Entries property editor.

To remove environment entries:

  1. From the Environment Entries property editor, select the row containing the desired enviroment entry information, and click the Remove button. The environment entry is removed from the table.
  2. Click OK to confirm the action, or click Cancel to stop the action.
See also
Editing Web Module References Properties

Legal Notices