Quickstarts

jts: Java Transaction Service - Distributed EJB Transactions Across Multiple Containers

What is it?

This example demonstrates how to perform distributed transactions in an application. A distributed transaction is a set of operations performed by two or more nodes, participating in an activity coordinated as a single entity of work, and fulfilling the properties of an ACID transaction.

ACID is a set of 4 properties that guarantee the resources are processed in the following manner:

  • Atomic - if any part of the transaction fails, all resources remain unchanged.
  • Consistent - the state will be consistent across resources after a commit
  • Isolated - the execution of the transaction for each resource is isolated from each others
  • Durable - the data will persist after the transaction is committed

The example uses Java Transaction Service (JTS) to propagate a transaction context across two Container-Managed Transaction (CMT) EJBs that, although deployed in separate servers, participate in the same transaction. In this example, one server processes the Customer and Account data and the other server processes the Invoice data.

The code base is essentially the same as the cmt quickstart, however in this case the InvoiceManager has been separated to a different deployment archive to demonstrate the usage of JTS. You can see the changes in the following ways:

  1. cmt/src/main/java/org/jboss/as/quickstarts/cmt/ejb/InvoiceManagerEJB.java has been moved to application-component-2/src/main/java/org/jboss/as/quickstarts/cmt/jts/ejb/InvoiceManagerEJB
  2. cmt/src/main/java/org/jboss/as/quickstarts/cmt/ejb/CustomerManagerEJB.java has been moved to jts/application-component-1/src/main/java/org/jboss/as/quickstarts/cmt/jts/ejb/CustomerManagerEJB.java

The changes to CustomerManagerEJB are purely to accommodate the fact that InvoiceManager is now distributed.

You will see that the CustomerManagerEJB uses the EJB home for the remote EJB, this is expected to connect to remote EJBs. The example expects the EJBs to be deployed onto the same physical machine. This is not a restriction of JTS and the example can easily be converted to run on separate machines by editing the hostname value for the InvoiceManagerEJB in org.jboss.as.quickstarts.cmt.jts.ejb.CustomerManagerEJB.

A simple MDB has been provided that prints out the messages sent but this is not a transactional MDB and is purely provided for debugging purposes.

After users complete this quickstart, they are invited to run through the following quickstart:

  1. jts-distributed-crash-rec - The crash recovery quickstart builds upon the jts quickstart by demonstrating the fault tolerance of JBossAS.

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Prerequisites

Developers should be familiar with the concepts introduced in the cmt quickstart.

This quickstart requires the configuration of two servers. The first server must be configured to use the PostgreSQL database. Instructions to install and configure PostgreSQL are below.

Install the PostgreSQL Database

This quickstart requires the PostgreSQL database. Instructions to install an configure PostgreSQL can be found here: Install and Configure the PostgreSQL Database

Note: For the purpose of this quickstart, replace the word QUICKSTART_DATABASENAME with jts-quickstart-database in the PostgreSQL instructions.

Be sure to start the PostgreSQL database. Unless you have set up the database to automatically start as a service, you must repeat the instructions "Start the database server" for your operating system every time you reboot your machine.

Wait until later in these instructions to add the PostgreSQL module and driver configuration to the first JBoss server.

Configure the JBoss Servers

For this example, you will need two instances of the application server, with a subtle startup configuration difference. Application server 2 must be started up with a port offset parameter provided to the startup script as "-Djboss.socket.binding.port-offset=100".

Since both application servers must be configured in the same way, you must configure the first server and then clone it. After you clone the second server, the first server must be configured for PostgreSQL.

Modify the Server Configuration file.

You can configure the server by running the configure-jts-transactions.cli script provided in the root directory of this quickstart, by using the JBoss CLI interactively, or by manually editing the configuration file.

NOTE - Before you begin:

  1. If it is running, stop the JBoss server.
  2. Backup the file: JBOSS_HOME/standalone/configuration/standalone-full.xml
  3. After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration.

