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

Part Number E41849-02

weblogic.j2ee.descriptor.wl
Interface JDBCXAParamsBean

All Superinterfaces:
SettableBean

public interface JDBCXAParamsBean
extends SettableBean

Contains the XA-related parameters of a data source.

Configuration parameters for a data source's XA-related behavior are specified using a XA parameters bean.

Access limited to the following security roles:
Deployer

Method Summary
 int getXaRetryDurationSeconds()
          Determines the duration in seconds for which the transaction manager will perform recover operations on the resource.
 int getXaRetryIntervalSeconds()
          The number of seconds between XA retry operations if XARetryDurationSeconds is set to a positive value.
 int getXaTransactionTimeout()
          The number of seconds to set as the transaction branch timeout.
 boolean isKeepLogicalConnOpenOnRelease()
          Enables WebLogic Server to keep the logical JDBC connection open for a global transaction when the physical XA connection is returned to the connection pool.
 boolean isKeepXaConnTillTxComplete()
          Enables WebLogic Server to associate the same XA database connection from the connection pool with a global transaction until the transaction completes.
 boolean isNeedTxCtxOnClose()
          Specifies whether the XA driver requires a distributed transaction context when closing various JDBC objects (result sets, statements, connections, and so forth).
 boolean isNewXaConnForCommit()
          Specifies that a dedicated XA connection is used for commit and rollback processing for a global transaction.
 boolean isRecoverOnlyOnce()
          Specifies that the transaction manager calls recover on the resource only once.
 boolean isResourceHealthMonitoring()
          Enables JTA resource health monitoring for an XA data source.
 boolean isRollbackLocalTxUponConnClose()
          Deprecated. 10.3.4.0
 boolean isXaEndOnlyOnce()
          Specifies that XAResource.end() is called only once for each pending XAResource.start().
 boolean isXaSetTransactionTimeout()
          Enables WebLogic Server to set a transaction branch timeout based on the value for XaTransactionTimeout.
 void setKeepLogicalConnOpenOnRelease(boolean keepLogicalConnOpenOnRelease)
           
 void setKeepXaConnTillTxComplete(boolean keepXaConnTillTxComplete)
           
 void setNeedTxCtxOnClose(boolean needTxCtxOnClose)
           
 void setNewXaConnForCommit(boolean newXaConnForCommit)
           
 void setRecoverOnlyOnce(boolean recoverOnlyOnce)
           
 void setResourceHealthMonitoring(boolean resourceHealthMonitoring)
           
 void setRollbackLocalTxUponConnClose(boolean rollbackLocalTxUponConnClose)
           
 void setXaEndOnlyOnce(boolean xaEndOnlyOnce)
           
 void setXaRetryDurationSeconds(int duration)
           
 void setXaRetryIntervalSeconds(int interval)
           
 void setXaSetTransactionTimeout(boolean xaSetTransactionTimeout)
           
 void setXaTransactionTimeout(int xaTransactionTimeout)
           
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 

Method Detail

isKeepXaConnTillTxComplete

boolean isKeepXaConnTillTxComplete()

Enables WebLogic Server to associate the same XA database connection from the connection pool with a global transaction until the transaction completes.

Only applies to connection pools that use an XA driver.

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

Default Value:
true

setKeepXaConnTillTxComplete

void setKeepXaConnTillTxComplete(boolean keepXaConnTillTxComplete)

isNeedTxCtxOnClose

boolean isNeedTxCtxOnClose()

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

When enabled, SQL exceptions that are thrown while closing the JDBC objects without a transaction context will be suppressed.

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

Default Value:
false

setNeedTxCtxOnClose

void setNeedTxCtxOnClose(boolean needTxCtxOnClose)

isXaEndOnlyOnce

boolean isXaEndOnlyOnce()

Specifies that XAResource.end() is called only once for each pending XAResource.start().

This option prevents the XA driver from calling XAResource.end(TMSUSPEND) and XAResource.end(TMSUCCESS) successively. Only applies to data sources that use an XA driver.

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

