weblogic.management.configuration
Interface JDBCConnectionPoolMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean

public interface JDBCConnectionPoolMBean
extends DeploymentMBean

This bean defines a JDBC connection pool.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

Access limited to the following security roles:

Deployer

setConnLeakProfilingEnabled

void setConnLeakProfilingEnabled(boolean enable)
                                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ConnLeadProfilingEnabled attribute.

Parameters:

enable - The new connLeakProfilingEnabled value

Throws:

InvalidAttributeValueException

See Also:

#isConnLeadProfilingEnabled

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

isConnLeakProfilingEnabled

boolean isConnLeakProfilingEnabled()

Deprecated. 

Specifies that JDBC connection leak information is gathered. This option is required to view leaked connections from the connection pool.

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 connection pool will store the stack trace at the time the Connection object is allocated from the connection 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 slow down connection pool operations, so it is not recommended for production use.

Returns:

The connLeakProfilingEnabled value

Default Value:

false

setConnProfilingEnabled

void setConnProfilingEnabled(boolean enable)
                             throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ConnProfilingEnabled attribute.

Parameters:

enable - The new connProfilingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.isConnProfilingEnabled()

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

isConnProfilingEnabled

boolean isConnProfilingEnabled()

Deprecated. 

Specifies whether the connection pool detects local transaction work left incomplete by application code, which can interfere with subsequent operations related to global (XA) transactions.

When connection profiling is active, the pool will store the stack trace at the time the connection object is released back into the pool by the client. If an exception is thrown during a subsequent operation related to global (XA) transactions, 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.

Returns:

The connProfilingEnabled value

Default Value:

false

isSqlStmtProfilingEnabled

boolean isSqlStmtProfilingEnabled()

Deprecated. 

Specifies whether the connection pool stores SQL statement text, execution time and other metrics.

This is a resource-consuming feature, so it's recommended that it's turned off on a production server.

Returns:

true if JDBC SQL roundtrip profiling enabled

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

setSqlStmtProfilingEnabled

void setSqlStmtProfilingEnabled(boolean enable)
                                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the SqlStmtProfilingEnabled attribute.

Parameters:

enable - The new sqlStmtProfilingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.isSqlStmtProfilingEnabled()

Changes take effect after you redeploy the module or restart the server.

getACLName

String getACLName()

Deprecated. 

The access control list (ACL) used to control access to this connection pool.

Permissions available to this ACL are:

• Reserve

  Allows users to get logical connections from this connection pool.

• Admin

  Allows all other operations on this connection pool, including: reset, shrink, shutdown, disable, and enable.

Lack of an ACL allows any user open access (provided that the user passes other WLS security controls).

Returns:

The aCLName value

setACLName

void setACLName(String name)
                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ACLName attribute.

Parameters:

name - The new aCLName value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getACLName()

getURL

String getURL()

Deprecated. 

The URL of the database to connect to. The format of the URL varies by JDBC driver.

The URL is passed to the JDBC driver to create the physical database connections.

Returns:

The uRL value

setURL

void setURL(String url)
            throws InvalidAttributeValueException

Deprecated. 

Sets the value of the URL attribute.

Parameters:

url - The new uRL value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getURL()

getDriverName

String getDriverName()

Deprecated. 

The full package name of JDBC driver class used to create the physical database connections in the connection pool. (Note that this driver class must be in the classpath of any server to which it is deployed.)

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.

Returns:

The driverName value

setDriverName

void setDriverName(String driverClassName)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the value of the DriverName attribute.

Parameters:

driverClassName - The new driverName value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getDriverName()

getProperties

Properties getProperties()

Deprecated. 

The list of properties passed to the JDBC driver that are used to create physical database connections. List each property=value pair on a separate line.

For example: server=dbserver1.

The list consists of attribute=value tags, separated by semi-colons. For example user=scott;server=myDB.

Note: Oracle recommends that you do not store passwords in this properties list. Instead, store them in PasswordEncrypted so that the value is encrypted in config.xml and in the Administration Console display.

Returns:

The properties value

See Also:

JDBCConnectionPoolMBean.getPasswordEncrypted()

setProperties

void setProperties(Properties props)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the value of the Properties attribute.

Parameters:

props - The new properties value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getProperties()

getLoginDelaySeconds

int getLoginDelaySeconds()

Deprecated. 

The number of seconds to delay before creating each physical database connection.

This delay supports database servers that cannot handle multiple requests for connections in rapid succession

The delay takes place both during initial pool creation and during the lifetime of the pool whenever a physical database connection is created.

Returns:

The loginDelaySeconds value

Default Value:

0

setLoginDelaySeconds

void setLoginDelaySeconds(int secs)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the value of the LoginDelaySeconds attribute.

Parameters:

secs - The new loginDelaySeconds value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getLoginDelaySeconds()

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getSecondsToTrustAnIdlePoolConnection

int getSecondsToTrustAnIdlePoolConnection()

Deprecated. 

The number of seconds within the use of a pooled connection that WebLogic Server trusts that the connection is still viable and will skip connection testing.