Modify the Server Configuration by Running the JBoss CLI Script

  1. Start the JBoss server with the full profile, passing a unique node ID by typing the following command. Be sure to replace UNIQUE_NODE_ID with a node identifier that is unique to both servers.

    For Linux:  JBOSS_HOME/bin/standalone.sh -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID
    For Windows:  JBOSS_HOME\bin\standalone.bat -c standalone-full.xml  -Djboss.tx.node.id=UNIQUE_NODE_ID
    
  2. Open a new command line, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:

    JBOSS_HOME/bin/jboss-cli.sh --connect --file=configure-jts-transactions.cli
    

    This script configures the server to use jts transaction processing. You should see the following result when you run the script:

    #1 /subsystem=jacorb:write-attribute(name=transactions,value=on)
    #2 /subsystem=jacorb:write-attribute(name=name,value=${jboss.node.name})
    #3 /subsystem=jacorb:write-attribute(name=root-context,value=${jboss.node.name}/Naming/root)
    #4 /subsystem=transactions:write-attribute(name=jts,value=true)
    #5 /subsystem=transactions:write-attribute(name=node-identifier,value=${jboss.tx.node.id}
    The batch executed successfully.
    {"outcome" => "success"}
    

Modify the Server Configuration Using the JBoss CLI Tool Interactively

  1. Start the JBoss server with the full profile, passing a unique node ID by typing the following command. Be sure to replace UNIQUE_NODE_ID with a node identifier that is unique to both servers.

    For Linux:  JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID
    For Windows:  JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID
    
  2. To start the JBoss CLI tool, open a new command line, navigate to the JBOSS_HOME directory, and type the following:

    For Linux: bin/jboss-cli.sh --connect
    For Windows: bin\jboss-cli.bat --connect
    
  3. At the prompt, type the following exactly as it appears. The server will replace ${jboss.node.name} with the actual node name and will replace ${jboss.tx.node.id} with the unique node ID value you passed as a parameter on the server start command line.

    /subsystem=jacorb/:write-attribute(name=transactions,value=on)
    /subsystem=jacorb:write-attribute(name=name,value=${jboss.node.name})
    /subsystem=jacorb:write-attribute(name=root-context,value=${jboss.node.name}/Naming/root)
    
    /subsystem=transactions/:write-attribute(name=jts,value=true)
    /subsystem=transactions/:write-attribute(name=node-identifier,value=${jboss.tx.node.id})
    
    :reload
    
  4. NOTE: When you have completed testing this quickstart, it is important to Remove the JTS Configuration from the JBoss Server.

Modify the Server Configuration Manually

  1. Make a backup copy of the JBOSS_HOME/standalone/configuration/standalone-full.xml file.
  2. Open the file JBOSS_HOME/standalone/configuration/standalone-full.xml
  3. Enable JTS as follows:

    • Find the orb subsystem and change the configuration to:

      <subsystem xmlns="urn:jboss:domain:jacorb:1.2">
          <orb>
              <initializers security="on" transactions="on"/>
          </orb>
      </subsystem>
      <subsystem xmlns="urn:jboss:domain:jacorb:1.1">
          <orb name="${jboss.node.name}">
              <initializers security="on" transactions="on"/>
          </orb>
          <naming root-context="${jboss.node.name}/Naming/root"/>
      </subsystem>
      
    • Find the transaction subsystem and append the <jts/> element:

      <subsystem xmlns="urn:jboss:domain:transactions:1.2">
          <core-environment node-identifier="${jboss.tx.node.id}">
          <!-- LEAVE EXISTING CONFIG AND APPEND THE FOLLOWING -->
          <jts/>
      </subsystem>
      
  4. NOTE: When you have completed testing this quickstart, it is important to Remove the JTS Configuration from the JBoss Server.

Clone the JBOSS_HOME Directory

Make a copy of this JBoss directory structure to use for the second server.

