PageRenderTime 59ms CodeModel.GetById 24ms RepoModel.GetById 1ms app.codeStats 0ms

/helloworld-mbean/README.md

https://gitlab.com/avinashmx/WildFly
Markdown | 133 lines | 84 code | 49 blank | 0 comment | 0 complexity | b5cf46d95c2db0e33526ec07a55c95d1 MD5 | raw file
    

  1. helloworld-mbean: Helloworld Using MBean and CDI component

    2. 

  2. ======================================================

    3. 

  3. Author: Lagarde Jeremie  

    4. 

  4. Level: Intermediate  

    5. 

  5. Technologies: CDI, JMX, MBean  

    6. 

  6. Summary: The `helloworld-mbean` quickstart demonstrates the use of *CDI* and *MBean* in WildFly and includes JConsole instructions and Arquillian tests.  

    7. 

  7. Target Product: WildFly    

    8. 

  8. Source: <https://github.com/wildfly/quickstart/>  

    9. 

  9. 

    10. 

  10. What is it?

    11. 

  11. -----------

    12. 

  12. 

    13. 

  13. The `helloworld-mbean` quickstart demonstrates the use of *CDI* and *MBean* in Red Hat JBoss Enterprise Application Platform. The project also includes a set of Arquillian tests for MBeans.

    14. 

  14. 

    15. 

  15. The example is composed of the following MBeans:

    16. 

  16. 

    17. 

  17. 1. `AnnotatedComponentHelloWorld`: This MBean is a managed bean with '@MXBean' annotation.

    18. 

  18. 

    19. 

  19. 1. `MXComponentHelloWorld`:  This MBean is a managed bean with 'MXBean' interface.

    20. 

  20. 

    21. 

  21. 1. `MXPojoHelloWorld`:  This MBean is a pojo using MXBean interface and declared in the `jboss-service.xml` file.

    22. 

  22. 

    23. 

  23. 1. `SarMXPojoHelloWorld`:  This MBean is a pojo using MXBean interface and declared in jboss-service.xml in SAR packaging.

    24. 

  24. 

    25. 

  25. System requirements

    26. 

  26. -------------------

    27. 

  27. 

    28. 

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

    29. 

  29. 

    30. 

  30. All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later. See [Configure Maven for WildFly 10](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN_JBOSS_EAP7.md#configure-maven-to-build-and-deploy-the-quickstarts) to make sure you are configured correctly for testing the quickstarts.

    31. 

  31. 

    32. 

  32. 

    33. 

  33. Use of WILDFLY_HOME

    34. 

  34. ---------------

    35. 

  35. 

    36. 

  36. 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](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_OF_EAP7_HOME.md#use-of-eap_home-and-jboss_home-variables).

    37. 

  37. 

    38. 

  38. 

    39. 

  39. Start the WildFly Server

    40. 

  40. -------------------------

    41. 

  41. 

    42. 

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

    43. 

  43. 2. The following shows the command line to start the server:

    44. 

  44. 

    45. 

  45.         For Linux:   WILDFLY_HOME/bin/standalone.sh

    46. 

  46.         For Windows: WILDFLY_HOME\bin\standalone.bat

    47. 

  47. 

    48. 

  48.  

    49. 

  49. Build and Deploy the Quickstart

    50. 

  50. -------------------------

    51. 

  51. 

    52. 

  52. 1. Make sure you have started the WildFly server as described above.

    53. 

  53. 2. Open a command propmt and navigate to the root directory of this quickstart.

    54. 

  54. 3. Type this command to build and deploy the archive:

    55. 

  55. 

    56. 

  56.         mvn clean wildfly:deploy

    57. 

  57. 

    58. 

  58. 4. This will deploy `helloworld-mbean-webapp\target\wildfly-helloworld-mbean-helloworld-mbean-webapp.war` and `helloworld-mbean-service\target\wildfly-helloworld-mbean-helloworld-mbean-service.sar` to the running instance of the server.

    59. 

  59. 

    60. 

  60. 

    61. 

  61. Access and Test the MBeans

    62. 

  62. --------------------------

    63. 

  63. 

    64. 

  64. 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/wildfly-helloworld-mbean-helloworld-mbean-webapp/>, you will see a screen shot image of the JConsole application,

    65. 

  65. 

    66. 

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

    67. 

  67. 

    68. 

  68. Start JConsole

    69. 

  69. --------------

    70. 

  70. 

    71. 

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

    72. 

  72. 

    73. 

  73.         For Linux:   JDK_HOME/bin/jconsole

    74. 

  74.         For Windows: JDK_HOME\bin\jconsole.exe

    75. 

  75. 

    76. 

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

    77. 

  77. 

    78. 

  78. ![MBeans in JConsole Connection](helloworld-mbean-webapp/src/main/webapp/jconsole_connection.png)

    79. 

  79. 

    80. 

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

    81. 

  81. 

    82. 

  82. Test the MBeans in JConsole

    83. 

  83. ---------------------------

    84. 

  84. 

    85. 

  85. You can use JConsole to inspect and use the MBeans :

    86. 

  86. ![MBeans in JConsole](helloworld-mbean-webapp/src/main/webapp/jconsole.png)

    87. 

  87. 

    88. 

  88. 1. Click on the MBeans tab.

    89. 

  89. 2. Expand `quickstarts` in the left column of the console.

    90. 

  90. 3. Under `quickstarts`, you see the 4 MBeans: `AnnotatedComponentHelloWorld`, `MXComponentHelloWorld`, `MXPojoHelloWorld`, and `SarMXPojoHelloWorld`

    91. 

  91. 4. Expand each MBean and choose: `Operations` --> `sayHello`.

    92. 

  92. 5. Type your name in the (p0 String ) input text box and click the `sayHello` button.

    93. 

  93.    * For the `AnnotatedComponentHelloWorld` and `MXComponentHelloWorld` examples, you will see a popup Window displaying `Hello <your name>!`.

    94. 

  94.    * For the `MXPojoHelloWorld` and `SarMXPojoHelloWorld` examples, you will see a popup Window displaying `Welcome <your name>!`.

    95. 

  95. 

    96. 

  96. 

    97. 

  97. Undeploy the Archive

    98. 

  98. --------------------

    99. 

  99. 

    100. 

  100. 1. Make sure you have started the WildFly server as described above.

    101. 

  101. 2. Open a command prompt and navigate to the root directory of this quickstart.

    102. 

  102. 3. When you are finished testing, type this command to undeploy the archive:

    103. 

  103. 

    104. 

  104.         mvn wildfly:undeploy

    105. 

  105. 

    106. 

  106. 

    107. 

  107. Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

    108. 

  108. -------------------------------------

    109. 

  109. 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](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_JBDS.md#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts) 

    110. 

  110. 

    111. 

  111. 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.

    112. 

  112. 

    113. 

  113. 1.  When you import the `helloworld-mbean` quickstart into JBoss Developer Studio, you see the following warnings for the `wildfly-helloworld-mbean-webapp/src/main/webapp/META-INF/jboss-service.xml` and `/wildfly-helloworld-mbean-service/src/main/resources/META-INF/jboss-service.xml` files:

    114. 

  114. 

    115. 

  115.         No grammar constraints (DTD or XML Schema) referenced in the document. 

    116. 

  116.     

    117. 

  117.    There is a known issue with the schema for the `jboss-service.xml` file that prevents successful validation. To prevent import errors, these files do not specify the schema location (http://www.jboss.org/schema/jbossas/jboss-service_7_0.xsd).

    118. 

  118. 2. Install the JBoss Tools Maven Packaging Configurator

    119. 

  119.    * If the "JBoss Central" page is not showing, open it by choosing `Help` --> `JBoss Central`.

    120. 

  120.    * Click the `Software/Install` tab at the bottom of the `JBoss Central`.

    121. 

  121.    * Select the "JBoss Tools Maven Packaging Configurator" and click `Update/Install`.

    122. 

  122. 3. Right click on the parent `wildfly-helloworld-mbean` parent project and choose `Maven` --> `Update Project...`. Select all projects and click `OK`.

    123. 

  123. 4. Right-click on the `helloworld-mbean-helloworld-mbean-service` project and choose `Run As` --> `Run on Server`. 

    124. 

  124. 5. Right-click on the `helloworld-mbean-helloworld-mbean-webapp` project and choose `Run As` --> `Run on Server`. 

    125. 

  125. 6. [Start JConsole](#start-jconsole) and [Test the MBeans in JConsole](#test-the-mbeans-in-jconsole) as described above.

    126. 

  126. 

    127. 

  127. Debug the Application

    128. 

  128. ------------------------------------

    129. 

  129. 

    130. 

  130. 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.

    131. 

  131. 

    132. 

  132.         mvn dependency:sources

    133. 

  133. 

    134. 

  134.