eap-cluster-app: Example Using Clustered Cache Deployed via JDG modules

Author: Wolf-Dieter Fink Level: Advanced Technologies: Infinispan, CDI, EJB Summary: The eap-cluster-app quickstart shows how to access Infinispan cache from a JBoss EAP application using JDG modules for EAP. Target Product: JDG Product Versions: JDG 7.x, EAP 7.x Source: https://github.com/infinispan/jdg-quickstart

What is it?

The eap-cluster-app quickstart demonstrates how to use an Infinispan cache in library mode. There are three different applications which show:

How to create and use an Infinispan clustered cache without having a JBoss EAP cluster
JBoss EAP cluster is independent of an Infinispan cluster
One JBoss EAP instance can use different Infinispan caches which are members of different Infinispan clusters
Programmatic cache configuration using Infinispan API and passing in a custom JGroups configuration file
File based configuration (administration application App1Cache)
Use CDI to inject the cache managers

Each application contains an embedded Infinispan cache which is accessed by stateless EJB's in the same application. Different JBoss EAP servers, except AppTwo, are not clustered to show that an unclustered application can share the Infinispan cache. There are two cache managers used which are not part of the same Infinispan cluster. The AdminApp is able to access both caches and change the entries. AppOne can only read the App1Cache and use a clustered EJB invocation to AppTwo to read from App2Cache. AppTwo is deployed as a clustered EJB application and only read App2Cache.

All applications need to have an installed JDG 7.0 or later module extention for the JBoss EAP server which can be downloaded from the Red Hat portal.

System requirements

All you need to build this project is Java 8.0 (Java SDK 1.8) or better, Maven 3.0 or better.

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

Configure Maven

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

Setup/Run the quickstart with automated script

Download the EAP server and jboss-datagrid EAP modules library;
Set the following two environment variables in the same shell: For Linux: export EAP_SERVER_ZIP_PATH=[Full path to the EAP server ZIP] export JDG_MODULES_ZIP_PATH= [Full path to the JDG EAP Modules ZIP] For Windows: set EAP_SERVER_ZIP_PATH=[Full path to the EAP server ZIP] set JDG_MODULES_ZIP_PATH= [Full path to the JDG EAP Modules ZIP]
While in the root folder of the eap-cluster-app quickstart, run the following commands:

For Linux:

       ./build.sh --setup or ./build.sh --setup-domain for setting up servers and running them either in standalone or domain mode;

       ./build.sh --run for running the quickstart;

       ./build.sh --teardown for stopping the started servers as well as deleting the created directories;

For Windows:

        build.bat --setup or build.bat --setup-domain for setting up servers and running them either in standalone or domain mode;

        build.bat --run for running the quickstart;

        build.bat --teardown for stopping the started servers as well as deleting the created directories;

You can also perform all setups manually with the following steps:

Setup/Run the quickstart manually

Configure and Start the Servers in standalone mode

Prepare a copy of the JBoss EAP

unzip jboss-datagrid-${version}-eap-modules-library.zip

copy the modules to the server modules directory

   For Linux:   cp -a jboss-datagrid-${version}-eap-modules-library/modules $EAP_HOME
   For Windows: xcopy /e/i/f jboss-datagrid-${version}-eap-modules-library/modules %EAP_HOME%\modules

Add a user to each server for EJB access

   For Linux:   $EAP_HOME/bin/add-user.sh -a -u quickuser -p quick-123
   For Windows: %EAP_HOME%\bin\add-user.bat -a -u quickuser -p quick-123

Add the following configuration snippets to EAP's standalone.xml:

Inside security-realms:

   <security-realm name="ejb-security-realm">
       <server-identities>
           <secret value="cXVpY2stMTIz"/>   <!-- this is a Base64 encoded password for the quickuser user -->
       </server-identities>
   </security-realm>

Inside remoting subsystem:

   <outbound-connections>
       <remote-outbound-connection name="remote-ejb-connection" outbound-socket-binding-ref="remote-ejb" username="quickuser" security-realm="ejb-security-realm" protocol="http-remoting">
           <properties>
               <property name="SASL_POLICY_NOANONYMOUS" value="false"/>
               <property name="SSL_ENABLED" value="false"/>
           </properties>
       </remote-outbound-connection>
   </outbound-connections>

Inside socket-binding-group:

   <outbound-socket-binding name="remote-ejb">
       <remote-destination host="localhost" port="8280"/>
   </outbound-socket-binding>

Copy the prepared EAP server to 4 different directories EAP_HOME[1-4].

Open a command line for each of the 4 nodes and navigate to the root of the EAP server directory. The following shows the command line to start the different servers:

 For Linux:   $EAP_HOME1/bin/standalone.sh -Djboss.node.name=node1
              $EAP_HOME2/bin/standalone.sh -Djboss.node.name=node2 -Djboss.socket.binding.port-offset=100
              $EAP_HOME3/bin/standalone.sh -Djboss.node.name=node3 -Djboss.socket.binding.port-offset=200 -c standalone-ha.xml
              $EAP_HOME4/bin/standalone.sh -Djboss.node.name=node4 -Djboss.socket.binding.port-offset=300 -c standalone-ha.xml

 For Windows: %EAP_HOME1%\bin\standalone.bat -Djboss.node.name=node1
              %EAP_HOME2%\bin\standalone.bat -Djboss.node.name=node2 -Djboss.socket.binding.port-offset=100
              %EAP_HOME3%\bin\standalone.bat -Djboss.node.name=node3 -Djboss.socket.binding.port-offset=200 -c standalone-ha.xml
              %EAP_HOME4%\bin\standalone.bat -Djboss.node.name=node4 -Djboss.socket.binding.port-offset=300 -c standalone-ha.xml

