JBoss EAP 6.1 Model Reference

  1. JBoss EAP 6.1
  2. subsystem=transactions

The configuration of the transaction subsystem.

Children (1)

  • log-store Representation of the transaction logging storage mechanism.
    • log-store Representation of the transaction logging storage mechanism.

Attributes (24)

  • default-timeout The default timeout.
    • Attribute Value
    Default Value 300
    Type INT
    Nillable true
    Expressions Allowed true
    Unit SECONDS
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • enable-statistics Whether statistics should be enabled.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-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 all-services
  • jdbc-action-store-drop-table Configure if jdbc action store should drop tables. Default is false. The server should be restarted for this setting to take effect.
    • 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 transcation logs in configured jdbc action store. The server should be restarted for this setting to take effect.
    • 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. Default is false. The server should be restarted for this setting to take effect.
    • 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 transcation logs in configured jdbc communication store. The server should be restarted for this setting to take effect.
    • 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. Default is false. The server should be restarted for this setting to take effect.
    • 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 transcation logs in configured jdbc state store. The server should be restarted for this setting to take effect.
    • 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. The server should be restarted for this setting to take effect.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • jts If true this enables the Java Transaction Service
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm
  • node-identifier Used to set the node identifier on the core environment.
    • Attribute Value
    Default Value 1
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • 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.
    • 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 JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.
    • Attribute Value
    Default Value jboss.server.data.dir
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • path Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.
    • Attribute Value
    Default Value var
    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 false
    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
    Type BOOLEAN
    Nillable false
    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
  • relative-to References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.
    • Attribute Value
    Default Value jboss.server.data.dir
    Type STRING
    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
  • 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 HornetQ 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. The server should be restarted for this setting to take effect. 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
  • 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 system file per transaction log. The server should be restarted for this setting to take effect. It's alternative to Horneq based store
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required jvm

Operations (4)

  • add Adds the transaction subsystem
    Request Parameter Type Required Expressions Allowed Default value Description
    jdbc-communication-store-drop-table BOOLEAN false true false Configure if jdbc communication store should drop tables. Default is false. The server should be restarted for this setting to take effect.
    relative-to STRING false true jboss.server.data.dir References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.
    process-id-uuid BOOLEAN true false Indicates whether the transaction manager should use a UUID based process id.
    socket-binding STRING true true Used to reference the correct socket binding to use for the recovery environment.
    jts BOOLEAN false false false If true this enables the Java Transaction Service
    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.
    path STRING false true var Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.
    jdbc-action-store-drop-table BOOLEAN false true false Configure if jdbc action store should drop tables. Default is false. The server should be restarted for this setting to take effect.
    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.
    default-timeout INT false true 300 The default timeout.
    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 system file per transaction log. The server should be restarted for this setting to take effect. It's alternative to Horneq based store
    jdbc-state-store-table-prefix STRING false true Optional prefix for table used to write transcation logs in configured jdbc state store. The server should be restarted for this setting to take effect.
    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'.
    use-hornetq-store BOOLEAN false false false Use the HornetQ 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. The server should be restarted for this setting to take effect. It's alternative to jdbc based store.
    jdbc-action-store-table-prefix STRING false true Optional prefix for table used to write transcation logs in configured jdbc action store. The server should be restarted for this setting to take effect.
    jdbc-state-store-drop-table BOOLEAN false true false Configure if jdbc state store should drop tables. Default is false. The server should be restarted for this setting to take effect.
    recovery-listener BOOLEAN false true false Used to specify if the recovery system should listen on a network socket or not.
    jdbc-store-datasource STRING false true Jndi name of non-XA datasource used. Datasource sghould be define in datasources subsystem. The server should be restarted for this setting to take effect.
    status-socket-binding STRING true true Used to reference the correct socket binding to use for the transaction status manager.
    jdbc-communication-store-table-prefix STRING false true Optional prefix for table used to write transcation logs in configured jdbc communication store. The server should be restarted for this setting to take effect.
    node-identifier STRING false true 1 Used to set the node identifier on the core environment.
    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..
    object-store-relative-to STRING false true jboss.server.data.dir References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.
    enable-statistics BOOLEAN false true false Whether statistics should be enabled.
  • 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
  • resolve-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