README.adoc

wsba-coordinator-completion-simple: Example of a WS-BA Enabled JAX-WS Web Service

The wsba-coordinator-completion-simple quickstart deploys a WS-BA (WS Business Activity) enabled JAX-WS Web service WAR (CoordinatorCompletion protocol).

What is it?

The wsba-coordinator-completion-simple quickstart demonstrates the deployment of a WS-BA (WS Business Activity) enabled JAX-WS Web service bundled in a WAR archive (Participant Completion protocol) for deployment to WildFly Application Server.

The Web service exposes a simple set collection as a service. The Service allows items to be added to the set within a Business Activity.

This example demonstrates the basics of implementing a WS-BA enabled Web service. It is beyond the scope of this quick start to demonstrate more advanced features. In particular:

• The Service does not implement the required hooks to support recovery in the presence of failures.

• It also does not utilize a transactional back-end resource.

• Only one web service participates in the protocol. As WS-BA is a coordination protocol, it is best suited to multi-participant scenarios.

For a more complete example, please see the XTS demonstrator application that ships with the Narayana project: http://narayana.io.

It is also assumed that you have an understanding of WS-BusinessActivity. For more details, read the XTS documentation that ships with the Narayana project: http://narayana.io/docs/product

The application consists of a single JAX-WS web service that is deployed within a WAR archive. It is tested with a JBoss Arquillian enabled JUnit test.

When running the org.jboss.as.quickstarts.wsba.coordinatorcompletion.simple.ClientTest#testSuccess() method, the following steps occur:

1. A new Business Activity is created by the client.

2. Multiple operations on a WS-BA enabled Web service is invoked by the client.

3. The JaxWSHeaderContextProcessor in the WS Client handler chain inserts the BA context into the outgoing SOAP messages.

4. When the service receives a SOAP request, the JaxWSHeaderContextProcessor in its handler chain inspects the BA context and associates the request with this BA.

5. The Web service operation is invoked.

6. For the first request, in this BA, A participant is enlisted in this BA. This allows the Web Service logic to respond to protocol events, such as compensate and close.

7. The service invokes the business logic. In this case, a String value is added to the set.

8. The client can then make additional calls to the SetService. As the SetService participates as a CoordinatorCompletion protocol, it will continue to accept calls to addValueToSet until it is told to complete by the coordinator.

9. The client can then decide to complete or cancel the BA.

   • If the client decides to complete, all participants will be told to complete. Providing all participants successfully complete, the coordinator will then tell all participants to close, otherwise the completed participants will be told to compensate.

   • If the participant decides to cancel, all participants will be told to compensate.

There is another test that shows how the client can cancel a BA.

Browse the source

System Requirements

The application this project produces is designed to be run on WildFly Application Server 31 or later.

All you need to build this project is Java 11.0 (Java SDK 11) or later and Maven 3.6.0 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.

Use of the WILDFLY_HOME and QUICKSTART_HOME Variables

In the following instructions, replace WILDFLY_HOME with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.

When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.

Start the WildFly Standalone Server

You must start WildFly with the XTS subsystem enabled.

1. Edit the log level to reduce the amount of log output. This should make it easier to read the logs produced by this example. To do this add the following logger block to the WILDFLY_HOME/standalone/configuration/standalone.xml of your JBoss distribution. You should add it just below one of the other logger blocks.

   <logger category="org.apache.cxf.service.factory.ReflectionServiceFactoryBean">
       <level name="WARN"/>
   </logger>

Configure the Server

You can configure the server by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-server.cli script provided in the root directory of this quickstart.

1. Before you begin, make sure you do the following:

   • Back up the WildFly standalone server configuration as described above.

   • Start the WildFly server with the standalone default profile :

     $ WILDFLY_HOME/bin/standalone.sh

2. Review the configure-server.cli file in the root of this quickstart directory. This script adds xts domain

3. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing WILDFLY_HOME with the path to your server:

   $ WILDFLY_HOME/bin/jboss-cli.sh --connect --file=configure-server.cli

   Note	For Windows, use the WILDFLY_HOME\bin\jboss-cli.bat script.

   You should see the following result when you run the script:

   The batch executed successfully

4. Stop the WildFly server.

Review the Modified Server Configuration

After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone.xml file and review the changes.

1. The following subsystem was added.

   <subsystem xmlns="urn:jboss:domain:xts:3.0">
               <host name="default-host"/>
               <xts-environment url="http://${jboss.bind.address:127.0.0.1}:8080/ws-c11/ActivationService"/>
               <default-context-propagation enabled="true"/>
   </subsystem>

2. The following extension was added.

           <extension module="org.jboss.as.xts"/>

3. Open a terminal and navigate to the root of the WildFly directory.

4. Start the WildFly server with XTS subsystem enabled by typing the following command.

   $ WILDFLY_HOME/bin/standalone.sh

   Note	For Windows, use the WILDFLY_HOME\bin\standalone.bat script.

Run the Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped since Arquillian tests require the use of a container.

Note	The Arquillian tests deploy the application, so make sure you undeploy the quickstart before you begin.

Follow these steps to run the tests.

1. Start the WildFly server as described above.

2. Open a terminal and navigate to the root directory of this quickstart.

3. Type the following command to run the verify goal with the arq-remote profile activated.

   $ mvn clean verify -Parq-remote

Note

You can also let Arquillian manage the WildFly server by using the arq-managed profile, meaning the tests will start the server for you. This profile requires that you provide Arquillian with the location of the WildFly server, either by setting the JBOSS_HOME environment variable, or by setting the jbossHome property in the arquillian.xml file. For more information, see Run the Arquillian Tests.

Investigate the Console Output

When you run the Arquillian tests, Maven prints summary of the performed tests to the console. You should see the following results.

Results :

