Viewing deployment descriptors

A deployment descriptor is an extensible markup language (XML) file that specifies configuration and container options for an application or module.

Before you begin

This topic assumes that you have installed an application or module on a server and that you want to view its deployment descriptor.

About this task

When you create an application or module in an assembly tool, the assembly tool creates deployment descriptor files for the application or module.

You can edit a deployment descriptor file manually. However, it is preferable to edit a deployment descriptor using an assembly tool deployment descriptor editor to ensure that the deployment descriptor has valid properties and that its references contain appropriate values.

After an application or module is installed on a server, you can view its deployment descriptor in the administrative console.

New or updated for this feature pack Prior to the Feature Pack for EJB 3.0, an enterprise archive (EAR) file was required to contain an application.xml file. The application.xml identifies each module of an application. An EJB 3.0 application is not required to provide an application.xml file in the EAR file. In the Feature Pack for EJB 3.0, when an application.xml file does not exist, the product examines the Java archive (JAR) file contents to determine whether the JAR file is an enterprise bean (EJB) module or an application client module. A JAR file should not contain more than one deployment descriptor in it. When an ejb-jar.xml file is found in a JAR file, the product considers it an EJB module. If an ejb-jar.xml file is not found and an application-client.xml is found, the product considers the JAR file to be an application client module. If both ejb-jar.xml and application-client.xml files exist in the JAR file, the product might consider a JAR file intended to be an application client module to be an EJB module or a JAR file intended to be an EJB module to be an application client module. Examine the JAR file to ensure that it does not contain more than one kind of deployment descriptor. If the JAR file contains more than one kind of deployment descriptor, remove the extraneous deployment descriptor.

Procedure

  1. Access a deployment descriptor view.

    Click the navigational option stated in Accessing a console view to view the deployment descriptor for a given module:

    Module Deployment descriptor file Accessing a console view
    Enterprise application application.xml Applications > Enterprise Applications > application_name > View deployment descriptor
    Web application WEB-INF/web.xml Applications > Enterprise Applications > application_name > Manage Modules > module_name > View deployment descriptor
    WEB-INF/portlet.xml Applications > Enterprise Applications > application_name > Manage Modules > module_name > View portlet deployment descriptor
    Enterprise bean ejb-jar.xml Applications > Enterprise Applications > application_name > Manage Modules > module_name > View deployment descriptor
    Application client application-client.xml No console view
    Web service webservices.xml Applications > Enterprise Applications > application_name > Manage Modules > module_name >
    • View Web services client deployment descriptor extension
    • View Web services server deployment descriptor
    • View Web services server deployment descriptor extension
    Viewing Web services deployment descriptors in the administrative console describes the views.
    Resource adapter ra.xml Resource Adapters > Resource Adapters > module_name > View deployment descriptor
  2. Click Expand All to view the deployment descriptor contents.

Results

A deployment descriptor such as the following for the product DefaultApplication is displayed:
<application id="Application_ID" >
  <display-name> DefaultApplication.ear</display-name>
  <description> This is the IBM WebSphere Application Server Default Application.</<description>
  <module id="WebModule_1" >
    <web>
      <web-uri> DefaultWebApplication.war</web-uri>
      <context-root> /</context-root>
    </web>
  </module>
  <module id="EjbModule_1" >
    <ejb> Increment.jar</ejb>
  </module>
  <security-role id="SecurityRole_1130344639273" >
    <description> All Authenticated users role.</description>
    <role-name> All Role</role-name>
  </security-role>
</application>

What to do next

Verify the deployment descriptor contents, including any configurations that it has for bindings, security roles, references to other resources, or Java Naming and Directory Interface (JNDI) names.

Change a deployment descriptor as needed in an assembly tool or using the console.




In this information ...


Related reference

IBM Redbooks, demos, education, and more

(Index)

Use IBM Suggests to retrieve related content from ibm.com and beyond, identified for your convenience.

This feature requires Internet access.

Task topic Task topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 2:56:59 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-dist&topic=trun_app_deploymtdesc
File name: trun_app_deploymtdesc.html