The following sections describe the
application.xml file. The
application.xml file is the deployment descriptor for an Enterprise application. The file is located in the
META-INF subdirectory of the application archive. It must begin with the following DOCTYPE declaration:
<!DOCTYPE application PUBLIC "-//Sun Microsystems,
Inc.//DTD J2EE Application 1.3//EN"
"http://java.sun.com/dtd/application_1_3.dtd">
application
The application element is the root element of the application deployment descriptor. The elements within the application element are described in the following sections.
The following table describes the elements you can define within the application element.
| Element | Required
Optional | Description |
|---|
| <icon>
| Optional | Specifies the locations of small and large images that represent the application in a GUI tool. This element is not currently used by WebLogic Server. For more information on the elements you can define within the icon element, refer to icon. |
| <display-name>
| Required | Specifies the application display name, a short name that is intended to be displayed by GUI tools. |
| <description> | Optional | Provides descriptive text about the application. |
| <module> | Required | The application.xml deployment descriptor contains one module element for each module within the Enterprise application. Each module element contains an connector, ejb, java, or web element that indicates the module type and location of the module within the application. An optional alt-dd element specifies an optional URI to the post-assembly version of the deployment descriptor. For more information on the elements you can define within the module element, refer to module. |
| <security-role> | Required | Contains the definition of a security role which is global to the application. Each security-role element contains an optional description element, and a role-name element. For more information on the elements you can define within the security-role element, refer to security-role. |
icon
The following table describes the elements you can define within an icon element.
| Element | Required
Optional | Description |
|---|
| <small-icon>
| Optional | Specifies the location for a small (16x16 pixel) .gif or .jpg image used to represent the application in a GUI tool. Currently, this is not used by WebLogic Server. |
| <large-icon>
| Optional | Specifies the location for a large (32x32 pixel) .gif or .jpg image used to represent the application in a GUI tool. Currently, this element is not used by WebLogic Server. |
module
The following table describes the elements you can define within a module element.
| Element | Required
Optional | Description |
|---|
| <alt-dd>
| Optional | Specifies an optional URI to the post-assembly version of the deployment descriptor file for a particular J2EE module. The URI must specify the full pathname of the deployment descriptor file relative to the application's root directory. If you do not specify alt-dd, the deployer must read the deployment descriptor from the default location and file name required by the respective module specification. You can specify an alternate deployment descriptor only for the J2EE deployment descriptors, web.xml and ejb-jar.xml. You cannot specify alternate descriptor files for the weblogic.xml or weblogic-ejb-jar.xml. |
| <connector>
| Required | Specifies the URI of a resource adapter (connector) archive file, relative to the top level of the application package. |
| <ejb> | Required | Defines an EJB module in the application file. Contains the path to an EJB JAR file in the application. Example: <ejb>petStore_EJB.jar</ejb> |
| <java> | Required | Defines a client application module in the application file. Example: <java>client_app.jar</java> |
| <web> | Required | Defines a Web application module in the application.xml file. The web element contains a web-uri element and a context-root element. If you do not declare a value for the context-root, then the basename of the web-uri element is used as the context path of the Web application. (Note that the context path must be unique in a given Web server. More than one Web application may be using the same Web server, so you must avoid context path clashes across multiple applications.) -
web-uri Defines the location of a Web module in the application.xml file. This is the name of the WAR file. -
context-root Specifies a context root for the Web application. Example: <web>
<web-uri>petStore.war</web-uri>
<context-root>estore</context-root>
</web> |
security-role
The following table describes the elements you can define within a security-role element.
| Element | Required
Optional | Description |
|---|
| <description>
| Optional | Text description of the security role. |
| <role-name>
| Optional | Defines the name of a security role or principal that is used for authorization within the application. Roles are mapped to WebLogic Server users or groups in the weblogic-application.xml deployment descriptor. Example: <security-role>
<description>the gold customer role</description>
<role-name>gold_customer</role-name>
</security-role>
<security-role>
<description>the customer role</description>
<role-name>customer</role-name>
</security-role> |