Tests run: 2, Failures: 0, Errors: 0, Skipped: 0

Note

You see the following warning when you run the Arquillian tests in remote mode. WARN [org.jboss.as.dependency.deprecated] (MSC service thread 1-4) WFLYSRV0221: Deployment "deployment.wsat-simple.war" is using a deprecated module ("org.jboss.xts") which may be removed in future versions without notice. This is because, in remote mode, you are responsible for starting the server with the XTS subsystem enabled. When you run the Arquillian tests in managed mode, the container uses the serverConfig property defined in the arquillian.xml file to start the server with the XTS subsystem enabled (default is standalone.xml).

Investigate the Server Log

The following messages should appear in the server log. Note there may be other log messages interlaced between these. The messages trace the steps taken by the tests.

Test success:

INFO  [stdout] (management-handler-threads - 10) Starting 'testSuccess'. This test invokes a WS twice within a BA. The BA is later closes, which causes these WS calls to complete successfully.
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Creating a new Business Activity
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Beginning Business Activity (All calls to Web services that support WS-BA wil be included in this activity)
INFO  [stdout] (management-handler-threads - 10) [CLIENT] invoking addValueToSet(1) on WS
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] invoked addValueToSet('1')
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Enlisting a participant into the BA
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Invoking the back-end business logic
INFO  [stdout] (management-handler-threads - 10) [CLIENT] invoking addValueToSet(2) on WS
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] invoked addValueToSet('2')
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Re-using the existing participant, already registered for this BA
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Invoking the back-end business logic
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Closing Business Activity (This will cause the BA to complete successfully)
INFO  [stdout] (TaskWorker-3) [SERVICE] Participant.complete (This tells the participant that the BA completed, but may be compensated later)
INFO  [stdout] (TaskWorker-3) [SERVICE] Participant.confirmCompleted('true') (This tells the participant that compensation information has been logged and that it is safe to commit any changes.)
INFO  [stdout] (TaskWorker-3) [SERVICE] Commit the backend resource (e.g. commit any changes to databases so that they are visible to others)
INFO  [stdout] (TaskWorker-1) [SERVICE] Participant.close (The participant knows that this BA is now finished and can throw away any temporary state)

Test cancel:

INFO  [stdout] (management-handler-threads - 10) Starting 'testCancel'. This test invokes a WS twice within a BA. The BA is later cancelled, which causes these WS calls to be compensated.
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Creating a new Business Activity
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Beginning Business Activity (All calls to Web services that support WS-BA will be included in this activity)
INFO  [stdout] (management-handler-threads - 10) [CLIENT] invoking addValueToSet(1) on WS
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] invoked addValueToSet('1')
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Enlisting a participant into the BA
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Invoking the back-end business logic
INFO  [stdout] (management-handler-threads - 10) [CLIENT] invoking addValueToSet(2) on WS
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] invoked addValueToSet('2')
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Re-using the existing participant, already registered for this BA
INFO  [stdout] (http-localhost-127.0.0.1-8080-2) [SERVICE] Invoking the back-end business logic
INFO  [stdout] (management-handler-threads - 10) [CLIENT] Cancelling Business Activity (This will cause the work to be compensated)
INFO  [stdout] (TaskWorker-3) [SERVICE] Participant.cancel (The participant should compensate any work done within this BA)
INFO  [stdout] (TaskWorker-3) [SERVICE] SetParticipantBA: Carrying out compensation action
INFO  [stdout] (TaskWorker-3) [SERVICE] Compensate the backend resource by removing '1' from the set (e.g. undo any changes to databases that were previously made visible to others)
INFO  [stdout] (TaskWorker-3) [SERVICE] Compensate the backend resource by removing '2' from the set (e.g. undo any changes to databases that were previously made visible to others)

Restore the WildFly Standalone Server Configuration

You can restore the original server configuration using either of the following methods.

• You can run the restore-configuration.cli script provided in the root directory of this quickstart.

• You can manually restore the configuration using the backup copy of the configuration file.

Restore the WildFly Standalone Server Configuration by Running the JBoss CLI Script

1. Start the WildFly server as described above.

2. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing WILDFLY_HOME with the path to your server:

   $ WILDFLY_HOME/bin/jboss-cli.sh --connect --file=restore-configuration.cli

   Note	For Windows, use the WILDFLY_HOME\bin\jboss-cli.bat script.

Run the Quickstart in Red Hat CodeReady Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests in Red Hat CodeReady Studio or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use Red Hat CodeReady Studio or Eclipse to Run the Quickstarts.

This quickstart is more complex than the others. It requires that you configure the WildFly server using the configure-server.cli file.

1. Make sure you import the quickstart into Red Hat CodeReady Studio.

2. If you have not already done so, you must configure a new WildFly server to use the XTS configuration.

   • In the Servers tab, right-click and choose New → Server.

   • Under Select the server type:, expand Red Hat JBoss Middleware and choose Red Hat JBoss Enterprise Application Platform 7.3.

   • For the Server name, enter WildFly XTS Configuration and click Next.

   • In the Create a new Server Adapter dialog, choose Create a new runtime (next page) from the drop-down menu and click Next.

   • In the JBoss Runtime dialog, enter the following information and then click Finish.

     Name: WildFly XTS Runtime
     Home Directory: Browse to the WILDFLY_HOME directory and select it.
     Runtime JRE: Choose an alternate JRE if not correct.
     Server base directory: This should already point to your standalone server configuration directory,_
     Configuration file: standalone.xml

3. Start the new WildFly XTS Configuration server.

4. Right-click on the wsba-coordinator-completion-simple project, choose Run As → Maven build, enter clean verify -Parq-remote for the Goals, and click Run to run the Arquillian tests. The test results appear in the console.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

$ mvn dependency:sources