A weblogic-ra.xml Schema

native-libdir

Required if native libraries are present.

Specifies the directory where all the native libraries exist that are required by the resource adapter.

jndi-name

Required only if a resource adapter bean is specified.

Specifies the JNDI name for the resource adapter. The resource adapter bean is registered into the JNDI tree with this name. It is not a required element if no resource adapter bean is specified. It is not a functional element if a JNDI name is specified for a resource adapter without a resource adapter bean.

enable-access-outside-app

Optional

As stated by JSR 322: Java EE Connector Architecture 1.6, if the resource adapter is packaged within an application (in other words, within an EAR), only components within the application should have access to the resource adapter. This element allows you to override this functionality.

Note: This element does not apply for standalone resource adapters.

Default Value: false

Note: When set to false, the resource adapter can only be accessed by clients that reside within the same application in which the resource adapter resides.

For version 1.0 resource adapters (supported in this release), the default value for this element is set to true.

enable-global-access-to-classes

Optional

When set to true, the resource adapter allows global access to its classes, and the adapter's classes are loaded by the WebLogic Server system classpath classloader directly so that these classes can be accessed by all applications.

The default value is false, in which case the adapter's classes are loaded by a classloader that is a child of the EAR's application classloader.

This value normally should be set to true for standalone adapters.

When set to true, you must to restart WebLogic Server if you change the adapter's classes and want to redeploy the adapter.

deploy-as-a-whole

Optional

When set to true, the resource adapter deployment fails if any error occurs, such as a failure with an outbound connection pool or an admin object bean.

When set to false, the resource adapter deployment succeeds, but in a HEALTH_CRITICAL state, if an error occurs when creating or configuring at least one outbound connection pool. This setting enables you to isolate, diagnose, and correct a failed outbound connection pool without needing to redeploy the resource adapter. If any other error occurs during deployment, such as the inability to parse or validate the ra.xml or weblogic-ra.xml files, a ResourceAdapter bean failure, or an admin object bean failure, the resource adapter deployment fails.

Default value: true

work-manager

Optional

This complex element is used to specify all the configurable elements for creating the Work Manager that will be used by the resource adapter bean. The work-manager element is imported from the weblogic-javaee.xsd schema.

The Work Manager dynamically adjusts the number of work threads to avoid deadlocks and achieve optimal throughput subject to concurrency constraints. It also meets objectives for response time goals, shares, and priorities.

For subelements of work-manager, see work-manager.

connector-work-manager

Optional

This complex element is used to specify all the configurable elements for the Connector Work Manager for this adapter module itself.

This element provides configurations that are not supported by the standard Work Manager.

For subelements of connector-work-manager, see connector-work-manager.

security

Optional

This complex element is used to specify all the security parameters for the operation of the resource adapter.

See security, for information on the security defaults that will be taken by the connector container.

properties

Optional

This complex element is used to override any properties that have been specified for the resource adapter bean in the ra.xml file.

For subelements of properties, see properties.

admin-objects

Optional

This complex element defines all of the admin objects in a resource adapter. As with the outbound-resource-adapter complex element (see outbound-resource-adapter), the admin-objects complex element has four hierarchical property levels that specify the configuration scope:

1. Global level — at this level, you specify parameters that apply to all admin objects in the resource adapter; you do so using the default-properties element. See default-properties in Table A-14, "admin-objects subelements".

2. Group level — at this level, you specify parameters that apply to all admin objects belonging to a particular admin object group specified in the ra.xml deployment descriptor; you do so using the admin-object-group element. The properties specified in the group override any parameters that are specified at the global level. See admin-object-group.

3. Instance level — under each admin object group, you can use the admin-object-instance element to specify admin object instances. These correspond to the admin object instances for the resource adapter. You can specify properties at the instance level and override those properties provided in the group and global levels. See admin-object-instance.

For admin-objects subelements, see admin-objects.

outbound-resource-adapter

Optional

This complex element is used to describe the outbound components of a resource adapter. As with the admin-objects complex element, this element has three hierarchical property levels that specify the configuration scope for defining outbound connection pools:

1. Global level — at this level, you specify parameters that apply to all outbound connection pools in the resource adapter using the default-connection-properties element. See default-connection-properties.

2. Group level — at this level, you specify parameters that apply to all outbound connections belonging to a particular connection factory specified in the ra.xml deployment descriptor using the connection-definition-group element. A one-to-one correspondence exists from a connection factory in ra.xml to a connection definition group in weblogic-ra.xml. The properties specified in a group override any parameters specified at the global level. See connection-definition-group.

3. The instance level — under each connection definition group, you can specify connection instances. These correspond to the individual connection pools for the resource adapter. Parameters can be specified at this level too and these override those provided at the group and global levels. See connection-instance.

For outbound-resource-adapter subelements, see outbound-resource-adapter.

name

Required

Specifies the name of the Work Manager.

