<data-source-jndi-name>

Required

1

Specifies the JNDI name in the application-specific JNDI tree.

<connection-factory>

Required

1

Specifies the connection parameters that define overrides for default connection factory settings.

• user-name—Optional. The user-name element is used to override UserName in the JDBCDataSourceFactoryMBean.

• url—Optional. The url element is used to override URL in the JDBCDataSourceFactoryMBean.

• driver-class-name—Optional. The driver-class-name element is used to override DriverName in the JDBCDataSourceFactoryMBean.

• connection-params—Zero or more.

• parameter+ (param-value, param-name)—One or more

For more information on the elements you can define within the connection-factory element, refer to connection-factory.

<pool-params>

Optional

1

Defines parameters that affect the behavior of the pool.

For more information on the elements you can define within the pool-params element, refer to pool-params.

<driver-params>

Optional

1

Sets behavior on WebLogic Server drivers.

For more information on the elements you can define within the driver-params element, refer to driver-params.

<acl-name>

Optional

1

DEPRECATED.

<factory-name>

Optional

1

Specifies the name of a JDBCDataSourceFactoryMBean in the config.xml file.

<connection-properties>

Optional

1

Specifies the connection properties for the connection factory. Elements that can be defined for the connection-properties element are:

• user-name—Optional. Used to override UserName in the JDBCDataSourceFactoryMBean.

• password—Optional. Used to override Password in the JDBCDataSourceFactoryMBean.

• url—Optional. Used to override URL in the JDBCDataSourceFactoryMBean.

• driver-class-name—Optional. Used to override DriverName in the JDBCDataSourceFactoryMBean

• connection-params—Zero or more. Used to set parameters which will be passed to the driver when making a connection. Example:

<connection-params>
<parameter>
<description>Desc of param
</description>
<param-name>foo</param-name>
<param-value>xyz</param-value>
</parameter>
</connection-params>

<size-params>

Optional

1

Defines parameters that affect the number of connections in the pool.

• initial-capacity—Optional. The initial-capacity element defines the number of physical database connections to create when the pool is initialized. The default value is 1.

• max-capacity—Optional. The max-capacity element defines the maximum number of physical database connections that this pool can contain. Note that the JDBC Driver may impose further limits on this value. The default value is 1.

• capacity-increment—Optional. The capacity-increment element defines the increment by which the pool capacity is expanded. When there are no more available physical connections to service requests, the pool creates this number of additional physical database connections and adds them to the pool. The pool ensures that it does not exceed the maximum number of physical connections as set by max-capacity. The default value is 1.

• shrinking-enabled—Optional. The shrinking-enabled element indicates whether or not the pool can shrink back to its initial-capacity when connections are detected to not be in use.

• shrink-period-minutes—Optional. The shrink-period-minutes element defines the number of minutes to wait before shrinking a connection pool that has incrementally increased to meet demand. The shrinking-enabled element must be set to true for shrinking to take place.

• shrink-frequency-seconds—Optional.

• highest-num-waiters—Optional.

• highest-num-unavailable—Optional.

<xa-params>

Optional

1

Defines the parameters for the XA DataSources.

• debug-level—Optional. Integer. The debug-level element defines the debugging level for XA operations. The default value is 0.

• keep-conn-until-tx-complete-enabled—Optional. Boolean. If you set the keep-conn-until-tx-complete-enabled element to true, the XA connection pool associates the same XA connection with the distributed transaction until the transaction completes.

• end-only-once-enabled—Optional. Boolean. If you set the end-only-once-enabled element to true, the XAResource.end() method is only called once for each pending XAResource.start() method.

• recover-only-once-enabled—Optional. Boolean. If you set the recover-only-once-enabled element to true, recover is only called one time on a resource.

• tx-context-on-close-needed—Optional. Set the tx-context-on-close-needed element to true if the XA driver requires a distributed transaction context when closing various JDBC objects (for example, result sets, statements, connections, and so on). If set to true, the SQL exceptions that are thrown while closing the JDBC objects in no transaction context are swallowed.

• new-conn-for-commit-enabled—Optional. Boolean. If you set the new-conn-for-commit-enabled element to true, a dedicated XA connection is used for commit/rollback processing of a particular distributed transaction.

<xa-params> Continued...

Optional

1

• prepared-statement-cache-size—Deprecated. Optional. Use the prepared-statement-cache-size element to set the size of the prepared statement cache. The size of the cache is a number of prepared statements created from a particular connection and stored in the cache for further use. Setting the size of the prepared statement cache to 0 turns it off.

Note: Prepared-statement-cache-size is deprecated. Use cache-size in driver-params/prepared-statement. See driver-params for more information.

• keep-logical-conn-open-on-release—Optional. Boolean. Set the keep-logical-conn-open-on-release element to true, to keep the logical JDBC connection open when the physical XA connection is returned to the XA connection pool. The default value is false.

