Show TOC Start of Content Area

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

Definition

An XML schema used to customize a resource adapter for Enterprise Information System (EIS) connectivity at deploy time.

Use

In the AS Java, you can deploy a resource adapter archive (RAR) that complies with the requirements of the J2EE Connector Architecture 1.5 standard.

Structure

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

This graphic is explained in the accompanying text

XML Schema Description

Schema Element / Attribute

Description

connector

The root element of the additional deployment descriptor for the resource adapter. This element includes additional general information for the resource adapter, JNDI name and load references.

description

Provides text describing the parent element. The elements that use this element should include any information that the Deployment Component’s Deployment File file producer wants to provide to the consumer of the Deployment Component’s Deployment File. Typically, the tools used by such a deployment File consumer will display the description when processing the parent element that contains the description. The lang attribute defines the language that the description is provided in. The default value is “en” (English).

Used in: connector

resourceadapter

This element includes additional general information for the resource adapter.

Used in: connector

Contains: ra-jndi-name, outbound-resourceadapter, inbound-resourceadapter, loader-references, workmanager-settings, extended properties

ra-jndi-name

Global name of the resource adapter. This name can be used in the Message-Driven Bean deployment descriptor and properties.

Used in: resourceadapter

outbound-resourceadapter

Additional information for the outbound resource adapter.

Used in: resourceadapter

Contains: connection-definition

connection-definition

Additional information about the definition that is already defined in the schema connection.

Used in: outbound-resourceadapter

Contains: connectionfactory-interface, jndi-name, alias, authentication-mechanism-type, authentication-type, user-store, identity-subject, pool-params

connectionfactory-interface

The fully qualified class name of the interface for this connection definition. The name must be the same as the name specified in the ra.xml.

Used in: connection-definition

jndi-name

The look-up name for the current out bound resource adapter.

Used in: connection-definition

alias

Alternative names that can be used for the lookup.

Used in: connection-definition

destination-name

The name of the security destination to be used.

Used in: connection-definition

authentication-mechanism-type

Specifies whether or not a resource adapter supports a specific authentication mechanism. Supported mechanisms are BasicPassword, SAPAssertionTicket.

Used in: connection-definition

authentication-type

Specifies how the users will be authenticated to EIS system using Caller Impersonation, Credentials Mapping, Configured Identity or Principal Mapping.

Used in: connection-definition

user-store

Deprecated.

Used in: connection-definition

identity-subject

Deprecated.

Used in: connection-definition

Contains: caller-principal, resource-principal

caller-principal

Deprecated.

Used in: identity-subject

Contains: group-name, user-name

group-name

Deprecated.

Used in: caller-principal

user-name

Deprecated.

Used in: caller-principal

resource-principal

Deprecated.

Used in: identity-subject

Contains: user-name, user-password

user-name

Deprecated.

Used in: resource-principal

user-password

Deprecated.

Used in: resource-principal

pool-params

Defines properties for management of the connection pool.

Used in: connection-definition

Contains: max-connections-number, max-time-to-wait-connection, expiration-control

max-connections-number

The maximum number of connections the DataSource can create.

Used in: pool-params

max-time-to-wait-connection

The time to wait for a connection to become free if the <max-connections-number> is reached.

Used in: pool-params

expiration-control

Parameters for connection life control. These are connection lifetime and a period to run a cleanup thread.

Used in: pool-params

Contains: connection-lifetime, run-cleanup-thread-interval

connection-lifetime

The period in seconds a connection can stay. After this period the connection is closed.

Used in: expiration-control

run-cleanup-thread-interval

The period in seconds, after which the system runs a thread to clean up unused connections.

Used in: expiration-control

inbound-resourceadapter

Provides additional information for the inbound resource adapter defined in the ra.xml.

Used in: resourceadapter

Contains: messageadapter

messageadapter

Additional information for the message adapter that is defined in the ra.xml.

Used in: inbound-resourceadapter.

Contains: messagelistener

messagelistener

Additional information for the message listener that is defined in the ra.xml.

Used in: messageadapter.

Contains: messagelistener-type, messagelistener-name

messagelistener-type

The class name of the message listener. This name must be the same as the name defined in the ra.xml.

Used in: messagelistener

messagelistener-name

A unique name for a message listener by which the listener is identified globally .

Used in: messagelistener

loader-references

The references to the class loaders of services, libraries, applications, interfaces for the resource adapter.

Used in: resourceadapter

Contains: loader-name

loader-name

The name of the loader of the component to which you want to have a reference.

Used in: loader-references

strength

The strength of the reference.

Used in: loader-references.

provider-name

The name of the provider of the reference.

Used in: loader-references

property

Additional properties for the resource adapter.

Used in: extended-properties

Contains: description, config-property-name, config-property-value

description

Description of the additional properties.

Used in: property

config-property-name

The name of the additional property.

Used in: property

config-property-value

The value of the additional property.

Used in: property

workmanager-settings

Specifies WorkManager settings.

The WorkManager provides a facility to submit Work instances for execution.

Contains: max-thread-count, start-thread-timeout

max-thread-count

Specifies the maximum concurrent threads that are executing Works.

Used in: workmanager-settings

start-thread-timeout

Deprecated.

Used in: workmanager-settings

template

Specifies if the resource adapter is just a template.

clonning

Properties for cloned resource adapters, which is used only internally for AS Java.

template-app-name

The name of the application from which the adapter is cloned.

template-ra-name

The name of the resource adapter from which the adapter is cloned.

 

End of Content Area