helloworld-mbean: Helloworld Using MBean and CDI component

Author: Lagarde Jeremie
Level: Intermediate
Technologies: CDI, JMX, MBean
Summary: The helloworld-mbean quickstart demonstrates the use of CDI and MBean in WildFly and includes JConsole instructions and Arquillian tests.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/

What is it?

The helloworld-mbean quickstart demonstrates the use of CDI and MBean in WildFly Application Server. The project also includes a set of Arquillian tests for MBeans.

The example is composed of the following MBeans:

AnnotatedComponentHelloWorld: This MBean is a managed bean with @MXBean annotation.
MXComponentHelloWorld: This MBean is a managed bean with MXBean interface.
MXPojoHelloWorld: This MBean is a pojo using MXBean interface and declared in the jboss-service.xml file.
SarMXPojoHelloWorld: This MBean is a pojo using MXBean interface and declared in jboss-service.xml in SAR packaging.

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 WildFly Server

Open a command prompt and navigate to the root of the WildFly directory.

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

Make sure you have started the WildFly server as described above.
Open a command prompt and navigate to the root directory of this quickstart.
Type this command to build and deploy the archive:
```
mvn clean install wildfly:deploy
```
This will deploy helloworld-mbean-webapp/target/helloworld-mbean-webapp.war and helloworld-mbean-service/target/helloworld-mbean-service.sar to the running instance of the server.

Access and Test the MBeans

This quickstart differs from the other quickstarts in that it uses JConsole to access and test the quickstart rather than access an URL in the browser. If you do access http://localhost:8080/helloworld-mbean-webapp/, you will see a screen shot image of the JConsole application,

The following sections describe how to use JConsole to inspect and test the MBeans.

Start JConsole

To connect to the WildFly server using JConsole, open a command prompt and type the following command :

For Linux:   JDK_HOME/bin/jconsole
For Windows: JDK_HOME\bin\jconsole.exe

Select the local org.jboss.modules.Main process and click Connect.

MBeans in JConsole Connection

A dialog displays with the warning Secure connection failed. Retry insecurely?. Click Insecure to continue.

Test the MBeans in JConsole

You can use JConsole to inspect and use the MBeans : MBeans in JConsole

Click on the MBeans tab.
Expand quickstarts in the left column of the console.
Under quickstarts, you see the 4 MBeans: AnnotatedComponentHelloWorld, MXComponentHelloWorld, MXPojoHelloWorld, and SarMXPojoHelloWorld
Expand each MBean and choose: Operations --> sayHello.
Type your name in the (p0 String ) input text box and click the sayHello button.

For the AnnotatedComponentHelloWorld and MXComponentHelloWorld examples, you will see a popup Window displaying Hello <your name>!.
For the MXPojoHelloWorld and SarMXPojoHelloWorld examples, you will see a popup Window displaying Welcome <your name>!.

Undeploy the Archive

Make sure you have started the WildFly server as described above.
Open a command prompt and navigate to the root directory of this quickstart.
When you are finished testing, type this command to undeploy the archive:
```
mvn wildfly:undeploy
```

Run the Arquillian Tests

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

Make sure you have started the WildFly server as described above.
Open a command prompt and navigate to the root directory of this quickstart.
Type the following command to run the test goal with the following profile activated:
```
mvn clean verify -Parq-remote
```

You can also let Arquillian manage the WildFly server by using the arq-managed profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.

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 and requires installation of the JBoss Tools Maven Packaging Configurator, so it deploys and runs differently in JBoss Developer Studio than the other quickstarts.

Install the JBoss Tools Maven Packaging Configurator
- If the Red Hat Central page is not showing, open it by choosing Help --> Red Hat Central.
- Click the Software/Update tab at the bottom of the Red Hat Central.
- Scroll down to the Maven section, select the JBoss Tools Maven Packaging Configurator and click Install/Update.
Right click on the parent helloworld-mbean parent project and choose Maven --> Update Project.... Select all projects and click OK.
Right-click on the helloworld-mbean-service project and choose Run As --> Run on Server.
Right-click on the helloworld-mbean-webapp project and choose Run As --> Run on Server.
Start JConsole and Test the MBeans in JConsole as described above.
To undeploy the web application, right-click on the helloworld-mbean-wepapp project and choose Run As --> Maven build. Enter wildfly:undeploy for the Goals and click Run.
To undeploy the web service, right-click on the helloworld-mbean-service project 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