If an application requests a connection within the time specified since the connection was tested or successfully used and returned to the connection pool, WebLogic Server skips the connection test before delivering it to an application (if TestConnectionsOnReserve is enabled).

WebLogic Server also skips the automatic refresh connection test if the connection was successfully used and returned to the connection pool within the time specified (if TestFrequencySeconds is specified).

SecondsToTrustAnIdlePoolConnection is a tuning feature that can improve application performance by minimizing the delay caused by database connection testing, especially during heavy traffic. However, it can reduce the effectiveness of connection testing, especially if the value is set too high. The appropriate value depends on your environment and the likelihood that a connection will become defunct.

Returns:

The secondsToTrustAnIdlePoolConnection value

Default Value:

10

setSecondsToTrustAnIdlePoolConnection

void setSecondsToTrustAnIdlePoolConnection(int secs)
                                           throws InvalidAttributeValueException

Deprecated. 

Sets the value of the SecondsToTrustAnIdlePoolConnection attribute.

Parameters:

secs - The new secondsToTrustAnIdlePoolConnection value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getSecondsToTrustAnIdlePoolConnection()

Default Value:

10

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getInitialCapacity

int getInitialCapacity()

Deprecated. 

The number of physical database connections to create when creating this JDBC connection pool. If unable to create this number of connections, creation of this connection pool will fail.

This is also the minimum number of physical connections the connection pool will keep available.

Returns:

The initialCapacity value

Default Value:

1

setInitialCapacity

void setInitialCapacity(int capacity)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the InitialCapacity attribute.

Parameters:

capacity - The new initialCapacity value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getInitialCapacity()

Changes take effect after you redeploy the module or restart the server.

Default Value:

1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getMaxCapacity

int getMaxCapacity()

Deprecated. 

The maximum number of physical database connections that this JDBC connection pool can contain.

Different JDBC Drivers and database servers may limit the number of possible physical connections.

Returns:

The maxCapacity value

Default Value:

ServerLegalHelper.DEFAULT_THREAD_POOL_SIZE

setMaxCapacity

void setMaxCapacity(int capacity)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the value of the MaxCapacity attribute.

Parameters:

capacity - The new maxCapacity value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getMaxCapacity()

Changes take effect after you redeploy the module or restart the server.

Default Value:

ServerLegalHelper.DEFAULT_THREAD_POOL_SIZE

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getCapacityIncrement

int getCapacityIncrement()

Deprecated. 

The increment by which this JDBC connection pool's 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.

Returns:

The capacityIncrement value

See Also:

JDBCConnectionPoolMBean.getMaxCapacity()

Default Value:

1

setCapacityIncrement

void setCapacityIncrement(int capacity)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the value of the CapacityIncrement attribute.

Parameters:

capacity - The new capacityIncrement value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getCapacityIncrement()

Changes take effect after you redeploy the module or restart the server.

Default Value:

1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

isShrinkingEnabled

boolean isShrinkingEnabled()

Deprecated. 

Specifies whether the JDBC connection pool can shrink back to its initial capacity or to the current number of connections in use if it detects that connections created during increased traffic are not being used.

When shrinking, the number of connections is reduced to the greater of either the initial capacity or the current number of connections in use.

Returns:

The shrinkingEnabled value

Default Value:

true

setShrinkingEnabled

void setShrinkingEnabled(boolean enable)
                         throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ShrinkingEnabled attribute.

Parameters:

enable - The new shrinkingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.isShrinkingEnabled()

Changes take effect after you redeploy the module or restart the server.

getShrinkPeriodMinutes

int getShrinkPeriodMinutes()

Deprecated. 

The number of minutes to wait before shrinking a connection pool that has incrementally increased to meet demand. (Requires that you enable connection pool shrinking.)

Returns:

The shrinkPeriodMinutes value

See Also:

JDBCConnectionPoolMBean.isShrinkingEnabled()

Default Value:

15

setShrinkPeriodMinutes

void setShrinkPeriodMinutes(int minutes)
                            throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ShrinkPeriodMinutes attribute.

Parameters:

minutes - The new shrinkPeriodMinutes value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getShrinkPeriodMinutes()

Changes take effect after you redeploy the module or restart the server.

Default Value:

15

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getShrinkFrequencySeconds

int getShrinkFrequencySeconds()

Deprecated. 

The number of seconds before WebLogic Server shrinks the connection pool to the original number of connections or number of connections currently in use. (Requires that you enable connection pool shrinking.)

Returns:

The shrinkFrequencySeconds value

Default Value:

900

setShrinkFrequencySeconds

void setShrinkFrequencySeconds(int seconds)
                               throws InvalidAttributeValueException

Deprecated. 

Sets the value of the ShrinkFrequencySeconds attribute.

Parameters:

seconds - The new shrinkFrequencySeconds value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getShrinkFrequencySeconds()

Changes take effect after you redeploy the module or restart the server.

Default Value:

900

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getRefreshMinutes

int getRefreshMinutes()

Deprecated. 

