activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbert...@apache.org
Subject [45/51] [partial] activemq-6 git commit: ACTIVEMQ6-1 - Initial HornetQ Donation Commit
Date Mon, 10 Nov 2014 16:32:56 GMT
http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/quickstart-guide/zh/installation.xml
----------------------------------------------------------------------
diff --git a/docs/quickstart-guide/zh/installation.xml b/docs/quickstart-guide/zh/installation.xml
new file mode 100644
index 0000000..dc89fd4
--- /dev/null
+++ b/docs/quickstart-guide/zh/installation.xml
@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+<chapter id="installation">
+   <title>安装</title>
+   <para>本章讲述如何安装HornetQ。</para>
+   <section id="installation.prerequisites">
+      <title>准备</title>
+      <note>
+         <para>HornetQ只能在Java 6或以上版本中运行</para>
+      </note>
+      <para>默认情况下HornetQ运行的内存是1GiB。如果你的电脑内存少于1GiB,或者你希望更多的内存给HornetQ,你
+         可以修改 <literal>bin/run.sh</literal>脚本文件。</para>
+      <para>HornetQ有自己的快速日志系统,它能够使用libaio(在Linux上它是默认的)或Java的NIO。
+         如果要使用libaio,你需要首先在你的Linux上安装它。</para>
+      <para>如果你不在使用Linux,则不需要考虑这个问题。</para>
+      <para>要安装libaio,你可以使用root用户完成以下步骤:</para>
+      <para>使用yum(例如在Fedora 或 Red Hat Enterprise Linux上):</para>
+      <programlisting>yum install libaio</programlisting>
+      <para>使用aptitude, (例如在Ubuntu或Debian系统上):</para>
+      <programlisting>apt-get install libaio</programlisting>
+   </section>
+   <section id="installation.standalone">
+      <title>单独的HornetQ服务器</title>
+      <para>将软件包下载后,将其解压到你选定的目录下。这里你就可以<link
linkend="running.standalone">直接运行了</link>。
+         下面给出了它的目录结构: </para>
+      <programlisting>
+         |___ bin
+         |
+         |___ config
+         |      |___ jboss-as-4
+         |      |___ jboss-as-5
+         |      |___ stand-alone
+         |
+         |___ docs
+         |      |___ api
+         |      |___ quickstart-guide
+         |      |___ user-manual
+         |
+         |___ examples
+         |      |___ core
+         |      |___ javaee
+         |      |___ jms
+         |
+         |___ lib
+         |
+         |___ licenses
+         |
+         |___ schemas
+      </programlisting>
+      <itemizedlist>
+         <listitem>
+            <para><literal>bin</literal> -- 运行HornetQ的二进制文件和脚本文件。</para>
+         </listitem>
+         <listitem>
+            <para><literal>config</literal> -- HornetQ的配置文件。它包括了单独模式或者运行在
+               JBoss AS 4 或 5中的配置。请参考配置索引来了解配置有详细信息。</para>
+         </listitem>
+         <listitem>
+            <para><literal>docs</literal> -- HornetQ的文档及Javadoc。
</para>
+         </listitem>
+         <listitem>
+            <para><literal>examples</literal> -- JMS and Java EE例子。有关详细信息请参见
+               'running examples'一章。 </para>
+         </listitem>
+         <listitem>
+            <para><literal>lib</literal> -- 运行HornetQ所需要的jar文件和库文件
</para>
+         </listitem>
+         <listitem>
+            <para><literal>licenses</literal> -- HornetQ的软件协议</para>
+         </listitem>
+         <listitem>
+            <para><literal>schemas</literal> -- HornetQ配置文件的XML
Schema</para>
+         </listitem>
+      </itemizedlist>
+   </section>
+   <section id="installation.jboss.as5">
+      <title>HornetQ运行于JBoss应用服务器5.x</title>
+      <para>HornetQ可以部署在<ulink url="http://www.jboss.org/jbossas/">JBoss
AS
+            5</ulink>中。目前默认的应用服务器没有安装HornetQ(HornetQ将是JBoss
6的默认JMS提供者),因此
+         你需要为HornetQ创建新的AS 5的配置(profile)。</para>
+      <para>创建AS 5新配置的步骤:</para>
+      <orderedlist>
+         <listitem>
+            <para>下载并安装JBoss AS 5</para>
+         </listitem>
+         <listitem>
+            <para>设置环境变量<literal>JBOSS_HOME</literal>指向JBoss
AS 5的安装目录。</para>
+         </listitem>
+         <listitem>
+            <para>运行HornetQ的<literal>config/jboss-as-5</literal>下的<literal>./build.sh</literal>
(或
+               者如果在Windows下运行<literal>build.bat</literal>)。</para>
+         </listitem>
+      </orderedlist>
+      <para>这将会在<literal>$JBOSS_HOME/server</literal>创建两个服务器配置:</para>
+      <itemizedlist>
+         <listitem>
+            <para><literal>default-with-hornetq</literal> -- 这个相当于AS
5的<literal
+                  >default</literal>配置但其JMS提供者替换成为HornetQ。在这个配置中的HornetQ
+               是<emphasis>非集群</emphasis>的。</para>
+         </listitem>
+         <listitem>
+            <para><literal>all-with-hornetq</literal> -- 这个相当于AS
5的<literal
+                  >all</literal>配置但其JMS提供者替换成为HornetQ。这个配置中的HornetQ
+               是<emphasis>集群</emphasis>的。</para>
+         </listitem>
+      </itemizedlist>
+      <para>这时,你就可以启动上面其中任何一个配置的JBoss AS 5服务器了,例如:</para>
+      <programlisting>$JBOSS_HOME/bin/run.sh -c default-with-hornetq</programlisting>
+   </section>
+   <section id="installation.jboss.as4">
+      <title>HornetQ运行于JBoss应用服务器4.x</title>
+      <para>为了在AS 4中安装HornetQ,你需要创建新的配置(profile)。</para>
+      <para>步骤如下:</para>
+      <orderedlist>
+         <listitem>
+            <para>下载并安装JBoss AS 4</para>
+         </listitem>
+         <listitem>
+            <para>设置环境变量<literal>JBOSS_HOME</literal>指向JBoss
AS 4的安装目录。</para>
+         </listitem>
+         <listitem>
+            <para>运行HornetQ的<literal>config/jboss-as-4</literal>下的<literal>./build.sh</literal>
(或
+               者如果在Windows下运行<literal>build.bat</literal>)。</para>
+         </listitem>
+      </orderedlist>
+      <para>这将会在<literal>$JBOSS_HOME/server</literal>创建两个服务器配置:</para>
+      <itemizedlist>
+         <listitem>
+            <para><literal>default-with-hornetq</literal> -- 这个相当于AS
4的<literal
+                  >default</literal>配置但其JMS提供者替换成为HornetQ。在这个配置中的HornetQ
+               是<emphasis>非集群</emphasis>的。</para>
+         </listitem>
+         <listitem>
+            <para><literal>all-with-hornetq</literal> -- 这个相当于AS
4的<literal
+                  >all</literal>配置但其JMS提供者替换成为HornetQ。这个配置中的HornetQ
+               是<emphasis>集群</emphasis>的。</para>
+         </listitem>
+      </itemizedlist>
+      <para>这时,你就可以启动上面其中任何一个配置的JBoss AS 4服务器了,例如:</para>
+      <programlisting>$JBOSS_HOME/bin/run.sh -c default-with-hornetq</programlisting>
+   </section>
+</chapter>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/quickstart-guide/zh/introduction.xml
----------------------------------------------------------------------
diff --git a/docs/quickstart-guide/zh/introduction.xml b/docs/quickstart-guide/zh/introduction.xml
new file mode 100644
index 0000000..e29f4fc
--- /dev/null
+++ b/docs/quickstart-guide/zh/introduction.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+<chapter id="introduction">
+    <title>快速入手</title>
+    <para>本简短的指南给出了如何下载、安装HornetQ,以及尽快开始使用HornetQ。</para>
+    <para>我们强烈建议当下载安装完成后,运行HornetQ的例子来了解HornetQ。我们有70多个例子来展示几乎
+        所有HornetQ的功能。</para>
+    <para>本指南不能代替用户手册。用户手册包括更加完整和深入的信息,供用户进一步全面掌握HornetQ。</para>
+</chapter>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/quickstart-guide/zh/master.xml
----------------------------------------------------------------------
diff --git a/docs/quickstart-guide/zh/master.xml b/docs/quickstart-guide/zh/master.xml
new file mode 100644
index 0000000..3971baf
--- /dev/null
+++ b/docs/quickstart-guide/zh/master.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN"
+        "../../../lib/docbook-support/support/docbook-dtd/docbookx.dtd" [
+        <!ENTITY about        SYSTEM "about.xml">
+        <!ENTITY download     SYSTEM "download.xml">
+        <!ENTITY examples     SYSTEM "examples.xml">
+        <!ENTITY installation SYSTEM "installation.xml">
+        <!ENTITY introduction SYSTEM "introduction.xml">
+        <!ENTITY notice       SYSTEM "notice.xml">
+        <!ENTITY running      SYSTEM "running.xml">
+        ]>
+<book lang="en">
+   <bookinfo>
+      <title>HornetQ快速指南</title>
+      <subtitle>Putting the buzz in messaging</subtitle>
+   </bookinfo>
+
+   <toc></toc>
+
+   &notice;
+   &about;
+   &introduction;
+   &download;
+   &installation;
+   &running;
+   &examples;
+</book>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/quickstart-guide/zh/notice.xml
----------------------------------------------------------------------
diff --git a/docs/quickstart-guide/zh/notice.xml b/docs/quickstart-guide/zh/notice.xml
new file mode 100644
index 0000000..a9db5e5
--- /dev/null
+++ b/docs/quickstart-guide/zh/notice.xml
@@ -0,0 +1,29 @@
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+
+
+<chapter id="notice">
+    <title>法律声明</title>
+        
+        <para>Red Hat, Inc. 以及其他公司2010年版权所有。</para>
+        <para>Red Hat公司依照 CC-BY-SA 3.0 Unported(Creative Commons 
+              Attribution-Share Alike)条款之规定授权用戶是用本手册中的文字和插图。</para>
+        <para>有关 CC-BY-SA 的解释请访问<ulink url="http://creativecommons.org/licenses/by-sa/3.0/">http://creativecommons.org/licenses/by-sa/3.0/</ulink>。根据CC-BY-SA的规定,如果要发布本文档或任何本文档的修改版本,都必须给出原始版本文档的URL。</para>
+        <para>Red Hat 作为本文档的授权方声明在相关法律允许的最大范围内放弃CC-BY-SA第4d节所规定的权利。</para>
+</chapter>
+

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/quickstart-guide/zh/running.xml
----------------------------------------------------------------------
diff --git a/docs/quickstart-guide/zh/running.xml b/docs/quickstart-guide/zh/running.xml
new file mode 100644
index 0000000..7833af8
--- /dev/null
+++ b/docs/quickstart-guide/zh/running.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+<chapter id="running">
+   <title>Starting The Server</title>
+   <section id="running.standalone">
+      <title>单独HornetQ</title>
+      <para>要运行单独的HornetQ服务,打开一个命令行窗口,进入到HornetQ的<literal>bin</literal>
+            目录下,执行<literal>./run.sh</literal> (或者在Windows下
<literal
+            >run.bat</literal>)。你将看到如下的输出:</para>
+      <programlisting>
+         bin$ ./run.sh
+         
+         15:05:54,108 INFO  @main [HornetQBootstrapServer] Starting HornetQ server
+         ...
+         15:06:02,566 INFO  @main [HornetQServerImpl] HornetQ Server version 
+         2.0.0.CR3 (yellowjacket, 111) started
+      </programlisting>
+      <para>这表明HornetQ已经启动并运行了。</para>
+      <para>默认情况下,不论是启动还是停止脚本都使用<literal>config/stand-alone/non-clustered</literal>
+         下的配置文件。要使用不同的配置目录,可运行<literal>./run.sh
../config/stand-alone/clustered</literal>
+         或者其它选定的目录。同样方法适用于停止脚本。</para>
+   </section>
+   <section id="running.jboss.as5">
+      <title>HornetQ在JBoss AS 5.x中运行</title>
+      <para>要在JBoss AS 5运行HornetQ,你需要创建<link
+            linkend="installation.jboss.as5">安装有HornetQ的AS 5的配置</link>。然后用这个配置启动AS
5。
+         例如,要运行一个带有<emphasis>非集群</emphasis>的HornetQ服务的AS
5,进入<literal
+            >$JBOSS_HOME/bin</literal>目录,然后键入:</para>
+      <programlisting>
+        bin$ ./run.sh -c default-with-hornetq
+        
+        15:18:35,460 INFO  [ServerImpl] Starting JBoss (Microcontainer)...
+        15:18:35,462 INFO  [ServerImpl] Release ID: JBoss (Microcontainer) [5.1.0.GA (build:
SVNTag=
+        JBoss_5_1_0_GA date=200905221053)
+        ...
+        15:19:30,305 INFO  [HornetQServerImpl] HornetQ Server version 
+        2.0.0.CR3 (yellowjacket, 111) started
+        ...
+        15:19:43,601 INFO  [ServerImpl] JBoss (Microcontainer) [5.1.0.GA (build: SVNTag=
+        JBoss_5_1_0_GA date=200905221053)]Started in 1m:14s:556ms
+      </programlisting>
+   </section>
+   <section id="running.jboss.as4">
+      <title>HornetQ在JBoss AS 4中运行</title>
+      <para>首先按照与JBoss AS 5相同的步骤创建<link linkend="installation.jboss.as4">安装有HornetQ的AS
4配置
+            </link>然后以相同的方式启动AS。</para>
+   </section>
+   <section id="running.jboss.as6">
+      <title>HornetQ在JBoss AS 6.0中运行</title>
+      <para>从JBoss AS 6.0 M3开始,HornetQ已经是默认的(内建)JMS提供者。所以无需安装即可运行。</para>
+   </section>
+</chapter>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/user-manual/en/Author_Group.xml
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/Author_Group.xml b/docs/user-manual/en/Author_Group.xml
new file mode 100644
index 0000000..42b4ffc
--- /dev/null
+++ b/docs/user-manual/en/Author_Group.xml
@@ -0,0 +1,82 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+  ~ Copyright 2009 Red Hat, Inc.
+  ~  Red Hat 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.
+  -->
+
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
+<!ENTITY % BOOK_ENTITIES SYSTEM "HornetQ_User_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<authorgroup>
+  <author>
+    <firstname>Clebert</firstname>
+    <surname>Suconic</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Project Lead</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+    </affiliation>
+    <email>csuconic@redhat.com</email>
+  </author>
+  <author>
+    <firstname>Andy</firstname>
+    <surname>Taylor</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Core Developer</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+    </affiliation>
+    <email>ataylor@redhat.com</email>
+  </author>
+  <author>
+    <firstname>Tim</firstname>
+    <surname>Fox</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Core Developer</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+     </affiliation>
+  </author>
+  <author>
+    <firstname>Jeff</firstname>
+    <surname>Mesnil</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Core Developer</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+    </affiliation>
+  </author>
+  <author>
+    <firstname>Howard</firstname>
+    <surname>Gao</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Core Developer</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+    </affiliation>
+    <email>ghoward@redhat.com</email>
+  </author>
+  <author>
+    <firstname>Francisco</firstname>
+    <surname>Borges</surname>
+  </author>
+  <author>
+    <firstname>Justin</firstname>
+    <surname>Bertram</surname>
+    <affiliation>
+      <shortaffil>Red Hat, Inc.</shortaffil>
+      <jobtitle>Core Developer</jobtitle>
+      <orgdiv>JBoss</orgdiv>
+    </affiliation>
+    <email>jbertram@redhat.com</email>
+  </author>
+</authorgroup>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/user-manual/en/Book_Info.xml
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/Book_Info.xml b/docs/user-manual/en/Book_Info.xml
new file mode 100644
index 0000000..f646ef6
--- /dev/null
+++ b/docs/user-manual/en/Book_Info.xml
@@ -0,0 +1,44 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+  ~ Copyright 2009 Red Hat, Inc.
+  ~  Red Hat 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.
+  -->
+
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
+<!ENTITY % BOOK_ENTITIES SYSTEM "HornetQ_User_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<bookinfo id="HornetQ_User_Manual">
+  <title>HornetQ User Manual</title>
+  <subtitle>Putting the buzz in messaging</subtitle>
+  <productname>HornetQ</productname>
+  <productnumber>2</productnumber>
+  <edition>2.1.0</edition>
+  <pubsnumber>1</pubsnumber>
+  <abstract>
+    <para>The User manual is an in depth manual on all aspects of HornetQ</para>
+  </abstract>
+  <corpauthor>
+    <inlinemediaobject>
+      <imageobject>
+        <imagedata fileref="images/hornetQ_logo_600px.png" format="PNG"/>
+      </imageobject>
+      <textobject>
+        <phrase>HornetQ Logo</phrase>
+      </textobject>
+    </inlinemediaobject>
+  </corpauthor>
+  <copyright>
+    <year>&YEAR;</year>
+    <holder>&HOLDER;</holder>
+  </copyright>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/>
+</bookinfo>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/user-manual/en/HornetQ_User_Manual.ent
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/HornetQ_User_Manual.ent b/docs/user-manual/en/HornetQ_User_Manual.ent
new file mode 100644
index 0000000..dd225e3
--- /dev/null
+++ b/docs/user-manual/en/HornetQ_User_Manual.ent
@@ -0,0 +1,18 @@
+<!ENTITY PRODUCT "HornetQ">
+<!ENTITY BOOKID "HornetQ_QuickStart_Guide">
+<!ENTITY YEAR "2011">
+<!ENTITY HOLDER "Red Hat Inc.">
+<!ENTITY semi ";"><!--
+  ~ Copyright 2009 Red Hat, Inc.
+  ~  Red Hat 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.
+  -->
+
+

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/user-manual/en/HornetQ_User_Manual.xml
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/HornetQ_User_Manual.xml b/docs/user-manual/en/HornetQ_User_Manual.xml
new file mode 100644
index 0000000..3ddf954
--- /dev/null
+++ b/docs/user-manual/en/HornetQ_User_Manual.xml
@@ -0,0 +1,74 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+  ~ Copyright 2009 Red Hat, Inc.
+  ~  Red Hat 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.
+  -->
+
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
+<!ENTITY % BOOK_ENTITIES SYSTEM "HornetQ_User_Manual.ent">
+%BOOK_ENTITIES;
+
+]>
+<book>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="notice.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="preface.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="project-info.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="messaging-concepts.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="architecture.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using-server.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using-jms.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using-core.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="jms-core-mapping.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="client-classpath.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="examples.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="wildcard-routing.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="wildcard-syntax.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="filter-expressions.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="persistence.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuring-transports.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="connection-ttl.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="transaction-config.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="flow-control.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="send-guarantees.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="undelivered-messages.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="message-expiry.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="large-messages.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="paging.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="queue-attributes.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="scheduled-messages.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="last-value-queues.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="message-grouping.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="pre-acknowledge.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="appserver-integration.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="jms-bridge.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="client-reconnection.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="diverts.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="core-bridges.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="duplicate-detection.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="clusters.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ha.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="libaio.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="thread-pooling.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="logging.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="rest.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="embedding-hornetq.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="spring-integration.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="aerogear-integration.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="vertx-integration.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="intercepting-operations.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="interoperability.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="perf-tuning.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="configuration-index.xml"/>
+</book>

