BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.1 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 or later are not available through the deprecated MBeanHome interface.)


weblogic.management.configuration
Interface JTAMBean

All Superinterfaces:
ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface JTAMBean
extends ConfigurationMBean

This interface provides access to the JTA configuration attributes. The methods defined herein are applicable for JTA configuration at the domain level.

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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 int getAbandonTimeoutSeconds()
          The transaction abandon timeout seconds for transactions in the second phase of the two-phase commit (prepared and later).
 int getBeforeCompletionIterationLimit()
          The maximum number of cycles that the transaction manager will perform the beforeCompletion synchronization callback for this WebLogic Server domain.
 int getCheckpointIntervalSeconds()
          The interval at which the transaction manager creates a new transaction log file and checks all old transaction log files to see if they are ready to be deleted.
 boolean getForgetHeuristics()
          Specifies whether the transaction manager will automatically perform an XAResource forget operation for heuristic transaction completions.
 int getMaxResourceRequestsOnServer()
          Maximum number of concurrent requests to resources allowed for each server.
 long getMaxResourceUnavailableMillis()
          Maximum duration in milliseconds that a resource is declared dead.
 int getMaxTransactions()
          The maximum number of simultaneous in-progress transactions allowed on a server in this WebLogic Server domain.
 int getMaxUniqueNameStatistics()
          The maximum number of unique transaction names for which statistics will be maintained.
 long getMaxXACallMillis()
          Maximum allowed duration of XA calls to resources.
 String getSecurityInteropMode()
          Specifies the security mode to use for XA calls in cross-domain transactions.
 long getSerializeEnlistmentsGCIntervalMillis()
          The interval at which internal objects used to serialize resource enlistment are cleaned up.
 int getTimeoutSeconds()
          The transaction timeout seconds for active transactions, before the prepared state.
 int getUnregisterResourceGracePeriod()
          The grace period (number of seconds) that the transaction manager waits for transactions involving the resource to complete before unregistering a resource.
 void setAbandonTimeoutSeconds(int timeout)
          Sets the value of the AbandonTimeoutSeconds attribute.
 void setBeforeCompletionIterationLimit(int iterations)
          Sets the value of the BeforeCompletionIterationLimit attribute.
 void setCheckpointIntervalSeconds(int interval)
          Sets value of the CheckpointIntervalSeconds attribute.
 void setForgetHeuristics(boolean forget)
          Sets the value of the ForgetHeuristics attribute.
 void setMaxTransactions(int max)
          Sets the value of the MaxTransactions attribute.
 void setMaxUniqueNameStatistics(int max)
          Sets the value of the MaxUniqueNameStatistics attribute.
 void setSecurityInteropMode(String mode)
          Sets the value of the SecurityInteropMode attribute.
 void setTimeoutSeconds(int timeout)
          Sets the value of the TimeoutSeconds attribute.
 void setUnregisterResourceGracePeriod(int seconds)
          Sets the unregisterResource grace period.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
 

Method Detail

getAbandonTimeoutSeconds

public int getAbandonTimeoutSeconds()

The transaction abandon timeout seconds for transactions in the second phase of the two-phase commit (prepared and later).

During the second phase of the two-phase commit process, the transaction manager will continue to try to complete the transaction until all resource managers indicate that the transaction is completed. Using this timeout, you can set the maximum time that a transaction manager will persist in attempting to complete a transaction during the second phase of the transaction. After the abandon transaction timer expires, no further attempt is made to resolve the transaction. If the transaction is in a prepared state before being abandoned, the transaction manager will roll back the transaction to release any locks held on behalf of the abandoned transaction.

Returns:
Abandon timeout in seconds. Default is 24 hours.
Default value:
86400

getBeforeCompletionIterationLimit

public int getBeforeCompletionIterationLimit()

The maximum number of cycles that the transaction manager will perform the beforeCompletion synchronization callback for this WebLogic Server domain.

