[jboss-cvs] JBoss Messaging SVN: r3621 - branches/Branch_Stable/docs/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Jan 23 19:43:43 EST 2008
Author: clebert.suconic at jboss.com
Date: 2008-01-23 19:43:43 -0500 (Wed, 23 Jan 2008)
New Revision: 3621
Modified:
branches/Branch_Stable/docs/userguide/en/modules/about.xml
branches/Branch_Stable/docs/userguide/en/modules/installation.xml
branches/Branch_Stable/docs/userguide/en/modules/introduction.xml
Log:
Documentation changes before the release
Modified: branches/Branch_Stable/docs/userguide/en/modules/about.xml
===================================================================
--- branches/Branch_Stable/docs/userguide/en/modules/about.xml 2008-01-23 11:52:09 UTC (rev 3620)
+++ branches/Branch_Stable/docs/userguide/en/modules/about.xml 2008-01-24 00:43:43 UTC (rev 3621)
@@ -1,38 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="about">
- <title>About JBoss Messaging 1.4.0.</title>
- <para>JBoss Messaging is the new enterprise messaging system from JBoss. It
- is a complete rewrite of JBossMQ, the legacy JBoss JMS provider.</para>
- <para>JBoss Messaging will be the default JMS provider in later versions of
- JBoss Enterprise Application Platform, and JBoss Service Integration
- Platform. It will also be the default JMS provider in JBoss Application
- Server 5, and is the default JMS provider for JBoss ESB.</para>
- <para>JBoss Messaging is an integral part of Red Hat's strategy for
- messaging.</para>
- <para>Compared with JBossMQ, JBoss Messaging offers improved performance in
- both single node and clustered environments.</para>
- <para>JBoss Messaging also features a much better modular architecture that
- will allow us to add more features in the future.</para>
- <para>JBoss Messaging can be easily installed in JBoss Application Server
- 4.2 using a few simple steps to remove JBoss MQ and replace with JBoss
- Messaging.</para>
- <para>Once JBoss Messaging becomes the default JMS provider in JBoss
- Application Server, there will be no need to do any manual
- installation.</para>
- <para>From release 1.4.0. onwards JBoss Messaging is designed for JBoss
- 4.2 only and is Java 5.</para>
- <para>The procedure of installing JBoss Messaging into JBoss Application
- Server is detailed in this guide.</para>
- <para>Please send your suggestions or comments to the <ulink
- url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=238">JBoss
- Messaging user forum</ulink>.</para>
- <para>Permanent Team: Tim Fox (Project Lead), Jeff Mesnil (Core Developer),
- Andy Taylor (Core Developer), Clebert Suconic (Core Developer)</para>
- <para>Contributors: Ovidiu Feodorov (Project Founder), Sergey Koshcheyev,
- Ron Sigal, Madhu Konda, Jay Howell, Tyronne Wickramarathne, Aaron Walker,
- Adrian Brock, Rajdeep Dua, Tom Elrod, Alex Fu, Juha Lindfors, Alexey
- Loubyansky, Luc Texier, Scott Stark, Aslak Knutsen</para>
- <para>Messaging support team: Jay Howell, David Boeren, Mike Clark, Tyronne
- Wickramarathne</para>
- <para>Other thanks to: Mark Little and Pete Bennett</para>
+ <title>About JBoss Messaging 1.4.0.</title>
+
+ <para>JBoss Messaging is the new enterprise messaging system from JBoss. It
+ is a complete rewrite of JBossMQ, the legacy JBoss JMS provider.</para>
+
+ <para>JBoss Messaging will be the default JMS provider in later versions of
+ JBoss Enterprise Application Platform, and JBoss Service Integration
+ Platform. It will also be the default JMS provider in JBoss Application
+ Server 5, and is the default JMS provider for JBoss ESB.</para>
+
+ <para>JBoss Messaging is an integral part of Red Hat's strategy for
+ messaging.</para>
+
+ <para>Compared with JBossMQ, JBoss Messaging offers improved performance in
+ both single node and clustered environments.</para>
+
+ <para>JBoss Messaging also features a much better modular architecture that
+ will allow us to add more features in the future.</para>
+
+ <para>JBoss Messaging can be easily installed in JBoss Application Server
+ 4.2 using a few simple steps to remove JBoss MQ and replace with JBoss
+ Messaging, and it is already the default implementation on JBoss 5 (Beta
+ releases at this point) and on JBoss EAP 4.3.</para>
+
+ <para>From release 1.4.0. onwards JBoss Messaging is designed for JBoss 4.2+
+ only and is Java 5.</para>
+
+ <para>The procedure of installing JBoss Messaging into JBoss Application
+ Server is detailed in this guide.</para>
+
+ <para>Please send your suggestions or comments to the <ulink
+ url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=238">JBoss
+ Messaging user forum</ulink>.</para>
+
+ <para>Permanent Team: Tim Fox (Project Lead), Jeff Mesnil (Core Developer),
+ Andy Taylor (Core Developer), Clebert Suconic (Core Developer)</para>
+
+ <para>Contributors: Ovidiu Feodorov (Project Founder), Sergey Koshcheyev,
+ Ron Sigal, Madhu Konda, Jay Howell, Tyronne Wickramarathne, Aaron Walker,
+ Adrian Brock, Rajdeep Dua, Tom Elrod, Alex Fu, Juha Lindfors, Alexey
+ Loubyansky, Luc Texier, Scott Stark, Aslak Knutsen</para>
+
+ <para>Messaging support team: Jay Howell, David Boeren, Mike Clark, Tyronne
+ Wickramarathne</para>
+
+ <para>Other thanks to: Mark Little and Pete Bennett</para>
</chapter>
\ No newline at end of file
Modified: branches/Branch_Stable/docs/userguide/en/modules/installation.xml
===================================================================
--- branches/Branch_Stable/docs/userguide/en/modules/installation.xml 2008-01-23 11:52:09 UTC (rev 3620)
+++ branches/Branch_Stable/docs/userguide/en/modules/installation.xml 2008-01-24 00:43:43 UTC (rev 3621)
@@ -1,157 +1,194 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="installation">
- <title>JBoss Messaging Installation</title>
- <para>This section describes procedures on how to install JBoss Messaging
- into JBoss AS. At the end of this procedure, you will create a JBoss
- Messaging configuration that will start a clustered or non-clustered
- messaging server.</para>
- <para>By default, JBoss AS 4 ships with JBossMQ as default JMS provider. In
- order to use the JBoss AS instance with JBoss Messaging, you need to
- perform the installation procedure described below.</para>
- <para><note>
- A JBossMQ and a JBoss Messaging instance cannot coexist, at least not unless special precautions are taken. Do not simply attempt to copy the Messaging release artifact
- <filename>jboss-messaging.sar</filename>
- over to the JBoss instance w
- <filename>deploy</filename>
- directory. Follow one of the alternate installation procedures outlined below instead.
- </note></para>
- <para><note>
- We only recommend and support installing JBoss Messaging in JBoss AS 4.2 or later. You should avoid using JBoss Messaging on any version of JBoss AS prior to JBoss 4.2.0.GA, such as 4.0.5.GA and 4.0.4.GA.
- </note><note>
- JBoss Messaging is built against the JBoss AS 4.2 libraries which are built using Java 5. Therefore JBoss Messaging only runs with Java 5 or later.
- </note></para>
- <section id="install">
- <title>Installing JBoss Messaging on JBoss AS 4.2</title>
- <para>In this section we present two different methods of installing
- JBoss Messaging in JBoss AS 4.2</para>
+ <title>JBoss Messaging Installation</title>
+
+ <para>This section describes procedures on how to install JBoss Messaging
+ into JBoss AS. At the end of this procedure, you will create a JBoss
+ Messaging configuration that will start a clustered or non-clustered
+ messaging server.</para>
+
+ <para>By default, JBoss AS 4 ships with JBossMQ as default JMS provider. In
+ order to use the JBoss AS instance with JBoss Messaging, you need to perform
+ the installation procedure described below.</para>
+
+ <para><note>
+ A JBossMQ and a JBoss Messaging instance cannot coexist, at least not unless special precautions are taken. Do not simply attempt to copy the Messaging release artifact
+
+ <filename>jboss-messaging.sar</filename>
+
+ over to the JBoss instance w
+
+ <filename>deploy</filename>
+
+ directory. Follow one of the alternate installation procedures outlined below instead.
+ </note></para>
+
+ <para><note>
+ We only recommend and support installing JBoss Messaging in JBoss AS 4.2 or later. You should avoid using JBoss Messaging on any version of JBoss AS prior to JBoss 4.2.0.GA, such as 4.0.5.GA and 4.0.4.GA.
+ </note><note>
+ JBoss Messaging is built against the JBoss AS 4.2 libraries which are built using Java 5. Therefore JBoss Messaging only runs with Java 5 or later.
+ </note></para>
+
+ <section id="install">
+ <title>Installing JBoss Messaging on JBoss AS 4.2</title>
+
+ <para>In this section we present two different methods of installing JBoss
+ Messaging in JBoss AS 4.2</para>
+
+ <itemizedlist>
+ <listitem>
+ If you have a completely clean JBoss AS 4.2.0 installation then you can do an
+
+ <xref linkend="install.automated">automatic install</xref>
+
+ .
+ </listitem>
+
+ <listitem>
+ If you have a JBoss 4.2.0 that you have changed in some way from a clean JBoss AS 4.2.0 installation then you will need to do a
+
+ <xref linkend="install.manual">manual install</xref>
+
+ .
+ </listitem>
+ </itemizedlist>
+
+ <section id="install.automated">
+ <title>Automated Installation</title>
+
+ <para><note>
+ This procedure should only be performed from a clean JBoss AS 4.2 installation. If you have modifed the JBoss AS 4.2 installation at all since installation then you will need to perform a manual clustered JBoss Messaging installation
+ </note></para>
+
<itemizedlist>
- <listitem>
- If you have a completely clean JBoss AS 4.2.0 installation then you can do an
- <xref linkend="install.automated">automatic install</xref>
- .
- </listitem>
- <listitem>
- If you have a JBoss 4.2.0 that you have changed in some way from a clean JBoss AS 4.2.0 installation then you will need to do a
- <xref linkend="install.manual">manual install</xref>
- .
- </listitem>
- </itemizedlist>
- <section id="install.automated">
- <title>Automated Installation</title>
- <para><note>
- This procedure should only be performed from a clean JBoss AS 4.2 installation. If you have modifed the JBoss AS 4.2 installation at all since installation then you will need to perform a manual clustered JBoss Messaging installation
- </note></para>
- <itemizedlist>
- <listitem>
- <para>Set up the <literal>JBOSS_HOME</literal> environment
- variable to point to the JBoss 4.2 installation you want to use
- JBoss Messaging with.</para>
- <para>Run the installation script, available in the
- <filename>util</filename> directory of the release bundle as
- follows:</para>
- <para>If you want to create a simple non clustered installion
- based on the default configuration:</para>
- <programlisting>
+ <listitem>
+ <para>Set up the <literal>JBOSS_HOME</literal> environment variable
+ to point to the JBoss 4.2 installation you want to use JBoss
+ Messaging with.</para>
+
+ <para>Run the installation script, available in the
+ <filename>util</filename> directory of the release bundle as
+ follows:</para>
+
+ <para>If you want to create a simple non clustered installion based
+ on the default configuration:</para>
+
+ <programlisting>
cd util
ant -f release-admin.xml
</programlisting>
- <para>If you want to create a clustered installation based on
- the all configuration or change the configuration name:</para>
- <programlisting>
+
+ <para>If you want to create a clustered installation based on the
+ all configuration or change the configuration name:</para>
+
+ <programlisting>
cd util
ant -f release-admin.xml -Dmessaging.config.source=all -Dmessaging.config.name=messaging-node0
</programlisting>
- <para>In the above you would substitute
- <literal>messaging-node0</literal> with whatever is the name
- you want to give the configuration. If you want several cluster
- nodes on the same machine, e.g. for development purposes then a
- good convention is to name them <literal>messaging-node0,
- messaging-node1</literal> to match
- <literal>messaging-node<ServerPeerID></literal></para>
- <para>The messaging.config.source variable determines which
- JBoss AS configuration (e.g. default or all) to base the
- installation on</para>
- <para>The installation script will create a
- <filename>$JBOSS_HOME/server/messaging-node0</filename>
- configuration. (If you have chosen
- <literal>messaging-node0</literal>)</para>
+
+ <para>In the above you would substitute
+ <literal>messaging-node0</literal> with whatever is the name you
+ want to give the configuration. If you want several cluster nodes on
+ the same machine, e.g. for development purposes then a good
+ convention is to name them <literal>messaging-node0,
+ messaging-node1</literal> to match
+ <literal>messaging-node<ServerPeerID></literal></para>
+
+ <para>The messaging.config.source variable determines which JBoss AS
+ configuration (e.g. default or all) to base the installation
+ on</para>
+
+ <para>The installation script will create a
+ <filename>$JBOSS_HOME/server/messaging-node0</filename>
+ configuration. (If you have chosen
+ <literal>messaging-node0</literal>)</para>
+ </listitem>
+
+ <para>For the rest of the procedure we assume JBOSS_CONFIG refers to
+ your new messaging configuration (e.g. messaging-node0 or
+ messaging)</para>
+
+ <para>You don't actually have to create an environment variable
+ <literal>JBOSS_CONFIG</literal>, this is just used in the installation
+ instructions to describe the steps</para>
+
+ <listitem>
+ <para>
+ <warning>For a clustered installation it is mandatory that a
+ shared database is available to all nodes in the cluster. The
+ default JBoss AS uses HSQLDB for its database which is a local
+ shared database. Therefore in order to use clustering you must
+ replace this with a different shared database. If the database is
+ not replaced then clustering will not work.</warning>
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Replace
+ <literal>$JBOSS_CONFIG/deploy/jboss-messaging.sar/hsqldb-persistence-service.xml</literal>
+ by the <literal>databasename>-persistence-service</literal>
+ from
+ <literal><downloadPackage>/examples/config.</literal>. For
+ instance <literal>mysql-persistence-service.xml</literal></para>
</listitem>
- <para>For the rest of the procedure we assume JBOSS_CONFIG refers
- to your new messaging configuration (e.g. messaging-node0 or
- messaging)</para>
- <para>You don't actually have to create an environment variable
- <literal>JBOSS_CONFIG</literal>, this is just used in the
- installation instructions to describe the steps</para>
+
+ <listitem><para>Configure a JCA datasource using an example from
+ <literal>$JBOSS_HOME/docs/examples/jca</literal></para> and
+ copying to <literal>$JBOSS_CONFIG/deploy</literal> <para>JBoss
+ Messaging uses <literal>DefaultDS</literal> by default so you
+ should configure your datasource to bind to that</para></listitem>
+
<listitem>
- <para>
- <warning>For a clustered installation it is mandatory that a
- shared database is available to all nodes in the cluster.
- The default JBoss AS uses HSQLDB for its database which is a
- local shared database. Therefore in order to use clustering
- you must replace this with a different shared database. If
- the database is not replaced then clustering will not
- work.</warning>
- </para>
- <itemizedlist>
- <listitem>
- <para>Replace
- <literal>$JBOSS_CONFIG/deploy/jboss-messaging.sar/hsqldb-persistence-service.xml</literal>
- by the
- <literal>databasename>-persistence-service</literal>
- from
- <literal><downloadPackage>/examples/config.</literal>.
- For instance
- <literal>mysql-persistence-service.xml</literal></para>
- </listitem>
- <listitem><para>Configure a JCA datasource using an example
- from <literal>$JBOSS_HOME/docs/examples/jca</literal></para>
- and copying to <literal>$JBOSS_CONFIG/deploy</literal>
- <para>JBoss Messaging uses <literal>DefaultDS</literal> by
- default so you should configure your datasource to bind to
- that</para></listitem>
- <listitem>
- <para>Remove hsqldb-ds.xml from
- <literal>$JBOSS_CONFIG/deploy</literal></para>
- </listitem>
- <listitem>
- <para>Copy your database driver to
- <literal>$JBOSS_CONFIG/lib</literal></para>
- <para>Your database driver can probably be downloaded
- from your database provider's web site</para>
- </listitem>
- </itemizedlist>
+ <para>Remove hsqldb-ds.xml from
+ <literal>$JBOSS_CONFIG/deploy</literal></para>
</listitem>
+
<listitem>
- <para>Ensure the <literal>ServerPeerID</literal> MBean
- attribute value in messaging-service.xml is unique for each
- node. The <literal>ServerPeerID</literal> value must be a valid
- integer. Every node MUST have a unique id, including those just
- connected by message bridges.</para>
- <para>
- <warning>Each node must have a unique
- <literal>ServerPeerID</literal> irrespective of whether you
- are using clustering.</warning>
- </para>
+ <para>Copy your database driver to
+ <literal>$JBOSS_CONFIG/lib</literal></para>
+
+ <para>Your database driver can probably be downloaded from your
+ database provider's web site</para>
</listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>Ensure the <literal>ServerPeerID</literal> MBean attribute
+ value in messaging-service.xml is unique for each node. The
+ <literal>ServerPeerID</literal> value must be a valid integer. Every
+ node MUST have a unique id, including those just connected by
+ message bridges.</para>
+
+ <para>
+ <warning>Each node must have a unique
+ <literal>ServerPeerID</literal> irrespective of whether you are
+ using clustering.</warning>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>If you want to run multiple JBoss Messaging nodes on the same
+ box using the same IP address, e.g. for development purposes, then
+ you can use the ServiceBindingManager to do this as follows:</para>
+
+ <itemizedlist>
<listitem>
- <para>If you want to run multiple JBoss Messaging nodes on the
- same box using the same IP address, e.g. for development
- purposes, then you can use the ServiceBindingManager to do this
- as follows:</para>
- <itemizedlist>
- <listitem>
- <para>Uncomment binding manager service from
- $JBOSS_CONFIG/conf/jboss-service.xml</para>
- </listitem>
- <listitem>
- <para>Specify the desired port rage (e.g. ports-01,
- ports-02... etc)</para>
- </listitem>
- <listitem>
- <para>Look at
- $JBOSS_HOME/docs/examples/binding-manager/sample-bindings.xml.
- Here is an example:</para>
- <programlisting>
+ <para>Uncomment binding manager service from
+ $JBOSS_CONFIG/conf/jboss-service.xml</para>
+ </listitem>
+
+ <listitem>
+ <para>Specify the desired port rage (e.g. ports-01, ports-02...
+ etc)</para>
+ </listitem>
+
+ <listitem>
+ <para>Look at
+ $JBOSS_HOME/docs/examples/binding-manager/sample-bindings.xml.
+ Here is an example:</para>
+
+ <programlisting>
<service-config name="jboss.messaging:service=Connector,transport=bisocket"
delegateClass="org.jboss.services.binding.AttributeMappingDelegate">
<delegate-config>
@@ -202,71 +239,90 @@
</service-config>
</programlisting>
- <warning>You must ensure that the config (like above) is
- identical to that in
- <literal>remoting-bisocket-service.xml</literal> With the
- exception of the actual serverBindPort which clearly must
- be different for each ports range. Please note that the
- default JBoss Messaging service binding manager bindings
- in <literal>sample-bindings.xml</literal> shipped with
- JBAS 4.2.0 may be out of date and you will need to copy
- the config from <literal>remoting-bisocket-service.xml.
- DO NOT just copy and paste from the above example - copy
- it from the JBoss Messaging
- distribution.</literal></warning>
- <para>You should ensure that each node is configured to
- use a different ports range.</para>
- </listitem>
- </itemizedlist>
+
+ <warning>You must ensure that the config (like above) is
+ identical to that in
+ <literal>remoting-bisocket-service.xml</literal> With the
+ exception of the actual serverBindPort which clearly must be
+ different for each ports range. Please note that the default
+ JBoss Messaging service binding manager bindings in
+ <literal>sample-bindings.xml</literal> shipped with JBAS 4.2.0
+ may be out of date and you will need to copy the config from
+ <literal>remoting-bisocket-service.xml. DO NOT just copy and
+ paste from the above example - copy it from the JBoss Messaging
+ distribution.</literal></warning>
+
+ <para>You should ensure that each node is configured to use a
+ different ports range.</para>
</listitem>
- <listitem>
- <para>There are few extra steps at <xref
- linkend="install.extra-steps" /></para>
- </listitem>
- <listitem>That's it</listitem>
- </itemizedlist>
- </section>
- <section id="install.manual">
- <title>Manual Installation</title>
- <para><note>
- This installation procedure should be performed if you are installing into a JBoss AS configuration that you have changed in some way from the default JBoss AS distribution. If you are just using the standard, untouched JBoss AS 4.2 distribution you can use the automated procedure above
- </note></para>
- <para>For this procedure we assume you already have your custom
- configuration located at
- <literal>JBOSS_CONFIG=$JBOSS_HOME/server/<myconfiguration></literal>,
- and that it contains a JBoss MQ installation.</para>
- <para>You don't actually have to create an environment variable
- <literal>JBOSS_CONFIG</literal>, this is just used in the
- installation instructions to describe the steps</para>
- <itemizedlist>
- <listitem>
- <para>Move
- <literal>$JBOSS_CONFIG/deploy/jms/hajndi-jms-ds.xml</literal>
- and <literal>$JBOSS_CONFIG/deploy/jms/jms-ra.rar</literal> to
- <literal>$JBOSS_CONFIG/deploy</literal></para>
- </listitem>
- <listitem>
-
- <para>Remove the old JBoss MQ by removing the directory
- <literal>$JBOSS_CONFIG/deploy/jms.</literal></para>
- .
- <para>Remove the old JBoss MQ jar file:
- <literal>$JBOSS_CONFIG/lib/jbossmq.jar</literal></para>
-
- <para>Make sure you don't have any JBossMQ files under
- <literal>$JBOSS_CONFIG/deploy-hasingleton</literal>. For that
- just remove
- <literal>$JBOSS_CONFIG/deploy-hasingleton/jms</literal></para>
-
- </listitem>
- <listitem>
-
- <para>Add a security policy called "messaging" on
- $JBOSS_CONFIG/config/login-config.xml. You could use this as an
- example, or create one according to JBoss Security
- Documentation:</para>
-
- <programlisting>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>There are few extra steps at <xref
+ linkend="install.extra-steps" /></para>
+ </listitem>
+
+ <listitem>That's it</listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="install.manual">
+ <title>Manual Installation</title>
+
+ <para><note>
+ This installation procedure should be performed if you are installing into a JBoss AS configuration that you have changed in some way from the default JBoss AS distribution. If you are just using the standard, untouched JBoss AS 4.2 distribution you can use the automated procedure above
+ </note></para>
+
+ <para>For this procedure we assume you already have your custom
+ configuration located at
+ <literal>JBOSS_CONFIG=$JBOSS_HOME/server/<myconfiguration></literal>,
+ and that it contains a JBoss MQ installation.</para>
+
+ <para>You don't actually have to create an environment variable
+ <literal>JBOSS_CONFIG</literal>, this is just used in the installation
+ instructions to describe the steps</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Move
+ <literal>$JBOSS_CONFIG/deploy/jms/hajndi-jms-ds.xml</literal> and
+ <literal>$JBOSS_CONFIG/deploy/jms/jms-ra.rar</literal> to
+ <literal>$JBOSS_CONFIG/deploy</literal></para>
+ </listitem>
+
+ <listitem>
+
+
+ <para>Remove the old JBoss MQ by removing the directory
+ <literal>$JBOSS_CONFIG/deploy/jms.</literal></para>
+
+ .
+
+ <para>Remove the old JBoss MQ jar file:
+ <literal>$JBOSS_CONFIG/lib/jbossmq.jar</literal></para>
+
+
+
+ <para>Make sure you don't have any JBossMQ files under
+ <literal>$JBOSS_CONFIG/deploy-hasingleton</literal>. For that just
+ remove
+ <literal>$JBOSS_CONFIG/deploy-hasingleton/jms</literal></para>
+
+
+ </listitem>
+
+ <listitem>
+
+
+ <para>Add a security policy called "messaging" on
+ $JBOSS_CONFIG/config/login-config.xml. You could use this as an
+ example, or create one according to JBoss Security
+ Documentation:</para>
+
+
+
+ <programlisting>
<application-policy name = "messaging">
<authentication>
<login-module code = "org.jboss.security.auth.spi.UsersRolesLoginModule" flag = "required" >
@@ -277,30 +333,38 @@
</authentication>
</application-policy>
</programlisting>
-
- <para>In case you are using the above policy you should also
- create files <literal>messaging-users.properties</literal> and
- <literal>messaging-roles.properties</literal> in the
- <literal>$JBOSS_CONFIG/config/props/</literal> directory</para>
- .
- <para>
- <note>You can find an example
- <literal>messaging-users.properties</literal> and
- <literal>messaging-roles.properties</literal> in the JBoss
- Messaging distribution in the
- <literal><downloadPackage>src/etc/server/default/config</literal>
- directory.</note>
- </para>
-
- <programlisting>
+
+
+
+ <para>In case you are using the above policy you should also create
+ files <literal>messaging-users.properties</literal> and
+ <literal>messaging-roles.properties</literal> in the
+ <literal>$JBOSS_CONFIG/config/props/</literal> directory</para>
+
+ .
+
+ <para>
+ <note>You can find an example
+ <literal>messaging-users.properties</literal> and
+ <literal>messaging-roles.properties</literal> in the JBoss
+ Messaging distribution in the
+ <literal><downloadPackage>src/etc/server/default/config</literal>
+ directory.</note>
+ </para>
+
+
+
+ <programlisting>
# messaging-roles.properties
# Add roles as you like
# user=role1,role2,...
#
guest=guest
</programlisting>
-
- <programlisting>
+
+
+
+ <programlisting>
# messaging-users.properties
# Add users as you like
@@ -308,93 +372,115 @@
#
guest=guest
</programlisting>
-
+
+
+ </listitem>
+
+ <listitem>
+ <para>Unzip jboss-messaging.sar from your download package into the
+ directory
+ <literal>JBOSS_CONFIG/deploy/jboss-messaging.sar</literal></para>
+
+ <para>JBoss Messaging should be deployed unzipped (exploded) so you
+ have easy access to its config files which are stored there.</para>
+ </listitem>
+
+ <listitem>
+ <para>Copy jboss-messaging.jar from your download package into the
+ directory <literal>JBOSS_CONFIG/lib</literal></para>
+
+ <para>jboss-messaging.jar needs to go in the lib directory so it is
+ accessible to other services e.g. the JBoss Transactions Recovery
+ Manager</para>
+ </listitem>
+
+ <listitem>
+ <para><warning>
+ For a clustered installation it is mandatory that a shared database is available to all nodes in the cluster. The default JBoss AS uses HSQLDB for its database which is a local shared database. Therefore in order to use clustering you must replace this with a different shared database. If the database is not replaced then clustering will not work.
+ </warning></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Replace
+ <literal>$JBOSS_CONFIG/deploy/jboss-messaging.sar/hsqldb-persistence-service.xml</literal>
+ by the <literal>databasename>-persistence-service</literal>
+ from
+ <literal><downloadPackage>/examples/config.</literal>. For
+ instance <literal>mysql-persistence-service.xml</literal></para>
</listitem>
+
<listitem>
- <para>Unzip jboss-messaging.sar from your download package into
- the directory
- <literal>JBOSS_CONFIG/deploy/jboss-messaging.sar</literal></para>
- <para>JBoss Messaging should be deployed unzipped (exploded) so
- you have easy access to its config files which are stored
- there.</para>
+
+
+ <para>Configure a JCA datasource using an example from
+ <literal>$JBOSS_HOME/docs/examples/jca</literal></para>
+
+ and copying to
+
+ <literal>$JBOSS_CONFIG/deploy</literal>
+
+
+
+ <para>JBoss Messaging uses <literal>DefaultDS</literal> by
+ default so you should configure your datasource to bind to
+ that</para>
+
+
</listitem>
+
<listitem>
- <para>Copy jboss-messaging.jar from your download package into
- the directory <literal>JBOSS_CONFIG/lib</literal></para>
- <para>jboss-messaging.jar needs to go in the lib directory so
- it is accessible to other services e.g. the JBoss Transactions
- Recovery Manager</para>
+ <para>Remove hsqldb-ds.xml from
+ <literal>$JBOSS_CONFIG/deploy</literal></para>
</listitem>
+
<listitem>
- <para><warning>
- For a clustered installation it is mandatory that a shared database is available to all nodes in the cluster. The default JBoss AS uses HSQLDB for its database which is a local shared database. Therefore in order to use clustering you must replace this with a different shared database. If the database is not replaced then clustering will not work.
- </warning></para>
- <itemizedlist>
- <listitem>
- <para>Replace
- <literal>$JBOSS_CONFIG/deploy/jboss-messaging.sar/hsqldb-persistence-service.xml</literal>
- by the
- <literal>databasename>-persistence-service</literal>
- from
- <literal><downloadPackage>/examples/config.</literal>.
- For instance
- <literal>mysql-persistence-service.xml</literal></para>
- </listitem>
- <listitem>
-
- <para>Configure a JCA datasource using an example from
- <literal>$JBOSS_HOME/docs/examples/jca</literal></para>
- and copying to
- <literal>$JBOSS_CONFIG/deploy</literal>
-
- <para>JBoss Messaging uses <literal>DefaultDS</literal>
- by default so you should configure your datasource to
- bind to that</para>
-
- </listitem>
- <listitem>
- <para>Remove hsqldb-ds.xml from
- <literal>$JBOSS_CONFIG/deploy</literal></para>
- </listitem>
- <listitem>
- <para>Copy your database driver to
- <literal>$JBOSS_CONFIG/lib</literal></para>
- <para>Your database driver can probably be downloaded
- from your database provider's web site</para>
- </listitem>
- </itemizedlist>
+ <para>Copy your database driver to
+ <literal>$JBOSS_CONFIG/lib</literal></para>
+
+ <para>Your database driver can probably be downloaded from your
+ database provider's web site</para>
</listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>Ensure the <literal>ServerPeerID</literal> MBean attribute
+ value in messaging-service.xml is unique for each node on the
+ cluster. The <literal>ServerPeerID</literal> value must be a valid
+ integer.</para>
+
+ <para><warning>
+ Each node must have a unique
+
+ <literal>ServerPeerID</literal>
+
+ irrespective of whether you are using clustering.
+ </warning></para>
+ </listitem>
+
+ <listitem>
+ <para>If you want to run multiple JBoss Messaging nodes on the same
+ box using the same IP address, e.g. for development purposes, then
+ you can use the ServiceBindingManager to do this as follows:</para>
+
+ <itemizedlist>
<listitem>
- <para>Ensure the <literal>ServerPeerID</literal> MBean
- attribute value in messaging-service.xml is unique for each
- node on the cluster. The <literal>ServerPeerID</literal> value
- must be a valid integer.</para>
- <para><warning>
- Each node must have a unique
- <literal>ServerPeerID</literal>
- irrespective of whether you are using clustering.
- </warning></para>
+ <para>Uncomment binding manager service from
+ $JBOSS_CONFIG/conf/jboss-service.xml</para>
</listitem>
+
<listitem>
- <para>If you want to run multiple JBoss Messaging nodes on the
- same box using the same IP address, e.g. for development
- purposes, then you can use the ServiceBindingManager to do this
- as follows:</para>
- <itemizedlist>
- <listitem>
- <para>Uncomment binding manager service from
- $JBOSS_CONFIG/conf/jboss-service.xml</para>
- </listitem>
- <listitem>
- <para>Specify the desired port rage (e.g. ports-01,
- ports-02... etc)</para>
- </listitem>
- <listitem>
- <para>Look at
- $JBOSS_HOME/docs/examples/binding-manager/sample-bindings.xml.
- On each port range, JBoss Remoting configuration should
- look like:</para>
- <programlisting>
+ <para>Specify the desired port rage (e.g. ports-01, ports-02...
+ etc)</para>
+ </listitem>
+
+ <listitem>
+ <para>Look at
+ $JBOSS_HOME/docs/examples/binding-manager/sample-bindings.xml.
+ On each port range, JBoss Remoting configuration should look
+ like:</para>
+
+ <programlisting>
<service-config name="jboss.messaging:service=Connector,transport=bisocket"
delegateClass="org.jboss.services.binding.AttributeMappingDelegate">
<delegate-config>
@@ -445,92 +531,119 @@
</service-config>
</programlisting>
- <warning>
- You must ensure that the config (like above) is identical to that in
- <literal>remoting-bisocket-service.xml</literal>
- With the exception of the actual serverBindPort which clearly must be different for each ports range. Please note that the default JBoss Messaging service binding manager bindings in
- <literal>sample-bindings.xml</literal>
- shipped with JBAS 4.2.0 may be out of date and you will need to copy the config from
- <literal>remoting-bisocket-service.xml. DO NOT just
- copy and paste from the above example - copy it from
- the JBoss Messaging distribution.</literal>
-
- <literal />
-
- <literal />
-
- <literal />
-
- </warning>
- <para>You should ensure that each node is configured to
- use a different ports range.</para>
- </listitem>
- </itemizedlist>
+
+ <warning>
+ You must ensure that the config (like above) is identical to that in
+
+ <literal>remoting-bisocket-service.xml</literal>
+
+ With the exception of the actual serverBindPort which clearly must be different for each ports range. Please note that the default JBoss Messaging service binding manager bindings in
+
+ <literal>sample-bindings.xml</literal>
+
+ shipped with JBAS 4.2.0 may be out of date and you will need to copy the config from
+
+ <literal>remoting-bisocket-service.xml. DO NOT just copy and
+ paste from the above example - copy it from the JBoss
+ Messaging distribution.</literal>
+
+
+
+ <literal />
+
+
+
+ <literal />
+
+
+
+ <literal />
+
+
+ </warning>
+
+ <para>You should ensure that each node is configured to use a
+ different ports range.</para>
</listitem>
- <listitem>
- <para>There are few extra steps at <xref
- linkend="install.extra-steps" /></para>
- </listitem>
- <listitem>
- That's it
- </listitem>
- </itemizedlist>
- </section>
- <section id="install.extra-steps">
- <title>Extra steps to complete your installation</title>
- <itemizedlist>
- <listitem>
- <para>
- <warning>SECURITY RISK! To avoid a security risk, you MUST
- specify the value of the attribute SuckerPassword in the
- Server Peer config (messaging-service.xml). If you do not
- specify a value, the default value will be used. Any person
- that knows the default value will be able to access to all
- destinations on the server. The password chosen should only
- be exposed to administrators</warning>
- </para>
- </listitem>
- <listitem>
- <para>
- <note>JBoss Messaging 1.4.0 requires a patched version of
- jboss-remoting.jar. This version is available on JBoss EAP 4.3, so if you're using a different version of JBoss you should download the patched version which can be found <ulink
- url="http://repository.jboss.com/jboss/remoting/2.2.2.SP4-brew/ ">here</ulink>The
- version is JBoss Remoting 2.2.2.SP4-brew. Please download it
- and copy it into the <literal>$JBOSS_HOME/server/<your
- server name>/lib directory</literal> of any server
- profiles that use JBoss Messaging 1.4.0. If you are using
- JBoss Messaging from a standalone client also make sure this
- jar is on your classpath *before*
- jbossall-client.jar.</note>
- </para>
- </listitem>
- <para>You should also make these changes on any configuration you
- choose, to remove all references to the old JBossMQ:</para>
- <listitem>
- <para>Edit <literal>$JBOSS_CONFIG/deploy/jms-ds.xml</literal>
- and replace jboss.mq by jboss.messaging on every
- occurrence</para>
- <para>If you are in a clustered installation, then do the above
- with the file
- <literal>$JBOSS_CONFIG/deploy/hajndi-jms-ds.xml</literal></para>
- </listitem>
- <listitem>
- <para>Edit
- <literal>$JBOSS_CONFIG/conf/standardjboss.xml</literal> and set
- <literal>CreateJBossMQDestination</literal> to false on every
- occurrence</para>
- <para>Make sure it looks like this:</para>
- <para>
- <literal><CreateJBossMQDestination>false</CreateJBossMQDestination></literal>
- </para>
- <para>Those Proxies will try to create a Destination on JBossMQ
- if they can't find it on JNDI, what would cause some errors
- related to JBoss MQ.</para>
- </listitem>
- <listitem>
- <para>Edit $JBOSS_CONFIG/conf/jboss-service.xml and remove the
- reference to JBoss MQ on JSR-77 Management Bean:</para>
- <programlisting>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para>There are few extra steps at <xref
+ linkend="install.extra-steps" /></para>
+ </listitem>
+
+ <listitem>
+ That's it
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="install.extra-steps">
+ <title>Extra steps to complete your installation</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <warning>SECURITY RISK! To avoid a security risk, you MUST specify
+ the value of the attribute SuckerPassword in the Server Peer
+ config (messaging-service.xml). If you do not specify a value, the
+ default value will be used. Any person that knows the default
+ value will be able to access to all destinations on the server.
+ The password chosen should only be exposed to
+ administrators</warning>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <note>JBoss Messaging 1.4.0 and 1.4.1 requires a patched version
+ of jboss-remoting.jar. This version is available on JBoss EAP 4.3
+ and JBoss 5, so if you're using a different version of JBoss you
+ should download the patched version which can be found <ulink
+ url="http://repository.jboss.com/jboss/remoting/2.2.2.SP4-brew/ ">here</ulink>The
+ version is JBoss Remoting 2.2.2.SP4-brew. Please download it and
+ copy it into the <literal>$JBOSS_HOME/server/<your server
+ name>/lib directory</literal> of any server profiles that use
+ JBoss Messaging 1.4.0 or 1.4.1. If you are using JBoss Messaging
+ from a standalone client also make sure this jar is on your
+ classpath *before* jbossall-client.jar.</note>
+ </para>
+ </listitem>
+
+ <para>You should also make these changes on any configuration you
+ choose, to remove all references to the old JBossMQ:</para>
+
+ <listitem>
+ <para>Edit <literal>$JBOSS_CONFIG/deploy/jms-ds.xml</literal> and
+ replace jboss.mq by jboss.messaging on every occurrence</para>
+
+ <para>If you are in a clustered installation, then do the above with
+ the file
+ <literal>$JBOSS_CONFIG/deploy/hajndi-jms-ds.xml</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>Edit <literal>$JBOSS_CONFIG/conf/standardjboss.xml</literal>
+ and set <literal>CreateJBossMQDestination</literal> to false on
+ every occurrence</para>
+
+ <para>Make sure it looks like this:</para>
+
+ <para>
+ <literal><CreateJBossMQDestination>false</CreateJBossMQDestination></literal>
+ </para>
+
+ <para>Those Proxies will try to create a Destination on JBossMQ if
+ they can't find it on JNDI, what would cause some errors related to
+ JBoss MQ.</para>
+ </listitem>
+
+ <listitem>
+ <para>Edit $JBOSS_CONFIG/conf/jboss-service.xml and remove the
+ reference to JBoss MQ on JSR-77 Management Bean:</para>
+
+ <programlisting>
<!-- ==================================================================== -->
<!-- JSR-77 Single JBoss Server Management Domain -->
<!-- ==================================================================== -->
@@ -539,12 +652,13 @@
... Remove this line ...
<attribute name="JMSService">jboss.mq:service=DestinationManager</attribute>
</programlisting>
- </listitem>
- <listitem>
- <para>Change
- <literal>$JBOSS_CONFIG/conf/login-config.xml</literal> and
- remove jboss-mq security policies</para>
- <programlisting>
+ </listitem>
+
+ <listitem>
+ <para>Change <literal>$JBOSS_CONFIG/conf/login-config.xml</literal>
+ and remove jboss-mq security policies</para>
+
+ <programlisting>
### Remove these lines:
<!-- Security domain for JBossMQ -->
@@ -575,25 +689,31 @@
-->
</programlisting>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- <section id="startingtheservice">
- <title>Starting the Server</title>
- <para>To run the server, execute the <filename>run.bat</filename> or
- <filename>run.sh</filename> script as appropriate for your operating
- system, in the <filename>$JBOSS_HOME/bin</filename> directory.</para>
- <programlisting>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+
+ <section id="startingtheservice">
+ <title>Starting the Server</title>
+
+ <para>To run the server, execute the <filename>run.bat</filename> or
+ <filename>run.sh</filename> script as appropriate for your operating
+ system, in the <filename>$JBOSS_HOME/bin</filename> directory.</para>
+
+ <programlisting>
cd $JBOSS_HOME/bin
./run.sh -c <config name>
</programlisting>
- <para>Where config_name is the name of the JBoss AS configuration where
- you have installed messaging. (The default is 'messaging')</para>
- <para>A successful JBoss Messaging deployment generates logging output
- similar to for a non clustered installation (for a clustered
- installation you will also see extra cluster related output)</para>
- <programlisting>
+
+ <para>Where config_name is the name of the JBoss AS configuration where
+ you have installed messaging. (The default is 'messaging')</para>
+
+ <para>A successful JBoss Messaging deployment generates logging output
+ similar to for a non clustered installation (for a clustered installation
+ you will also see extra cluster related output)</para>
+
+ <programlisting>
....
13:19:14,914 WARN [JDBCPersistenceManager]
@@ -668,48 +788,65 @@
e=200705111440)] Started in 19s:359ms
</programlisting>
- <note>
- The warning message
- <literal>"DataSource connection transaction isolation should be
- READ_COMMITTED, but it is currently NONE"</literal>
- is there to remind you that by default JBossAS ships with Hypersonic, an in-memory Java-based database engine, which is apropriate for demo purposes, but not for heavy load production environments. The
- <ulink
- url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigJBossMQDB">Critique
- of Hypersonic</ulink>
- wiki page outlines some of the well-known issues occuring when using this database.
- </note>
- <warning>
- Before using Messaging in production, you
- <emphasis>must</emphasis>
- configure the Messaging instance to use an enterprise-class database backend such as Oracle, Sybase, PostgreSQL, MS SQL or MySQL, otherwise you risk losing your data. See
- <xref linkend="conf.changingds" />
- for details about replacing Hypersonic.
- </warning>
- </section>
- <section id="inst.validation">
- <title>Installation Validation</title>
- <para>The release bundle contains a series of examples that should run
- "out of the box" and could be used to validate a new installation. Such
- an example sends a persistent JMS message to a queue called
- <literal>queue/testQueue</literal>.</para>
- <para>To run the example and validate the installation, open an new
- command line window and set the <literal>JBOSS_HOME</literal>
- environment variable to point to the JBoss AS 4.x installation you've
- just installed Messaging on. Navigate to the folder where you extracted
- the release bundle and drill down to
- <filename>/examples/queue</filename>. Apache Ant must pe present in your
- path in order to be able to run the example.</para>
- <para>Make sure you start the JBoss server before trying to run the
- tests</para>
- <programlisting>
+ <note>
+ The warning message
+
+ <literal>"DataSource connection transaction isolation should be
+ READ_COMMITTED, but it is currently NONE"</literal>
+
+ is there to remind you that by default JBossAS ships with Hypersonic, an in-memory Java-based database engine, which is apropriate for demo purposes, but not for heavy load production environments. The
+
+ <ulink
+ url="http://wiki.jboss.org/wiki/Wiki.jsp?page=ConfigJBossMQDB">Critique
+ of Hypersonic</ulink>
+
+ wiki page outlines some of the well-known issues occuring when using this database.
+ </note>
+
+ <warning>
+ Before using Messaging in production, you
+
+ <emphasis>must</emphasis>
+
+ configure the Messaging instance to use an enterprise-class database backend such as Oracle, Sybase, PostgreSQL, MS SQL or MySQL, otherwise you risk losing your data. See
+
+ <xref linkend="conf.changingds" />
+
+ for details about replacing Hypersonic.
+ </warning>
+ </section>
+
+ <section id="inst.validation">
+ <title>Installation Validation</title>
+
+ <para>The release bundle contains a series of examples that should run
+ "out of the box" and could be used to validate a new installation. Such an
+ example sends a persistent JMS message to a queue called
+ <literal>queue/testQueue</literal>.</para>
+
+ <para>To run the example and validate the installation, open an new
+ command line window and set the <literal>JBOSS_HOME</literal> environment
+ variable to point to the JBoss AS 4.x installation you've just installed
+ Messaging on. Navigate to the folder where you extracted the release
+ bundle and drill down to <filename>/examples/queue</filename>. Apache Ant
+ must pe present in your path in order to be able to run the
+ example.</para>
+
+ <para>Make sure you start the JBoss server before trying to run the
+ tests</para>
+
+ <programlisting>
+
setenv JBOSS_HOME=<your_JBoss_installation>
cd .../examples/queue
$ant
</programlisting>
- <para>A successfull execution log output looks similar to:</para>
- <programlisting>
+
+ <para>A successfull execution log output looks similar to:</para>
+
+ <programlisting>
[tim at Vigor14 queue]$ ant
Buildfile: build.xml
@@ -749,58 +886,77 @@
[tim at Vigor14 queue]$
</programlisting>
- <para>It is recommended to run <literal>all</literal> validation
- examples available in the <filename>example</filename> directory
- (<filename>queue</filename>, <filename>topic</filename>,
- <filename>mdb</filename>, <filename>stateless</filename>, etc.). In
- <xref linkend="examples" />, we will have a look at each of those
- examples.</para>
- </section>
- <section id="inst.remoteclient">
- <title>Accessing JBoss Messaging from a remote client</title>
- <para>In order to access JBoss Messaging from a client outside the JBoss
- app server, you will need to ensure the following jar files are on the
- client classpath:</para>
- <itemizedlist>
- <listitem>
- <para><note>
- JBoss Messaging 1.4.0 requires a patched version of jboss-remoting.jar. The version is JBoss Remoting 2.2.2.SP4-brew. This version is available on JBoss EAP 4.3, so if you're using a different version you should download it. The patched jar can be found
- <ulink
- url="http://repository.jboss.com/jboss/remoting/2.2.2.SP4-brew/lib/">here</ulink>
- . Please download it and make sure this jar is on your classpath *before* jbossall-client.jar.
- </note></para>
- </listitem>
- <listitem>
- <para>jboss-messaging-client.jar - This is available in the
- messaging distribution</para>
- </listitem>
- <listitem>
- <para>jbossall-client.jar - This is available in your
- $JBOSS_HOME/client directory</para>
- </listitem>
- <listitem>
- <para>$JBOSS_HOME/server/<SERVER_NAME>/deploy/jboss-aop.deployer/jboss-aop.jar</para>
- <para>JBoss AOP 1.5.5.GA+</para>
- <para><ulink
- url="http://repository.jboss.com/jboss/aop/1.5.5.GA/lib/">http://repository.jboss.com/jboss/aop/1.5.5.GA/lib/</ulink></para>
- <para>(For AOP, sometimes you have to use a specific JAR according
- to your JVM of choice. Use the most convenient for you)</para>
- </listitem>
- <listitem>
- <para>$JBOSS_HOME/server/<SERVER_NAME>/lib/javassist.jar</para>
- <para>Javassist 3.5.0.GA-brew+</para>
- <para><ulink
- url="http://repository.jboss.com/javassist/3.5.0.GA-brew/lib/">http://repository.jboss.com/javassist/3.5.0.GA-brew/lib/</ulink></para>
- </listitem>
- <listitem>
- <para>$JBOSS_HOME/server/<SERVER_NAME>/lib/trove.jar</para>
- <para>trove 1.0.2-brew</para>
- <para><ulink
- url="http://repository.jboss.com/trove/1.0.2-brew/lib/">http://repository.jboss.com/trove/1.0.2-brew/lib/</ulink></para>
- </listitem>
- <listitem>
- <para>log4j</para>
- </listitem>
- </itemizedlist>
- </section>
+
+ <para>It is recommended to run <literal>all</literal> validation examples
+ available in the <filename>example</filename> directory
+ (<filename>queue</filename>, <filename>topic</filename>,
+ <filename>mdb</filename>, <filename>stateless</filename>, etc.). In <xref
+ linkend="examples" />, we will have a look at each of those
+ examples.</para>
+ </section>
+
+ <section id="inst.remoteclient">
+ <title>Accessing JBoss Messaging from a remote client</title>
+
+ <para>In order to access JBoss Messaging from a client outside the JBoss
+ app server, you will need to ensure the following jar files are on the
+ client classpath:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><note>
+ JBoss Messaging 1.4.0 requires a patched version of jboss-remoting.jar. The version is JBoss Remoting 2.2.2.SP4-brew. This version is available on JBoss EAP 4.3, so if you're using a different version you should download it. The patched jar can be found
+
+ <ulink
+ url="http://repository.jboss.com/jboss/remoting/2.2.2.SP4-brew/lib/">here</ulink>
+
+ . Please download it and make sure this jar is on your classpath *before* jbossall-client.jar.
+ </note></para>
+ </listitem>
+
+ <listitem>
+ <para>jboss-messaging-client.jar - This is available in the messaging
+ distribution</para>
+ </listitem>
+
+ <listitem>
+ <para>jbossall-client.jar - This is available in your
+ $JBOSS_HOME/client directory</para>
+ </listitem>
+
+ <listitem>
+ <para>$JBOSS_HOME/server/<SERVER_NAME>/deploy/jboss-aop.deployer/jboss-aop.jar</para>
+
+ <para>JBoss AOP 1.5.5.GA+</para>
+
+ <para><ulink
+ url="http://repository.jboss.com/jboss/aop/1.5.5.GA/lib/">http://repository.jboss.com/jboss/aop/1.5.5.GA/lib/</ulink></para>
+
+ <para>(For AOP, sometimes you have to use a specific JAR according to
+ your JVM of choice. Use the most convenient for you)</para>
+ </listitem>
+
+ <listitem>
+ <para>$JBOSS_HOME/server/<SERVER_NAME>/lib/javassist.jar</para>
+
+ <para>Javassist 3.5.0.GA-brew+</para>
+
+ <para><ulink
+ url="http://repository.jboss.com/javassist/3.5.0.GA-brew/lib/">http://repository.jboss.com/javassist/3.5.0.GA-brew/lib/</ulink></para>
+ </listitem>
+
+ <listitem>
+ <para>$JBOSS_HOME/server/<SERVER_NAME>/lib/trove.jar</para>
+
+ <para>trove 1.0.2-brew</para>
+
+ <para><ulink
+ url="http://repository.jboss.com/trove/1.0.2-brew/lib/">http://repository.jboss.com/trove/1.0.2-brew/lib/</ulink></para>
+ </listitem>
+
+ <listitem>
+ <para>log4j</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</chapter>
\ No newline at end of file
Modified: branches/Branch_Stable/docs/userguide/en/modules/introduction.xml
===================================================================
--- branches/Branch_Stable/docs/userguide/en/modules/introduction.xml 2008-01-23 11:52:09 UTC (rev 3620)
+++ branches/Branch_Stable/docs/userguide/en/modules/introduction.xml 2008-01-24 00:43:43 UTC (rev 3621)
@@ -1,226 +1,215 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="introduction">
- <title>Introduction</title>
+ <title>Introduction</title>
- <para>JBoss Messaging provides an open source and standards-based messaging
- platform that brings enterprise-class messaging to the mass market.</para>
+ <para>JBoss Messaging provides an open source and standards-based messaging
+ platform that brings enterprise-class messaging to the mass market.</para>
- <para>JBoss Messaging implements a high performance, robust messaging core
- that is designed to support the largest and most heavily utilized SOAs,
- enterprise service buses (ESBs) and other integration needs ranging from
- the simplest to the highest demand networks.</para>
+ <para>JBoss Messaging implements a high performance, robust messaging core
+ that is designed to support the largest and most heavily utilized SOAs,
+ enterprise service buses (ESBs) and other integration needs ranging from the
+ simplest to the highest demand networks.</para>
- <para>It will allow you to smoothly distribute your application load across
- your cluster, intelligently balancing and utilizing each nodes CPU cycles,
- with no single point of failure, providing a highly scalable and performant
- clustering implementation.</para>
+ <para>It will allow you to smoothly distribute your application load across
+ your cluster, intelligently balancing and utilizing each nodes CPU cycles,
+ with no single point of failure, providing a highly scalable and performant
+ clustering implementation.</para>
- <para>JBoss Messaging includes a JMS front-end to deliver messaging in a
- standards-based format as well as being designed to be able to support
- other messaging protocols in the future.</para>
+ <para>JBoss Messaging includes a JMS front-end to deliver messaging in a
+ standards-based format as well as being designed to be able to support other
+ messaging protocols in the future.</para>
- <para>JBoss Messaging is destined to become an integral part of the JBoss
- Enterprise Application Platform, and the new Service Integration
- Platform.</para>
+ <para>JBoss Messaging is destined to become an integral part of the JBoss
+ Enterprise Application Platform, and the new Service Integration
+ Platform.</para>
- <para>Currently it is available for embedded use within the JBoss
- Application Server 4.2.0.GA or later (JBossAS). Work to integrate JBoss
- Messaging with the new JBoss Microcontainer is under way.</para>
+ <para>Currently it is available for embedded use within the JBoss
+ Application Server 4.2.0.GA or later (JBossAS). Work to integrate JBoss
+ Messaging with the new JBoss Microcontainer is under way.</para>
- <para>JBoss Messaging is also an integral part of Red Hat's strategy for
- messaging. JBoss Messaging is committed to AMQP ( <ulink
- url="http://www.amqp.org">AMQP</ulink>)- the new messaging standard from
- Red Hat and others. Later versions of JBoss Messaging will support AMQP,
- and JBoss Messaging will be focussed on becoming the premier AMQP Java
- broker.</para>
+ <para>JBoss Messaging is also an integral part of Red Hat's strategy for
+ messaging. JBoss Messaging is committed to AMQP ( <ulink
+ url="http://www.amqp.org">AMQP</ulink>)- the new messaging standard from Red
+ Hat and others. Later versions of JBoss Messaging will support AMQP, and
+ JBoss Messaging will be focussed on becoming the premier AMQP Java
+ broker.</para>
- <section id="support">
- <title>JBoss Messaging support cover from Red Hat</title>
+ <section id="support">
+ <title>JBoss Messaging support cover from Red Hat</title>
- <para>JBoss Messaging is destined to become part of both Application
- Server Platform and Service Integration Platform as default JMS
- provider.Production support will then be fully available for these
- plaforms and it will cover JBoss Messaging.</para>
+ <para>JBoss Messaging is part of JBoss Application Server Integration
+ Platform (JBoss EAP 4.3) and it is already the default JMS provider on
+ JBoss AS 5 (under Beta release at this current time).Production support is
+ already available through JBoss EAP 4.3, and we offer developer support
+ for JBoss 4.2.x.</para>
+ </section>
- <para>There is a currently an early adopters program where production
- support is given for JBoss Messaging. Applications are considered on a
- case-by-case basis.</para>
+ <section id="features">
+ <title>JBoss Messaging Features</title>
- <para>Currently developer support is generally available for JBoss
- Messaging when installed in JBoss 4.2.x</para>
- </section>
+ <para>JBoss Messaging provides:</para>
- <section id="features">
- <title>JBoss Messaging Features</title>
+ <itemizedlist>
+ <listitem>
+ <para>A fully compatible and Sun certified JMS 1.1 implementation,
+ that currently works with a standard 4.2 or later JBoss Application
+ Server installation.</para>
+ </listitem>
- <para>JBoss Messaging provides:</para>
+ <listitem>
+ <para>A strong focus on performance, reliability and scalability with
+ high throughput and low latency.</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>A fully compatible and Sun certified JMS 1.1 implementation,
- that currently works with a standard 4.2 or later JBoss
- Application Server installation.</para>
- </listitem>
+ <listitem>
+ <para>A foundation for JBoss ESB for SOA initiatives; JBoss ESB uses
+ JBoss Messaging as its default JMS provider.</para>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>A strong focus on performance, reliability and scalability
- with high throughput and low latency.</para>
- </listitem>
+ <para>Other JBoss Messaging features include:</para>
- <listitem>
- <para>A foundation for JBoss ESB for SOA initiatives; JBoss ESB
- uses JBoss Messaging as its default JMS provider.</para>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Publish-subscribe and point-to-point messaging models</para>
+ </listitem>
- <para>Other JBoss Messaging features include:</para>
+ <listitem>
+ <para>Persistent and non-persistent messages</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Publish-subscribe and point-to-point messaging models</para>
- </listitem>
+ <listitem>
+ <para>Guaranteed message delivery that ensures that messages arrive
+ once and only once where required</para>
+ </listitem>
- <listitem>
- <para>Persistent and non-persistent messages</para>
- </listitem>
+ <listitem>
+ <para>Transactional and reliable - supporting ACID semantics</para>
+ </listitem>
- <listitem>
- <para>Guaranteed message delivery that ensures that messages
- arrive once and only once where required</para>
- </listitem>
+ <listitem>
+ <para>Customizable security framework based on JAAS</para>
+ </listitem>
- <listitem>
- <para>Transactional and reliable - supporting ACID
- semantics</para>
- </listitem>
+ <listitem>
+ <para>Fully integrated with JBoss Transactions (formerly known as
+ Arjuna JTA) for full transaction recoverability.</para>
+ </listitem>
- <listitem>
- <para>Customizable security framework based on JAAS</para>
- </listitem>
+ <listitem>
+ <para>Extensive JMX management interface</para>
+ </listitem>
- <listitem>
- <para>Fully integrated with JBoss Transactions (formerly known as
- Arjuna JTA) for full transaction recoverability.</para>
- </listitem>
+ <listitem>
+ <para>Support for most major databases including Oracle, Sybase, MS
+ SQL Server, PostgreSQL and MySQL</para>
+ </listitem>
- <listitem>
- <para>Extensive JMX management interface</para>
- </listitem>
+ <listitem>
+ <para>HTTP transport to allow use through firewalls that only allow
+ HTTP traffic</para>
+ </listitem>
- <listitem>
- <para>Support for most major databases including Oracle, Sybase,
- MS SQL Server, PostgreSQL and MySQL</para>
- </listitem>
+ <listitem>
+ <para>SSL transport</para>
+ </listitem>
- <listitem>
- <para>HTTP transport to allow use through firewalls that only
- allow HTTP traffic</para>
- </listitem>
+ <listitem>
+ <para>Configurable DLQs (Dead Letter Queues) and Expiry Queues</para>
+ </listitem>
- <listitem>
- <para>SSL transport</para>
- </listitem>
+ <listitem>
+ <para>Message statistics. Gives you a rolling historical view of what
+ messages were delivered to what queues and subscriptions</para>
+ </listitem>
- <listitem>
- <para>Configurable DLQs (Dead Letter Queues) and Expiry
- Queues</para>
- </listitem>
+ <listitem>
+ <para>Automatic paging of messages to storage. Allows the use of very
+ large queues - too large to fit in memory at once</para>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Message statistics. Gives you a rolling historical view of
- what messages were delivered to what queues and
- subscriptions</para>
- </listitem>
+ <para>Clustering features:</para>
- <listitem>
- <para>Automatic paging of messages to storage. Allows the use of
- very large queues - too large to fit in memory at once</para>
- </listitem>
- </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para>Fully clustered queues and topics. "Logical" queues and topics
+ are distributed across the cluster. You can send to a queue or a topic
+ from any node, and receive from any other.</para>
+ </listitem>
- <para>Clustering features:</para>
+ <listitem>
+ <para>Fully clustered durable subscriptions. A particular durable
+ subscription can be accessed from any node of the cluster - allowing
+ you to spread processing load from that subscription across the
+ cluster.</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Fully clustered queues and topics. "Logical" queues and
- topics are distributed across the cluster. You can send to a queue
- or a topic from any node, and receive from any other.</para>
- </listitem>
+ <listitem>
+ <para>Fully clustered temporary queues. Send a message with a replyTo
+ of a temp queue and it can be sent back on any node of the
+ cluster.</para>
+ </listitem>
- <listitem>
- <para>Fully clustered durable subscriptions. A particular durable
- subscription can be accessed from any node of the cluster -
- allowing you to spread processing load from that subscription
- across the cluster.</para>
- </listitem>
+ <listitem>
+ <para>Intelligent message redistribution. Messages are automatically
+ moved between different nodes of the cluster if consumers are faster
+ on one node than another. This can help prevent starvation or build up
+ of messages on particular nodes.</para>
+ </listitem>
- <listitem>
- <para>Fully clustered temporary queues. Send a message with a
- replyTo of a temp queue and it can be sent back on any node of the
- cluster.</para>
- </listitem>
+ <listitem>
+ <para>Message order protection. If you want to ensure that the order
+ of messages produced by a producer is the same as is consumed by a
+ consumer then you can set this to true. This works even in the
+ presence of message redistribution.</para>
+ </listitem>
- <listitem>
- <para>Intelligent message redistribution. Messages are
- automatically moved between different nodes of the cluster if
- consumers are faster on one node than another. This can help
- prevent starvation or build up of messages on particular
- nodes.</para>
- </listitem>
+ <listitem>
+ <para>Fully transparent failover. When a server fails, your sessions
+ continue without exceptions on a new node as if nothing happened.
+ (Fully configurable - If you don't want this you can fall back to
+ exceptions being thrown and manually recreation of connections on
+ another node)</para>
+ </listitem>
- <listitem>
- <para>Message order protection. If you want to ensure that the
- order of messages produced by a producer is the same as is
- consumed by a consumer then you can set this to true. This works
- even in the presence of message redistribution.</para>
- </listitem>
+ <listitem>
+ <para>High availability and seamless fail-over. If the node you are
+ connected to fails, you will automatically fail over to another node
+ and will not lose any persistent messages. You can carry on with your
+ session seamlessly where you left off. Once and only once delivery of
+ persistent messages is respected at all times.</para>
+ </listitem>
- <listitem>
- <para>Fully transparent failover. When a server fails, your
- sessions continue without exceptions on a new node as if nothing
- happened. (Fully configurable - If you don't want this you can
- fall back to exceptions being thrown and manually recreation of
- connections on another node)</para>
- </listitem>
+ <listitem>
+ <para>Message bridge. JBoss Messaging contains a message bridge
+ component which enables you to bridge messages between any two JMS1.1
+ destinations on the same or physical separate locations. (E.g.
+ separated by a WAN). This allows you to connect geographically
+ separate clusters, forming huge globally distributed logical queues
+ and topics.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
- <listitem>
- <para>High availability and seamless fail-over. If the node you
- are connected to fails, you will automatically fail over to
- another node and will not lose any persistent messages. You can
- carry on with your session seamlessly where you left off. Once and
- only once delivery of persistent messages is respected at all
- times.</para>
- </listitem>
+ <section id="compatibility">
+ <title>Compatibility with JBossMQ</title>
- <listitem>
- <para>Message bridge. JBoss Messaging contains a message bridge
- component which enables you to bridge messages between any two
- JMS1.1 destinations on the same or physical separate locations.
- (E.g. separated by a WAN). This allows you to connect
- geographically separate clusters, forming huge globally
- distributed logical queues and topics.</para>
- </listitem>
- </itemizedlist>
- </section>
+ <para>JBoss MQ is the JMS implementation currently shipped within JBoss
+ AS. Since JBoss Messaging is JMS 1.1 and JMS 1.0.2b compatible, the JMS
+ code written against JBossMQ will run with JBoss Messaging without any
+ changes.</para>
- <section id="compatibility">
- <title>Compatibility with JBossMQ</title>
+ <para>JBoss Messaging does not have wire format compatibility with JBoss
+ MQ so it would be necessary to upgrade JBoss MQ clients with JBoss
+ Messaging client jars</para>
- <para>JBoss MQ is the JMS implementation currently shipped within JBoss
- AS. Since JBoss Messaging is JMS 1.1 and JMS 1.0.2b compatible, the JMS
- code written against JBossMQ will run with JBoss Messaging without any
- changes.</para>
+ <para><important>
+ Even if JBoss Messaging deployment descriptors are very similar to JBoss MQ deployment descriptors, they are
- <para>JBoss Messaging does not have wire format compatibility with JBoss
- MQ so it would be necessary to upgrade JBoss MQ clients with JBoss
- Messaging client jars</para>
+ <emphasis>not</emphasis>
- <para><important>
- Even if JBoss Messaging deployment descriptors are very similar to JBoss MQ deployment descriptors, they are
-
- <emphasis>not</emphasis>
-
- identical, so they will require some simple adjustments to get them to work with JBoss Messaging. Also, the database data model is completely different, so don't attempt to use JBoss Messaging with a JBoss MQ data schema and vice-versa.
- </important></para>
- </section>
+ identical, so they will require some simple adjustments to get them to work with JBoss Messaging. Also, the database data model is completely different, so don't attempt to use JBoss Messaging with a JBoss MQ data schema and vice-versa.
+ </important></para>
+ </section>
</chapter>
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list