Package weblogic.j2ee.descriptor.wl

Interface JDBCOracleParamsBean

All Superinterfaces:

SettableBean

public interface JDBCOracleParamsBean
extends SettableBean

Contains the Oracle database-related parameters of a data source.

Configuration parameters for a data source's Oracle-specific behavior are specified using a Oracle parameters bean.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAffinityPolicy()	The affinity policy determines how JDBC connections to specific Oracle RAC instances are selected and returned to the application.
java.lang.String	getConnectionInitializationCallback()	The name of the Connection Initialization Callback class.
java.lang.String	getOnsNodeList()	A comma-separate list of ONS daemon listen addresses and ports to which connect to for receiving ONS-based FAN events.
java.lang.String	getOnsWalletFile()	The location of the Oracle wallet file in which the SSL certificates are stored.
java.lang.String	getOnsWalletPassword()	The wallet password attribute that is included as part of the ONS client configuration string.
byte[]	getOnsWalletPasswordEncrypted()	The encrypted database password as set with setOnsWalletPassword(), or with setOnsWalletPasswordEncrypted(byte[] bytes).
int	getReplayInitiationTimeout()	The amount of time, in seconds, a data source allows for Application Continuity replay processing before timing out and ending a replay session context.
boolean	isActiveGridlink()	Indicates a configured Active GridLink datasource.
boolean	isFanEnabled()	Enables the data source to subscribe to and process Oracle FAN events.
boolean	isOracleEnableJavaNetFastPath()	Deprecated. 12.2.1.3.1
boolean	isOracleOptimizeUtf8Conversion()	Deprecated. 14.1.2.0.0
boolean	isOracleProxySession()	Enables Oracle JDBC Proxy Authentication.
boolean	isRebalanceOnUpEvent()	Rebalancing connections incurs overhead due to connection creation to the new instance, and the closing of connections to existing instances, which may impact application performance under load, cause database logon storms, etc.
boolean	isUseDatabaseCredentials()	If enabled, Oracle database credentials are used in getConnection instead of application server credentials.
void	setActiveGridlink(boolean activeGridlink)
void	setAffinityPolicy(java.lang.String affinityPolicy)
void	setConnectionInitializationCallback(java.lang.String className)
void	setFanEnabled(boolean fanEnabled)
void	setOnsNodeList(java.lang.String onsNodes)
void	setOnsWalletFile(java.lang.String onsWalletFile)
void	setOnsWalletPassword(java.lang.String password)
void	setOnsWalletPasswordEncrypted(byte[] passwordEncrypted)
void	setOracleEnableJavaNetFastPath(boolean oracleEnableJavaNetFastPath)	Deprecated. 12.2.1.3.1
void	setOracleOptimizeUtf8Conversion(boolean oracleOptimizeUtf8Conversion)	Deprecated. 14.1.2.0.0
void	setOracleProxySession(boolean oracleProxySession)
void	setRebalanceOnUpEvent(boolean rebalance)
void	setReplayInitiationTimeout(int replayInitiationTimeout)
void	setUseDatabaseCredentials(boolean useDatabaseCredentials)

Method Detail

isFanEnabled

boolean isFanEnabled()

Enables the data source to subscribe to and process Oracle FAN events.

This attribute is only applicable for RAC configurations that publish FAN notification events using the ONS protocol.

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setFanEnabled

void setFanEnabled(boolean fanEnabled)

getOnsNodeList

java.lang.String getOnsNodeList()

A comma-separate list of ONS daemon listen addresses and ports to which connect to for receiving ONS-based FAN events. It is required when connecting to Oracle 11g databases and optional when connecting to Oracle database releases 12c and higher.

setOnsNodeList

void setOnsNodeList(java.lang.String onsNodes)

getOnsWalletFile

java.lang.String getOnsWalletFile()

The location of the Oracle wallet file in which the SSL certificates are stored. Only required when the ONS client is configured to communicate with ONS daemons using SSL.

setOnsWalletFile

void setOnsWalletFile(java.lang.String onsWalletFile)

getOnsWalletPasswordEncrypted

byte[] getOnsWalletPasswordEncrypted()

The encrypted database password as set with setOnsWalletPassword(), or with setOnsWalletPasswordEncrypted(byte[] bytes).

Returns:

The password value as an encrypted byte array

Access limited to the following security roles:

Deployer

setOnsWalletPasswordEncrypted

void setOnsWalletPasswordEncrypted(byte[] passwordEncrypted)

Access limited to the following security roles:

Deployer