• local-transaction-supported—Optional. Boolean. Set the local-transaction-supported to true if the XA driver supports SQL with no global transaction; otherwise, set it to false. The default value is false.

• resource-health-monitoring-enabled—Optional. Set the resource-health-monitoring-enabled element to true to enable JTA resource health monitoring for this connection pool.

<xa-params> Continued...

Optional

1

• xa-set-transaction-timeout—Optional.

Used in: xa-params

Example:

<xa-set-transaction-timeout>

true

</xa-set-transaction-timeout>

• xa-transaction-timeout—Optional.

When the xa-set-transaction-timeout value is set to true, the transaction manager invokes setTransactionTimeout on the resource before calling XAResource.start. The Transaction Manager passes the global transaction timeout value. If this attribute is set to a value greater than 0, then this value is used in place of the global transaction timeout.

Default value: 0

Used in: xa-params

Example:

<xa-transaction-timeout>

30

</xa-transaction-timeout>

• rollback-localtx-upon-connclose—Optional.

When the rollback-localtx-upon-connclose element is true, the connection pool calls rollback() on the connection before putting it back in the pool.

Default value: false

Used in: xa-params

Example:

<rollback-localtx-upon-connclose>

true </rollback-localtx-upon-connclose>

<login-delay-seconds>

Optional

1

Sets the number of seconds to delay before creating each physical database connection. Some database servers cannot handle multiple requests for connections in rapid succession. This property allows you to build in a small delay to let the database server catch up. This delay occurs both during initial pool creation and during the lifetime of the pool whenever a physical database connection is created.

<leak-profiling-enabled>

Optional

1

Enables JDBC connection leak profiling. A connection leak occurs when a connection from the pool is not closed explicitly by calling the close() method on that connection. When connection leak profiling is active, the pool stores the stack trace at the time the connection object is allocated from the pool and given to the client. When a connection leak is detected (when the connection object is garbage collected), this stack trace is reported.

This element uses extra resources and will likely slowdown connection pool operations, so it is not recommended for production use.

<connection-check-params>

Optional

1

• Defines whether, when, and how connections in a pool is checked to make sure they are still alive.

• table-name—Optional. The table-name element defines a table in the schema that can be queried.

• check-on-reserve-enabled—Optional. If the check-on-reserve-enabled element is set to true, then the connection will be tested each time before it is handed out to a user.

• check-on-release-enabled—Optional. If the check-on-release-enabled element is set to true, then the connection will be tested each time a user returns a connection to the pool.

• refresh-minutes—Optional. If the refresh-minutes element is defined, a trigger is fired periodically (based on the number of minutes specified). This trigger checks each connection in the pool to make sure it is still valid.

• check-on-create-enabled—Optional. If set to true, then the connection will be tested when it is created.

• connection-reserve-timeout-seconds—Optional. Number of seconds after which the call to reserve a connection from the pool will timeout.

• connection-creation-retry-frequency-seconds—Optional. The frequency of retry attempts by the pool to establish connections to the database.

• inactive-connection-timeout-seconds—Optional. The number of seconds of inactivity after which reserved connections will forcibly be released back into the pool.

<connection-check-params>

Continued...

Optional

1

• test-frequency-seconds—Optional. The number of seconds between database connection tests. After every test-frequency-seconds interval, unused database connections are tested using table-name. Connections that do not pass the test will be closed and reopened to re-establish a valid physical database connection. If table-name is not set, the test will not be performed.

• init-sql—Optional. Specifies a SQL query that automatically runs when a connection is created.

<jdbcxa-debug-level>

Optional

1

This is an internal setting.

<remove-infected-connections-enabled>

Optional

1

Controls whether a connection is removed from the pool when the application asks for the underlying vendor connection object. Enabling this attribute has an impact on performance; it essentially disables the pooling of connections (as connections are removed from the pool and replaced with new connections).

<statement>

Optional

1

Defines the driver-params statement. Contains the following optional element: profiling-enabled.

Example:

<statement>
<profiling-enabled>true
</profiling-enabled>
</statement>

<prepared-statement

Optional

1

Enables the running of JDBC prepared statement cache profiling. When enabled, prepared statement cache profiles are stored in external storage for further analysis. This is a resource-consuming feature, so it is recommended that you turn it off on a production server. The default value is false.

• profiling-enabled—Optional.

• cache-profiling-threshold—Optional. The cache-profiling-threshold element defines a number of statement requests after which the state of the prepared statement cache is logged. This element minimizes the output volume. This is a resource-consuming feature, so it is recommended that you turn it off on a production server.

• cache-size—Optional. The cache-size element returns the size of the prepared statement cache. The size of the cache is a number of prepared statements created from a particular connection and stored in the cache for further use.

• parameter-logging-enabled—Optional. During SQL roundtrip profiling it is possible to store values of prepared statement parameters. The parameter-logging-enabled element enables the storing of statement parameters. This is a resource-consuming feature, so it is recommended that you turn it off on a production server.

