activemq-artemis/examples/protocols/stomp/stomp-websockets
Clebert Suconic 505b732843 [maven-release-plugin] prepare for next development iteration 2016-09-06 12:17:31 -04:00
..
aerogear-chat This commit has improvements on the examples including: 2015-08-11 23:44:43 -04:00
chat ARTEMIS-593 clarify STOMP websocket support 2016-06-27 14:25:51 -05:00
src/main ARTEMIS-593 clarify STOMP websocket support 2016-06-27 14:25:51 -05:00
pom.xml [maven-release-plugin] prepare for next development iteration 2016-09-06 12:17:31 -04:00
readme.html ARTEMIS-593 clarify STOMP websocket support 2016-06-27 14:25:51 -05:00

readme.html

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<html>
  <head>
    <title>ActiveMQ Artemis Stomp WebSockets Example</title>
    <link rel="stylesheet" type="text/css" href="../../../common/common.css" />
    <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" />
    <script src="../../../common/prettify.js"></script>
  </head>
  <body onload="prettyPrint()">
     <h1>Stomp WebSockets Example</h1>

     <pre>To run the example, simply type <b>mvn verify</b> from this directory, <br>or <b>mvn -PnoServer verify</b> if you want to start and create the server manually.</pre>

     <p>This example shows you how to configure ActiveMQ Artemis to send and receive Stomp messages from modern web browser using Web Sockets.</p>

     <p>The example will start a ActiveMQ Artemis server configured with Stomp over Web Sockets and JMS. Web browsers clients and
       Java application will exchange message using a JMS Topic.</p></para>
     <pre class="prettyprint">
&lt;acceptor name="stomp-websocket">tcp://localhost:61614&lt;/acceptor></pre>

     <h2>Example step-by-step</h2>

     <p><i>To run the example, simply type <code>mvn verify -Pexample</code> from this directory</i></p>

    <p>To subscribe to the topic from your web browser, open the <a href="chat/index.html">Chat Example</a> or the <a href="aerogear-chat/aerogear-index.html">JBoss AeroGear STOMP notifier Chat Example</a> from another tab.
      The chat example is preconfigured to connect to the ActiveMQ Artemis server with the URL <code>ws://localhost:61613</code> and subscribe to the JMS Topic (through its core address
      <code>jms.topic.chat</code>).
    </p>
    <p>You can open as many Web clients as you want and they will all exchange messages through the topic</p>
    <p>If you run again the Java application (with <code>./build.sh</code>), the web clients will also receive its message</p>

    <h2>Documentation</h2>
    <p>A JavaScript library is used on the browser side to be able to use Stomp Over Web Sockets (please see its <a href="http://jmesnil.net/stomp-websocket/doc/">documentation</a>
      for a complete description).</p>
    <p>The <a href="aerogear-chat/aerogear-index.html">JBoss AeroGear STOMP notifier Chat Example</a> is using the AeroGear Notifier which is a collection of adapters that provide a unified or similar API for interacting with different messaging services and protocols. The STOMP adapter is used for communicating with STOMP over WebSockets. See more at: <a href="http://aerogear.org/docs/specs/aerogear-js/">JBoss aerogear-js</a> </p>
  </body>
</html>