An XML schema used to customize a resource adapter for Enterprise Information System (EIS) connectivity at deploy time.
In the AS Java, you can deploy a resource adapter archive (RAR) that complies with the requirements of the Java EE Connector Architecture 1.5 standard.
The connector-j2ee-engine.xsd has the following structure:
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 displays 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 ra.xml . 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 |
Deprecated. 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 user is 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-principa l |
user-name |
Deprecated. Used in: caller-principa l |
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 ManagedConnectionFactory can create. Default value: 100 Used in: pool-params |
max-time-to-wait-connection |
The time (in seconds) to wait for a connection to become free if the <max-connections-number> is reached. Default value: 60 Used in: pool-params |
expiration-control |
Parameters for connection life control. These are connection lifetime and a period to run a cleanup thread. By default, the expiration control is disabled. 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 |
adminobjects |
Contains definitions of additional admin-objects . Contains: adminobject |
adminobject |
Contains definitions of additional admin-objects which are using one adminobject-interface specified in ra.xml . For each adminobject , jndi-name and config-properties are specified. Used in: adminobjects Contains: adminobject-interface , adminobject-instance |
adminobject-interface |
The adminobject-interface must be defined in ra.xml and must be unique for all adminobject elements. Multiple admin-objects cannot use the same adminobject-interface . Used in: adminobject Example: <adminobject-interface>javax.jms.Destination</adminobject-interface> |
adminobject-instance |
Defines one adminobject-instance which is using the interface defined in the <adminobject-interface> . Used in: adminobject Contains: jndi-name , config-property |
jndi-name |
Specifies the JNDI name of the admin-object configured instance. The jndi-name element content must be unique. Multiple admin-objects cannot use the same jndi-name . Used in: adminobject-instance |
config-property |
The element config-property contains a declaration of a single configuration property for an adminobject-instance . Used in: adminobejct-instance Contains: description , config-property-name , config-property-type , config-property-value |
description |
Provides description of the config-property element. Used in: config-property |
config-property-name |
Contains the name of a configuration property. Used in: config-property |
config-property-type |
Contains the Java type of the configuration property. Possible values: java.lang.Boolean , java.lang.String , java.lang.Integer , java.lang.Doulble , java.lang.Byte , java.lang.Short , java.lang.Long , java.lang.Float , java.lang.Character Used in: config-property Example: <config-property-type>java.lang.String</config-property-type> |
config-property-value |
Contains the value of a configuration entry. Note
It is possible that a resource adapter deployer to override this information during deployment. Used in: config-property |
loader-references |
The references to the class loaders of services, libraries, applications, interfaces for the resource adapter. Note
The specified references are valid only when the resource adapter is deployed as a stand-alone module. In case it is deployed within an application, the specified loader references are ignored, and these in application-j2ee-engine.xml are considered. Used in: resourceadapter Contains: loader-name |
loader-name |
The full name of the loader of the component to which you want to have a reference. Contains information about the component type. Used in: loader-references Example: service:connector |
strength |
The strength of the reference. Possible values: weak , hard Default value: weak Used in: loader-references |
provider-name |
The name of the provider of the referenced component. Used in: loader-references |
property |
Additional properties for the resource adapter. Note
This element is designed for future enhancements of the XML definition. 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. Note
Template resource adapters are used only for creation of cloned instances. If a resource adapter is a template, it is not activated and applications cannot use it directly |
clonning |
Properties for cloned resource adapters. Recommendation
We recommend that you do not use this element. It is designed for AS Java internal usage only. |
template-app-name |
The name of the application from which the adapter is cloned. Recommendation
We recommend that you do not use this element. It is designed for AS Java internal usage only. |
template-ra-name |
The name of the resource adapter from which the adapter is cloned. Recommendation
We recommend that you do not use this element. It is designed for AS Java internal usage only. |