Show TOC

Object documentationapplication-j2ee-engine.xsd Locate this document in the navigation structure

 

This XML schema describes how to specify additional, AS Java-specific information about a Java EE application.

Structure

The application-j2ee-engine.xsd has the following structure:

This graphic is explained in the accompanying text.

XML Schema Description

Schema Element / Attribute

Description

application-j2ee-engine

The root element for this deployment descriptor. It contains information about the different components of a particular application along with the references of the application to other components.

Contains: reference, classpath, provider-name, modules-additional, fail-over-enable, start-up, java-version. Specifies an application reference to another application, library, service, or interface.

Used in: application-j2ee-engine.

Contains: reference-target.

reference

Specifies an application reference to another application, library, service, or interface.

Used in: application-j2ee-engine.

Contains: reference-target.

reference-target

The name of the component that is referenced by the application.

Used in: reference.

Contains: target-type, provider-name.

reference-type

The type of the reference. Possible values are:

  • hard

  • weak

Used in: reference.

target-type

The type of the target that is referenced by the application. Possible values are:

  • application

  • library

  • service interface

Used in: reference-type.

provider-name

The name of the provider of the target that is referenced by the application.

Used in: reference-type.

classpath

Caution Caution

This element is deprecated. You have to use the reference element to refer to the resources that you need. These resources should be packaged in development components.

End of the caution.

Contains the classpath to different resources (JAR or class files) that your application uses, but which are not necessary to be available when you deploy your application. If you call these resources from your application at runtime and they are still not available, you will receive an exception.

The classpath you specify can be either relative to the AS Java root directory, or absolute.

Used in: application-j2ee-engine.

provider-name

The name of the application provider.

Used in: application-j2ee-engine.

modules-additional

Specifies application modules that must be distributed to containers that are not standard Java EE containers, such as WebDynpro, Web services, JMSConnector, and so on.

Used in: application-j2ee-engine.

Contains: module.

module

Specifies a particular application component and the non-Java EE container to which this component must be distributed.

Used in: modules-additional.

Contains: entry-name, container-type.

entry-name

The name of the application component. This name must be the exact entry name of the component in the EAR. For example if your component is located in a directory named xyz in the EAR, then the entry-name of the component must be xyz/component_name.

Used in: module.

container-type

The name of the container to which this component is distributed. To view the containers that are available on the AS Java, execute the CONTAINER_INFO -a shell command.

Used in: module.

fail-over-enable

Enables failover for the application.

Used in: application-j2ee-engine.

Contains: mode, scope.

mode

The fail-over mode. Possible values are:

  • disable – the failover is not enabled. The session data is stored locally for the server node.

  • on_request - the HTTP session is serialized after completing each HTTP request

  • on_attribute - the HTTP session is serialized every time an attribute is added, changed, or removed from the HTTP session

Used in: fail-over-enable

scope

The scope of the fail-over. This is an optional attribute. Possible values are:

  • instance_local – failover in the instance. The session data in this case is accessible only within the instance.

  • cluster_wide – failover in the cluster. The session data is accessible in the whole cluster. In case of on_attribute or on_request failover mode and not specified scope the default is cluster_wide.

start-up

Specifies the start-up mode of the application.

Used in: application-j2ee-engine.

Contains: mode.

mode

The start-up mode of the application. Possible values are:

  • lazy - the application is started when there is a request to it

  • always - the application is started when the server is started

  • manual - application start is disabled

Used in: start-up.

java-version

Specifies the Java EE version of the application.

Used in: application-j2ee-engine.