Default Value:
false

setXaEndOnlyOnce

void setXaEndOnlyOnce(boolean xaEndOnlyOnce)

isNewXaConnForCommit

boolean isNewXaConnForCommit()

Specifies that a dedicated XA connection is used for commit and rollback processing for a global transaction.

Only applies to data sources that use an XA driver.

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

Default Value:
false

setNewXaConnForCommit

void setNewXaConnForCommit(boolean newXaConnForCommit)

isKeepLogicalConnOpenOnRelease

boolean isKeepLogicalConnOpenOnRelease()

Enables WebLogic Server to keep the logical JDBC connection open for a global transaction when the physical XA connection is returned to the connection pool.

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 be returned to the connection pool).

Only applies to data sources that use an XA driver.

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

Default Value:
false

setKeepLogicalConnOpenOnRelease

void setKeepLogicalConnOpenOnRelease(boolean keepLogicalConnOpenOnRelease)

isResourceHealthMonitoring

boolean isResourceHealthMonitoring()

Enables JTA resource health monitoring for an XA data source. When enabled, if an XA resource fails to respond to an XA call within the period specified in MaxXACallMillis, WebLogic Server marks the data source as unhealthy and blocks any further calls to the resource.

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

Default Value:
true

setResourceHealthMonitoring

void setResourceHealthMonitoring(boolean resourceHealthMonitoring)

isRecoverOnlyOnce

boolean isRecoverOnlyOnce()

Specifies that the transaction manager calls recover on the resource only once. Only applies to data sources that use an XA driver.

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

Default Value:
false

setRecoverOnlyOnce

void setRecoverOnlyOnce(boolean recoverOnlyOnce)

isXaSetTransactionTimeout

boolean isXaSetTransactionTimeout()

Enables WebLogic Server to set a transaction branch timeout based on the value for XaTransactionTimeout.

When enabled, the WebLogic Server Transaction Manager calls XAResource.setTransactionTimeout() before calling XAResource.start, and passes either the XA Transaction Timeout value or the global transaction timeout.

You may want to set a transaction branch timeout if you have long-running transactions that exceed the default timeout value on the XA resource.

Note: To use this feature, the resource manager (typically, the JDBC driver) must support the javax.transaction.xa.XAResource.setTransactionTimeout() method.

See Also:
JDBCXAParamsBean.getXaTransactionTimeout()
Default Value:
false

setXaSetTransactionTimeout

void setXaSetTransactionTimeout(boolean xaSetTransactionTimeout)

getXaTransactionTimeout

int getXaTransactionTimeout()

The number of seconds to set as the transaction branch timeout.

If set, this value is passed as the transaction timeout value in the XAResource.setTransactionTimeout() call on the XA resource manager, typically the JDBC driver.

When this value 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.

Note: You must enable XaSetTransactionTimeout to enable setting the transaction branch timeout.

See Also:
JDBCXAParamsBean.isXaSetTransactionTimeout()
Default Value:
0

setXaTransactionTimeout

void setXaTransactionTimeout(int xaTransactionTimeout)

isRollbackLocalTxUponConnClose

boolean isRollbackLocalTxUponConnClose()
Deprecated. 10.3.4.0

Enables WebLogic Server to call rollback() on the connection before returning the connection to the connection pool.

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

This option is deprecated. Its value is currently ignored.

Default Value:
false

setRollbackLocalTxUponConnClose

void setRollbackLocalTxUponConnClose(boolean rollbackLocalTxUponConnClose)

getXaRetryDurationSeconds

int getXaRetryDurationSeconds()
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)

getXaRetryIntervalSeconds

int getXaRetryIntervalSeconds()
The number of seconds between XA retry operations if XARetryDurationSeconds is set to a positive value.

Default Value:
60

setXaRetryIntervalSeconds

void setXaRetryIntervalSeconds(int interval)

Copyright 1996, 2014, 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.1.3)

Part Number E41849-02