Configure Server1 to use PostgreSQL

  1. Application server 1 must be configured to use PostgreSQL as per the instructions in Install and Configure the PostgreSQL Database.

Start the JBoss servers

Start the the two JBoss EAP servers with the full profile, passing a unique node ID by typing the following command. You must pass a socket binding port offset on the command to start the second server. Be sure to replace UNIQUE_NODE_ID with a node identifier that is unique to both servers.

If you are using Linux:

    Server 1: JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID
    Server 2: JBOSS_HOME_SERVER_2/bin/standalone.sh -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID -Djboss.socket.binding.port-offset=100

If you are using Windows

    Server 1: JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID
    Server 2: JBOSS_HOME_SERVER_2\bin\standalone.bat -c standalone-full.xml -Djboss.tx.node.id=UNIQUE_NODE_ID -Djboss.socket.binding.port-offset=100

Build and Deploy the Quickstart

Since this quickstart builds two separate components, you can not use the standard Build and Deploy commands used by most of the other quickstarts. You must follow these steps to build, deploy, and run this quickstart.

  1. Make sure you have started the JBoss server with the PostgreSQL driver
  2. Open a command line and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

    mvn clean install jboss-as:deploy
    
  4. This will deploy application-component-1/target/jboss-jts-application-component-1.war and application-component-2/target/jboss-jts-application-component-2.jar to the running instance of the server.

Access the application

The application will be running at the following URL: http://localhost:8080/jboss-jts-application-component-1/.

When you enter a name and click to "Add" that customer, you will see the following in the application server 1 console:

14:31:48,334 WARNING [javax.enterprise.resource.webcontainer.jsf.renderkit] (http-localhost-127.0.0.1-8080-1) Unable to find component with ID name in view.
14:31:50,457 ERROR [jacorb.orb] (http-localhost-127.0.0.1-8080-1) no adapter activator exists for jts-quickstart&%InvoiceManagerEJBImpl&%home
14:31:50,767 INFO  [org.jboss.ejb.client] (http-localhost-127.0.0.1-8080-1) JBoss EJB Client version 1.0.5.Final
14:31:51,430 WARN  [com.arjuna.ats.jts] (RequestProcessor-5) ARJUNA022261: ServerTopLevelAction detected that the transaction was inactive

You will also see the following in application-server-2 console:

14:31:50,750 INFO  [org.jboss.ejb.client] (RequestProcessor-10) JBoss EJB Client version 1.0.5.Final
14:31:51,395 INFO  [class org.jboss.as.quickstarts.cmt.jts.mdb.HelloWorldMDB] (Thread-1 (HornetQ-client-global-threads-1567863645)) Received Message: Created invoice for customer named: Tom

The web page will also change and show you the new list of customers.

Undeploy the Archive

  1. Make sure you have started the JBoss Server as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:

    mvn package jboss-as:undeploy
    

Remove the JTS Configuration from the JBoss Server

You must remove the JTS server configuration you did during setup because it interferes with the JTA quickstarts.

You can modify the server configuration by running the remove-jts-transactions.cli script provided in the root directory of this quickstart, by using the JBoss CLI interactively, or by manually editing the configuration file.

Remove the JTS Server Configuration by Running the JBoss CLI Script

  1. Start the JBoss server with the full profile.

    For Linux:  JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full.xml
    For Windows:  JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full.xml
    
  2. Open a new command line, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server:

    JBOSS_HOME/bin/jboss-cli.sh --connect --file=remove-jts-transactions.cli 
    

    This script removes the test queue from the messaging subsystem in the server configuration. You should see the following result when you run the script:

    #1 /subsystem=jacorb:write-attribute(name=transactions,value=spec)
    #2 /subsystem=jacorb:undefine-attribute(name=name)
    #3 /subsystem=transactions:undefine-attribute(name=jts)
    #4 /subsystem=transactions:undefine-attribute(name=node-identifier)
    The batch executed successfully.
    {"outcome" => "success"}
    

