A weblogic-ra.xml Schema
weblogic-ra.xml
file. The schema for weblogic-ra.xml
is http://xmlns.oracle.com/weblogic/weblogic-connector/1.5/weblogic-connector.xsd
. If your resource adapter archive (RAR) does not contain a weblogic-ra.xml
deployment descriptor, WebLogic Server automatically selects the default values of the deployment descriptor elements.
- weblogic-connector
Theweblogic-connector
element is the root element of the WebLogic-specific deployment descriptor for the deployed resource adapter. You can define the following elements within theweblogic-connector
element. - work-manager
Thework-manager
element is a complex element that is used to specify all the configurable elements for creating the Work Manager that will be used by the resource adapter bean. - connector-work-manager
Theconnector-work-manager
element is a complex element that is used to specify all the configurable elements for the Connector Work Manager for the resource adapter module. - security
Thesecurity
complex element contains default security information that can be configured for the connector container. - properties
Theproperties
element, a subelement ofweblogic-connector
, is a container for properties specified for the resource adapter bean inra.xml
. It holds one more or moreproperty
elements. - admin-objects
Theadmin-objects
complex element defines all of the admin objects in the resource adapter. - outbound-resource-adapter
Theoutbound-resource-adapter
element is a sub-element of theweblogic-connector
element. You can define the following elements within theoutbound-resource-adapter
element.
weblogic-connector
The weblogic-connector
element is the root element of the WebLogic-specific deployment descriptor for the deployed resource adapter. You can define the following elements within the weblogic-connector
element.
Table A-1 weblogic-connector subelements
Element | Required/Optional | Description |
---|---|---|
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 byJSR 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: 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 |
enable-global-access-to-classes |
Optional |
When set to When set to The default value is This value normally should be set to When set to |
deploy-as-a-whole |
Optional |
When set to When set to Default value: |
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 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 |
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 |
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 For subelements of |
admin-objects |
Optional |
This complex element defines all of the admin objects in a resource adapter. As with the
For |
outbound-resource-adapter |
Optional |
This complex element is used to describe the outbound components of a resource adapter. As with the admin-objects
For |
Parent topic: weblogic-ra.xml Schema
work-manager
work-manager
element is a complex element that 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 following subelements can be configured in the work-manager
element.
Table A-2 work-manager subelements
Element | Required/Optional | Description |
---|---|---|
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. |
|
Optional |
A
|
|
Optional |
You can choose between the following two elements:
|
|
Optional |
You can choose between the following two elements:
|
|
Optional |
You can choose between the following two elements:
|
Parent topic: weblogic-ra.xml Schema
connector-work-manager
connector-work-manager
element is a complex element that is used to specify all the configurable elements for the Connector Work Manager for the resource adapter module. This element provides configurations that are not supported by the standard WebLogic Work Manager. The following subelement can be configured in the connector-work-manager
element.
Table A-3 connector-work-manager subelement
Element | Required/Optional | Description |
---|---|---|
max-concurrent-long-running-requests |
Optional |
Specifies the maximum number of concurrent long-running Because each long-running Default value: 10 |
Parent topic: weblogic-ra.xml Schema
security
security
complex element contains default security information that can be configured for the connector container. For more information, see Configuring Security Identities for Resource Adapters.
Table A-4 security subelements
Element | Required/Optional | Description |
---|---|---|
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 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 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 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 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 Two choices related to establishing the caller identity for a work instance are described in JSR 322: Java EE Connector Architecture 1.6:
The element See security-work-context, for subelements of this element. |
- default-principal-name
- manage-as-principal-name
- run-as-principal-name
- run-work-as-principal-name
- security-work-context
Parent topic: weblogic-ra.xml Schema
default-principal-name
The default-principal-name
element contains the following subelements.
Table A-5 default-principal-name subelements
Element | Required/Optional | Description |
---|---|---|
use-anonymous-identity |
Required |
Specifies that the anonymous identity should be used. |
principal-name |
Required |
Specifies that the principal name should be used. This should match a defined WebLogic Server user name. |
Parent topic: security
manage-as-principal-name
The manage-as-principal-name
element contains the following subelements.
Table A-6 manage-as-principal-name subelements
Element | Required/Optional | Description |
---|---|---|
use-anonymous-identity |
Required |
Specifies that the anonymous identity should be used. |
principal-name |
Required |
Specifies that the principal name should be used. This should match a defined WebLogic Server user name. |
Parent topic: security
run-as-principal-name
The run-as-principal-name
element contains the following subelements.
Table A-7 run-as-principal-name subelements
Element | Required/Optional | Description |
---|---|---|
use-anonymous-identity |
Required |
Specifies that the anonymous identity should be used. |
principal-name |
Required |
Specifies that the principal name should be used. This should match a defined WebLogic Server user name. |
use-caller-identity |
Required |
Specifies that the caller's identity should be used. |
Parent topic: security
run-work-as-principal-name
The run-work-as-principal-name
element contains the following subelements.
Table A-8 run-work-as-principal-name subelements
Element | Required/Optional | Description |
---|---|---|
use-anonymous-identity |
Required |
Specifies that the |
principal-name |
Required |
Specifies that the principal name should be used. This should match a defined WebLogic Server user name. |
use-caller-identity |
Required |
Specifies that the caller's identity should be used. |
Parent topic: security
security-work-context
The security-work-context
element contains the following subelements.
Table A-9 security-work-context subelements
Element | Required/Optional | Description |
---|---|---|
inbound-mapping-required |
Optional |
The default value is If set to Default value: |
caller-principal-default-mapped |
Optional |
Specifies the default mapping for EIS user names to either a specific WebLogic user name or the WebLogic user That is, if no WebLogic user name is found for an EIS user, this default mapping is used. See caller-principal-default-mapped, for subelements of this element. |
caller-principal-mapping |
Optional |
Specifies the mapping of an EIS user name to either a specific WebLogic user name or the WebLogic See caller-principal-mapping, for subelements of this element. |
group-principal-default-mapped |
Optional |
Specifies the default mapping for EIS group names to a specific WebLogic group name. That is, if no WebLogic group name is found for an EIS group, this default mapping is used. |
group-principal-mapping |
Optional |
Specifies the mapping of an EIS group name to specific WebLogic group name. There may be zero or more See group-principal-mapping, for subelements of this mapping. |
Parent topic: security
caller-principal-default-mapped
The caller-principal-default-mapped
element contains the following subelements.
Table A-10 caller-principal-default-mapped subelements
Element | Required/Optional | Description |
---|---|---|
use-anonymous-identity |
Required |
Specifies that the WebLogic |
principal-name |
Required |
Specifies that the principal name should be used. This should match a WebLogic user name defined in the WebLogic security realm. |
Parent topic: security-work-context
caller-principal-mapping
The caller-principal-mapping
complex element is used to specify a mapping from an EIS group name to WebLogic group name. It contains the following subelements.
Table A-11 caller-principal-mapping subelements
Element | Required/Optional | Description |
---|---|---|
eis-caller-principal |
Required |
Specifies an EIS user principal name. |
mapped-caller-principal |
Required |
Specifies either the mapped WebLogic user principal name or the |
Parent topic: security-work-context
group-principal-mapping
The group-principal-mapping
element contains the following subelements.
Table A-12 group-principal-mapping subelements
Element | Required/Optional | Description |
---|---|---|
eis-group-principal |
Required |
Specifies an EIS group principal name. |
mapped-group-principal |
Required |
Specifies the mapped WebLogic group principal name. |
Parent topic: security-work-context
properties
The properties
element, a subelement of weblogic-connector
, is a container for properties specified for the resource adapter bean in ra.xml
. It holds one more or more property
elements.
You define property
elements within the properties
element as follows.
Table A-13 properties subelements
Element | Required/Optional | Description |
---|---|---|
property |
Required |
The It holds two subelements:
|
Parent topic: weblogic-ra.xml Schema
admin-objects
admin-objects
complex element defines all of the admin objects in the resource adapter. As with the outbound-resource-adapter complex element, the admin-objects
complex element has three hierarchical property levels that you can specify.
The admin-objects
element is a sub-element of the weblogic-connector
element. You can define the following elements within the admin-objects
element.
Table A-14 admin-objects subelements
Element | Required/Optional | Description |
---|---|---|
default-properties |
Optional |
Specifies the default properties that apply to all admin objects (at the global level) in the resource adapter. The |
admin-object-group |
One or more |
Specifies the default parameters that apply to all admin objects belonging to a particular admin object group specified in the For |
Parent topic: weblogic-ra.xml Schema
admin-object-group
The admin-object-group
element is used to define an admin object group. At the group level, you specify parameters that apply to all admin objects belonging to a particular admin object group specified in the ra.xml
deployment descriptor. The properties specified in the group override any parameters that are specified at the global level.
The admin-object-interface
element (a subelement of the admin-object-group
element) serves as a required unique element (a key) to each admin-object-group
. There must be a one-to-one relationship between the weblogic-ra.xml admin-object-interface
element and the ra.xml adminobject-interface
element.
The admin-object-group
element is a sub-element of the weblogic-connector
element. You can define the following elements within the admin-object-group
element
Table A-15 admin-object-group
Element | Required/Optional | Description |
---|---|---|
admin-object-interface |
Required |
The |
admin-object-class |
Required in 1.6 adapters |
The combination of the
|
default-properties |
Optional |
Specifies all the default properties that apply to all admin objects in this admin object group. The |
admin-object-instance |
One or more |
Specifies one or more admin object instances within the admin object group, corresponding to the admin object instances for the resource adapter. You can specify properties at the instance level and override those provided in the group and global levels. For subelements, see admin-object-instance. |
Parent topic: admin-objects
admin-object-instance
You can define the following subelements under admin-object-instance
.
Table A-16 admin-object-instance subelements
Element | Required/Optional | Description |
---|---|---|
jndi-name |
Required |
The JNDI name used to define the reference name for the connection instance. The connection pool is bound into a JNDI that clients outside the application can see. Note: The Example A- element must be set to |
properties |
Optional |
Defines all the properties that apply to the admin object instance. The |
Parent topic: admin-object-group
outbound-resource-adapter
The outbound-resource-adapter
element is a sub-element of the weblogic-connector
element. You can define the following elements within the outbound-resource-adapter
element.
Table A-17 outbound-resource-adapter subelements
Element | Required/Optional | Description |
---|---|---|
default-connection-properties |
Optional |
This complex element is used to specify the properties at an global level. At this level, the user is able to specify parameters that apply to all outbound connection pools in the resource adapter. For subelements, see default-connection-properties. |
connection-definition-group |
One or more |
This element is used to specify all the connection definition groups. There must be a one-to-one correspondence relationship between the connection factories in the The properties specified in the group override any parameters that are specified at the global level using For subelements, see connection-definition-group. |
default-connection-properties
The default-connection-properties
element is a sub-element of the outbound-resource-adapter
element. You can define the following elements within the default-connection-properties
element.
Table A-18 default-connection-properties subelements
Element | Required/Optional | Description |
---|---|---|
pool-params |
Optional |
Serves as the root element for providing connection pool-specific parameters for this connection factory. WebLogic Server uses these specifications to control the behavior of the maintained pool of ManagedConnections. This is an optional element. Failure to specify this element or any of its specific element items results in default values being assigned. Refer to the description of each individual element for the designated default value. For subelements, see pool-params. |
logging |
Optional |
Contains parameters for configuring logging of the For subelements, see logging. |
transaction-support |
Optional |
Specifies the level of transaction support for a particular Connection Factory. It provides the ability to override the transaction-support value specified in the The value of transaction-support must be one of the following:
For related information, see Connection Management. |
authentication-mechanism |
Optional |
The Note that |
reauthentication-support |
Optional |
A Boolean that specifies whether a particular connection factory supports re-authentication of an existing |
properties |
Optional |
The |
res-auth |
Optional |
Specifies whether to use container- or application-managed security. The values for this element can be one of |
Parent topic: outbound-resource-adapter
pool-params
The pool-params
element is a sub-element of the default-connection-properties
element. You can define the following elements within the pool-params
element.
Table A-19 pool-params subelements
Element | Required/Optional | Description |
---|---|---|
initial-capacity |
Optional |
Specifies the initial number of ManagedConnections, which WebLogic Server attempts to create during deployment. Default Value: 1 |
max-capacity |
Optional |
Specifies the maximum number of ManagedConnections, which WebLogic Server will allow. Requests for newly allocated ManagedConnections beyond this limit results in a Default Value: 10 |
capacity-increment |
Optional |
Specifies the maximum number of additional ManagedConnections that WebLogic Server attempts to create during resizing of the maintained connection pool. Default Value: 1 |
shrinking-enabled |
Optional |
Specifies whether unused ManagedConnections will be destroyed and removed from the connection pool as a means to control system resources. Default Value: true |
shrink-frequency-seconds |
Optional |
Specifies the amount of time (in seconds) the Connection Pool Management waits between attempts to destroy unused ManagedConnections. Default Value: 900 seconds |
highest-num-waiters |
Optional |
Specifies the maximum number of threads that can concurrently block waiting to reserve a connection from the pool. Default Value: 0 |
highest-num-unavailable |
Optional |
Specifies the maximum number of ManagedConnections in the pool that can be made unavailable to the application for purposes such as refreshing the connection. Note that in cases like the backend system being unavailable, this specified value could be exceeded due to factors outside the pool's control. Default Value: 0 |
connection-creation-retry-frequency-seconds |
Optional |
The periodicity of retry attempts by the pool to create connections. Default Value: 0 |
connection-reserve-timeout-seconds |
Optional |
Sets the number of seconds after which the call to reserve a connection from the pool will timeout. Default Value: -1 (do not block when reserving resources) |
test-frequency-seconds |
Optional |
The frequency with which connections in the pool are tested. Default Value: 0 |
test-connections-on-create |
Optional |
Enables the testing of newly created connections. Default Value: false |
test-connections-on-release |
Optional |
Enables testing of connections when they are being released back into the pool. Default Value: false |
test-connections-on-reserve |
Optional |
Enables testing of connections when they are being reserved. Default Value: false |
profile-harvest-frequency-seconds |
Optional |
Specifies how frequently the profile for the connection pool is being harvested. |
ignore-in-use-connections-enabled |
Optional |
When the connection pool is being shut down, this element is used to specify whether it is acceptable to ignore connections that are in use at that time. |
match-connections-supported |
Optional |
Indicates whether the resource adapter supports the Default Value: true |
Parent topic: default-connection-properties
logging
The logging
element is a sub-element of the default-connection-properties
element. You can define the following elements within the logging
element.
Table A-20 logging subelements
Element | Required/Optional | Description |
---|---|---|
log-filename |
Optional |
Specifies the name of the log file from which output generated from the The full address of the filename is required. |
logging-enabled |
Optional |
Indicates whether or not the log writer is set for either the Default Value: false |
rotation-type |
Optional |
Sets the file rotation type. Possible values are
Default Value: |
number-of-files-limited |
Optional |
Specifies whether to limit the number of files that this server instance creates to store old log messages. (Requires that you specify a If you enable Default Value: false |
file-count |
Optional |
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Default Value: 7 |
file-size-limit |
Optional |
The size that triggers the server to move log messages to a separate file. (Requires that you specify a rotation-type of Default Value: 500 |
rotate-log-on-startup |
Optional |
Specifies whether a server rotates its log file during its startup cycle. Default Value: true |
log-file-rotation-dir |
Optional |
Specifies the directory path where the rotated log files will be stored. |
rotation-time |
Optional |
The start time for a time-based rotation sequence of the log file, in the format If the specified time has already past, then the server starts its file rotation immediately. By default, the rotation cycle begins immediately. |
file-time-span |
Optional |
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a Default Value: 24 |
Parent topic: default-connection-properties
connection-definition-group
The connection-definition-group
element is used to define a connection definition group. At the group 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.
The connection-factory-interface
element (a subelement of the connection-definition-group
element) serves as a required unique element (a key) to each connection-definition-group
. There must be a one-to-one relationship between the weblogic-ra.xml connection-definition-interface
element and the ra.xml connectiondefinition-interface
element.
The connection-definition-group
element is a sub-element of the outbound-resource-adapter
element. You can define the following elements within the connection-definition-group
element.
Table A-21 connection-definition-group subelements
Element | Description |
---|---|
connection-factory-interface |
Every connection definition group has a key (a required unique element). This key is the The value specified for |
default-connection-properties |
This complex element is used to define properties for outbound connections at the group level. |
connection-instance |
Under each connection definition group, the user 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 in the group and global levels. This element specifies a description of the connection pool. (A connection instance is equivalent to a connection pool.) It is used to document the connection pool. See connection-instance. |
Parent topic: outbound-resource-adapter
connection-instance
You can define the following subelements under connection-instance
.
Table A-22 connection-instance subelements
Element | Required/Optional | Description |
---|---|---|
description |
Optional |
Specifies a description of the connection instance. |
jndi-name |
Required |
The JNDI name used to define the reference name for the connection instance. |
connection-properties |
Optional |
Defines all the properties that apply to the connection instance. The |
Parent topic: connection-definition-group