weblogic.j2ee.descriptor.wl
Interface JDBCDataSourceParamsBean

All Superinterfaces:

SettableBean

public interface JDBCDataSourceParamsBean
extends SettableBean

Contains the basic usage parameters of a data source.

Configuration parameters for the basic usage of a data source are specified using a data source parameters bean.

Access limited to the following security roles:

Deployer

getJNDINames

String[] getJNDINames()

The JNDI path to where this Data Source is bound. By default, the JNDI name is the name of the data source.

Applications that look up the JNDI path will get a javax.sql.DataSource instance that corresponds to this data source.

setJNDINames

void setJNDINames(String[] jndiNames)

addJNDIName

void addJNDIName(String jndiName)

Used to specify additional JNDI names for the Data Source. WebLogic Server internally defaults the JNDI name to the name of the data source bean.

removeJNDIName

void removeJNDIName(String jndiName)

getScope

String getScope()

Specifies the scoping of the data source.

You can specify one of the following scopes:

• Global

  Specifies that the data source is bound in the cluster-wide JNDI tree with the JNDIName specified so that the data source is available for use to any JDBC client across the cluster.

  This is the default setting.

• Application

  Specifies that the data source is bound in the application's local namespace with the JNDIName specified so that the data source is available for use only by JDBC clients within the application. This can only be used for packaged datasources and is ignored for JDBC System resources.

Default Value:

weblogic.jdbc.common.internal.JDBCConstants.SCOPE_GLOBAL

Valid Values:

weblogic.jdbc.common.internal.JDBCConstants.SCOPE_GLOBAL, weblogic.jdbc.common.internal.JDBCConstants.SCOPE_APPLICATION

setScope

void setScope(String scope)

isRowPrefetch

boolean isRowPrefetch()

Enables multiple rows to be "prefetched" (that is, sent from the server to the client) in one server access.

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.

Default Value:

false

setRowPrefetch

void setRowPrefetch(boolean rowPrefetch)

getRowPrefetchSize

int getRowPrefetchSize()

If row prefetching is enabled, specifies the number of result set rows to prefetch for a client.

The optimal prefetch size depends on the particulars of the query. In general, increasing this number will increase performance, until a particular value is reached. At that point further increases do not result in any significant performance increase. Very rarely will increased performance result from exceeding 100 rows. The default value should be reasonable for most situations.

Default Value:

48

Maximum Value:

65536

Minimum Value:

2

setRowPrefetchSize

void setRowPrefetchSize(int rowPrefetchSize)

getStreamChunkSize

int getStreamChunkSize()

Specifies the data chunk size for steaming data types.

Streaming data types (for example resulting from a call to getBinaryStream()) are sent in sized chunks from WebLogic Server to the client as needed.

Default Value:

256

Maximum Value:

65536

Minimum Value:

1

setStreamChunkSize

void setStreamChunkSize(int streamChunkSize)

getAlgorithmType

String getAlgorithmType()

The algorithm determines the connection request processing for the multi data source.

You can specify one of the following algorithm types:

• Failover

  Connection requests are sent to the first data source in the list; if the request fails, the request is sent to the next data source in the list, and so forth. The process is repeated until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.

• Load balancing

  The multi data source distributes connection requests evenly to its member data sources. With this algorithm, the multi data source also provides failover processing. That is, if a request fails, the multi data source sends the request to the next data source in the list until a valid connection is obtained, or until the end of the list is reached, in which case an exception is thrown.

Default Value:

weblogic.jdbc.common.internal.JDBCConstants.ALGORITHM_FAILOVER

Valid Values:

weblogic.jdbc.common.internal.JDBCConstants.ALGORITHM_LOAD_BALANCING, weblogic.jdbc.common.internal.JDBCConstants.ALGORITHM_FAILOVER

setAlgorithmType

void setAlgorithmType(String algorithmType)

getDataSourceList

String getDataSourceList()

The list of data sources to which the multi data source will route connection requests. The order of data sources in the list determines the failover order.

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

Default Value:

null

setDataSourceList

void setDataSourceList(String dataSourceList)

getConnectionPoolFailoverCallbackHandler

String getConnectionPoolFailoverCallbackHandler()

The name of the application class to handle the callback sent when a multi data source is ready to failover or fail back connection requests to another data source within the multi data source.

The name must be the absolute name of an application class that implements the weblogic.jdbc.extensions.ConnectionPoolFailoverCallback interface.

See Also:

ConnectionPoolFailoverCallback

Default Value:

null

setConnectionPoolFailoverCallbackHandler

void setConnectionPoolFailoverCallbackHandler(String connectionPoolFailoverCallbackHandler)

isFailoverRequestIfBusy

boolean isFailoverRequestIfBusy()

For multi data sources with the failover algorithm, enables the multi data source to failover connection requests to the next data source if all connections in the current data source are in use.

Default Value:

false

setFailoverRequestIfBusy

void setFailoverRequestIfBusy(boolean failoverRequestIfBusy)

getGlobalTransactionsProtocol

String getGlobalTransactionsProtocol()

Determines the transaction protocol (global transaction processing behavior) for the data source. Options include:

• TwoPhaseCommit - Standard XA transaction processing. Requires an XA driver.

• LoggingLastResource - A performance enhancement for one non-XA resource.

• EmulateTwoPhaseCommit - Enables one non-XA resource to participate in a global transaction, but has some risk to data.

• OnePhaseCommit - One-phase XA transaction processing using a non-XA driver. This is the default setting.

• None - Support for local transactions only.

Default Value:

weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_ONE_PHASE_COMMIT

Valid Values:

weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_TWO_PHASE_COMMIT, weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_LOGGING_LAST_RESOURCE, weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_EMULATE_TWO_PHASE_COMMIT, weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_ONE_PHASE_COMMIT, weblogic.jdbc.common.internal.JDBCConstants.TX_PROTO_NONE

setGlobalTransactionsProtocol

void setGlobalTransactionsProtocol(String globalTransactionsProtocol)

isKeepConnAfterLocalTx

boolean isKeepConnAfterLocalTx()

Deprecated. 10.3.4.0

Enables WebLogic Server to keep the physical database connection associated with the logical connection when committing a local transaction instead releasing it and getting another physical connection when needed.

Setting this option to true may require additional connections to be configured on the database.

Use this setting to work around specific problems with JDBC XA drivers.

Default Value:

true

setKeepConnAfterLocalTx

void setKeepConnAfterLocalTx(boolean keepConnAfterLocalTx)

isKeepConnAfterGlobalTx

boolean isKeepConnAfterGlobalTx()

Enables WebLogic Server to keep the physical database connection associated with the logical connection when committing a global transaction instead releasing it and getting another physical connection when needed.

Setting this option to true may require additional connections to be configured on the database.

Use this setting to work around specific problems with JDBC XA drivers.

Default Value:

false

setKeepConnAfterGlobalTx

void setKeepConnAfterGlobalTx(boolean keepConnAfterGlobalTx)