Show TOC Start of Content Area

Object documentation appclient-j2ee-engine.xsd  Locate the document in its SAP Library structure

Definition

An XML schema used for creating XML documents to customize an application client at deploy time.

Use

This XML is not required for the proper deployment of the application client. You can use it to specify the resources that the application client accesses.

Structure

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

This graphic is explained in the accompanying text

XML Schema Description

Schema Element / Attribute

Description

appclient-j2ee-engine

The root element for this XML schema. It contains declarations of resource references, resource environment references, enterprise bean references, server component references, message destination references, message destination, and persistence unit references.

resource-ref

Contains information about a reference to a resource that the application client uses. This information enables the client to look up the resource reference and to access the necessary resource associated to the reference.

Used in: appclient-j2ee-engine.

Contains: res-ref-name, res-link.

res-ref-name

Defines the name of the resource reference. The client looks up the reference by its name. It must be the same as the name specified in the application-client.xml.

Used in:  resource-ref .

res-link

Specifies the JNDI name of the resource that is linked to the resource reference. The value of this tag depends on the type of the referenced resource:

      for resources of type javax.sql.DataSource it is either the value of the <data-source-name>, or the value of the <alias> tag you specified in the data-sources.xml descriptor. If you have used the data-source-aliases.xml instead, the value of this tag must be the same as the value of the <alias> tag for the corresponding DataSource.

      for resources of type javax.jms.QueueConnectionFactory and javax.jms.TopicConnectionFactory, it is either the value of the <factory-name>, or the value of the <alias> tag you specified in the jms-factories.xml descriptor.

      for resources of type javax.resource.cci.ConnectionFactory, it is either the value of the <jndi-name> tag, or the value of the <alias> tag you specified in the connector-j2ee-engine.xml descriptor. Or if you have not used the connector-j2ee-engine.xml descriptor at all (since it is not mandatory), the value of this tag is equivalent to the name of the corresponding RAR file (not including the .rar file extension).

Used in: resource-ref.

resource-env-ref

Encapsulates information about the references from the application client to administered objects. For example, JMS Destination or ConnectionFactory objects.

Used in: appclient-j2ee-engine.

Contains: resource-env-ref-name, jndi-name.

resource-env-ref-name

Defines the name of the resource environment reference entry.

Used in: resource-env-ref.

jndi-name

Specifies the JNDI name of a referenced resource. Depending on the scheme element this tag is used in, it can have different possible values. If used in:

      resource-env-ref element, then the value of this tag must be the same as the name of the resource environment entry that you specified in the <destination-name> tag of the jms-destinations.xml descriptor.

      ejb-ref element, then:

       if you have specified a custom JNDI name for your enterprise bean using the <jndi-name> tag of the ejb-j2ee-engine.xml descriptor, the value of this tag must be the same.

       if you have not specified a custom JNDI name for your enterprise bean, then the JNDI name of the bean has the following format: <provider name>/<application name>/<enterprise bean name>.

  • server-component-ref element, then the value of this tag must be the name used to bind the corresponding server component in the JNDI tree.

Used in: resource-env-ref, ejb-ref, server-component-ref, message-destination.

ejb-ref

Contains information about an EJB that is referenced by the application client. This information is used for lookup operations.

Used in: appclient-j2ee-engine.

Contains: ejb-ref-name , jndi-name.

ejb-ref-name

Specifies the name of the EJB reference.

Used in: ejb-ref.

server-component-ref

Deprecated.

Contains information about the server component referenced by the application client.

Used in: appclient-j2ee-engine.

Contains: description, name, type, jndi-name.

description

Provides descriptive text about the server component that is referenced. This element is optional.

Used in: server-component-ref.

name

Deprecated.

Specifies the name of the referenced server component.

Used in: server-component-ref.

type

Deprecated.

Specifies the type of the referenced server component. The values of this tag can be:

      Service

      Interface

Used in: server-component-ref.

message-destination

Additional information for message destination specified in application-client.xml

Used in: appclient-j2ee-engine.

Contains: message-destination-name, jndi-name.

message-destination-name

The name of the message destination to use.

Used in: message-destination.

persistence-unit-ref

Defines a reference to a persistence unit.

Used in: appclient-j2ee-engine.

Contains: persistence-unit-ref-name.

persistence-unit-ref-name

The name of the reference to the persistence unit.

Used in: persistence-unit-ref.

jndi-name

The JNDI name of the persistence unit.

Used in: persistence-unit-ref.

 

End of Content Area