weblogic.management.configuration
Interface JTAMBean

All Superinterfaces:

ConfigurationMBean

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."

SSLNOTREQUIRED

static final String SSLNOTREQUIRED

See Also:

Constant Field Values

SSLREQUIRED

static final String SSLREQUIRED

See Also:

Constant Field Values

CLIENTCERTREQUIRED

static final String CLIENTCERTREQUIRED

See Also:

Constant Field Values

getTimeoutSeconds

int getTimeoutSeconds()

Specifies the maximum amount of time, in seconds, an active transaction is allowed to be in the first phase of a two-phase commit transaction. If the specified amount of time expires, the transaction is automatically rolled back.

Returns:

Transaction timeout in seconds.

Default Value:

30

setTimeoutSeconds

void setTimeoutSeconds(int timeout)
                       throws InvalidAttributeValueException,
                              DistributedManagementException

Sets the value of the TimeoutSeconds attribute.

Parameters:

timeout - Transaction timeout in seconds.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getTimeoutSeconds()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getAbandonTimeoutSeconds

int getAbandonTimeoutSeconds()

Specifies the maximum amount of time, in seconds, a transaction manager persists in attempting to complete the second phase of a two-phase commit transaction.

During the second phase of a two-phase commit transaction, the transaction manager continues to try to complete the transaction until all resource managers indicate that the transaction is completed. 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 rolls 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

setAbandonTimeoutSeconds

void setAbandonTimeoutSeconds(int timeout)
                              throws InvalidAttributeValueException,
                                     DistributedManagementException

Sets the value of the AbandonTimeoutSeconds attribute.

Parameters:

timeout - Abandon timeout in seconds.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getAbandonTimeoutSeconds()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getCompletionTimeoutSeconds

int getCompletionTimeoutSeconds()

Specifies the maximum amount of time, in seconds, a transaction manager waits for all resource managers to respond and indicate if the transaction can be committed or rolled back.

• The default value is 0, which sets the value to approximately twice the default transaction-timeout value with a maximum value of 120 seconds. This value provides backward compatibility for prior releases without this setting.
• If the specified value is -1, the maximum value supported by this attribute is used.
• If the specified value exceeds the value set for abandon-timeout-seconds, the value of abandon-timeout-seconds is used.

Returns:

Completion timeout in seconds.

Default Value:

0

setCompletionTimeoutSeconds

void setCompletionTimeoutSeconds(int completionTimeout)
                                 throws InvalidAttributeValueException,
                                        DistributedManagementException

Sets the value of the CompletionTimeoutSeconds attribute.

Parameters:

completionTimeout - Completion timeout in seconds.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getCompletionTimeoutSeconds()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

-1

getForgetHeuristics

boolean getForgetHeuristics()

Specifies whether the transaction manager automatically performs an XA Resource 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

setForgetHeuristics

void setForgetHeuristics(boolean forget)
                         throws InvalidAttributeValueException,
                                DistributedManagementException

Sets the value of the ForgetHeuristics attribute.

Parameters:

forget - Whether or not to forget heuristic transactions in affected resource managers.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getForgetHeuristics()

getBeforeCompletionIterationLimit

int getBeforeCompletionIterationLimit()

The maximum number of cycles that the transaction manager performs 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 synchronization occurs.

Returns:

The maximum beforeCompletion iterations

Default Value:

10

setBeforeCompletionIterationLimit

void setBeforeCompletionIterationLimit(int iterations)
                                       throws InvalidAttributeValueException,
                                              DistributedManagementException

Sets the value of the BeforeCompletionIterationLimit attribute.

Parameters:

iterations - The maximum number of beforeCompletion iterations among registered objects.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getBeforeCompletionIterationLimit()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getMaxTransactions

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

setMaxTransactions

void setMaxTransactions(int max)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Sets the value of the MaxTransactions attribute.

Parameters:

max - The maximum number of concurrent transactions.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getMaxTransactions()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

1

getMaxUniqueNameStatistics

int getMaxUniqueNameStatistics()

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

The first 1001 unique transaction names are maintained as their own transaction name and stored in each statistic. After the 1001st transaction name is reached, the transaction name is stored as weblogic.transaction.statistics.namedOverflow, and the transaction statistic is also merged and maintained in weblogic.transaction.statistics.namedOverflow.

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

Returns:

Limit of individual transaction name statistics.

Default Value:

1000

setMaxUniqueNameStatistics

void setMaxUniqueNameStatistics(int max)
                                throws InvalidAttributeValueException,
                                       DistributedManagementException

Sets the value of the MaxUniqueNameStatistics attribute.

Parameters:

max - Limit of individual transaction name statistics

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getMaxUniqueNameStatistics()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getMaxResourceRequestsOnServer

int getMaxResourceRequestsOnServer()

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

Returns:

The maxResourceRequestsOnServer value

Default Value:

50

getMaxXACallMillis

long getMaxXACallMillis()