The number of minutes between database connection tests. (Requires that you specify a Test Table Name.)

At the specified interval, unused database connections are tested. Connections that do not pass the test will be closed and reopened to re-establish a valid physical database connection.

Returns:

The refreshMinutes value

See Also:

JDBCConnectionPoolMBean.getTestTableName()

Default Value:

0

setRefreshMinutes

void setRefreshMinutes(int minutes)
                       throws InvalidAttributeValueException

Deprecated. 

Sets the value of the RefreshMinutes attribute.

Parameters:

minutes - The new refreshMinutes value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getRefreshMinutes()

Changes take effect after you redeploy the module or restart the server.

Default Value:

0

Maximum Value:

35791394

Minimum Value:

0

getTestFrequencySeconds

int getTestFrequencySeconds()

Deprecated. 

The number of seconds between when WebLogic Server tests unused database connections. (Requires that you specify a Test Table Name.)

Connections that fail the test are closed and reopened to re-establish a valid physical database connection. If the test fails again, the connection is closed.

When set to 0, periodic testing is disabled.

Returns:

The testFrequencySeconds value

See Also:

JDBCConnectionPoolMBean.getTestTableName(), JDBCConnectionPoolMBean.setHighestNumUnavailable(int)

Default Value:

120

setTestFrequencySeconds

void setTestFrequencySeconds(int seconds)
                             throws InvalidAttributeValueException

Deprecated. 

Specifies the value of the TestFrequencySeconds attribute.

Parameters:

seconds - The new testFrequencySeconds value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getTestFrequencySeconds()

Changes take effect after you redeploy the module or restart the server.

Default Value:

120

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getTestTableName

String getTestTableName()

Deprecated. 

The name of the database table to use when testing physical database connections. This name is required when you specify a Test Frequency and enable Test Reserved Connections, Test Created Connections, and Test Released Connections.

The default SQL code used to test a connection is

"select count(*) from TestTableName"

Most database servers optimize this SQL to avoid a table scan, but it is still a good idea to set the Test Table Name to the name of a table that is known to have few rows, or even no rows.

If the name 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.

Returns:

The testTableName value

setTestTableName

void setTestTableName(String table)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the value of the TestTableName attribute.

Parameters:

table - The new testTableName value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getTestTableName()

Changes take effect after you redeploy the module or restart the server.

setTestConnectionsOnReserve

void setTestConnectionsOnReserve(boolean enable)
                                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the TestConnectionsOnReserve attribute.

Parameters:

enable - The new testConnectionsOnReserve value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getTestConnectionsOnReserve()

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

getTestConnectionsOnReserve

boolean getTestConnectionsOnReserve()

Deprecated. 

Specifies whether WebLogic Server tests a connection before giving it to the client. This test is required for connection pools used within a MultiPool that use the High Availability algorithm. (Requires that you specify a Test Table Name.)

The test adds a small delay in serving the client's request for a connection from the pool, but ensures that the client receives a working connection (assuming that the DBMS is available and accessible).

Returns:

The TestConnectionsOnReserve value

See Also:

JDBCConnectionPoolMBean.getTestTableName()

setTestConnectionsOnRelease

void setTestConnectionsOnRelease(boolean enable)
                                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the TestConnectionsOnRelease attribute.

Parameters:

enable - The new testConnectionsOnRelease value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getTestConnectionsOnRelease()

Changes take effect after you redeploy the module or restart the server.

Default Value:

false

getTestConnectionsOnRelease

boolean getTestConnectionsOnRelease()

Deprecated. 

Specifies whether WebLogic Server tests a connection before returning it to this JDBC connection pool. (Requires that you specify a Test Table Name.)

If all connections in the pool are already in use and a client is waiting for a connection, the client's wait will be slightly longer while the connection is tested.

Returns:

The TestConnectionsOnRelease value

See Also:

JDBCConnectionPoolMBean.getTestTableName()

setTestConnectionsOnCreate

void setTestConnectionsOnCreate(boolean enable)
                                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the TestConnectionsOnCreate attribute.

Parameters:

enable - The new testConnectionsOnCreate value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getTestConnectionsOnCreate()

Changes take effect after you redeploy the module or restart the server.

Default Value:

true

getTestConnectionsOnCreate

boolean getTestConnectionsOnCreate()

Deprecated. 

Specifies whether WebLogic Server tests a connection after creating it but before adding it to the list of connections available in the pool. (Requires that you specify a Test Table Name.)

The test adds a small delay in creating the connection, but ensures that the client receives a working connection (assuming that the DBMS is available and accessible).

Returns:

The TestConnectionsOnCreate value

See Also:

JDBCConnectionPoolMBean.getTestTableName()

getPassword

String getPassword()

Deprecated. 

The database password.

The value of this attribute can be set indirectly by passing it as a key=value pair by passing it to the MBean server's setAttribute method for the Properties attribute. However, Oracle recommends that you set the value directly by passing it to the MBean server's setAttribute method for this (PasswordEncrypted) attribute.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the PasswordEncrypted attribute to the encrypted value.