http://git-wip-us.apache.org/repos/asf/activemq-6/blob/8ecd255f/docs/user-manual/en/aerogear-integration.xml
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/aerogear-integration.xml b/docs/user-manual/en/aerogear-integration.xml
new file mode 100644
index 0000000..44e3e23
--- /dev/null
+++ b/docs/user-manual/en/aerogear-integration.xml
@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- ============================================================================= -->
+<!-- Copyright © 2009 Red Hat, Inc. and others.                                    -->
+<!--                                                                               -->
+<!-- The text of and illustrations in this document are licensed by Red Hat under  -->
+<!-- a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). -->
+<!--                                                                               -->
+<!-- An explanation of CC-BY-SA is available at                                    -->
+<!--                                                                               -->
+<!--            http://creativecommons.org/licenses/by-sa/3.0/.                    -->
+<!--                                                                               -->
+<!-- In accordance with CC-BY-SA, if you distribute this document or an adaptation -->
+<!-- of it, you must provide the URL for the original version.                     -->
+<!--                                                                               -->
+<!-- Red Hat, as the licensor of this document, waives the right to enforce,       -->
+<!-- and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent        -->
+<!-- permitted by applicable law.                                                  -->
+<!-- ============================================================================= -->
+
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
+        <!ENTITY % BOOK_ENTITIES SYSTEM "HornetQ_User_Manual.ent">
+        %BOOK_ENTITIES;
+        ]>
+<chapter id="aerogear-integration">
+    <title>AeroGear Integration</title>
+    <para>AeroGears push technology provides support for different push notification
technologies like Google Cloud Messaging,
+        Apple's APNs or Mozilla's SimplePush. HornetQ allows you to configure a Connector
Service that will consume messages
+    from a queue and forward them to an AeroGear push server and subsequently sent as notifications
to mobile devices.</para>
+    <section>
+    <title>Configuring an AeroGear Connector Service</title>
+    <para>AeroGear Connector services are configured in the connector-services configuration:</para>
+    <programlisting>
+    &lt;connector-service name="aerogear-connector">
+    &lt;factory-class>org.hornetq.integration.aerogear.AeroGearConnectorServiceFactory&lt;/factory-class>
+    &lt;param key="endpoint" value="endpoint"/>
+    &lt;param key="queue" value="jms.queue.aerogearQueue"/>
+    &lt;param key="application-id" value="an applicationid"/>
+    &lt;param key="master-secret" value="a mastersecret"/>
+    &lt;/connector-service>
+    &lt;address-setting match="jms.queue.lastValueQueue">
+    &lt;last-value-queue>true&lt;/last-value-queue>
+    &lt;/address-setting>
+    </programlisting>
+    <para>Shown are the required params for the connector service and are:</para>
+
+        <itemizedlist>
+            <listitem>
+                <para><literal>endpoint</literal>. The endpoint or URL
of you AeroGear application.</para>
+            </listitem>
+            <listitem>
+                <para><literal>queue</literal>. The name of the queue to
consume from.</para>
+            </listitem>
+            <listitem>
+                <para><literal>application-id</literal>. The application
id of your mobile application in AeroGear.</para>
+            </listitem>
+            <listitem>
+                <para><literal>master-secret</literal>. The secret of your
mobile application in AeroGear.</para>
+            </listitem>
+        </itemizedlist>
+        <para>As well as these required paramaters there are the following optional
parameters</para>
+        <itemizedlist>
+            <listitem>
+                <para><literal>ttl</literal>. The time to live for the
message once AeroGear receives it.</para>
+            </listitem>
+            <listitem>
+                <para><literal>badge</literal>. The badge the mobile app
should use for the notification.</para>
+            </listitem>
+            <listitem>
+                <para><literal>sound</literal>. The sound the mobile app
should use for the notification.</para>
+            </listitem>
+            <listitem>
+                <para><literal>filter</literal>. A message filter(selector)
to use on the connector.</para>
+            </listitem>
+            <listitem>
+                <para><literal>retry-interval</literal>. If an error occurs
on send, how long before we try again to connect.</para>
+            </listitem>
+            <listitem>
+                <para><literal>retry-attempts</literal>. How many times
we should try to reconnect after an error.</para>
+            </listitem>
+            <listitem>
+                <para><literal>variants</literal>. A comma separated list
of variants that should get the message.</para>
+            </listitem>
+            <listitem>
+                <para><literal>aliases</literal>. A list of aliases that
should get the message.</para>
+            </listitem>
+            <listitem>
+                <para><literal>device-types</literal>. A list of device
types that should get the messag.</para>
+            </listitem>
+        </itemizedlist>
+        <para>More in depth explanations of the AeroGear related parameters can be
found in the <ulink
+                url="http://aerogear.org/push/">AeroGear Push docs</ulink></para>
+    </section>
+    <section>
+        <title>How to send a message for AeroGear</title>
+        <para>To send a message intended for AeroGear simply send a JMS Message and
set the appropriate headers, like so</para>
+        <programlisting>
+    Message message = session.createMessage();
+
+    message.setStringProperty("AEROGEAR_ALERT", "Hello this is a notification from HornetQ");
+
+    producer.send(message);
+        </programlisting>
+        <para>The 'AEROGEAR_ALERT' property will be the alert sent to the mobile device.</para>
+        <note><para>If the message does not contain this property then it will
be simply ignored and left on the queue</para></note>
+        <para>Its also possible to override any of the other AeroGear parameters by
simply setting them on the message,
+        for instance if you wanted to set ttl of a message you would:</para>
+        <programlisting>
+    message.setIntProperty("AEROGEAR_TTL", 1234);
+        </programlisting>
+        <para>or if you wanted to set the list of variants you would use:</para>
+        <programlisting>
+    message.setStringProperty("AEROGEAR_VARIANTS", "variant1,variant2,variant3");
+        </programlisting>
+        <para>Again refer to the AeroGear documentation for a more in depth view on
how to use these settings</para>
+    </section>
+</chapter>
\ No newline at end of file


Mime
View raw message