Maximum allowed time duration, in milliseconds, for 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

getMaxResourceUnavailableMillis

long getMaxResourceUnavailableMillis()

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

Returns:

The maxResourceUnavailableMillis value

Default Value:

1800000

getCheckpointIntervalSeconds

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

setCheckpointIntervalSeconds

void setCheckpointIntervalSeconds(int interval)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Sets value of the CheckpointIntervalSeconds attribute.

Parameters:

interval - The new checkpointIntervalSeconds value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getCheckpointIntervalSeconds()

Maximum Value:

1800

Minimum Value:

10

getSerializeEnlistmentsGCIntervalMillis

long getSerializeEnlistmentsGCIntervalMillis()

The time interval, in milliseconds, at which internal objects used to serialize resource enlistment are cleaned up.

Returns:

The serializeEnlistmentsGCIntervalMillis value

Default Value:

30000

Minimum Value:

0

setParallelXAEnabled

void setParallelXAEnabled(boolean enabled)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Sets the value of the ParallelXAEnabled attribute.

Parameters:

enabled - The new enabled value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getParallelXAEnabled()

getUnregisterResourceGracePeriod

int getUnregisterResourceGracePeriod()

The amount of time, in seconds, a transaction manager waits for transactions involving the resource to complete before unregistering a resource. This grace period helps 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 blocks until the call returns 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 outstanding transactions are associated with the resource, the unregisterResource call returns and a log message is written to the server on which the resource was previously registered.

Returns:

The unregisterResource grace period in seconds.

Default Value:

30

setUnregisterResourceGracePeriod

void setUnregisterResourceGracePeriod(int seconds)
                                      throws InvalidAttributeValueException,
                                             DistributedManagementException

Sets the unregisterResource grace period.

Parameters:

seconds - The new grace period value.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getUnregisterResourceGracePeriod()

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getSecurityInteropMode

String getSecurityInteropMode()

Specifies the security mode of the communication channel used for XA calls between servers that participate in a global transaction. All server instances in a domain must have the same security mode setting.

Security Interoperability Mode options:

• default The transaction coordinator makes calls using the kernel identity over an admin channel if it is enabled, and anonymous otherwise. Man-in-the-middle attacks are possible if the admin channel is not enabled.
• performance The transaction coordinator makes calls using anonymous at all times. This implies a security risk since a malicious third party could then try to affect the outcome of transactions using a man-in-the-middle attack.
• compatibility The transaction coordinator makes calls as the kernel identity over an insecure channel. This is a high security risk because a successful man-in-the-middle attack would allow the attacker to gain administrative control over both domains. This setting should only be used when strong network security is in place.

Returns:

The security interoperability mode.

Default Value:

"default"

Valid Values:

"default", "performance", "compatibility"

setSecurityInteropMode

void setSecurityInteropMode(String mode)
                            throws InvalidAttributeValueException,
                                   DistributedManagementException

Sets the value of the SecurityInteropMode attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getSecurityInteropMode()

getWSATTransportSecurityMode

String getWSATTransportSecurityMode()

Specifies transport security mode required by WebService Transaction endpoints.

Transport Security options:

• SSLNotRequired All WebService Transaction protocol messages are exchanged over the HTTP channel.
• SSLRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS.
• ClientCertRequired All WebService Transaction protocol messages are and can only be exchanged over the HTTPS, and WLS enforces the presence of client certificate

Returns:

The WSAT transport security mode.

Default Value:

"SSLNotRequired"

Valid Values:

"SSLNotRequired", "SSLRequired", "ClientCertRequired"

setWSATTransportSecurityMode

void setWSATTransportSecurityMode(String mode)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Sets the value of the WSATTransportSecurityMode attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.getWSATTransportSecurityMode()

isWSATIssuedTokenEnabled

boolean isWSATIssuedTokenEnabled()

Specifies whether to use issuedtoken to enable authentication between the WS-AT coordinator and participant.

Default Value:

false

setWSATIssuedTokenEnabled

void setWSATIssuedTokenEnabled(boolean enabled)
                               throws InvalidAttributeValueException,
                                      DistributedManagementException

Sets the value of the WSATIssuedTokenEnabled attribute.

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.isWSATIssuedTokenEnabled()

isTwoPhaseEnabled

boolean isTwoPhaseEnabled()

Indicates that the two-phase commit protocol is used to coordinate transactions across two or more resource managers.

If not selected:

• Two-phase commit is disabled and any attempt to use two-phase commit results in a RollbackException being thrown.
• All transaction logging is disabled, including checkpoint records.

Default Value:

true

setTwoPhaseEnabled

void setTwoPhaseEnabled(boolean isTwoPhaseEnabled)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Sets the value of the TwoPhaseEnabled attribute. When false, all transaction logging is disabled, including checkpoint records. Only one-phase commit processing is allowed.

Parameters:

isTwoPhaseEnabled - The new isTwoPhaseEnabled value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JTAMBean.isTwoPhaseEnabled()