Using this Password attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use PasswordEncrypted.

Returns:

The password value

See Also:

JDBCConnectionPoolMBean.getProperties(), JDBCConnectionPoolMBean.getPasswordEncrypted()

Access limited to the following security roles:

Deployer

setPassword

void setPassword(String password)
                 throws InvalidAttributeValueException

Deprecated. 

Sets the password attribute passed to the JDBC driver when creating physical database connections. This value overrides any password that you defined in Properties.

The value is stored in an encrypted form in the config.xml file and when displayed on the Administration Console. Use this method to avoid storing passwords in clear text in config.xml.

Parameters:

password - The new password value

Throws:

InvalidAttributeValueException

getPasswordEncrypted

byte[] getPasswordEncrypted()

Deprecated. 

The encrypted database password.

The value of this attribute can be set indirectly by passing it as a key=value pair by passing it to the MBean server's setAttribute method for the Properties attribute. However, Oracle recommends that you set the value directly by using weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method. Doing so overrides the corresponding key=value pair in Properties if you set one.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The password value as an encrypted byte array

setPasswordEncrypted

void setPasswordEncrypted(byte[] bytes)
                          throws InvalidAttributeValueException

Deprecated. 

Encrypts the password and sets the value of the PasswordEncrypted attribute.

Parameters:

bytes - The new password value as a byte array.

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getPasswordEncrypted()

getXAPassword

String getXAPassword()

Deprecated. 

The password that is used to create physical XA database connections.

The value of this attribute can be set indirectly by passing it as a key=value pair by passing it to the MBean server's setAttribute method for the Properties attribute. However, Oracle recommends that you set the value directly by passing it to the MBean server's setAttribute method for this (XAPassword) attribute.

When you set the value of this attribute, WebLogic Server does the following:

1. Encrypts the value.
2. Sets the value of the XAPasswordEncrypted attribute to the encrypted value.

Using this XAPassword attribute is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use XAPasswordEncrypted.

Returns:

The xAPassword value

See Also:

JDBCConnectionPoolMBean.getProperties(), JDBCConnectionPoolMBean.getXAPasswordEncrypted()

Access limited to the following security roles:

Deployer

setXAPassword

void setXAPassword(String password)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XAPassword attribute.

Parameters:

password - The new xAPassword value

Throws:

InvalidAttributeValueException

getXAPasswordEncrypted

byte[] getXAPasswordEncrypted()

Deprecated. 

The password that is used to create physical XA database connections.

The value of this attribute can be set indirectly by passing it as a key=value pair by passing it to the MBean server's setAttribute method for the Properties attribute. However, Oracle recommends that you set the value directly by using weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method. Doing so overrides the corresponding key=value pair in Properties if you set one. It also causes WebLogic Server to encrypt the value and set the attribute to the encrypted value.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:

The xAPassword value as encrypted byte array.

setXAPasswordEncrypted

void setXAPasswordEncrypted(byte[] bytes)
                            throws InvalidAttributeValueException

Deprecated. 

Encrypts the password and sets the value of the XAPasswordEncrypted attribute.

Parameters:

bytes - The new xAPassword value as a byte array.

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getXAPasswordEncrypted()

getKeepXAConnTillTxComplete

boolean getKeepXAConnTillTxComplete()

Deprecated. 

Specifies whether the XA connection pool associates the same XA connection with the distributed transaction until the transaction completes. Only applies to connection pools that use an XA driver.

Use this setting to work around specific problems with third party vendor's XA driver.

Default Value:

false

setKeepXAConnTillTxComplete

void setKeepXAConnTillTxComplete(boolean b)
                                 throws InvalidAttributeValueException

Deprecated. 

Sets the value of the KeepXAConnTillTxComplete attribute.

Parameters:

b - The new keepXAConnTillTxComplete value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getKeepXAConnTillTxComplete()

getNeedTxCtxOnClose

boolean getNeedTxCtxOnClose()

Deprecated. 

Specifies whether the XA driver requires a distributed transaction context when closing various JDBC objects (result sets, statements, connections, and so on). Only applies to connection pools that use an XA driver.

When enabled, SQL exceptions that are thrown while closing the JDBC objects in no transaction context will be swallowed.

Use this setting to work around specific problems with third party vendor's XA driver.

Default Value:

false

setNeedTxCtxOnClose

void setNeedTxCtxOnClose(boolean b)
                         throws InvalidAttributeValueException

Deprecated. 

Sets the value of the NeedTxCtcOnClose attribute.

Parameters:

b - The new needTxCtxOnClose value

Throws:

InvalidAttributeValueException

See Also:

#getNeedTxCtcOnClose

getXAEndOnlyOnce

boolean getXAEndOnlyOnce()

Deprecated. 

Specifies that XAResource.end() is called only once for each pending XAResource.start(). The XA driver will not call XAResource.end(TMSUSPEND), XAResource.end(TMSUCCESS) successively. Only applies to connection pools that use an XA driver.

Use this setting to work around specific problems with third party vendor's XA driver.

