Application Deployment Descriptor editor
The Application Deployment Descriptor editor includes scrollable pages and collapsible sections that represent the various properties and settings in the deployment descriptor (application.xml) and other metadata written to bindings and extensions files. The editor is dynamic, and sections and pages are created based on the application deployment descriptor version and the workbench capabilities that are enabled.
The core function is typically located at the top of an editor page. To see core pages and sections, set focus on the editor and press Alt + Shift + C. The core pages, sections, headers, and tabs will highlight blue and remain in this state until you press Alt + Shift + C again. The extensions and bindings are usually nested sections and found at the bottom of the editor pages. Collapsing a section hides the content, but leaves the heading information. This is useful in filtering through the data and properties on each page. The editor remember the sections that you collapse when you close and reopen the editor. Also, you can resize sections by dragging a hidden border at the end or beginning of each section.
The application deployment descriptor editor typically modifies the following resources:
The application deployment descriptor editor typically displays the following pages, sections, and views:
The Overview page in the application editor provides a quick summary of the contents in the application deployment descriptor. It includes the following sections: General Information, Modules, Security Roles, Icons, and WebSphere Extensions.
General Information section
Use the General Information section to view the display name and description for the enterprise application, as stored in the application.xml file.
On the Overview page, the Modules section displays the names of the modules that are defined for the application, and provides a quick link to the Module page of the editor.
Security Roles section
On the Overview page, the Security roles section displays the security roles that are defined for the application, and provides a quick link to the Security page of the editor.
Use the Icons section to choose icons that represent your enterprise application. These icons are mainly used for identification on the server. In order to use an icon, you must first import the graphic file into the enterprise application project (basically, it must be contained inside the EAR file in order for it to be found at deploy time). Once the file has been imported into the project, you will be able to select it within the icon dialog on the application deployment descriptor editor. If you do not import the file into the project, you will not see any icons within the dialogs.
WebSphere Extensions section
(For applications that target WebSphere Application Server) On the Overview page, the WebSphere Extension section provides a place to set the reload interval and shared session context properties.
Use the Module page to add, edit, browse, and remove EJB, Web, and Application Client modules from the enterprise application. When you select a module in the Modules list, its attributes are displayed on the fields on the right side of the pane. The list of fields changes dynamically to match the type of module selected.
Project Utility JARs section
Use this section to add a Java project as a utility JAR file that can be used by modules in the enterprise application. For each Java project, a utility JAR will be created when the EAR file is exported.
Use the Security page to view, add, remove, gather, and combine security roles. The Gather option rolls up all security roles defined in modules that are included in the application. The resulting list is the union of all roles in all modules in the application. The Replace option replaces an original role with another, existing role. The original role is removed from the application and any modules within the application.
WebSphere Bindings section
(For applications that target WebSphere Application Server) On the Security page, the WebSphere bindings section provides a place to add users and groups to the security roles.
Security Role Run As Bindings section
(For applications that target WebSphere Application Server) Use the Security role run as bindings section to specify the security identity that a bean will execute as.
You can specify a user ID and password that are required to access a bean from another bean. This additional security level is a WebSphere Application Server binding.
Before you can add a security role "run as" binding, you must first create a security role on the Assembly Descriptor page of the EJB deployment descriptor editor for an EJB module. Then you need to add a security identity on the Access page of the EJB deployment descriptor editor. This security identity must be set to use the identity of a security role. Then, in the application deployment descriptor editor, gather up the security roles and select the role that you created for your enterprise beans. This enables the Security Role Run as Bindings section in the application deployment descriptor editor.
This setting is a WebSphere Application Server binding for an enterprise application that allows you to specify a user ID and password that are required in order to execute an enterprise bean.
For enterprise applications that are targeted to use a WebSphere Application Server runtime environment, you can use the Deployment page to specify additional options for deploying to the server. For example, you can define JDBC providers, data sources, resource properties, and the applications that you want to deploy on the server.
Use the Source page to view and modify the application.xml file directly. The XML on the source page changes dynamically when the deployment descriptor is edited, and the other pages of the application deployment descriptor editor reflect changes that you make on the Source page. Editing the XML source is not the recommended method for editing the deployment descriptor. It is suggested that you make as many changes as possible using the other pages and sections of the editor.
The Web Deployment Descriptor editor
The Web Deployment Descriptor editor lets you specify deployment information for modules created in the Web development environment. The information appears in the web.xml file. Note that you use the Web deployment descriptor to set deployment descriptor attributes. You do not use it to manipulate Web resource content.
The web.xml file for a Web project provides information necessary for deploying a Web application module. It is used in building a WAR file from a project. Whenever you create a new Web project, a minimal web.xml file is automatically created in WEB-INF under the project's WebContent folder.
The Web Deployment Descriptor editor is dynamic and includes many tabbed pages (views) that represent various properties and settings in the deployment descriptor. For example, you can click the Servlets tab to display the Servlets page, in which you can add or remove servlets and JSPs that are used in the Web application.
The Web Deployment Descriptor editor includes the following tabbed pages:
Provides a quick summary of the contents in the Web deployment descriptor and lets you add, remove, or change the contents.
You can edit settings in the following sections of the Overview page:
General Information - lets you view and edit general information, including the display name, description (not displayed to end users), and client session time out (in minutes).
Servlets and JSPs - lets you view the servlets and JSPs used in the application.
Filters - lets you view filters used in the application.
Pages - lets you view welcome pages used in the application.
Mime type - lets you view file extensions that are mapped to mime types.
Security - lets you view the security roles and their constraints defined for the Web application.
Icons - lets you view, change, or add icons representing the Web application.
Usage - list the enterprise applications that are using this Web module.
Web Library projects - lets you view, add, or remove references to JAR files mapped to Java projects.
Listeners - lets you view listeners used in the application.
References - lets you view resources that the Web application references.
Environment Variables - lets you view environment variables that are relevant to the Web application.
Context Parameters - lets you view the context initialization parameters that apply to all the servlets in the Web application.
WebSphere Bindings - lets you bind the Web application to a virtual host so that execution is enabled on that virtual host.
Lets you create a new servlet, add an existing servlet or JSP file to the deployment descriptor, or remove the selected servlet of JSP file from the deployment descriptor.
You can edit settings in the following sections of the Servlets page:
Servlets and JSPs - list servlets and JSPs used in this application. You can add or remove servlets and JSPs from the list.
Details - lists details about the selected servlet or JSP. Details listed include the servlet class (canonical name), the display name (a short name for display purposes), and a description.
URL Mappings - lists URLs mapped to the selected servlet.
Initialization - lists the initialization parameters that are configured for the selected servlet or JSP file.
Load on Startup - enables you to specify the details of a servlet's load-on-startup element, including load order.
Security role references - list the security roles referenced in the Web application and lets you edit the security roles that are authorized to access the servlet. You can add or remove security roles. If you add a security role reference, you specify the role reference name, the role link, and a description.
Run as - lists details of the selected servlet's run-as element.
Icons - lets you view or change icons (small or large) used to represent the selected servlet or JSP file.
WebSphere Extensions - list and lets you change the details of the Servlet Extension for the selected servlet. You can add a new extension by clicking Add. The Add Markup Language entry wizard appears. Also, depending on the Servlet Version of the project you are working with, you can specify global and local transaction settings.
Lets you create a new filter, add an existing filter to the deployment descriptor, or remove the selected filter from the deployment descriptor.
In the Filters page of the Web deployment descriptor editor, you can add or remove:
filter mappings to URL
filter mappings to servlet
filter initialization parameters
Lets you define security roles and security constraints.
The Security page has the following two sections:
Security Roles - lists and lets you add or remove the security roles defined for this Web application as well as provide a description of each role.
Security Constraints - lets you add or remove security constraints for specific security roles as well as add descriptions of each security constraint. In addition, you can add or remove Web resources and their HTTP methods, define the security roles who are authorized to access the Web resources, and specify user data constraints on user data: (None, Integral, or Confidential.) None means that the application requires no transport guarantees. Integral means data cannot be changed in transit between client and server. Confidential means data content cannot be observed while it is in transit. These data contraints usually require the use of SSL.
Lets you add or remove references to the deployment descriptor.
The following are the types of references you can define on this page:
EJB reference - create a reference to an enterprise bean.
Service reference - create a reference to a Web service
Resource reference - create a reference to an external resource
Message Destination reference - create a reference to a JMS destination
Resource Environment reference - create a reference to administered objects
You can also use this page to specify binding information, properties, and extensions for the WebSphere Application Server.
Lets you add and configure handlers for a selected port component. This includes specifying a handler description and display name, specifying implementation details, adding initial parameters, and adding SOAP headers.
In the WS Handler page of the Web deployment descriptor editor, you can:
remove an existing or create a new web service handler
view overview and implementation details for a selected handler
choose an icon for a selected handler
remove existing or create initial parameters for a selected handler
add or remove SOAP headers for a selected handler
Lets you add or remove welcome and error pages to the deployment descriptor. Also allows you to define the login-config element and add exception types to error pages.
In the Pages page of the Web deployment descriptor editor, you can:
Remove an existing or add a new welcome file
Specify login configuration values
Remove an existing or create a new error code error page
Error pages are pages that you configure to display in response to specific HTTP error codes. To add or remove an error page from a Web application, you must add or remove the error page from the web.xml file.
Remove an existing or create a new exception type error page
Lets you add or remove listeners, environment variables, tag lib references, context parameters and MIME Mappings.
In the Variables page of the Web deployment descriptor editor, you can add or remove:
tag lib references
locale encoding mappings
JSP property groups
Lets you configure extension information for the Web Service.
The Web Service Client Security Extension page appears in the Web deployment descriptor editor, only when you have already defined a web service. You can use this page to:
Add, edit, or remove a service reference
Add, edit or remove a port Qname binding
Add, edit or remove the default mappings for a selected service
Modify the Request Generator configuration for the Selected Port Qname Binding, including integrity, confidentiality and security settings.
Modify timestamp and other information
Lets you configure binding information for the Web Service.
The Web Service Client Binding page appears in the Web deployment descriptor editor, only when you have already defined a web service. You can use this page to:
add or remove a web service to a client binding
view service reference details, including the deployed WSDL file
add or remove a port qualified name binding
specify setting for the selected port qualified name binding
add or remove default mappings
add or remove parameters for the selected service reference
modify the security configuration for generating request messages
modify the security configuration for consuming response messages
add or remove parameters of the selected port qualified name binding
Lets you specify settings for WebSphere extensions (such as enabling reloading). Other settings include MIME filters, JSP attributes, file serving attributes, invoker attributes, and servlet caching configurations.
In the Extensions page of the Web deployment descriptor editor, you can:
modify various general settings. For example, you can specify whether:
reloading is enabled
file serving is enabled
directory browsing is enabled
to serve servlets by classname
automatic request encoding is enabled
automatic response encoding is enabled
automatic filter loading is enabled
add or remove MIME filters
add or remove JSP attributes
add or remove file serving attributes
add or remove invoker attributes
add, remove or edit servlet caching configurations
Although you can edit web.xml directly, we recommend that you edit the multiple tabbed pages in the Web Deployment Descriptor editor. As you specify deployment information in these tabbed pages, the editor automatically incorporates the appropriate XML tagging in web.xml (or in the appropriate .xmi file).
In addition to the configuration information in the web.xml file, other deployment descriptors in a Web project include the following information:
Binding information - information is required by the application server to bind the deployment information specified in the application to a specific instance. For example, it may map a logical name of an external dependency or resource to the actual physical JNDI name of the resource. It also may map security role information to a set of groups or users.
IBM binding and extensions information (ibm-web-bnd.xmi and ibm-web-ext.xmi files) - additions to the standard descriptors for J2EE applications, Web applications, and enterprise beans. The extensions enable Enterprise Edition or legacy (older) systems to work in the current WebSphere Application Server environment. They are also used to specify application behavior that is vendor-specific, undefined in a current specification, or expected to be included in a future specification.
If you import a WAR file into an existing Web project, you can include the deployment descriptor files included in the WAR file as the Web project's new deployment descriptor. Any specific deployment information already defined in these files is used when deploying the updated Web application.
The web.xml file can be updated automatically to reflect changes to your Web project. For instance, when you use the New Servlet wizard to create a new servlet in a Web project, the wizard places the appropriate servlet entry into the web.xml file.