WildFly Full 25 Model Reference

  1. home
  2. subsystem=transactions

The configuration of the transaction subsystem.

Children (2)

  • commit-markable-resource Configures a datasource to be considered by the transaction manager as a CMR resource. CMR is a non-XA database resource that can reliably participate in an XA transaction.
  • log-store Representation of the transaction logging storage mechanism.
    • log-store Representation of the transaction logging storage mechanism.

Provided capabilities(4)

Attributes (39)

  • average-commit-time The average time of transaction commit, measured from the moment the client calls commit until the transaction manager determines that the commit attempt was successful.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Unit NANOSECONDS
    Storage runtime
    Access Type metric
  • default-timeout The default timeout, in seconds, for a new transaction started by the transaction manager (see also the 'maximum-timeout' attribute).
    • Attribute Value
    Default Value 300
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Unit SECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • enable-statistics Whether transaction statistics should be gathered.
    • Deprecated Since 2.0.0
    Use statistics-enabled.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • enable-tsm-status Set to 'true' to enable the transaction status manager (TSM) service (used for out of process recovery). When 'true' the application server binds to the socket defined by the 'status-socket-binding' attribute.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • hornetq-store-enable-async-io Whether AsyncIO should be enabled for the journal store.
    • Deprecated Since 3.0.0
    Use journal-store-enable-async-io.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-action-store-drop-table If set to true then the jdbc-action-store table will be dropped during application server startup.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-action-store-table-prefix Optional prefix for the name of the database table used for writing transaction log records of the action store type.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-communication-store-drop-table If set to true then the jdbc-communication-store table will be dropped during application server startup.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-communication-store-table-prefix Optional prefix for the name of the database table used for writing transaction log records of the communication store type.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-state-store-drop-table If set to true then the jdbc-state-store table will be dropped during application server startup.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-state-store-table-prefix Optional prefix for the name of the database table used for writing transaction log records of the state store type.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-store-datasource The JNDI name of a non-XA datasource (i.e. one whose 'jta' attribute is set to false) to be used for the JDBC store. The datasource must be defined in the datasources subsystem.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • journal-store-enable-async-io Whether AsyncIO should be enabled for the journal store. When true, the transaction manager will use the native aio (POSIX asynchronous I/O) libraries provided by the platform, if available. Applicable only when use-journal-store is set true.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jts If true, this enables the Java Transaction Service (JTS). If JTS is enabled then the transactions attribute of the 'iiop-openjdk' subsystem must be set to 'full'. This setting changes the internal mechanisms used in the transaction manager. It has no impact on the user working with JTA API.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • maximum-timeout If the 'default-timeout' attribute is zero then this value is used for setting the maximum timeout value (in seconds) for newly started transactions.
    • Attribute Value
    Default Value 31536000
    Type INT
    Nillable true
    Expressions Allowed true
    Min 300
    Max 2,147,483,647
    Unit SECONDS
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • node-identifier Used to set the node identifier. Each Xid that the transaction manager creates will have this identifier encoded within it and ensures the transaction manager will only recover branches which match the specified identifier. It is imperative that this identifier is unique between application server instances which share either an object store or access common resource managers.
    • Attribute Value
    Default Value 1
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • number-of-aborted-transactions The number of aborted (i.e. rolled-back) transactions.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-application-rollbacks The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behavior is considered an attribute of the application configuration.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-committed-transactions The number of committed transactions.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-heuristics The number of transactions which have terminated with heuristic outcomes.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-inflight-transactions The number of transactions that have begun but not yet terminated.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-nested-transactions The total number of nested (sub) transactions created.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-resource-rollbacks The number of transactions that rolled back due to resource (participant) failure.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-system-rollbacks The number of transactions that have been rolled back due to internal system errors.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-timed-out-transactions The number of transactions that have rolled back due to timeout.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • number-of-transactions The total number of transactions (top-level and nested) created.
    • Attribute Value
    Type LONG
    Nillable true
    Expressions Allowed false
    Storage runtime
    Access Type metric
  • object-store-path Denotes a path where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. When the 'relative-to' attribute is undefined the value is considered an absolute path. This setting is valid when default or journal store is used. It's not used when the jdbc journal store is used.
    • Attribute Value
    Default Value tx-object-store
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • object-store-relative-to References a global path configuration in the domain model, defaulting to the application server data directory (jboss.server.data.dir). The value of the 'object-store-path' attribute will be treated as relative to this path. Undefine this attribute to disable the default behavior and force the value of the 'object-store-path' attribute to be treated as an absolute path.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • process-id-socket-binding The name of the socket binding to use if the transaction manager should use a socket-based generation of transaction id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • process-id-socket-max-ports The maximum number of ports to search for an open port if the transaction manager should use a socket-based generation of transaction id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • process-id-uuid Indicates a strategy used for obtaining a unique identifier needed for creation of transaction instances. When true then the transaction manager generates the transaction id based on process id (PID). When set to false then the transaction manager generates the transaction id based on the referenced socket binding, i.e. the attribute 'process-id-socket-binding' is required.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • recovery-listener Used to specify if the recovery system should listen on a network socket or not. When true the application server binds to a socket at the port defined by the 'socket-binding' attribute. When the recovery listener is activated the user can remotely control the recovery manager.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • socket-binding References an existing socket binding that the transaction manager will listen on for recovery requests.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • stale-transaction-time The time for which transaction that contains remote enlistments is held in memory after it is being completed.
    • Attribute Value
    Default Value 600
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Unit SECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • statistics-enabled Whether transaction statistics should be gathered. The statistics are available by reading subsystem attributes prefixed with 'number-' and within the 'average-commit-time' attribute.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • status-socket-binding References an existing socket binding that the transaction manager will listen on for transaction status requests.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • use-hornetq-store Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log.It's alternative to jdbc based store.
    • Deprecated Since 3.0.0
    Use use-journal-store.
    Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • use-jdbc-store Use the jdbc store for writing transaction logs. Data is saved in the database indicated by the 'jdbc-store-datasource' attribute. Set to true to enable. Note that the server will not boot if both 'use-journal-store' and 'use-jdbc-store' attributes are set to true. If both are set to false then the default filesystem based store will be used.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • use-journal-store Use the journal store for writing transaction logs. The journal store consists of one file for all the transactions. Set to true to enable. Note that the server will not boot if both 'use-journal-store' and 'use-jdbc-store' attributes are set to true. If both are set to false then the default filesystem based store will be used.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm

Operations (3)

  • add Adds the transaction subsystem.
    Request Parameter Type Required Expressions Allowed Default value Description
    default-timeout INT false true 300 The default timeout, in seconds, for a new transaction started by the transaction manager (see also the 'maximum-timeout' attribute).
    enable-statistics BOOLEAN false true false Whether transaction statistics should be gathered.
    enable-tsm-status BOOLEAN false true false Set to 'true' to enable the transaction status manager (TSM) service (used for out of process recovery). When 'true' the application server binds to the socket defined by the 'status-socket-binding' attribute.
    hornetq-store-enable-async-io BOOLEAN false true false Whether AsyncIO should be enabled for the journal store.
    jdbc-action-store-drop-table BOOLEAN false true false If set to true then the jdbc-action-store table will be dropped during application server startup.
    jdbc-action-store-table-prefix STRING false true Optional prefix for the name of the database table used for writing transaction log records of the action store type.
    jdbc-communication-store-drop-table BOOLEAN false true false If set to true then the jdbc-communication-store table will be dropped during application server startup.
    jdbc-communication-store-table-prefix STRING false true Optional prefix for the name of the database table used for writing transaction log records of the communication store type.
    jdbc-state-store-drop-table BOOLEAN false true false If set to true then the jdbc-state-store table will be dropped during application server startup.
    jdbc-state-store-table-prefix STRING false true Optional prefix for the name of the database table used for writing transaction log records of the state store type.
    jdbc-store-datasource STRING false true The JNDI name of a non-XA datasource (i.e. one whose 'jta' attribute is set to false) to be used for the JDBC store. The datasource must be defined in the datasources subsystem.
    journal-store-enable-async-io BOOLEAN false true false Whether AsyncIO should be enabled for the journal store. When true, the transaction manager will use the native aio (POSIX asynchronous I/O) libraries provided by the platform, if available. Applicable only when use-journal-store is set true.
    jts BOOLEAN false false false If true, this enables the Java Transaction Service (JTS). If JTS is enabled then the transactions attribute of the 'iiop-openjdk' subsystem must be set to 'full'. This setting changes the internal mechanisms used in the transaction manager. It has no impact on the user working with JTA API.
    maximum-timeout INT false true 31536000 If the 'default-timeout' attribute is zero then this value is used for setting the maximum timeout value (in seconds) for newly started transactions.
    node-identifier STRING false true 1 Used to set the node identifier. Each Xid that the transaction manager creates will have this identifier encoded within it and ensures the transaction manager will only recover branches which match the specified identifier. It is imperative that this identifier is unique between application server instances which share either an object store or access common resource managers.
    object-store-path STRING false true tx-object-store Denotes a path where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. When the 'relative-to' attribute is undefined the value is considered an absolute path. This setting is valid when default or journal store is used. It's not used when the jdbc journal store is used.
    object-store-relative-to STRING false true References a global path configuration in the domain model, defaulting to the application server data directory (jboss.server.data.dir). The value of the 'object-store-path' attribute will be treated as relative to this path. Undefine this attribute to disable the default behavior and force the value of the 'object-store-path' attribute to be treated as an absolute path.
    process-id-socket-binding STRING true true The name of the socket binding to use if the transaction manager should use a socket-based generation of transaction id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.
    process-id-socket-max-ports INT false true 10 The maximum number of ports to search for an open port if the transaction manager should use a socket-based generation of transaction id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.
    process-id-uuid BOOLEAN false false false Indicates a strategy used for obtaining a unique identifier needed for creation of transaction instances. When true then the transaction manager generates the transaction id based on process id (PID). When set to false then the transaction manager generates the transaction id based on the referenced socket binding, i.e. the attribute 'process-id-socket-binding' is required.
    recovery-listener BOOLEAN false true false Used to specify if the recovery system should listen on a network socket or not. When true the application server binds to a socket at the port defined by the 'socket-binding' attribute. When the recovery listener is activated the user can remotely control the recovery manager.
    socket-binding STRING true true References an existing socket binding that the transaction manager will listen on for recovery requests.
    stale-transaction-time INT false true 600 The time for which transaction that contains remote enlistments is held in memory after it is being completed.
    statistics-enabled BOOLEAN false true false Whether transaction statistics should be gathered. The statistics are available by reading subsystem attributes prefixed with 'number-' and within the 'average-commit-time' attribute.
    status-socket-binding STRING true true References an existing socket binding that the transaction manager will listen on for transaction status requests.
    use-hornetq-store BOOLEAN false false false Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log.It's alternative to jdbc based store.
    use-jdbc-store BOOLEAN false false false Use the jdbc store for writing transaction logs. Data is saved in the database indicated by the 'jdbc-store-datasource' attribute. Set to true to enable. Note that the server will not boot if both 'use-journal-store' and 'use-jdbc-store' attributes are set to true. If both are set to false then the default filesystem based store will be used.
    use-journal-store BOOLEAN false false false Use the journal store for writing transaction logs. The journal store consists of one file for all the transactions. Set to true to enable. Note that the server will not boot if both 'use-journal-store' and 'use-jdbc-store' attributes are set to true. If both are set to false then the default filesystem based store will be used.
  • remove Removes the transaction subsystem.
  • resolve-object-store-path Resolves a relative path of a previously named paths or one of the standard paths provided by the system.
    Request Parameter Type Required Expressions Allowed Default value Description
    relative-to-only BOOLEAN false false Indicates whether only the relative-to attribute should be resolved or the full path should be resolved. The default is false meaning the entire path will be resolved.

    Reply properties

    The resolved path from the relative path attribute.
    type
    STRING