Default Value:

false

setXAEndOnlyOnce

void setXAEndOnlyOnce(boolean b)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XAEndOnlyOnce attribute.

Parameters:

b - The new xAEndOnlyOnce value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getXAEndOnlyOnce()

getNewXAConnForCommit

boolean getNewXAConnForCommit()

Deprecated. 

Specifies whether a dedicated XA connection is used for commit/rollback processing of a particular distributed transaction. Only applies to connection pools that use an XA driver.

Use this setting to work around specific problems with third party vendor's XA driver.

Default Value:

false

setNewXAConnForCommit

void setNewXAConnForCommit(boolean b)
                           throws InvalidAttributeValueException

Deprecated. 

Sets the value of the NewXAConnForCommit attribute.

Parameters:

b - The new newXAConnForCommit value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getNewXAConnForCommit()

getKeepLogicalConnOpenOnRelease

boolean getKeepLogicalConnOpenOnRelease()

Deprecated. 

Specifies whether the logical JDBC connection is kept open when the physical XA connection is returned to the XA connection pool. Only applies to connection pools that use an XA driver.

Select this option if the XA driver used to create database connections or the DBMS requires that a logical JDBC connection be kept open while transaction processing continues (although the physical XA connection can returned to the XA connection pool).

Use this setting to work around specific problems with third party vendor's XA driver.

Default Value:

false

setKeepLogicalConnOpenOnRelease

void setKeepLogicalConnOpenOnRelease(boolean b)
                                     throws InvalidAttributeValueException

Deprecated. 

Sets the value of the KeepLogicalConnOpenOnRelease attribute.

Parameters:

b - The new keepLogicalConnOpenOnRelease value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getKeepLogicalConnOpenOnRelease()

getXAPreparedStatementCacheSize

int getXAPreparedStatementCacheSize()

Deprecated. 

The maximum number of prepared statements cached by this particular XA connection pool. Only applies to connection pools that use an XA driver.

If set to 0, caching is turned off.

Default Value:

JDBCLegalHelper.UNSPECIFIED_CACHE_STATEMENTS_SIZE

setXAPreparedStatementCacheSize

void setXAPreparedStatementCacheSize(int size)
                                     throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XAPreparedStatementCacheSize attribute.

Parameters:

size - The new xAPreparedStatementCacheSize value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getXAPreparedStatementCacheSize()

Maximum Value:

weblogic.management.configuration.JDBCLegalHelper.MAX_CACHE_STATEMENTS_SIZE

Minimum Value:

weblogic.management.configuration.JDBCLegalHelper.UNSPECIFIED_CACHE_STATEMENTS_SIZE

getEnableResourceHealthMonitoring

boolean getEnableResourceHealthMonitoring()

Deprecated. 

Returns whether 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.

Default Value:

true

setEnableResourceHealthMonitoring

void setEnableResourceHealthMonitoring(boolean enable)
                                       throws InvalidAttributeValueException

Deprecated. 

Determines whether 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.

Parameters:

enable - The new enableResourceHealthMonitoring value

Throws:

InvalidAttributeValueException

getXASetTransactionTimeout

boolean getXASetTransactionTimeout()

Deprecated. 

When set to true, the WebLogic Server Transaction Manager calls XAResource.setTransactionTimeout() before calling XAResource.start, and passes either the XATransactionTimeout or the global transaction timeout in seconds.

When set to false, the Transaction Manager does not call setTransactionTimeout().

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

Default Value:

false

setXASetTransactionTimeout

void setXASetTransactionTimeout(boolean b)
                                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XASetTransactionTimeout attribute.

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getXASetTransactionTimeout()

getXATransactionTimeout

int getXATransactionTimeout()

Deprecated. 

Determines the number of seconds to pass as the transaction timeout value in the XAResource.setTransactionTimeout() method. When this property is set to 0, the WebLogic Server Transaction Manager passes the global WebLogic Server transaction timeout in seconds in the method.

If set, this value should be greater than or equal to the global WebLogic Server transaction timeout.

XASetTransactionTimeout must be set to "true" or this property is ignored.

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

Default Value:

0

setXATransactionTimeout

void setXATransactionTimeout(int timeout)
                             throws InvalidAttributeValueException

Deprecated. 

Sets the value of the XATransactionTimeout attribute.

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getXATransactionTimeout()

getXARetryDurationSeconds

int getXARetryDurationSeconds()

Deprecated. 

Determines the duration in seconds for which the transaction manager will perform recover operations on the resource. A value of zero indicates that no retries will be performed.

Default Value:

0

setXARetryDurationSeconds

void setXARetryDurationSeconds(int duration)
                               throws InvalidAttributeValueException

Deprecated. 

Determines the duration in seconds for which the transaction manager will perform recover operations on the resource. A value of zero indicates that no retries will be performed.

Throws:

InvalidAttributeValueException

getXARetryIntervalSeconds

int getXARetryIntervalSeconds()

Deprecated. 

Determines the time in seconds between XA retry operations if the XARetryDurationSeconds attribute is set to a positive value.

