WebLogic Server Configuration Reference

 Previous Next Contents Index View as PDF  

JDBCConnectionPool

 


Description

This bean defines a JDBC connection pool.

 


Syntax

<JDBCConnectionPool
ACLName="String"
CapacityIncrement="number"
ConnLeakProfilingEnabled=( "true" | "false" )
CountOfRefreshFailuresTillDisable="number"
CountOfTestFailuresTillFlush="number"
DeploymentOrder="number"
DriverName="String"
EnableResourceHealthMonitoring=( "true" | "false" )
InitialCapacity="number"
LoginDelaySeconds="number of seconds"
MaxCapacity="number"
Name="String"
Notes="String"
Password="String"
PreparedStatementCacheSize="number"
Properties="java.util.Properties"
RefreshMinutes="number of minutes"
ShrinkPeriodMinutes="number of minutes"
ShrinkingEnabled=( "true" | "false" )
SqlStmtProfilingEnabled=( "true" | "false" )
SupportsLocalTransaction=( "true" | "false" )
Targets="list of Target names"
TestConnectionsOnRelease=( "true" | "false" )
TestConnectionsOnReserve=( "true" | "false" )
TestTableName="String"
URL="String"
XAPassword="String"
XAPreparedStatementCacheSize="number"
/>

 


Parent Elements

 


Attributes

Table 17-1 JDBCConnectionPool attributes

Attribute

Description

Range of Values and Default

ACLName

Deprecated. Returns the ACL used to control access to this Connection Pool.

Admin Console field label: ACLName

Required: no

CapacityIncrement

Increment by which the connection pool capacity is expanded. When there are no more available physical connections to service requests, the connection pool will create this number of additional physical database connections and add them to the connection pool. The connection pool will ensure that it does not exceed the maximum number of physical connections as set by MaxCapacity.

Admin Console field label: Capacity Increment

Required: no

Default: 1

Minimum: 1

Maximum: 231-1

ConnLeakProfilingEnabled

This property enables JDBC Connection leak profiling.

A Connection leak occurs when a connection from the pool is not closed explicitly by calling close() on that connection.

When connection leak profiling is active, the pool will store 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 feature uses extra resources and will likely slowdown Connection Pool operations, so it is not recommended for production use.

Required: no

Default: false

Secure value: false

CountOfRefreshFailuresTillDisable

Set the number of consecutive failures to replace dead pool connections before we disable the pool. Zero means we will never disable the pool.

Required: no

Default: 0

CountOfTestFailuresTillFlush

Set the number of consecutive failed pool connection tests before we close all the connections the pool. Zero means we will never close all the connections in the pool.

Required: no

Default: 0

DeploymentOrder

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type. For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

Required: no

Default: 1000

Minimum: 0

Maximum: 231-1

DriverName

The full package name of the JDBC 2-tier driver class used to create the physical connections between WebLogic Server and the DBMS for this connection pool. For example:

com.pointbase.jdbc.jdbcUniversalDriver

It must be the name of a class that implements the java.sql.Driver interface. Check the documentation for the JDBC driver to find the full pathname.

Admin Console field label: Driver Classname

Required: no

EnableResourceHealthMonitoring

Returns true if JTA resource health monitoring is enabled for this XA connection pool.

This property applies to XA connection pools only, and is ignored for connection pools that use a non-XA driver.

Required: no

Default: true

InitialCapacity

The number of physical database connections to create when creating the connection pool.

Admin Console field label: Initial Capacity

Required: no

Default: 1

Minimum: 0

Maximum: 231-1

LoginDelaySeconds

The number of seconds to delay before creating each physical database connection. This delay takes place both during initial pool creation and during the lifetime of the pool whenever a physical database connection is created.

Admin Console field label: Login Delay Seconds

Required: no

Units: seconds

Default: 0

Minimum: 0

Maximum: 231-1

MaxCapacity

Maximum number of physical database connections that this connection pool can contain. Different JDBC Drivers and database servers may limit the number of possible physical connections.

Admin Console field label: Maximum Capacity

Required: no

Default: 15

Minimum: 1

Maximum: 231-1

Name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Admin Console field label: Name

Required: no

Notes

Optional information that you can include to describe this configuration.

Admin Console field label: Notes

Required: no

Password

Returns the database password as set with setPassword() or as a key=value pair in setProperties().

Admin Console field label: Password

Required: no

Encrypted: yes

PreparedStatementCacheSize

Sets size of the prepared statement cache. The size of the cache is a number of prepared statements created from particular connection and stored in the cache for further use. Setting the size of the prepared statement cache to 0 The number of prepared statements stored in the cache for further use. WebLogic Server can reuse prepared statements in the cache without reloading them, which can increase server performance. Setting the size of the prepared statement cache to 0 (the default) turns it off.

Admin Console field label: Prepared Statement Cache Size

Required: no

Default: 5

Properties

Returns the list of properties passed to the the 2-tier JDBC Driver to use when creating physical database connections.

Admin Console field label: Properties (key=value)

Required: no

RefreshMinutes

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

Admin Console field label: Refresh Period

Required: no

Units: minutes

Default: 0

Minimum: 0

Maximum: 35791394

ShrinkPeriodMinutes

Number of minutes to wait before shrinking a connection pool that has incrementally increased to meet demand. ShrinkingEnabled must be set to true for a connection pool to shrink.

Admin Console field label: Shrink Period

Required: no

Units: minutes

Default: 15

Minimum: 1

Maximum: 231-1

ShrinkingEnabled

Indicates whether or not the pool can shrink back to its InitialCapacity when it is detected that connections created during increased traffic are not being used.

Admin Console field label: Allow Shrinking

Required: no

Default: true

Secure value: true

SqlStmtProfilingEnabled

SQL roundtrip profiling stores SQL statement text, execution time and other metrics.

Required: no

Default: false

SupportsLocalTransaction

Set to true if the XA driver used to create physical database connections supports SQL without global transactions. Set to false (the default) if the XA driver does not support SQL without global transactions.

This property applies to connection pools that use an XA driver only, and is ignored for connection pools that use non-XA drivers.

Admin Console field label: Supports Local Transaction

Required: no

Default: false

Targets

The targets in the current domain on which this item can be deployed.

Admin Console field label: Targets

Required: no

TestConnectionsOnRelease


Admin Console field label: Test Released Connections

Required: no

Default: false

TestConnectionsOnReserve


Admin Console field label: Test Reserved Connections

Required: no

Default: false

TestTableName

The name of the table used when testing a physical database connection. The default SQL code used to test a connection is

"select count(*) from TestTableName"

The TestTableName must exist and be accessible to the database user for the connection. Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set TestTableName to the name of a table that is known to have few rows, or even no rows.

If TestTableName begins with "SQL ", then the rest of the string following that leading token will be taken as a literal sql statement that will be used to test a connection.

Admin Console field label: Test Table Name

Required: no

URL

Returns the database URL used to create the connections in this Connection Pool.

Admin Console field label: URL

Required: no

XAPassword

If set, this value overrides the password in the open string. This password is used to create physical XA database connections. The value is stored in an encrypted form in the config.xml file. This value overrides any password value in the open string defined in Properties.

Admin Console field label: Open String Password

Required: no

Encrypted: yes

XAPreparedStatementCacheSize


Admin Console field label: XAPrepared Statement Cache Size

Required: no

Default: 5

 

Back to Top Previous Next