• max-parameter-length—Optional. During SQL roundtrip profiling it is possible to store values of prepared statement parameters. The max-parameter-length element defines maximum length of the string passed as a parameter for JDBC SQL roundtrip profiling. This is a resource-consuming feature, so you should limit the length of data for a parameter to reduce the output volume.

• cache-type—Optional.

<row-prefetch-enabled>

Optional

1

Specifies whether to enable row prefetching between a client and WebLogic Server for each ResultSet.

When an external client accesses a database using JDBC through Weblogic Server, row prefetching improves performance by fetching multiple rows from the server to the client in one server access. WebLogic Server ignores

this setting and does not use row prefetching when the client and WebLogic Server are in the same JVM

<row-prefetch-size>

Optional

1

Specifies the number of result set rows to prefetch for a client.

The optimal value depends on the particulars of the query. In general, increasing this number increases performance, until a particular value is reached. At that point further increases do not result in any significant increase in performance.

Note: Typically you will not see any increase in performance after 100 rows. The default value should be adequate for most situations.

Valid values for this element are between 2 and 65536. The default value is 48.

<stream-chunk-size>

Optional

1

Specifies the data chunk size for streaming data types, which are pulled from WebLogic Server to the client as needed.

<realm-name>

Optional

1

Names a security realm to be used by the application. If none is specified, the system default realm is used

<security-role-assignment>

Optional

Unbounded

Declares a mapping between an application-wide security role and one or more WebLogic Server principals.

Example:

<security-role-assignment>
<role-name>
PayrollAdmin
</role-name>
<principal-name>
Tanya
</principal-name>
<principal-name>
Fred
</principal-name>
<principal-name>
system
</principal-name>
</security-role-assignment>

<startup-class>

Required

1

Defines the name of the class to be run when the application is being deployed.

<startup-uri>

Optional

1

Defines a JAR file within the EAR that contains the startup-class. If startup-uri is not defined, then its assumed that the class is visible to the application.

<shutdown-class>

Required

1

Defines the name of the class to be run when the application is undeployed.

<shutdown-uri>

Optional

1

Defines a JAR file within the EAR that contains the shutdown-class. If you do not define the shutdown-uri element, it is assumed that the class is visible to the application.

<name>

Required

1

The name of the Work Manager.

<response-time-request-class>

Optional

1

See the description of the <response-time-request> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <fair-share-request-class>, <context-request-class>, or <request-class-name>.

<fair-share-request-class>

Optional

1

See the description of the <fair-share-request> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <response-time-request-class>, <context-request-class>, or <request-class-name>.

<context-request-class>

Optional

1

See the description of the <context-request> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <fair-share-request-class>, <response-time-request-class>, or <request-class-name>.

<request-class-name>

Optional

1

The name of the request class.

If you specify this element, you cannot also specify <fair-share-request-class>, <context-request-class>, or <response-time-request-class>.

<min-threads-constraint>

Optional

1

See the description of the <min-threads-constraint> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <min-threads-constaint-name>.

<min-threads-constraint-name>

Optional

1

The name of the min-threads constraint.

If you specify this element, you cannot also specify <min-threads-constaint>.

<max-threads-constraint>

Optional

1

See the description of the <max-threads-constraint> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <max-threads-constaint-name>.

<max-threads-constraint-name>

Optional

1

The name of the max-threads constraint.

If you specify this element, you cannot also specify <max-threads-constaint>.

<capacity>

Optional

1

See the description of the <capacity> element in weblogic-application for information on this child element of <work-manager>.

If you specify this element, you cannot also specify <capacity-name>.

<capacity-name>

Optional

1

The name of the thread capacity constraint.

If you specify this element, you cannot also specify <capacity>.

<work-manager-shutdown-trigger>

Optional

1

Used to specify a Stuck Thread Work Manager component that can shut down the Work Manager in response to stuck threads.

You can specify the following child elements:

• max-stuck-thread-time—The maximum amount of time, in seconds, that a thread should remain stuck.

• stuck-thread-count—Number of stuck threads that triggers the stuck thread work manager.

If you specify this element, you cannot also specify <ignore-stuck-threads>.

<ignore-stuck-threads>

Optional

1

Specifies whether the Work Manager should ignore stuck threads and never shut down even if threads become stuck.

If you specify this element, you cannot also specify <work-manager-shutdown-trigger>.

<library-name>

Required

1

Specifies the name of the referenced shared J2EE library.

<specification-version>

Optional

1

Specifies the minimum specification-version required.

<implementation-version>

Optional

1

Specifies the minimum implementation-version required.

<exact-match>

Optional

1

Specifies whether there must be an exact match between the specification and implementation version that is specified and that of the referenced library.

Default value is false.

<context-root>

Optional

1

Specifies the context-root of the references Web Applications shared J2EE library.