Default Value:

60

setXARetryIntervalSeconds

void setXARetryIntervalSeconds(int interval)
                               throws InvalidAttributeValueException

Deprecated. 

Determines the time in seconds between XA retry operations if the XARetryDurationSeconds attribute is set to a positive value.

Throws:

InvalidAttributeValueException

setPreparedStatementCacheSize

void setPreparedStatementCacheSize(int cacheSize)

Deprecated. 

Sets the value of the PreparedStatementCacheSize attribute.

Parameters:

cacheSize - The new preparedStatementCacheSize value

See Also:

JDBCConnectionPoolMBean.getPreparedStatementCacheSize()

Maximum Value:

weblogic.management.configuration.JDBCLegalHelper.MAX_CACHE_STATEMENTS_SIZE

Minimum Value:

weblogic.management.configuration.JDBCLegalHelper.UNSPECIFIED_CACHE_STATEMENTS_SIZE

getPreparedStatementCacheSize

int getPreparedStatementCacheSize()

Deprecated. 

The number of prepared statements stored in the cache. (This might increase server performance.)

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 turns it off.

Returns:

The preparedStatementCacheSize value

Default Value:

JDBCLegalHelper.UNSPECIFIED_CACHE_STATEMENTS_SIZE

setConnectionReserveTimeoutSeconds

void setConnectionReserveTimeoutSeconds(int seconds)

Deprecated. 

The number of seconds after which a call to reserve a connection from the connection pool will timeout.

When set to 0, a call will never timeout.

When set to -1, a call will timeout immediately.

Parameters:

seconds - The new connectionReserveTimeoutSeconds value

See Also:

JDBCConnectionPoolMBean.getConnectionReserveTimeoutSeconds()

Changes take effect after you redeploy the module or restart the server.

Default Value:

10

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getConnectionReserveTimeoutSeconds

int getConnectionReserveTimeoutSeconds()

Deprecated. 

The number of seconds after which a call to reserve a connection from the connection pool will timeout.

When set to 0, a call will never timeout.

When set to -1, a call will timeout immediately.

Returns:

The connectionReserveTimeoutSeconds value

See Also:

JDBCConnectionPoolMBean.getHighestNumWaiters()

setConnectionCreationRetryFrequencySeconds

void setConnectionCreationRetryFrequencySeconds(int seconds)

Deprecated. 

Sets the value of the ConnectionCreationRetryFrequencySeconds attribute.

Parameters:

seconds - The new connectionCreationRetryFrequencySeconds value

See Also:

JDBCConnectionPoolMBean.getConnectionCreationRetryFrequencySeconds()

Changes take effect after you redeploy the module or restart the server.

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getConnectionCreationRetryFrequencySeconds

int getConnectionCreationRetryFrequencySeconds()

Deprecated. 

The number of seconds between when the connection pool retries to establish connections to the database. Do not enable connection retries for connection pools included in a High Availability MultiPool.

If you do not set this value, connection pool creation fails if the database is unavailable. If set and if the database is unavailable when the connection pool is created, WebLogic Server will attempt to create connections in the pool again after the number of seconds you specify, and will continue to attempt to create the connections until it succeeds.

Note: Do not enable connection creation retries for connection pools included in a High Availability MultiPool. Connection requests to the MultiPool will fail (not fail-over) when a connection pool in the list is dead and the number of connection requests equals the number of connections in the first connection pool, even if connections are available in subsequent connection pools in the MultiPool.

When set to 0, connection retry is disabled.

Returns:

The connectionCreationRetryFrequencySeconds value

setInactiveConnectionTimeoutSeconds

void setInactiveConnectionTimeoutSeconds(int seconds)

Deprecated. 

Sets the value of the InactiveConnectionTimeoutSeconds attribute.

Parameters:

seconds - The new inactiveConnectionTimeoutSeconds value

See Also:

JDBCConnectionPoolMBean.getInactiveConnectionTimeoutSeconds()

Changes take effect after you redeploy the module or restart the server.

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getInactiveConnectionTimeoutSeconds

int getInactiveConnectionTimeoutSeconds()

Deprecated. 

The number of inactive seconds on a reserved connection before WebLogic Server reclaims the connection and releases it back into the connection pool.

When set to 0, the feature is disabled.

Returns:

The inactiveConnectionTimeoutSeconds value

setHighestNumWaiters

void setHighestNumWaiters(int count)

Deprecated. 

Sets the value of the HighestNumWaiters attribute.

Parameters:

count - The new highestNumWaiters value

See Also:

JDBCConnectionPoolMBean.getHighestNumWaiters()

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Integer.MAX_VALUE

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getHighestNumWaiters

int getHighestNumWaiters()

Deprecated. 

The maximum number of connection requests that can concurrently block threads while waiting to reserve a connection from the connection pool.

Returns:

The highestNumWaiters value

See Also:

JDBCConnectionPoolMBean.getConnectionReserveTimeoutSeconds()

setHighestNumUnavailable

void setHighestNumUnavailable(int count)

