inter-app: Communicate Between Two Applications Using EJB and CDI

Author: Pete Muir
Level: Advanced
Technologies: EJB, CDI, JSF
Summary: The inter-app quickstart shows you how to use a shared API JAR and an EJB to provide inter-application communication between two WAR deployments.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/

What is it?

The inter-app quickstart shows you how to easily communicate between two modular deployments to WildFly Application Server. Two WARs, with a shared API JAR, are deployed to the application server. EJB is used to provide inter-application communication, with EJB beans alised to CDI beans, making the inter-application communication transparent to clients of the bean.

CDI only provides intra-application injection within a top level deployment, for example, an EAR, WAR, or JAR. This improves performance of the application server, as to satisfy an injection point all possible candidates have to be scanned / analyzed. If inter-app injection was supported by CDI, performance would scale according to the number of deployments you have (the more deployments in the running system, the slower the deployment). Java EE injection uses unique JNDI names for the wiring, so each injection point is O(1). The approach shown here combines the two approaches such that you limit the name based wiring to one location in your code, and the main consumers of components can use CDI injection to reference these name wired components. For the name approach to work though, you still need to publish instances, and EJB singletons allow you to do that with just one extra annotation.

In all, the project has three modules:

System Requirements

The application this project produces is designed to be run on WildFly Application Server 11 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 for WildFly 11 to make sure you are configured correctly for testing the quickstarts.

Use of WILDFLY_HOME

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.

Start the Server

  1. Open a command prompt and navigate to the root of the WildFly directory.
  2. The following shows the command line to start the server:
    For Linux:   WILDFLY_HOME/bin/standalone.sh
    For Windows: WILDFLY_HOME\bin\standalone.bat
    

Build and Deploy the Quickstart

  1. Make sure you have started the WildFly server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:
    mvn clean install wildfly:deploy
    
  4. This will deploy shared/target/inter-app-app-shared.jar, appA/target/inter-app-app-appA.war and appB/target/inter-app-app-appB.war to the running instance of the server.

Access the Application

Access the running application in a browser at the following URLs:

You are presented with a form that allows you to set the value on the bean in the other application, as well as display of the value on this application's bean. Enter a new value and press Update and Send! to update the value on the other application. Do the same on the other application, and hit the button again on the first application. You should see the values shared between the applications.

Undeploy the Archive

This quickstart undeploys differently than some of the others because of the WAR and JAR interdependencies.

When you are finished testing, follow these steps to undeploy the archives:

  1. Make sure you have started the WildFly server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type the following command to undeploy the inter-app-appA.war and inter-app-appB.war archives.
    mvn wildfly:undeploy -pl appA,appB
    
  4. Type the following command to undeploy the inter-app-shared.jar archive.

    mvn wildfly:undeploy -pl shared
    

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 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 JBoss Developer Studio or Eclipse to Run the Quickstarts.

This quickstart consists of multiple projects containing interdependencies on each other, so it deploys and runs differently in JBoss Developer Studio than the other quickstarts.

  1. In the Servers tab, right-click on the WildFly server and choose Start.
  2. Deploy the projects in one of the following ways.
  3. Right-click on the inter-app-app-appA project and choose Run As --> Run on Server. A browser window appears that accesses the running appA application.
  4. Right-click on the inter-app-app-appB project and choose Run As --> Run on Server. A browser window appears that accesses the running appB application.
  5. To undeploy the inter-app-app-appBproject, right-click on it and choose Run As --> Maven build. Enter wildfly:undeploy for the Goals and click Run.
  6. To undeploy the inter-app-app-appAproject, right-click on it and choose Run As --> Maven build. Enter wildfly:undeploy for the Goals and click Run.

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