Nothing prevents a Synchronization object from registering another during beforeCompletion, even those whose beforeCompletions have already been called. For example, an EJB can call another in its ejbStore() method. To accommodate this, the transaction manager calls all Synchronization objects, then repeats the cycle if new ones have been registered. This count sets a limit to the number of cycles that can happen.

Returns:
The maximum beforeCompletion iterations
Default value:
10

getCheckpointIntervalSeconds

public int getCheckpointIntervalSeconds()

The interval at which the transaction manager creates a new transaction log file and checks all old transaction log files to see if they are ready to be deleted.

Returns:
The checkpointIntervalSeconds value
Default value:
300

getForgetHeuristics

public boolean getForgetHeuristics()

Specifies whether the transaction manager will automatically perform an XAResource forget operation for heuristic transaction completions.

When enabled, the transaction manager automatically performs an XA Resource forget() operation for all resources as soon as the transaction learns of a heuristic outcome. Disable this feature only if you know what to do with the resource when it reports a heuristic decision.

Returns:
true if heuristic transactions are to be forgotten in affected resource managers, false otherwise.
Default value:
true

getMaxResourceRequestsOnServer

public int getMaxResourceRequestsOnServer()

Maximum number of concurrent requests to resources allowed for each server.

Returns:
The maxResourceRequestsOnServer value
Default value:
50

getMaxResourceUnavailableMillis

public long getMaxResourceUnavailableMillis()

Maximum duration in milliseconds that a resource is declared dead. After the duration, the resource will be declared available again, even if the resource provider does not explicitly re-register the resource.

Returns:
The maxResourceUnavailableMillis value
Default value:
1800000

getMaxTransactions

public int getMaxTransactions()

The maximum number of simultaneous in-progress transactions allowed on a server in this WebLogic Server domain.

Returns:
The maximum number of concurrent transactions.
Default value:
10000

getMaxUniqueNameStatistics

public int getMaxUniqueNameStatistics()

The maximum number of unique transaction names for which statistics will be maintained.

A transaction name typically represents a category of business transactions (such as "funds-transfer")

Returns:
Limit of individual transaction name statistics.
Default value:
1000

getMaxXACallMillis

public long getMaxXACallMillis()

Maximum allowed duration of XA calls to resources. If a particular XA call to a resource exceeds the limit, the resource is declared unavailable.

Returns:
The maxXACallMillis value
Default value:
120000

getSecurityInteropMode

public String getSecurityInteropMode()

Specifies the security mode to use for XA calls in cross-domain transactions. Only applies to transactions in which some participating resources are running on older versions of WebLogic Server.

In previous releases of WebLogic Server, the transaction coordinator used the kernel identity when calling to remote resources, however calls were made over a non-secure channel. In the current release, remote calls made as the kernel identity must use a secure channel, which causes an interoperability problem with previous WebLogic domains and a possible performance problem in JTA with an admin channel enabled. The security interoperability mode setting enables you to control the XA call behavior.

Security Interoperability Mode options:

Returns:
The interop mode for cross-domain transactions.
Default value:
"default"
Legal values:
"default", "performance", "compatibility"
A configurable MBean attribute.
A dynamic MBean attribute.

getSerializeEnlistmentsGCIntervalMillis

public long getSerializeEnlistmentsGCIntervalMillis()

The interval at which internal objects used to serialize resource enlistment are cleaned up.

Returns:
The serializeEnlistmentsGCIntervalMillis value
Default value:
30000
Minimum value:
0

getTimeoutSeconds

public int getTimeoutSeconds()

The transaction timeout seconds for active transactions, before the prepared state.

If the transaction is still in the "active" state after this time (counting from begin()), it is automatically rolled back. Once the transaction moves on to the prepared state, however, this timeout does not apply; the transaction is retried until all the resources are committed.

Returns:
Transaction timeout in seconds.
Default value:
30

getUnregisterResourceGracePeriod

public int getUnregisterResourceGracePeriod()