Deprecated. 

Sets the value of the HighestNumUnavailable attribute.

Parameters:

count - The new highestNumUnavailable value

See Also:

JDBCConnectionPoolMBean.getHighestNumUnavailable()

Changes take effect after you redeploy the module or restart the server.

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getHighestNumUnavailable

int getHighestNumUnavailable()

Deprecated. 

The maximum number of connections in the connection pool that can be made unavailable for use by an application. Connections become unavailable while being tested or refreshed.

Note that in cases likes the back end system being unavailable, this specified value could be exceeded due to factors outside the pool's control.

When set to 0, this feature is disabled.

Returns:

The highestNumUnavailable value

setInitSQL

void setInitSQL(String table)
                throws InvalidAttributeValueException

Deprecated. 

Sets the value of the InitSQL statement.

Parameters:

table - The new initSQL value

Throws:

InvalidAttributeValueException

See Also:

JDBCConnectionPoolMBean.getInitSQL()

getInitSQL

String getInitSQL()

Deprecated. 

SQL statement to execute that will initialize a newly created physical connection. Start the statement with SQL followed by a space.

If the statement 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 initialize a connection. Else, the statement will be treated as the name of a table and the following SQL statement will be used to initialize a connection:
"select count(*) from InitSQL"

The table InitSQL 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 InitSQL to the name of a table that is known to have few rows, or even no rows.

Returns:

The initSQL value

setStatementCacheSize

void setStatementCacheSize(int cacheSize)

Deprecated. 

Sets the value of the StatementCacheSize attribute.

Parameters:

cacheSize - The new statementCacheSize value

See Also:

JDBCConnectionPoolMBean.getStatementCacheSize()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

JDBCLegalHelper.MAX_CACHE_STATEMENTS_SIZE

Minimum Value:

JDBCLegalHelper.MIN_CACHE_STATEMENTS_SIZE

getStatementCacheSize

int getStatementCacheSize()

Deprecated. 

The number of prepared and callable statements stored in the cache. (This might increase server performance.)

WebLogic Server can reuse statements in the cache without reloading them, which can increase server performance. Each connection in the pool has its own cache of statements.

Setting the size of the statement cache to 0 turns it off.

Returns:

The statementCacheSize value

Default Value:

JDBCLegalHelper.DEFAULT_CACHE_STATEMENTS_SIZE

setStatementCacheType

void setStatementCacheType(String type)

Deprecated. 

Sets the value of the StatementCacheType attribute.

Parameters:

type - The new statementCacheType value

See Also:

JDBCConnectionPoolMBean.getStatementCacheType()

Valid Values:

JDBCLegalHelper.STATEMENT_CACHE_TYPE_LRU, JDBCLegalHelper.STATEMENT_CACHE_TYPE_FIXED

getStatementCacheType

String getStatementCacheType()

Deprecated. 

The algorithm used for maintaining the prepared statements stored in the cache.

Connection pools support the following cache types:

• LRU

  replaces the least recently used statements when new statements are used.

• FIXED

  keeps the first fixed number of statements in the cache.

Returns:

The statementCacheType value

Default Value:

JDBCLegalHelper.STATEMENT_CACHE_TYPE_DEFAULT

setRemoveInfectedConnectionsEnabled

void setRemoveInfectedConnectionsEnabled(boolean enable)

Deprecated. 

Sets the value of the RemoveInfectedConnectionsEnabled attribute.

Parameters:

enable - The new removeInfectedConnectionsEnabled value

See Also:

JDBCConnectionPoolMBean.isRemoveInfectedConnectionsEnabled()

Default Value:

true

isRemoveInfectedConnectionsEnabled

boolean isRemoveInfectedConnectionsEnabled()

Deprecated. 

Specifies whether a connection will be removed from the connection pool when the application asks for the underlying vendor connection object.

If you use this setting, you must make sure that the database connection is suitable for reuse by other applications.

When enabled, the physical connection is not returned to the connection pool after the application closes the logical connection. Instead, the physical connection is closed and recreated.

When not enabled, when you close the logical connection, the physical connection is returned to the connection pool.

Returns:

The removeInfectedConnectionsEnabled value

See Also:

WLConnection

setRollbackLocalTxUponConnClose

void setRollbackLocalTxUponConnClose(boolean enable)

Deprecated. 

Sets the value of the RollbackLocalTxUponConnClose attribute.

Parameters:

enable - The new rollbackLocalTxUponConnClose value

See Also:

JDBCConnectionPoolMBean.getRollbackLocalTxUponConnClose()

Default Value:

false

getRollbackLocalTxUponConnClose

boolean getRollbackLocalTxUponConnClose()

Deprecated. 

Specifies whether the WLS connection pool will call rollback() on the connection before putting it back in the pool.

Enabling this attribute will have a performance impact as the rollback call requires communication with the database server.

Returns:

The rollbackLocalTxUponConnClose value

setTestStatementTimeout

void setTestStatementTimeout(int timeout)

Deprecated. 

Sets the value of the TestStatementTimeout attribute.

