WildFly Full 24 Model Reference

  1. home
  2. subsystem=transactions

The configuration of the transaction subsystem.

Children (2)

  • commit-markable-resource a CMR resource (i.e. a local 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 for a transaction managed by the transaction manager.
    • 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 Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not.
    • 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 Configure if jdbc action store should drop tables.
    • 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 table used to write transaction logs in configured jdbc action store.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-communication-store-drop-table Configure if jdbc communication store should drop tables.
    • 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 table used to write transaction logs in configured jdbc communication store.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-state-store-drop-table Configure if jdbc state store should drop tables.
    • 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 table used to write transaction logs in configured jdbc state store.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jdbc-store-datasource Jndi name of non-XA datasource used. Datasource sghould be define in datasources subsystem. For this would work the non-XA datasource has to be marked as jta="false".
    • 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. For this settings being active journal natives libraries needs to be available.
    • 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. Use of the JTS needs configuration in IIOP OpenJDK where Transactions parameter needs to be set to full.
    • 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 is zero then this value is consulted to set the maximum timeout (in seconds) for a transaction managed by the transaction manager.
    • 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 on the core environment. Each Xid that Transaction Manager creates will have this identifier encoded within it and ensures 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. rolledback) 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 relative or absolute filesystem path denoting 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. This settings is valid when default or journal store is used. It's not used when 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 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 configuration to use if the transaction manager should use a socket-based process 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 process 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 whether the transaction manager should use a UUID based process id.
    • 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.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • socket-binding Used to reference the correct socket binding to use for the recovery environment.
    • 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.
    • 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 Used to reference the correct socket binding to use for the transaction status manager.
    • 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. Set to true to enable and to false to use the default log store type. The default log store is normally one file file per transaction log. It's alternative to journal based store.
    • 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. Set to true to enable and to false to use the default log store type. The default log store creates normally one file system file per transaction log. The journal one consists from one file for all the transactions. It's alternative to jdbc based store.
    • 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 for a transaction managed by the transaction manager.
    enable-statistics BOOLEAN false true false Whether transaction statistics should be gathered.
    enable-tsm-status BOOLEAN false true false Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not.
    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 Configure if jdbc action store should drop tables.
    jdbc-action-store-table-prefix STRING false true Optional prefix for table used to write transaction logs in configured jdbc action store.
    jdbc-communication-store-drop-table BOOLEAN false true false Configure if jdbc communication store should drop tables.
    jdbc-communication-store-table-prefix STRING false true Optional prefix for table used to write transaction logs in configured jdbc communication store.
    jdbc-state-store-drop-table BOOLEAN false true false Configure if jdbc state store should drop tables.
    jdbc-state-store-table-prefix STRING false true Optional prefix for table used to write transaction logs in configured jdbc state store.
    jdbc-store-datasource STRING false true Jndi name of non-XA datasource used. Datasource sghould be define in datasources subsystem. For this would work the non-XA datasource has to be marked as jta="false".
    journal-store-enable-async-io BOOLEAN false true false Whether AsyncIO should be enabled for the journal store. For this settings being active journal natives libraries needs to be available.
    jts BOOLEAN false false false If true this enables the Java Transaction Service. Use of the JTS needs configuration in IIOP OpenJDK where Transactions parameter needs to be set to full.
    maximum-timeout INT false true 31536000 If the default timeout is zero then this value is consulted to set the maximum timeout (in seconds) for a transaction managed by the transaction manager.
    node-identifier STRING false true 1 Used to set the node identifier on the core environment. Each Xid that Transaction Manager creates will have this identifier encoded within it and ensures 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 relative or absolute filesystem path denoting 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. This settings is valid when default or journal store is used. It's not used when 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 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 configuration to use if the transaction manager should use a socket-based process 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 process 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 whether the transaction manager should use a UUID based process id.
    recovery-listener BOOLEAN false true false Used to specify if the recovery system should listen on a network socket or not.
    socket-binding STRING true true Used to reference the correct socket binding to use for the recovery environment.
    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.
    status-socket-binding STRING true true Used to reference the correct socket binding to use for the transaction status manager.
    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. Set to true to enable and to false to use the default log store type. The default log store is normally one file file per transaction log. It's alternative to journal based store.
    use-journal-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 creates normally one file system file per transaction log. The journal one consists from one file for all the transactions. It's alternative to jdbc based store.
  • 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