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

/helloworld-mdb/README.md

https://gitlab.com/ThomasHunt3r/jboss-eap-quickstarts
Markdown | 224 lines | 134 code | 90 blank | 0 comment | 0 complexity | ce7b754ba20aadab1ffba9da8e7b3484 MD5 | raw file
    

  1. helloworld-mdb: Helloword Using an MDB (Message-Driven Bean)
    2. 

  2. ============================================================
    3. 

  3. Author: Serge Pagop, Andy Taylor, Jeff Mesnil  
    4. 

  4. Level: Intermediate  
    5. 

  5. Technologies: JMS, EJB, MDB  
    6. 

  6. Summary: Demonstrates the use of JMS 1.1 and EJB 3.1 Message-Driven Bean  
    7. 

  7. Target Product: EAP  
    8. 

  8. Product Versions: EAP 6.1, EAP 6.2, EAP 6.3, EAP 6.4  
    9. 

  9. Source: <https://github.com/jboss-developer/jboss-eap-quickstarts/>  
    10. 

  10. 

  11. What is it?
    12. 

  12. -----------
    13. 

  13. 

  14. This example demonstrates the use of *JMS 1.1* and *EJB 3.1 Message-Driven Bean* in Red Hat JBoss Enterprise Application Platform.
    15. 

  15. 

  16. This project creates two JMS resources:
    17. 

  17. 

  18. * A queue named `HELLOWORLDMDBQueue` bound in JNDI as `java:/queue/HELLOWORLDMDBQueue`
    19. 

  19. * A topic named `HELLOWORLDMDBTopic` bound in JNDI as `java:/topic/HELLOWORLDMDBTopic`
    20. 

  20. 

  21. 

  22. System requirements
    23. 

  23. -------------------
    24. 

  24. 

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

  26. 

  27. All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.
    28. 

  28. 

  29.  
    30. 

  30. Configure Maven
    31. 

  31. ---------------
    32. 

  32. 

  33. If you have not yet done so, you must [Configure Maven](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONFIGURE_MAVEN.md#configure-maven-to-build-and-deploy-the-quickstarts) before testing the quickstarts.
    34. 

  34. 

  35. 

  36. Start the JBoss EAP Server with the Full Profile
    37. 

  37. ---------------
    38. 

  38. 

  39. 1. Open a command prompt and navigate to the root of the JBoss EAP directory.
    40. 

  40. 2. The following shows the command line to start the server with the full profile:
    41. 

  41. 

  42.         For Linux:   EAP_HOME/bin/standalone.sh -c standalone-full.xml
    43. 

  43.         For Windows: EAP_HOME\bin\standalone.bat -c standalone-full.xml
    44. 

  44. 

  45. 

  46. Build and Deploy the Quickstart
    47. 

  47. -------------------------
    48. 

  48. 

  49. _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 [Build and Deploy the Quickstarts](../README.md#build-and-deploy-the-quickstarts) for complete instructions and additional options._
    50. 

  50. 

  51. 1. Make sure you have started the JBoss EAP server as described above.
    52. 

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

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

  54. 

  55.         mvn clean install jboss-as:deploy
    56. 

  56. 

  57. 4. This will deploy `target/jboss-helloworld-mdb.war` to the running instance of the server. Look at the JBoss EAP console or Server log and you should see log messages corresponding to the deployment of the message-driven beans and the JMS destinations:
    58. 

  58. 

  59.         14:11:01,020 INFO org.hornetq.core.server.impl.HornetQServerImpl trying to deploy queue jms.queue.HELLOWORLDMDBQueue
    60. 

  60.         14:11:01,029 INFO org.jboss.as.messaging JBAS011601: Bound messaging object to jndi name java:/queue/HELLOWORLDMDBQueue
    61. 

  61.         14:11:01,030 INFO org.hornetq.core.server.impl.HornetQServerImpl trying to deploy queue jms.topic.HELLOWORLDMDBTopic
    62. 

  62.         14:11:01,060 INFO org.jboss.as.ejb3 JBAS014142: Started message driven bean 'HelloWorldQueueMDB' with 'hornetq-ra' resource adapter
    63. 

  63.         14:11:01,060 INFO org.jboss.as.ejb3 JBAS014142: Started message driven bean 'HelloWorldQTopicMDB' with 'hornetq-ra' resource adapter
    64. 

  64.         14:11:01,070 INFO org.jboss.as.messaging JBAS011601: Bound messaging object to jndi name java:/topic/HELLOWORLDMDBTopic
    65. 

  65. 

  66. Access the application 
    67. 

  67. ---------------------
    68. 

  68. 

  69. The application will be running at the following URL: <http://localhost:8080/jboss-helloworld-mdb/> and will send some messages to the queue.
    70. 

  70. 

  71. To send messages to the topic, use the following URL: <http://localhost:8080/jboss-helloworld-mdb/HelloWorldMDBServletClient?topic>
    72. 

  72. 

  73. Investigate the Server Console Output
    74. 

  74. -------------------------
    75. 

  75. 

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

  77. 

  78.     17:51:52,122 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-1 (HornetQ-client-global-threads-26912020)) Received Message from queue: This is message 1
    79. 

  79.     17:51:52,123 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-11 (HornetQ-client-global-threads-26912020)) Received Message from queue: This is message 2
    80. 

  80.     17:51:52,124 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-12 (HornetQ-client-global-threads-26912020)) Received Message from queue: This is message 5
    81. 

  81.     17:51:52,135 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-13 (HornetQ-client-global-threads-26912020)) Received Message from queue: This is message 4
    82. 

  82.     17:51:52,136 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-14 (HornetQ-client-global-threads-26912020)) Received Message from queue: This is message 3
    83. 

  83. 

  84. 

  85. Undeploy the Archive
    86. 

  86. --------------------
    87. 

  87. 

  88. 1. Make sure you have started the JBoss EAP server as described above.
    89. 

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

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

  91. 

  92.         mvn jboss-as:undeploy
    93. 

  93. 

  94. 

  95. Run the Quickstart in JBoss Developer Studio or Eclipse
    96. 

  96. -------------------------------------
    97. 

  97. You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/USE_JDBS.md#use-jboss-developer-studio-or-eclipse-to-run-the-quickstarts) 
    98. 

  98. 

  99. _NOTE:_ Within JBoss Developer Studio, be sure to define a server runtime environment that uses the `standalone-full.xml` configuration file.
    100. 

  100. 

  101. 

  102. Debug the Application
    103. 

  103. ------------------------------------
    104. 

  104. 

  105. 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.
    106. 

  106. 

  107.     mvn dependency:sources
    108. 

  108.    
    109. 

  109. 

  110. 

  111. Build and Deploy the Quickstart - to OpenShift
    112. 

  112. -------------------------
    113. 

  113. 

  114. ### Create an OpenShift Account and Domain
    115. 

  115. 

  116. If you do not yet have an OpenShift account and domain, [Sign in to OpenShift](https://openshift.redhat.com/app/login) to create the account and domain. [Get Started with OpenShift](https://openshift.redhat.com/app/getting_started) will show you how to install the OpenShift Express command line interface.
    117. 

  117. 

  118. ### Create the OpenShift Application
    119. 

  119. 

  120. _NOTE_: The domain name for this application will be `helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com`. In these instructions, be sure to replace all instances of `YOUR_DOMAIN_NAME` with your own OpenShift account user name.
    121. 

  121. 

  122. Open a shell command prompt and change to a directory of your choice. Enter the following command to create a JBoss EAP 6 application:
    123. 

  123. 

  124.         rhc app create -a helloworldmdb -t jbosseap-6
    125. 

  125. 

  126. This command creates an OpenShift application called `helloworldmdb` and will run the application inside the `jbosseap-6`. You should see some output similar to the following:
    127. 

  127. 

  128.     Application Options
    129. 

  129.     -------------------
    130. 

  130.       Namespace:  YOUR_DOMAIN_NAME
    131. 

  131.       Cartridges: jbosseap-6 (addtl. costs may apply)
    132. 

  132.       Gear Size:  default
    133. 

  133.       Scaling:    no
    134. 

  134. 

  135.     Creating application 'helloworldmdb' ... done
    136. 

  136. 

  137.     Waiting for your DNS name to be available ... done
    138. 

  138. 

  139.     Cloning into 'helloworldmdb'...
    140. 

  140.     Warning: Permanently added the RSA host key for IP address '54.237.58.0' to the list of known hosts.
    141. 

  141. 

  142.     Your application 'helloworldmdb' is now available.
    143. 

  143. 

  144.       URL:        http://helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com/
    145. 

  145.       SSH to:     52864af85973ca430200006f@helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com
    146. 

  146.       Git remote: ssh://52864af85973ca430200006f@helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com/~/git/helloworldmdb.git/
    147. 

  147.       Cloned to:  CURRENT_DIRECTORY/helloworldmdb
    148. 

  148. 

  149.     Run 'rhc show-app helloworldmdb' for more details about your app.
    150. 

  150. 

  151. The create command creates a git repository in the current directory with the same name as the application, in this case, `helloworldmdb`. Notice that the output also reports the URL at which the application can be accessed. Make sure it is available by typing the published url <http://helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com/> into a browser or use command line tools such as curl or wget. Be sure to replace `YOUR_DOMAIN_NAME` with your OpenShift account domain name.
    152. 

  152.         
    153. 

  153. 

  154. ### Migrate the Quickstart Source
    155. 

  155. 

  156. Now that you have confirmed it is working you can migrate the quickstart source. You do not need the generated default application, so navigate to the new git repository directory and tell git to remove the source and pom files:
    157. 

  157. 

  158.     cd helloworldmdb
    159. 

  159.     git rm -r src pom.xml
    160. 

  160. 

  161. Copy the source for the `helloworld-mdb` quickstart into this new git repository:
    162. 

  162. 

  163.     cp -r QUICKSTART_HOME/helloworld-mdb/src .
    164. 

  164.     cp QUICKSTART_HOME/helloworld-mdb/pom.xml .
    165. 

  165.     
    166. 

  166. ### Configure the OpenShift Server
    167. 

  167. 

  168. HornetQ is enabled by default in `.openshift/config/standalone.xml`. There is nothing to do to be able to send and receive messages from OpenShift.
    169. 

  169. 

  170. ### Deploy the OpenShift Application
    171. 

  171. 

  172. You can now deploy the changes to your OpenShift application using git as follows:
    173. 

  173. 

  174.     git add src pom.xml .openshift
    175. 

  175.     git commit -m "helloworld-mdb quickstart on OpenShift"
    176. 

  176.     git push
    177. 

  177. 

  178. The final push command triggers the OpenShift infrastructure to build and deploy the changes. 
    179. 

  179. 

  180. Note that the `openshift` profile in the `pom.xml` file is activated by OpenShift. This causes the WAR built by OpenShift to be copied to the `deployments/` directory and deployed without a context path.
    181. 

  181. 

  182. ### Test the OpenShift Application
    183. 

  183. 

  184. When the push command returns you can test the application by getting the following URL either via a browser or using tools such as curl or wget. Be sure to replace the `YOUR_DOMAIN_NAME` in the URL with your OpenShift account domain name.
    185. 

  185. 

  186. * <http://helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com/> to send messages to the queue
    187. 

  187. * <http://helloworldmdb-YOUR_DOMAIN_NAME.rhcloud.com/HelloWorldMDBServletClient?topic> to send messages to the topic
    188. 

  188. 

  189. If the application has run succesfully you should see some output in the browser.
    190. 

  190. 

  191. You can use the OpenShift command line tools or the OpenShift web console to discover and control the application.
    192. 

  192. 

  193. 

  194. ### View the JBoss EAP Server Log on OpenShift
    195. 

  195. 

  196. Now you can look at the output of the server by running the following command:
    197. 

  197. 

  198.     rhc tail -a helloworldmdb
    199. 

  199. 

  200. This will show the tail of the JBoss EAP server log, which should show something like the following.
    201. 

  201. 

  202.     2012/03/02 05:52:33,065 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-0 (HornetQ-client-global-threads-1772719)) Received Message from queue: This is message 4
    203. 

  203.     2012/03/02 05:52:33,065 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-1 (HornetQ-client-global-threads-1772719)) Received Message from queue: This is message 1
    204. 

  204.     2012/03/02 05:52:33,067 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-6 (HornetQ-client-global-threads-1772719)) Received Message from queue: This is message 5
    205. 

  205.     2012/03/02 05:52:33,065 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-3 (HornetQ-client-global-threads-1772719)) Received Message from queue: This is message 3
    206. 

  206.     2012/03/02 05:52:33,065 INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldMDB] (Thread-2 (HornetQ-client-global-threads-1772719)) Received Message from queue: This is message 2
    207. 

  207. 

  208. _Note:_ You may see the following error in the log:
    209. 

  209. 

  210.         2014/03/17 07:50:36,231 ERROR [org.jboss.as.controller.management-operation] (management-handler-thread - 4) JBAS014613: Operation ("read-resource") failed - address: ([("subsystem" => "deployment-scanner")]) - failure description: "JBAS014807: Management resource '[(\"subsystem\" => \"deployment-scanner\")]' not found"
    211. 

  211. 

  212. This is a benign error that occurs when the status of the deployment is checked too early in the process. This process is retried, so you can safely ignore this error.
    213. 

  213. 

  214. ### Delete the OpenShift Application
    215. 

  215. 

  216. When you are finished with the application you can delete it from OpenShift it as follows:
    217. 

  217. 

  218.         rhc app-delete -a helloworldmdb
    219. 

  219.         
    220. 

  220. _Note_: There is a limit to the number of applications you can deploy concurrently to OpenShift. If the `rhc app create` command returns an error indicating you have reached that limit, you must delete an existing application before you continue. 
    221. 

  221. 

  222. * To view the list of your OpenShift applications, type: `rhc domain show`
    223. 

  223. * To delete an application from OpenShift, type the following, substituting the application name you want to delete: `rhc app-delete -a APPLICATION_NAME_TO_DELETE`
    224. 

  224. 

  225.