Add the configuration for node2 (AppOne) to use EJB server-to-server invocation:

 For Linux:   $EAP_HOME2/bin/jboss-cli.sh -c --controller=localhost:10090 --file=$QUICKSTART_HOME/install-appOne-standalone.cli
 For Windows: %EAP_HOME2%\bin\jboss-cli.bat -c --controller=localhost:10090 --file=%QUICKSTART_HOME%/install-appOne-standalone.cli

Configure and Start the Servers in domain mode

Copy a fresh EAP installation to EAP_HOME

unzip jboss-datagrid-${version}-eap-modules-library.zip

copy the modules to the server modules directory

   For Linux:   cp -a jboss-datagrid-${version}-eap-modules-library/modules $EAP_HOME
   For Windows: xcopy /e/i/f jboss-datagrid-${version}-eap-modules-library/modules %EAP_HOME%\modules

Open a command line and navigate to the root of EAP.

Add a user:

 For Linux:   $EAP_HOME/bin/add-user.sh -a -u quickuser -p quick-123
 For Windows: %EAP_HOME%\bin\add-user.bat -a -u quickuser -p quick-123

The following shows the command line to start the domain:

 For Linux:   $EAP_HOME/bin/domain.sh
 For Windows: %EAP_HOME%\bin\domain.bat

Apply the configuration for the quickstart, the domain will contain 4 nodes:

 For Linux:   $EAP_HOME/bin/jboss-cli.sh -c --file=$QUICKSTART_HOME/install-domain.cli
 For Windows: %EAP_HOME%\bin\jboss-cli.bat -c --file=%QUICKSTART_HOME%/install-domain.cli

Build the Application

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See the main README for more information.

Open a command line and navigate to the root directory of this quickstart.
Type this command to build the archive:
```
 mvn clean install
```

Copy the application to the appropriate server

 For Linux:   cp adminApp/ear/target/jboss-eap-application-adminApp.ear $EAP_HOME1/standalone/deployments
              cp appOne/ear/target/jboss-eap-application-AppOne.ear $EAP_HOME2/standalone/deployments
              cp appTwo/ear/target/jboss-eap-application-AppTwo.ear $EAP_HOME3/standalone/deployments
              cp appTwo/ear/target/jboss-eap-application-AppTwo.ear $EAP_HOME4/standalone/deployments

 For Windows: copy adminApp\ear\target\jboss-eap-application-adminApp.ear %EAP_HOME1%\standalone\deployments
              copy appOne\ear\target\jboss-eap-application-AppOne.ear %EAP_HOME2%\standalone\deployments
              copy appTwo\ear\target\jboss-eap-application-AppTwo.ear %EAP_HOME3%\standalone\deployments
              copy appTwo\ear\target\jboss-eap-application-AppTwo.ear %EAP_HOME4%\standalone\deployments

When domain mode is used, deploy the applications in the following way:

 For Linux:   $EAP_HOME/bin/jboss-cli.sh -c --file=$QUICKSTART_HOME/deploy-domain.cli
 For Windows: %EAP_HOME%\bin\jboss-cli.bat -c --file=%QUICKSTART_HOME%/deploy-domain.cli

Access the application

To start the different following applications you need to navigate to the client directory of this quickstart.

Step 1: Add values to App1 cache with the AdminApp and validate that they are replicated to the server instance of AppOne. Add a value to App2 cache, rollback the transaction and check that it is not added to the cache after rollback. The AdminServer and the AppOneServer are not configured as JBoss EAP cluster, only the Infinispan caches are configured by the application to communicate and replicate the caches.

    mvn -Dexec.mainClass=org.jboss.as.quickstarts.datagrid.eap.app.AdminClient exec:java

To add more instances it is possible to overwrite the used connections by adding the following argument

    mvn -Dexec.args="AdminHost AdminPort AppOneHost AppOnePort" ....

The defaults are "locahost 4447 localhost 4547"

The console output shows the actions and results (example below), any unexpected result will show an Exception.

Add a value to App1Cache with the AdminApp and check on the same instance that the value is correct added
    success
Check the previous added value of App1Cache by accessing the AppOne Server
    success
Add a value to App2Cache and check on the same instance that the value is correct added
    success
Check whether changes to a cache are rollbacked if the transaction fail
    The cache App2 work as expected on rollback

Step 2: Add values to App2 cache with the AdminApp and access AppOne to show that the EJB invocation is clustered and both AppTwo instances are used. Show that the JBoss EAP and Infinispan clusters are not related and the Infinispan cluster is able to use a different JGroups implementation as the JBoss EAP server.

    mvn -Dexec.mainClass=org.jboss.as.quickstarts.datagrid.eap.app.AppOneClient exec:java

The console output shows the actions and results, any unexpected result will show an Exception

Add a value to App2Cache with the AdminApp
Access the App2Cache from the AppOneServer by using the clustered EJB@AppTwoServer
    success : received the following node names for EJB invocation : [node3, node4]

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

    mvn dependency:sources
    mvn dependency:resolve -Dclassifier=javadoc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

eap-cluster-app: Example Using Clustered Cache Deployed via JDG modules

What is it?

System requirements

Configure Maven

Setup/Run the quickstart with automated script

Setup/Run the quickstart manually

Configure and Start the Servers in standalone mode

Configure and Start the Servers in domain mode

Build the Application

Access the application

Debug the Application

Files

README.md

Latest commit

History

README.md

File metadata and controls

eap-cluster-app: Example Using Clustered Cache Deployed via JDG modules

What is it?

System requirements

Configure Maven

Setup/Run the quickstart with automated script

Setup/Run the quickstart manually

Configure and Start the Servers in standalone mode

Configure and Start the Servers in domain mode

Build the Application

Access the application

Debug the Application