The managed-executor-service quickstart demonstrates how Java EE applications can submit tasks for asynchronous execution.

What is it?

The Managed Executor Service (javax.enterprise.concurrent.ManagedExecutorService) allows Java EE applications to submit tasks for asynchronous execution. It is an extension of Java SE’s Executor Service (java.util.concurrent.ExecutorService) adapted to the Java EE platform requirements.

Managed Executor Service instances are managed by the application server, thus Java EE applications are forbidden to invoke any lifecycle related method.

A JAX-RS resource provides access to some operations that are executed asynchronously.

This quickstart does not contain any user interface. The tests must be run to verify everything is working correctly.

Considerations for Use in a Production Environment

H2 Database

This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7.1. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment.

Datasource Configuration File

This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in JBoss EAP and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the Configuration Guide for Red Hat JBoss Enterprise Application Platform.

System Requirements

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

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

Use of EAP_HOME

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

Start the JBoss EAP Standalone Server

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the default profile by typing the following command.

    $ EAP_HOME/bin/standalone.sh 
    Note
    For Windows, use the EAP_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 JBoss EAP 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 JBoss EAP 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 JBoss EAP 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.

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running org.jboss.as.quickstarts.managedexecutorservice.test.ProductsRestClientIT
org.xnio.Xnio <clinit>
INFO: XNIO version 3.3.4.Final
org.xnio.nio.NioXnio <clinit>
INFO: XNIO NIO Implementation Version 3.3.4.Final
org.jboss.remoting3.EndpointImpl <clinit>
INFO: JBoss Remoting version 4.0.18.Final
org.jboss.as.quickstarts.managedexecutorservice.test.ProductsRestClientIT testRestResources
INFO: creating a new product
org.jboss.as.quickstarts.managedexecutorservice.test.ProductsRestClientIT testRestResources
INFO: Product created. Executing a long running task
org.jboss.as.quickstarts.managedexecutorservice.test.ProductsRestClientIT testRestResources
INFO: Deleting all products
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 5.619 sec - in org.jboss.as.quickstarts.managedexecutorservice.test.ProductsRestClientIT

Results :

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

Investigate the Server Console Output

Look at the JBoss EAP console or Server log and you should see log messages like the following:

INFO  [ProductResourceRESTService] (default task-51) Will create a new Product on other Thread
INFO  [ProductResourceRESTService] (default task-51) Returning response
INFO  [PersitTask] (EE-ManagedExecutorService-default-Thread-5) Begin transaction
INFO  [PersitTask] (EE-ManagedExecutorService-default-Thread-5) Persisting a new product
INFO  [PersitTask] (EE-ManagedExecutorService-default-Thread-5) Commit transaction
INFO  [ProductResourceRESTService] (default task-52) Submitting a new long running task to be executed
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [LongRunningTask] (EE-ManagedExecutorService-default-Thread-5) Starting a long running task
INFO  [LongRunningTask] (EE-ManagedExecutorService-default-Thread-5) Analysing A Product
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Waiting for the result to be available...
INFO  [ProductResourceRESTService] (default task-52) Result is available. Returning result...56
INFO  [ProductResourceRESTService] (default task-53) Will delete all Products on other Thread
INFO  [ProductResourceRESTService] (default task-53) Returning response
INFO  [DeleteTask] (EE-ManagedExecutorService-default-Thread-5) Begin transaction
INFO  [DeleteTask] (EE-ManagedExecutorService-default-Thread-5) Deleting all products
INFO  [DeleteTask] (EE-ManagedExecutorService-default-Thread-5) Commit transaction. Products deleted: 1

Note that the PersistTask and DeleteTask were executed after ProductResourceRESTService sends a Response. The only exception is for LongRunningTask where ProductResourceRESTService waits for its response.

Server Log: Expected Warnings and Errors

You will see the following warnings in the server log. You can ignore these warnings.

WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in a future version.

HHH000431: Unable to determine H2 database version, certain features may not work

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

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

To run the tests in Red Hat JBoss Developer Studio, you must first set the active Maven profile in project properties to one of the following:

  • arq-remote: This setting is used for a remote server. JBoss Developer Studio starts the server for you.

  • arq-managed: This setting is used for a managed server. If you use this setting, you must start the server before you run the tests.

Then, to run the tests, right click on the project or individual classes and select Run As –> JUnit Test in the context menu.

Deploy the Quickstart to OpenShift Online

Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.

Create and Deploy the Quickstart Project

Follow these instructions to deploy this quickstart to OpenShift Online.

  1. Browse to OpenShift Online console and login with your credentials.

  2. On the View All Projects or Welcome to Project page, click Create Project.

  3. On the Create Project page, enter the following information:

    Name:  managed-executor-service
    Display Name managed-executor-service
    Description: managed-executor-service
  4. Click Create to create the project.

  5. On the My Projects page, choose your new managed-executor-service and click Browse Catalog.

  6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

  7. Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.

    Add to Project: managed-executor-service
    Application Name: managed-executor-service
    Custom http Route Hostname: (leave blank)
    Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/
    Git Reference: openshift
    Context directory: managed-executor-service
  8. Click the Create button.

  9. Click on the Continue to the project overview link.

    • You should see "Build #1 is running …​" with the console log below.

      Cloning ...
      Downloading ...
      Building ...
      Copying ...
      Pushing ...
    • At the end of the build, you should see "Push successful".

    • Click View Full Log to see the entire log.

  10. Click the Overview tab to see the managed-executor-service deployment.

  11. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:

    http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com

Delete the Quickstart Project

Follow these instructions to delete the project from OpenShift Online.

  1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the managed-executor-service project.

  2. Type the name of the project to confirm, and then click Delete

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