Remove the JTS Server Configuration using the JBoss CLI Tool

  1. Start the JBoss server with the full profile.

    For Linux:  JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full.xml
    For Windows:  JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full.xml
    
  2. To start the JBoss CLI tool, open a new command line, navigate to the JBOSS_HOME directory, and type the following:

    For Linux: bin/jboss-cli.sh --connect
    For Windows: bin\jboss-cli.bat --connect
    
  3. At the prompt, type the following:

    /subsystem=jacorb/:write-attribute(name=transactions,value=spec)
    /subsystem=jacorb/:undefine-attribute(name=name)
    /subsystem=transactions/:undefine-attribute(name=jts)
    /subsystem=transactions/:undefine-attribute(name=node-identifier)
    :reload
    

Remove the JTS Server Configuration Manually

  1. Stop the server.
  2. If you backed up the JBOSS_HOME/standalone/configuration/standalone-full.xml,simply replace the edited configuration file with the backup copy.
  3. If you did not make a backup copy, open the file JBOSS_HOME/standalone/configuration/standalone-full.xml and disable JTS as follows:
* Find the orb subsystem and change the configuration back to:

        <subsystem xmlns="urn:jboss:domain:jacorb:1.2">
            <orb>
                <initializers security="on" transactions="spec"/>
            </orb>
        </subsystem>
* Find the transaction subsystem and remove the `<jts/>` element:

        <subsystem xmlns="urn:jboss:domain:transactions:1.2">
            <!-- REMOVE node-identifier ATTRIBUTE FROM core-environment ELEMENT -->
            <!-- LEAVE EXISTING CONFIG AND REMOVE THE </jts> -->
        </subsystem>

Share the Knowledge

Find this guide useful?

Feedback

Find a bug in the guide? Something missing? You can fix it by [forking the repository](http://github.com/jboss-jdf/jboss-as-quickstart), making the correction and [sending a pull request](http://help.github.com/send-pull-requests). If you're just plain stuck, feel free to ask a question in the [user discussion forum](http://jboss.org/jdf/forums/jdf-users).

Recent Changelog

  • Nov 08, 2013: Bz1028448: add spaces to end of metadata so it renders with a line break in html Sande Gilda
  • Oct 08, 2013: Bz1011833: add html versions of readme files and fix deployment instructions Sande Gilda
  • Oct 02, 2013: Readme: add product versions metadata, remove versions in text, remove temp repo from settings.xml Sande Gilda
  • Sep 24, 2013: Remove references to jboss as 7 from the quickstarts Sande Gilda
  • Sep 23, 2013: Update metadata source urls to new repository Sande Gilda
  • Sep 13, 2013: Jdf-487: remove -as- from quickstart artifactid and archive names and access urls in readme files Sande Gilda
  • Jun 21, 2013: Fix bug 976791: jts and ejb-asynchronous readme files updates Sande Gilda
  • Jun 12, 2013: Modify readme file internal links to use generated anchors. remove hard-coded anchors. fixed obsolete links and other markdown rendering problems Sande Gilda
  • May 23, 2013: Jdf-327: add missing server configuration steps for jts quickstart Sande Gilda
  • May 13, 2013: Jdf issue 243: add jboss-cli scripts for all quickstarts that modify server configuration Sande Gilda
  • Feb 12, 2013: Add quickstart source repository of record to the readme files Sande Gilda
  • Dec 12, 2012: Fix issue 378: issues with cmt and jts readme files Sande Gilda
  • Nov 02, 2012: Ensure that the user knows to set the node-identifier Tom Jenkinson
  • Sep 06, 2012: Add jboss-cli commands in addition to the manual edits of the server config file. fix typo in postgresql Sande Gilda
  • Sep 11, 2012: Add target product (https://issues.jboss.org/browse/jdf-108) Sande Gilda

See full history »