JTAClusterMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

       
Since12.1.2.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.JTAClusterMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
    Access Points Inherited from JTAMBean Because this MBean extends or implements JTAMBean, you can also access this MBean by retrieving JTAMBeans. The following attributes contain JTAMBeans and its subtypes:


      Attributes

      This section describes the following attributes:


      AbandonTimeoutSeconds

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value1
      Maximum value2147483647

      BeforeCompletionIterationLimit

      The maximum number of cycles that the transaction manager performs the beforeCompletion synchronization callback for this cluster.

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value1
      Maximum value2147483647

      CachingDisabled

      Private property that disables caching in proxies.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      CheckpointIntervalSeconds

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value10
      Maximum value1800

      ClusterwideRecoveryEnabled

      Indicates that cluster-wide recovery is used for distributed transactions.

      When enabled, recovery operations for a distributed transaction are applied to all the servers of the cluster hosting a InterposedTransactionManager rather than just the server hosting the InterposedTransactionManager.

             
      Privileges Read/Write
      Typeboolean

      CompletionTimeoutSeconds

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value-1
      Maximum value2147483647

      CrossDomainRecoveryRetryInterval

      The interval at which a store lock for a given server in a recovery domain will be checked for takeover eligibility.

      Deprecated. 12.2.1.3.0 Replaced with getSiteDomainRecoveryRetryInterval.

             
      Privileges Read/Write
      Typeint
      Default Value60
      Minimum value1
      Maximum value2147483647

      CrossSiteRecoveryLeaseExpiration

      The time after which a lease expires making it eligible for recovery by another site.

      Deprecated. 12.2.1.4.0

             
      Privileges Read/Write
      Typeint
      Default Value30
      Minimum value1
      Maximum value2147483647

      CrossSiteRecoveryLeaseUpdate

      The time in seconds in which to update at lease timestamp.

      Deprecated. 12.2.1.4.0

             
      Privileges Read/Write
      Typeint
      Default Value10
      Minimum value1
      Maximum value2147483647

      CrossSiteRecoveryRetryInterval

      The interval at which a lease for a given server in a recovery domain will be checked for takeover eligibility.

      Deprecated. 12.2.1.4.0

             
      Privileges Read/Write
      Typeint
      Default Value60
      Minimum value1
      Maximum value2147483647

      DeterminerCandidateResourceInfoList

      Returns a list of one or more transaction resources (determiners). A determiner's in-doubt transaction records are used during transaction recovery when a TLog is not present.

             
      Available Since Release 12.2.1.0.0
      Privileges Read only
      Type
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Determiners

      Specifies a list of one or more transaction resources (determiners) separated by line breaks. A determiner's in-doubt transaction records are used during transaction recovery when a TLog is not present.

             
      Privileges Read/Write
      Typeclass java.lang.String[]

      DynamicallyCreated

      Return whether the MBean was created dynamically or is persisted to config.xml

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      ForgetHeuristics

      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.

             
      Privileges Read/Write
      Typeboolean

      Id

      Return the unique id of this MBean instance

             
      Privileges Read only
      Typelong
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      MaxResourceRequestsOnServer

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

             
      Privileges Read/Write
      Typeint
      Minimum value10
      Maximum value2147483647

      MaxResourceUnavailableMillis

      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.

             
      Privileges Read/Write
      Typelong
      Minimum value0
      Maximum value9223372036854775807

      MaxRetrySecondsBeforeDeterminerFail

      The maximum amount of time, in seconds, WebLogic Server waits for the determiner to recover from a failure. If the determiner does not recover after this period, WebLogic Server sets the TLog health state to HEALTH_FAILED.

             
      Privileges Read/Write
      Typeint
      Default Value300
      Minimum value0
      Maximum value2147483647

      MaxTransactions

      The maximum number of simultaneous in-progress transactions allowed on a server in this cluster.

             
      Privileges Read/Write
      Typeint
      Minimum value1
      Maximum value2147483647

      MaxTransactionsHealthIntervalMillis

      The interval for which the transaction map must be full for the JTA subsystem to declare its health as CRITICAL.

             
      Privileges Read/Write
      Typelong
      Minimum value1000
      Maximum value9223372036854775807

      MaxUniqueNameStatistics

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

             
      Privileges Read/Write
      Typeint
      Minimum value0
      Maximum value2147483647

      MaxXACallMillis

      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.

             
      Privileges Read/Write
      Typelong
      Minimum value0
      Maximum value9223372036854775807

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      MigrationCheckpointIntervalSeconds

      The time interval, in seconds, that the checkpoint is done for the migrated transaction logs (TLOGs).

             
      Privileges Read/Write
      Typeint
      Minimum value1
      Maximum value2147483647

      Name

      The user-specified name of this MBean instance.

      This name is included as one of the key properties in the MBean's javax.management.ObjectName:

      Name=user-specified-name

             
      Privileges Read/Write
      Typejava.lang.String

      Notes

      Optional information that you can include to describe this configuration.

      WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

      Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

                 
      Privileges Read/Write
      Security rolesWrite access is granted only to the following roles:
      • Deployer
      • Operator
      Typejava.lang.String

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      ParallelXADispatchPolicy

      The dispatch policy to use when performing XA operations in parallel.

             
      Privileges Read/Write
      Typejava.lang.String

      ParallelXAEnabled

      Indicates that XA calls are executed in parallel if there are available threads.

             
      Privileges Read/Write
      Typeboolean

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      PurgeResourceFromCheckpointIntervalSeconds

      The interval that a particular resource must be accessed within for it to be included in the checkpoint record.

             
      Privileges Read/Write
      Typeint
      Minimum value0
      Maximum value2147483647

      RecoverySiteName

      The name of the site whose transactions this site/domain will recover in the event that intra-cluster transaction service migration is not successful or efficient.

      Deprecated. 12.2.1.4.0

             
      Privileges Read/Write
      Typejava.lang.String

      RecoveryThresholdMillis

      The interval that recovery is attempted until the resource becomes available.

             
      Privileges Read/Write
      Typelong
      Minimum value60000
      Maximum value9223372036854775807

      Registered

      Returns false if the MBean represented by this object has been unregistered.

      Deprecated.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SecurityInteropMode

      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:

             
      Privileges Read/Write
      Typejava.lang.String

      SerializeEnlistmentsGCIntervalMillis

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

             
      Privileges Read/Write
      Typelong
      Minimum value0

      ShutdownGracePeriod

      Indicates how long the server should wait for active transactions to complete before allowing shutdown.

             
      Privileges Read/Write
      Typeint
      Default Value180

      Tags

      Return all tags on this Configuration MBean

             
      Available Since Release 12.2.1.0.0
      Privileges Read/Write
      Typeclass java.lang.String[]

      TightlyCoupledTransactionsEnabled

      Indicates tight coupling of transaction branches that span different transaction manager systems.

      When enabled, WebLogic uses the transaction identifier of a transaction imported by the InterposedTransactionManager for XA calls rather than an internally mapped Xid. This applies to inter-domain WebLogic transactions and transactions imported from Tuxedo. This allows for tight coupling of transaction branches for transactions that span across different transaction manager systems.

      If a transaction between WebLogic and Tuxedo resources uses a GridLink Data Source with GridLink Affinity enabled, the XA Affinity context is automatically used for the transaction.

             
      Privileges Read/Write
      Typeboolean

      TimeoutSeconds

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value1
      Maximum value2147483647

      TLOGWriteWhenDeterminerExistsEnabled

      Indicates two-phase transaction recovery logs are written even if one or more determiners are configured.

             
      Privileges Read/Write
      Typeboolean

      TwoPhaseEnabled

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

      If not selected:

             
      Privileges Read/Write
      Typeboolean

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      UnregisterResourceGracePeriod

      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.

             
      Privileges Read/Write
      Typeint
      Minimum value0
      Maximum value2147483647

      UseNonSecureAddressesForDomains

      Returns the domains for which non-secure protocols should be used for internal JTA communication if the servers in the domains are configured to use network channels.

             
      Available Since Release 12.2.1.4.0
      Privileges Read/Write
      Typeclass java.lang.String[]

      UsePublicAddressesForRemoteDomains

      Returns the remote domains for which public addresses should be used if the servers in the domains are configured to use network channels for internal JTA communication.

             
      Available Since Release 12.2.1.4.0
      Privileges Read/Write
      Typeclass java.lang.String[]

      WSATIssuedTokenEnabled

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

             
      Privileges Read/Write
      Typeboolean

      WSATTransportSecurityMode

      Specifies transport security mode required by WebService Transaction endpoints.

      Transport Security options:

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSSLNotRequired
      Legal Values
      • SSLNotRequired
      • SSLRequired
      • ClientCertRequired


      Operations

      This section describes the following operations:


      addTag

      Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

         
      Operation Name"addTag"
      ParametersObject [] {  tag }

      where:

      • tag is an object of type java.lang.String that specifies:

        tag to be added to the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      freezeCurrentValue

      If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

      Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

      Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

      Deprecated. 9.0.0.0

         
      Operation Name"freezeCurrentValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException
      • javax.management.MBeanException

      getInheritedProperties

      Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

         
      Operation Name"getInheritedProperties"
      ParametersObject [] {  propertyNames }

      where:

      • propertyNames is an object of type [Ljava.lang.String; that specifies:

        properties to check

      SignatureString [] { "[Ljava.lang.String;" }
      Returns class

      isInherited

      Check if the value of a property is inherited from template mbean or not.

         
      Operation Name"isInherited"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        the name of the property

      SignatureString [] { "java.lang.String" }
      Returns boolean

      isSet

      Returns true if the specified attribute has been set explicitly in this MBean instance.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check

      SignatureString [] { "java.lang.String" }
      Returns boolean

      removeTag

      Remove a tag from this Configuration MBean

         
      Operation Name"removeTag"
      ParametersObject [] {  tag }

      where:

      • tag is an object of type java.lang.String that specifies:

        tag to be removed from the MBean

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.IllegalArgumentException
        IllegalArgumentException if the tag contains illegal punctuation

      restoreDefaultValue

      If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

      Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

      Deprecated. 9.0.0.0

         
      Operation Name"restoreDefaultValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore

      SignatureString [] { "java.lang.String" }
      Returns void