getOnsWalletPassword

java.lang.String getOnsWalletPassword()

The wallet password attribute that is included as part of the ONS client configuration string. This attribute is only required when ONS is configured to use the SSL protocol.

The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.

Returns:

The clear text value of the ONS wallet password if it can be determined

Access limited to the following security roles:

Deployer

setOnsWalletPassword

void setOnsWalletPassword(java.lang.String password)

Access limited to the following security roles:

Deployer

isOracleEnableJavaNetFastPath

@Deprecated
boolean isOracleEnableJavaNetFastPath()

Deprecated.

12.2.1.3.1

This option no longer does anything.

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setOracleEnableJavaNetFastPath

@Deprecated
void setOracleEnableJavaNetFastPath(boolean oracleEnableJavaNetFastPath)

Deprecated.

12.2.1.3.1

isOracleOptimizeUtf8Conversion

boolean isOracleOptimizeUtf8Conversion()

Deprecated.

14.1.2.0.0

Enables the Oracle JDBC optimize UTF-8 conversion option (no longer supported).

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setOracleOptimizeUtf8Conversion

void setOracleOptimizeUtf8Conversion(boolean oracleOptimizeUtf8Conversion)

Deprecated.

14.1.2.0.0

getConnectionInitializationCallback

java.lang.String getConnectionInitializationCallback()

The name of the Connection Initialization Callback class.

This name is automatically passed to registerConnectionInitializationCallback when a data source is created. The class must implement oracle.ucp.jdbc.ConnectionInitializationCallback.

setConnectionInitializationCallback

void setConnectionInitializationCallback(java.lang.String className)

getAffinityPolicy

java.lang.String getAffinityPolicy()

The affinity policy determines how JDBC connections to specific Oracle RAC instances are selected and returned to the application. When an initial connection is returned to the application, an affinity context is created that identifies the RAC instance. The affinity context is stored in the application context (global transaction or http session), propagates with the context, and is used during subsequent connection requests to return a connection to the same instance.

Options include:

• Transaction: Transaction affinity where the affinity context is associated with the JTA global transaction context.
• Session: Web-session affinity where the affinity context is stored in the http session. The affinity policy automatically changes to Transaction if a global transaction is started in the web session.
• Data: Currently not supported.
• None: No affinity.

The affinity policy only applies to Active GridLink data sources.

Default Value:

"Session"

Valid Values:

"Transaction", "Session", "Data", "None"

setAffinityPolicy

void setAffinityPolicy(java.lang.String affinityPolicy)

isOracleProxySession

boolean isOracleProxySession()

Enables Oracle JDBC Proxy Authentication.

• Only applicable for the Oracle driver.
• Requires WebLogic Server user IDs are mapped to database user IDs using credential mapping.

Default Value:

false

setOracleProxySession

void setOracleProxySession(boolean oracleProxySession)

isUseDatabaseCredentials

boolean isUseDatabaseCredentials()

If enabled, Oracle database credentials are used in getConnection instead of application server credentials. The database credentials are used to get a proxy session without requiring any work in the credential mapper.

Default Value:

false

setUseDatabaseCredentials

void setUseDatabaseCredentials(boolean useDatabaseCredentials)

getReplayInitiationTimeout

int getReplayInitiationTimeout()

The amount of time, in seconds, a data source allows for Application Continuity replay processing before timing out and ending a replay session context.

• When set to zero (0) seconds, replay processing (failover) is disabled, although begin/endRequest are still called. You can use this for collecting coverage and measuring performance.
• The default value is 3600 seconds.
• See oracle.ucp.jdbc.ConnectionInitializationCallback.

Default Value:

3600

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setReplayInitiationTimeout

void setReplayInitiationTimeout(int replayInitiationTimeout)

isActiveGridlink

boolean isActiveGridlink()

Indicates a configured Active GridLink datasource. This attributed is set to true when using the console to create an Active GridLink datasource. It is ignored if FanEnabled is true or OnsNodeList is a non-null string.

Default Value:

false

setActiveGridlink

void setActiveGridlink(boolean activeGridlink)

isRebalanceOnUpEvent

boolean isRebalanceOnUpEvent()

Rebalancing connections incurs overhead due to connection creation to the new instance, and the closing of connections to existing instances, which may impact application performance under load, cause database logon storms, etc. When the value is set to false, connections to existing instances are preserved and new connections are distributed across running instances as necessary.

Default Value:

true

setRebalanceOnUpEvent

void setRebalanceOnUpEvent(boolean rebalance)