application_1_3.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

application_1_3.dtd

This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or documentation may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any.

Third party software, including font technology, is copyrighted and licensed from Sun suppliers.

Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans, are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S. and other countries.

All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.

PostScript is a registered trademark of Adobe Systems, Inc.

Federal Acquisitions: Commercial Software - Government Users Subject to Standard License Terms and Conditions.

DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

_________________________________________________________________________

Ce produit ou document est prote'ge' par un copyright et distribue' avec des licences qui en restreignent l'utilisation, la copie, la distribution, et la de'compilation. Aucune partie de ce produit ou de sa documentation associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses bailleurs de licence, s'il y en a.

Le logiciel de'tenu par des tiers, et qui comprend la technologie relative aux polices de caracte`res, est prote'ge' par un copyright et licencie' par des fournisseurs de Sun.

Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans, sont des marques de fabrique ou des marques de'pose'es de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays.

Toutes les marques SPARC sont utilise'es sous licence et sont des marques de fabrique ou des marques de'pose'es de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont base's sur une architecture de'veloppe'e par Sun Microsystems, Inc.

Postcript est une marque enregistre'e d'Adobe Systems Inc.

LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.

Root element

The application element is the root element of a J2EE application deployment descriptor.

<application>'s children

Name Cardinality

description One or none

display-name Only one

icon One or none

module At least one

security-role Any number

<application>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(icon?, display-name, description?, module+, security-role*)

<alt-dd>

Child of module

The alt-dd element 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 alt-dd is not specified, the deployer must read the deployment descriptor from the default location and file name required by the respective component specification.

Used in: module

<alt-dd>'s attributes

Name Values Default

id Match the ID rules.

Child of module

The connector element specifies the URI of a resource adapter archive file, relative to the top level of the application package.

Used in: module

<connector>'s attributes

Name Values Default

id Match the ID rules.

<context-root>

Child of web

The context-root element specifies the context root of a web application.

Used in: web

<context-root>'s attributes

Name Values Default

id Match the ID rules.

Child of application, security-role

The description element is used to provide text describing the parent element. The description element should include any information that the application ear file producer wants to provide to the consumer of the application ear file (i.e., to the Deployer). Typically, the tools used by the application ear file consumer will display the description when processing the parent element that contains the description.

Used in: application, security-role

<description>'s attributes

Name Values Default

id Match the ID rules.

<display-name>

Child of application

The display-name element contains a short name that is intended to be displayed by tools. The display name need not be unique.

Used in: application

Example:

<display-name>Employee Self Service</display-name>

<display-name>'s attributes

Name Values Default

id Match the ID rules.

<ejb>

Child of module

The ejb element specifies the URI of an ejb-jar, relative to the top level of the application package.

Used in: module

<ejb>'s attributes

Name Values Default

id Match the ID rules.

<icon>

Child of application

The icon element contains small-icon and large-icon elements that specify the file names for small and a large GIF or JPEG icon images used to represent the parent element in a GUI tool.

Used in: application

<icon>'s children

Name Cardinality

large-icon One or none

small-icon One or none

<icon>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(small-icon?, large-icon?)

<java>

Child of module

The java element specifies the URI of a java application client module, relative to the top level of the application package.

Used in: module

<java>'s attributes

Name Values Default

id Match the ID rules.

<large-icon>

Child of icon

The large-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the application's ear file.

The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

<large-icon>'s attributes

Name Values Default

id Match the ID rules.

Child of application

The module element represents a single J2EE module and contains a connector, ejb, java, or web element, which indicates the module type and contains a path to the module file, and an optional alt-dd element, which specifies an optional URI to the post-assembly version of the deployment descriptor.

The application deployment descriptor must have one module element for each J2EE module in the application package.

Used in: application

<module>'s children

Name Cardinality

alt-dd One or none

connector One or none

ejb One or none

java One or none

web One or none

<module>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

((connector | ejb | java | web), alt-dd?)

<role-name>

Child of security-role

The role-name element contains the name of a security role.

The name must conform to the lexical rules for an NMTOKEN.

Used in: security-role

<role-name>'s attributes

Name Values Default

id Match the ID rules.

<security-role>

Child of application

The security-role element contains the definition of a security role. The definition consists of an optional description of the security role, and the security role name.

Used in: application

Example:

<security-role> <description> This role includes all employees who are authorized to access the employee service application. </description> <role-name>employee</role-name> </security-role>

<security-role>'s children

Name Cardinality

description One or none

role-name Only one

<security-role>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, role-name)

<small-icon>

Child of icon

The small-icon element contains the name of a file containing a small (16 x 16) icon image. The file name is a relative path within the application's ear file.

The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

<small-icon>'s attributes

Name Values Default

id Match the ID rules.

<web>

Child of module

The web element contains the web-uri and context-root of a web application module.

Used in: module

<web>'s children

Name Cardinality

context-root Only one

web-uri Only one

<web>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(web-uri, context-root)

<web-uri>

Child of web

The web-uri element specifies the URI of a web application file, relative to the top level of the application package.

Used in: web

<web-uri>'s attributes

Name Values Default

id Match the ID rules.

@id	Attribute of alt-dd

The ID mechanism is to allow tools that produce additional deployment information (i.e., information beyond the standard deployment descriptor information) to store the non-standard information in a separate file, and easily refer from these tool-specific files to the information in the standard deployment descriptor.

Tools are not allowed to add the non-standard information into the standard deployment descriptor.