JSR 322: Java EE Connector Architecture 1.6 describes how a resource adapter can submit work threads to the application server. These work threads are managed by the WebLogic Server Work Manager. The Work Manager dynamically adjusts the number of work threads to avoid deadlocks and achieve optimal throughput subject to concurrency constraints. It also meets objectives for response time goals, shares, and priorities.

response-time-request-class
fair-share-request-class
context-request-class
request-class-name

Optional

A work-manager element can include one and only one of the following four elements:

response-time-request-class - Defines the response time request class for the application. Response time is defined with attribute goal-ms in milliseconds. The increment is ((goal - T) Cr)/R, where T is the average thread use time, R the arrival rate, and Cr a coefficient to prioritize response time goals over fair shares.

fair-share-request-class - Defines the fair share request class. Fair share is defined with attribute percentage of default share. Therefore, the default is 100. The increment is Cf/(P R T), where P is the percentage, R the arrival rate, T the average thread use time, and Cf a coefficient for fair shares to prioritize them lower than response time goals.

context-request-class - Defines the context class. Context is defined with multiple cases mapping contextual information, like current user or its role, cookie, or work area fields to named service classes.

request-class-name - Defines the request class name.

min-threads-constraint
min-threads-constraint-name

Optional

You can choose between the following two elements:

min-threads-constraint - Used to guarantee a number of threads the server allocates to requests of the constrained work set to avoid deadlocks. The default is zero. A min-threads value of one is useful, for example, for a replication update request, which is called synchronously from a peer.

min-threads-constraint-name - Defines a name for the min-threads-constraint element.

max-threads-constraint
max-threads-constraint-name

Optional

You can choose between the following two elements:

max-threads-constraint - Limits the number of concurrent threads executing requests from the constrained work set. The default is unlimited. For example, consider a constraint defined with maximum threads of 10 and shared by 3 entry points. The scheduling logic ensures that not more than 10 threads are executing requests from the three entry points combined.

max-threads-constraint-name - Defines a name for the max-threads-constraint element.

capacity
capacity-name

Optional

You can choose between the following two elements:

capacity - Constraints can be defined and applied to sets of entry points, called constrained work sets. The server starts rejecting requests only when the capacity is reached. The default is zero. Note that the capacity includes all requests, queued or executing, from the constrained work set. This constraint is primarily intended for subsystems like JMS, which do their own flow control. This constraint is independent of the global queue threshold.

capacity-name - Defines a name for the capacity element.

max-concurrent-long-running-requests

Optional

Specifies the maximum number of concurrent long-running Work instance requests allowed for a resource adapter instance.

Because each long-running Work instance request executes in its own thread, an excessive number of long-running Work requests can have a negative affect on server performance and stability. A resource adapter typically needs only a few long-running Work requests, such as periodically listening to a socket or scheduling other Work instances. New long-running Work request submissions are rejected if the number of currently active long-running Work requests exceeds the specified limit.

Default value: 10

default-principal-name

Optional

Specifies the default secure ID to be used for calls into the resource adapter.

If this value is not specified, the default is the anonymous identity, which is the same as no security identity.

See default-principal-name for subelements of this element.

manage-as-principal-name

Optional

Specifies the secure ID to be used for running various resource adapter management tasks, including startup, shutdown, testing, shrinking, and transaction management.

If not specified, it defaults to the default-principal-name value. If default-principal-name is not specified, it defaults to the anonymous identity.

See manage-as-principal-name for subelements of this element.

run-as-principal-name

Optional

Specifies the secure ID to be used by all calls from the connector container into the resource adapter code during connection requests. (This element currently applies only to outbound functions.)

If not specified, it defaults to the default-principal-name value. If default-principal-name is not specified, it uses the identity of the requesting caller.

See run-as-principal-name for subelements of this element.

run-work-as-principal-name

Optional

Specifies the secure ID to be used to run all work instances started by the resource adapter.

If not specified, it defaults to the default-principal-name value. If default-principal-name is not specified, it uses the identity that was used to start the work.

See run-work-as-principal-name for subelements of this element.

security-work-context

Optional

This complex element specifies all security contextual parameters of the WorkContext.

Two choices related to establishing the caller identity for a work instance are described in JSR 322: Java EE Connector Architecture 1.6:

• Case 1: The resource adapter flows an identity into the application server's security policy domain. In this case, the application server may just use the initiating principal, flown-in from the resource adapter, as the caller principal in the security context that the Work instance executes as.

• Case 2: The resource adapter flows in an identity belonging to the EIS security domain. The resource adapter establishes a connection to the EIS and executes a Work instance in the context of an EIS identity. In this case, the initiating or caller principal does not exist in the application server's security domain. A translation from one domain to the other is required to be performed. That is, the user or group name in the EIS security domain is mapped to a corresponding user or group name in the application server's security domain. If no such a user or group mapping is found, the default mapping is applied.

The element inbound-mapping-required specifies whether the flown in identity translation from the EIS security domain to the application server's security domain is required.

See security-work-context, for subelements of this element.