The grace period (number of seconds) that the transaction manager waits for transactions involving the resource to complete before unregistering a resource. The grace period can help minimize the risk of abandoned transactions because of an unregistered resource, such as a JDBC data source module packaged with an application.

During the specified grace period, the unregisterResource call will block until the call can return, and no new transactions are started for the associated resource. If the number of outstanding transactions for the resource goes to 0, the unregisterResource call returns immediately.

At the end of the grace period, if there are still outstanding transactions associated with the resource, the unregisterResource call returns and a log message is written on the server on which the resource was previously registered.

Returns:
The unregisterResource grace period in seconds.
Default value:
30

setAbandonTimeoutSeconds

public void setAbandonTimeoutSeconds(int timeout)
                              throws InvalidAttributeValueException,
                                     weblogic.management.DistributedManagementException

Sets the value of the AbandonTimeoutSeconds attribute.

Parameters:
timeout - Abandon timeout in seconds.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getAbandonTimeoutSeconds()
Minimum value:
1
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

setBeforeCompletionIterationLimit

public void setBeforeCompletionIterationLimit(int iterations)
                                       throws InvalidAttributeValueException,
                                              weblogic.management.DistributedManagementException

Sets the value of the BeforeCompletionIterationLimit attribute.

Parameters:
iterations - The maximum number of beforeCompletion iterations among registered objects.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getBeforeCompletionIterationLimit()
Minimum value:
1
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

setCheckpointIntervalSeconds

public void setCheckpointIntervalSeconds(int interval)
                                  throws InvalidAttributeValueException,
                                         weblogic.management.DistributedManagementException

Sets value of the CheckpointIntervalSeconds attribute.

Parameters:
interval - The new checkpointIntervalSeconds value
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getCheckpointIntervalSeconds()
Minimum value:
10
Maximum value:
1800
A dynamic MBean attribute.

setForgetHeuristics

public void setForgetHeuristics(boolean forget)
                         throws InvalidAttributeValueException,
                                weblogic.management.DistributedManagementException

Sets the value of the ForgetHeuristics attribute.

Parameters:
forget - Whether or not to forget heuristic transactions in affected resource managers.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getForgetHeuristics()
A dynamic MBean attribute.

setMaxTransactions

public void setMaxTransactions(int max)
                        throws InvalidAttributeValueException,
                               weblogic.management.DistributedManagementException

Sets the value of the MaxTransactions attribute.

Parameters:
max - The maximum number of concurrent transactions.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getMaxTransactions()
Minimum value:
1
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

setMaxUniqueNameStatistics

public void setMaxUniqueNameStatistics(int max)
                                throws InvalidAttributeValueException,
                                       weblogic.management.DistributedManagementException

Sets the value of the MaxUniqueNameStatistics attribute.

Parameters:
max - Limit of individual transaction name statistics
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getMaxUniqueNameStatistics()
Minimum value:
0
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

setSecurityInteropMode

public void setSecurityInteropMode(String mode)
                            throws InvalidAttributeValueException,
                                   weblogic.management.DistributedManagementException

Sets the value of the SecurityInteropMode attribute.

Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getSecurityInteropMode()

setTimeoutSeconds

public void setTimeoutSeconds(int timeout)
                       throws InvalidAttributeValueException,
                              weblogic.management.DistributedManagementException

Sets the value of the TimeoutSeconds attribute.

Parameters:
timeout - Transaction timeout in seconds.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getTimeoutSeconds()
Minimum value:
1
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

setUnregisterResourceGracePeriod

public void setUnregisterResourceGracePeriod(int seconds)
                                      throws InvalidAttributeValueException,
                                             weblogic.management.DistributedManagementException

Sets the unregisterResource grace period.

Parameters:
seconds - The new grace period value.
Throws:
InvalidAttributeValueException
weblogic.management.DistributedManagementException
See Also:
getUnregisterResourceGracePeriod()
Minimum value:
0
Maximum value:
java.lang.Integer.MAX_VALUE
A dynamic MBean attribute.

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs91
Copyright 2005 BEA Systems Inc.