Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


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.


Method Summary
abstract  void addJNDIName(String jndiName)
          Used to specify additional JNDI names for the Data Source.
abstract  String getAlgorithmType()
          The algorithm determines the connection request processing for the multi data source.
abstract  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.
abstract  String getDataSourceList()
          The list of data sources to which the multi data source will route connection requests.
abstract  String getGlobalTransactionsProtocol()
          Determines the transaction protocol (global transaction processing behavior) for the data source.
abstract  String[] getJNDINames()
          The JNDI path for this Data Source.
abstract  String getProxySwitchingCallback()
          The name of the switching callback class for a Proxy data source.
abstract  String getProxySwitchingProperties()
          Specifies the switching properties passed to the switching callback method for a Proxy data source.
abstract  int getRowPrefetchSize()
          Deprecated. 12.2.1.0
abstract  String getScope()
          Specifies the scoping of the data source.
abstract  int getStreamChunkSize()
          Deprecated. 12.2.1.0
abstract  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.
abstract  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.
abstract  boolean isKeepConnAfterLocalTx()
          Deprecated. 10.3.4.0
abstract  boolean isRowPrefetch()
          Deprecated. 12.2.1.0
abstract  void removeJNDIName(String jndiName)
           
abstract  void setAlgorithmType(String algorithmType)
           
abstract  void setConnectionPoolFailoverCallbackHandler(String connectionPoolFailoverCallbackHandler)
           
abstract  void setDataSourceList(String dataSourceList)
           
abstract  void setFailoverRequestIfBusy(boolean failoverRequestIfBusy)
           
abstract  void setGlobalTransactionsProtocol(String globalTransactionsProtocol)
           
abstract  void setJNDINames(String[] jndiNames)
           
abstract  void setKeepConnAfterGlobalTx(boolean keepConnAfterGlobalTx)
           
abstract  void setKeepConnAfterLocalTx(boolean keepConnAfterLocalTx)
          Deprecated. 10.3.4.0
abstract  void setProxySwitchingCallback(String proxySwitchingCallback)
           
abstract  void setProxySwitchingProperties(String proxySwitchingProperties)
           
abstract  void setRowPrefetch(boolean rowPrefetch)
          Deprecated. 12.2.1.0
abstract  void setRowPrefetchSize(int rowPrefetchSize)
          Deprecated. 12.2.1.0
abstract  void setScope(String scope)
           
abstract  void setStreamChunkSize(int streamChunkSize)
          Deprecated. 12.2.1.0

 

Method Detail

getJNDINames

String[] getJNDINames()

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

Applications that look up the JNDI path 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.

Parameters:
jndiName -

removeJNDIName

void removeJNDIName(String jndiName)
Parameters:
jndiName -

getScope

String getScope()

Specifies the scoping of the data source.

You can specify one of the following scopes:


setScope

void setScope(String scope)

isRowPrefetch

boolean isRowPrefetch()
Deprecated. 12.2.1.0

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

This parameter applies only to the deprecated JDBC over RMI.

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.


setRowPrefetch

void setRowPrefetch(boolean rowPrefetch)
Deprecated. 12.2.1.0

getRowPrefetchSize

int getRowPrefetchSize()
Deprecated. 12.2.1.0

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

This parameter applies only to the deprecated JDBC over RMI.

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.


setRowPrefetchSize

void setRowPrefetchSize(int rowPrefetchSize)
Deprecated. 12.2.1.0

getStreamChunkSize

int getStreamChunkSize()
Deprecated. 12.2.1.0

Specifies the data chunk size for steaming data types.

This parameter applies only to the deprecated JDBC over RMI.

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


setStreamChunkSize

void setStreamChunkSize(int streamChunkSize)
Deprecated. 12.2.1.0

getAlgorithmType

String getAlgorithmType()

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

You can specify one of the following algorithm types:


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.


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

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.


setFailoverRequestIfBusy

void setFailoverRequestIfBusy(boolean failoverRequestIfBusy)

getGlobalTransactionsProtocol

String getGlobalTransactionsProtocol()

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


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.


setKeepConnAfterLocalTx

void setKeepConnAfterLocalTx(boolean keepConnAfterLocalTx)
Deprecated. 10.3.4.0

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.


setKeepConnAfterGlobalTx

void setKeepConnAfterGlobalTx(boolean keepConnAfterGlobalTx)

getProxySwitchingCallback

String getProxySwitchingCallback()

The name of the switching callback class for a Proxy data source.

This class implements the weblogic.jdbc.extensions.DataSourceSwitchingCallback interface.

See Also:
DataSourceSwitchingCallback

setProxySwitchingCallback

void setProxySwitchingCallback(String proxySwitchingCallback)

getProxySwitchingProperties

String getProxySwitchingProperties()
Specifies the switching properties passed to the switching callback method for a Proxy data source.
See Also:
DataSourceSwitchingCallback

setProxySwitchingProperties

void setProxySwitchingProperties(String proxySwitchingProperties)

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09