Parameters:

timeout - The new testStatementTimeout value

See Also:

JDBCConnectionPoolMBean.getTestStatementTimeout()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getTestStatementTimeout

int getTestStatementTimeout()

Deprecated. 

The time after which the test statement (configured by applications using the pool attribute Test Table Name) or initialization statement (configured by applications using the pool attribute InitSQL) currently being executed will be timed out.

Efficacy of this feature relies on underlying JDBC driver support. WebLogic Server passes the time specified to the JDBC driver using the java.sql.Statement.setQueryTimeout() method. If your JDBC driver does not support this method, it may throw an exception and the timeout value is ignored.

A value of -1 disables this feature.

A value of 0 means that statements will not time out.

Returns:

the testStatementTimeout value

See Also:

JDBCConnectionPoolMBean.getTestTableName(), JDBCConnectionPoolMBean.getInitSQL()

Default Value:

-1

setStatementTimeout

void setStatementTimeout(int timeout)

Deprecated. 

Sets the value of the StatementTimeout attribute.

Parameters:

timeout - The new statementTimeout value

See Also:

JDBCConnectionPoolMBean.getStatementTimeout()

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getStatementTimeout

int getStatementTimeout()

Deprecated. 

The time after which a statement currently being executed will be timed-out.

Efficacy of this feature relies on underlying JDBC driver support. WebLogic Server passes the time specified to the JDBC driver using the java.sql.Statement.setQueryTimeout() method. If your JDBC driver does not support this method, it may throw an exception and the timeout value is ignored.

A value of -1 disables this feature.

A value of 0 means that statements will not time out.

Returns:

the statementTimeout value

Default Value:

-1

setIgnoreInUseConnectionsEnabled

void setIgnoreInUseConnectionsEnabled(boolean enable)

Deprecated. 

Enables pool to be shutdown even if connections are still in use.

Parameters:

enable - The new ignoreInUseConnectionsEnabled value

Changes take effect after you redeploy the module or restart the server.

isIgnoreInUseConnectionsEnabled

boolean isIgnoreInUseConnectionsEnabled()

Deprecated. 

Returns the configured ignoreInUseConnectionsEnabled value.

Returns:

the ignoreInUseConnectionsEnabled value

Default Value:

true

setCredentialMappingEnabled

void setCredentialMappingEnabled(boolean enable)

Deprecated. 

Enables pool to install client id for every connection reserved by the application based Credential Mapping.

Parameters:

the - credentialMappingEnabled value

Changes take effect after you redeploy the module or restart the server.

isCredentialMappingEnabled

boolean isCredentialMappingEnabled()

Deprecated. 

Returns the configured ignoreInUseConnectionsEnabled value.

Returns:

the credentialMappingEnabled value

Default Value:

false

setCountOfTestFailuresTillFlush

void setCountOfTestFailuresTillFlush(int flush_threshold)

Deprecated. 

Sets the number of consecutive pool con test failures till we flush the pool.

Parameters:

flush_threshold - The flush_threshold value

See Also:

JDBCConnectionPoolMBean.getCountOfTestFailuresTillFlush()

Changes take effect after you redeploy the module or restart the server.

Minimum Value:

0

getCountOfTestFailuresTillFlush

int getCountOfTestFailuresTillFlush()

Deprecated. 

The number of consecutive pool con test failures till we flush the pool.

If a pool temporarily loses DBMS connectivity, all the connections are probably dead. It is much faster to close them all, rather than have the pool test each one during a reserve, and then replace it. This setting tells the pool to flush all the connections in the pool after N consecutive times finding that a connection being tested is dead.

Setting the count to zero means we will not flush.

Returns:

The number of consecutive test failures till we flush the pool

Default Value:

JDBCLegalHelper.COUNT_TILL_FLUSH_DEFAULT

setCountOfRefreshFailuresTillDisable

void setCountOfRefreshFailuresTillDisable(int disable_threshold)

Deprecated. 

Sets the number of consecutive pool con refresh failures till we disable the pool.

Parameters:

disable_threshold - The disable_threshold value

See Also:

#getCountOfRefreshFaluresTillDisable

Changes take effect after you redeploy the module or restart the server.

Minimum Value:

0

getCountOfRefreshFailuresTillDisable

int getCountOfRefreshFailuresTillDisable()

Deprecated. 

The number of consecutive pool con refresh failures till we disable the pool.

If a pool loses DBMS connectivity, all the connections are dead and we won't be able to replace them till the DBMS is back. Applications that continue to ask the pool for connections will suffer slowness while the pool tries in vain to test dead connections and tries in vain to make a new one. Sometiimes this can take minutes. This setting tells the pool to disable itself so the applications will at least get a quick failure response, and if a multipool is involved, it can fail over to the next pool quickly. The self-disabled pool will periodically try to reconnect, and will re-enable itself asap.

Setting the count to zero means we will not disable.

Returns:

The number of consecutive refresh failures till we disable the pool

Default Value:

JDBCLegalHelper.COUNT_TILL_DISABLE_DEFAULT