Author: clebert.suconic(a)jboss.com
Date: 2011-03-29 20:37:06 -0400 (Tue, 29 Mar 2011)
New Revision: 10411
Modified:
trunk/docs/user-manual/en/Book_Info.xml
trunk/docs/user-manual/en/clusters.xml
trunk/docs/user-manual/en/configuration-index.xml
trunk/docs/user-manual/en/ha.xml
trunk/docs/user-manual/en/management.xml
trunk/docs/user-manual/en/queue-attributes.xml
trunk/docs/user-manual/en/using-core.xml
Log:
Removing invalid links
Modified: trunk/docs/user-manual/en/Book_Info.xml
===================================================================
--- trunk/docs/user-manual/en/Book_Info.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/Book_Info.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -20,6 +20,7 @@
<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>
Modified: trunk/docs/user-manual/en/clusters.xml
===================================================================
--- trunk/docs/user-manual/en/clusters.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/clusters.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -14,7 +14,7 @@
-->
<chapter id="clusters">
- <title>HornetQ and EAP Cluster Configuration</title>
+ <title>HornetQ and Application Server Cluster Configuration</title>
<section>
<title>Configuring Failover</title>
<para>
Modified: trunk/docs/user-manual/en/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/configuration-index.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/configuration-index.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -53,14 +53,13 @@
<entry>false</entry>
</row>
<row>
- <entry><link
linkend="ha/mode.shared.configuration">backup</link></entry>
+ <entry>backup</entry>
<entry>Boolean</entry>
<entry>Is this server a backup server</entry>
<entry>false</entry>
</row>
<row>
- <entry><link
linkend="configuring.bindings.journal"
- >bindings-directory</link></entry>
+ <entry><link
linkend="configuring.bindings.journal">bindings-directory</link></entry>
<entry>String</entry>
<entry>the directory to store the persisted bindings
to</entry>
<entry>data/bindings</entry>
@@ -253,7 +252,7 @@
<entry>jms.queue.hornetq.management</entry>
</row>
<row>
- <entry><link
linkend="clusters.clusteruser"
+ <entry><link linkend="clusters"
cluster-user</link></entry>
<entry>String</entry>
<entry>the user used by cluster connections to
communicate between the
@@ -261,7 +260,7 @@
<entry>HORNETQ.CLUSTER.ADMIN.USER</entry>
</row>
<row>
- <entry><link
linkend="clusters.clusteruser"
+ <entry><link linkend="clusters"
cluster-password</link></entry>
<entry>String</entry>
<entry>the password used by cluster connections to
communicate between the
@@ -514,7 +513,7 @@
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.broadcast-groups"
+ <entry><link linkend="clusters"
broadcast-groups</link></entry>
<entry>BroadcastGroup</entry>
<entry>a list of broadcast groups to
create</entry>
@@ -522,7 +521,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.name
(attribute)</link>
+ <link
linkend="clusters">broadcast-group.name (attribute)</link>
</entry>
<entry>String</entry>
<entry>a unique name for the broadcast group -
mandatory</entry>
@@ -530,7 +529,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.local-bind-address</link>
+ <link
linkend="clusters">broadcast-group.local-bind-address</link>
</entry>
<entry>String</entry>
<entry>local bind address that the datagram socket is
bound to</entry>
@@ -538,7 +537,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.local-bind-port</link>
+ <link
linkend="clusters">broadcast-group.local-bind-port</link>
</entry>
<entry>Integer</entry>
<entry>local port to which the datagram socket is bound
to</entry>
@@ -546,7 +545,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.group-address</link>
+ <link
linkend="clusters">broadcast-group.group-address</link>
</entry>
<entry>String</entry>
<entry>multicast address to which the data will be
broadcast - mandatory</entry>
@@ -554,7 +553,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.group-port</link>
+ <link
linkend="clusters">broadcast-group.group-port</link>
</entry>
<entry>Integer</entry>
<entry>UDP port number used for broadcasting -
mandatory</entry>
@@ -562,7 +561,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.broadcast-period</link>
+ <link
linkend="clusters">broadcast-group.broadcast-period</link>
</entry>
<entry>Long</entry>
<entry>period in milliseconds between consecutive
broadcasts</entry>
@@ -570,7 +569,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.connector-ref</link>
+ <link
linkend="clusters">broadcast-group.connector-ref</link>
</entry>
<entry>A pair of connector</entry>
<entry>A pair connector and
@@ -579,7 +578,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.connector-ref.connector-name
(attribute)</link>
+ <link
linkend="clusters">broadcast-group.connector-ref.connector-name
(attribute)</link>
</entry>
<entry>String</entry>
<entry>Name of the live connector -
mandatory</entry>
@@ -587,21 +586,21 @@
</row>
<row>
<entry>
- <link
linkend="clusters.broadcast-groups">broadcast-group.connector-ref.backup-connector-name
(attribute)</link>
+ <link
linkend="clusters">broadcast-group.connector-ref.backup-connector-name
(attribute)</link>
</entry>
<entry>String</entry>
<entry>Name of the backup connector -
optional</entry>
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.discovery-groups"
+ <entry><link linkend="clusters"
discovery-groups</link></entry>
<entry>DiscoveryGroup</entry>
<entry>a list of discovery groups to
create</entry>
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.discovery-groups"
+ <entry><link linkend="clusters"
discovery-group.name (attribute)</link></entry>
<entry>String</entry>
<entry>a unique name for the discovery group -
mandatory</entry>
@@ -609,7 +608,7 @@
</row>
<row>
<entry>
- <link
linkend="clusters.discovery-groups">discovery-group.local-bind-address</link>
+ <link
linkend="clusters">discovery-group.local-bind-address</link>
</entry>
<entry>String</entry>
<entry>the discovery group will be bound only to this
local address</entry>
@@ -617,7 +616,7 @@
</row>
<row>
<entry
id="configuration.discovery-group.group-address">
- <link
linkend="clusters.discovery-groups">discovery-group.group-address</link>
+ <link
linkend="clusters">discovery-group.group-address</link>
</entry>
<entry>String</entry>
<entry>Multicast IP address of the group to listen on -
mandatory</entry>
@@ -625,7 +624,7 @@
</row>
<row>
<entry
id="configuration.discovery-group.group-port">
- <link
linkend="clusters.discovery-groups">discovery-group.group-port</link>
+ <link
linkend="clusters">discovery-group.group-port</link>
</entry>
<entry>Integer</entry>
<entry>UDP port of the multicast group -
mandatory</entry>
@@ -633,7 +632,7 @@
</row>
<row>
<entry
id="configuration.discovery-group.refresh-timeout">
- <link
linkend="clusters.discovery-groups">discovery-group.refresh-timeout</link>
+ <link
linkend="clusters">discovery-group.refresh-timeout</link>
</entry>
<entry>Integer</entry>
<entry>Period the discovery group
@@ -821,28 +820,28 @@
<entry>null</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections</link></entry>
<entry>ClusterConnection</entry>
<entry>a list of cluster connections</entry>
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.name (attribute)</link></entry>
<entry>String</entry>
<entry>unique name for this cluster
connection</entry>
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.address</link></entry>
<entry>String</entry>
<entry>name of address this cluster connection applies
to</entry>
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.forward-when-no-consumers</link></entry>
<entry>Boolean</entry>
<entry>should messages be load balanced if there are no
matching
@@ -850,21 +849,21 @@
<entry>false</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.max-hops</link></entry>
<entry>Integer</entry>
<entry>maximum number of hops cluster topology is
propagated</entry>
<entry>1</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.retry-interval</link></entry>
<entry>Long</entry>
<entry>period (in ms) between successive
retries</entry>
<entry>2000</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.use-duplicate-detection</link></entry>
<entry>Boolean</entry>
<entry>should duplicate detection headers be inserted
in forwarded
@@ -872,14 +871,14 @@
<entry>true</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.discovery-group-ref</link></entry>
<entry>String</entry>
<entry>name of discovery group used by this
bridge</entry>
<entry>null</entry>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.connector-ref.connector-name
(attribute)</link></entry>
<entry>String</entry>
@@ -887,7 +886,7 @@
<entry/>
</row>
<row>
- <entry><link
linkend="clusters.cluster-connections"
+ <entry><link linkend="clusters"
cluster-connections.connector-ref.backup-connector-name
(attribute)</link></entry>
<entry>String</entry>
@@ -991,7 +990,7 @@
<entry>-1</entry>
</row>
<row>
- <entry><link
linkend="clusters.message-redistribution"
+ <entry><link linkend="clusters"
address-settings.redistribution-delay</link></entry>
<entry>Long</entry>
<entry>how long (in ms) to wait after the last consumer
is closed on a
@@ -1068,14 +1067,14 @@
<entry>false</entry>
</row>
<row>
- <entry><link
linkend="clusters.static.servers">connection-factory.connectors</link>
+ <entry><link
linkend="clusters">connection-factory.connectors</link>
</entry>
<entry>String</entry>
<entry>A list of connectors used by the connection
factory</entry>
<entry />
</row>
<row>
- <entry><link
linkend="clusters.static.servers"
+ <entry><link linkend="clusters"
connection-factory.connectors.connector-ref.connector-name
(attribute)</link>
</entry>
<entry>String</entry>
@@ -1083,7 +1082,7 @@
<entry />
</row>
<row>
- <entry><link
linkend="clusters.static.servers"
+ <entry><link linkend="clusters"
connection-factory.connectors.connector-ref.backup-connector-name
(attribute)</link>
</entry>
<entry>String</entry>
@@ -1091,7 +1090,7 @@
<entry />
</row>
<row>
- <entry><link
linkend="clusters-discovery.groups.clientside"
+ <entry><link linkend="clusters"
connection-factory.discovery-group-ref.discovery-group-name
(attribute)</link>
</entry>
<entry>String</entry>
@@ -1100,7 +1099,7 @@
</row>
<row>
<entry
id="configuration.connection-factory.discovery-initial-wait-timeout">
- <link
linkend="clusters-discovery.groups.clientside"
+ <link linkend="clusters"
connection-factory.discovery-initial-wait-timeout</link>
</entry>
<entry>Long</entry>
@@ -1158,7 +1157,7 @@
</row>
<row>
<entry
id="configuration.connection-factory.connection-load-balancing-policy-class-name">
- <link
linkend="clusters.client.loadbalancing">
+ <link linkend="clusters">
connection-factory.connection-load-balancing-policy-class-name</link>
</entry>
<entry>String</entry>
@@ -1218,7 +1217,7 @@
<entry>100 * 1024</entry>
</row>
<row>
- <entry><link
linkend="large-messages.cache.client"
+ <entry><link linkend="clusters"
connection-factory.cache-large-message-client</link></entry>
<entry>Boolean</entry>
<entry>If true clients using this connection factory
will hold the large
Modified: trunk/docs/user-manual/en/ha.xml
===================================================================
--- trunk/docs/user-manual/en/ha.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/ha.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -170,9 +170,9 @@
number of different ways. They can be configured explicitly or probably
the most
common way of doing this is to use <emphasis>server
discovery</emphasis> for the
client to automatically discover the list. For full details on how to
configure
- server discovery, please see <xref
linkend="clusters.server-discovery"/>.
+ server discovery, please see <xref linkend="clusters"/>.
Alternatively, the clients can explicitly connect to a specific server
and download
- the current servers and backups see <xref
linkend="clusters.static.servers"/>.</para>
+ the current servers and backups see <xref
linkend="clusters"/>.</para>
<para>To enable automatic client failover, the client must be
configured to allow
non-zero reconnection attempts (as explained in <xref
linkend="client-reconnection"
/>).</para>
Modified: trunk/docs/user-manual/en/management.xml
===================================================================
--- trunk/docs/user-manual/en/management.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/management.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -304,7 +304,7 @@
core.broadcastgroup.<the broadcast group
name></literal>). Broadcast
groups parameters can
be retrieved using the <literal
BroadcastGroupControl</literal> attributes (see <xref
-
linkend="clusters.broadcast-groups"/>)</para>
+ linkend="clusters"/>)</para>
</listitem>
<listitem>
<para>Discovery groups</para>
@@ -315,7 +315,7 @@
name>"</literal> or the resource name
<literal>core.discovery.<the
discovery group name></literal>). Discovery groups
parameters can be
retrieved using the
<literal>DiscoveryGroupControl</literal> attributes (see
- <xref
linkend="clusters.discovery-groups"/>)</para>
+ <xref linkend="clusters"/>)</para>
</listitem>
<listitem>
<para>Cluster connections</para>
@@ -327,7 +327,7 @@
core.clusterconnection.<the cluster connection
name></literal>).
Cluster connections parameters
can be retrieved using the <literal
ClusterConnectionControl</literal> attributes (see <xref
-
linkend="clusters.cluster-connections"/>)</para>
+ linkend="clusters"/>)</para>
</listitem>
</itemizedlist>
</section>
Modified: trunk/docs/user-manual/en/queue-attributes.xml
===================================================================
--- trunk/docs/user-manual/en/queue-attributes.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/queue-attributes.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -132,7 +132,7 @@
set paging on an address. This is explained <link
linkend="paging">here</link>.</para>
<para><literal>redistribution-delay</literal> defines how long
to wait when the last
consumer is closed on a queue before redistributing any messages. see
<link
-
linkend="clusters.message-redistribution">here</link>.</para>
+ linkend="clusters">here</link>.</para>
<para><literal>send-to-dla-on-no-route</literal>. If a message
is sent to an address, but the server does not route it to any queues,
for example, there might be no queues bound to that address, or none of the
queues have filters that match, then normally that message
would be discarded. However if this parameter is set to true for that address, if
the message is not routed to any queues it will instead
Modified: trunk/docs/user-manual/en/using-core.xml
===================================================================
--- trunk/docs/user-manual/en/using-core.xml 2011-03-29 17:18:19 UTC (rev 10410)
+++ trunk/docs/user-manual/en/using-core.xml 2011-03-30 00:37:06 UTC (rev 10411)
@@ -16,11 +16,6 @@
<!-- 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="using-core">
<title>Using Core</title>
<para>HornetQ core is a completely JMS-agnostic messaging system with its own
non-JMS API. We
@@ -99,10 +94,10 @@
<para>In core, there is no concept of a Topic, Topic is a JMS only
term. Instead, in
core, we just deal with <emphasis>addresses</emphasis>
and
<emphasis>queues</emphasis>.</para>
- <para>For example, a JMS topic would be implemented by a single
address to which many
- queues are bound. Each queue represents a subscription of the topic.
A JMS Queue
- would be implemented as a single address to which one queue is bound
- that
- queue represents the JMS queue.</para>
+ <para>For example, a JMS topic would be implemented by a single
address to which
+ many queues are bound. Each queue represents a subscription of the
topic. A JMS
+ Queue would be implemented as a single address to which one queue is
bound -
+ that queue represents the JMS queue.</para>
</note>
</section>
<section>
@@ -124,17 +119,17 @@
<para>Clients use <literal>ServerLocator</literal>
instances to create <literal
ClientSessionFactory</literal> instances.
<literal>ServerLocator</literal>
instances are used to
locate servers and create connections to them. </para>
- <para>In JMS terms think of a
<literal>ServerLocator</literal> in the same way you would a
- JMS Connection Factory</para>
- <para><literal>ServerLocator</literal> instances are
created using the
- <literal>HornetQClient</literal> factory class.</para>
+ <para>In JMS terms think of a
<literal>ServerLocator</literal> in the same way you would
+ a JMS Connection Factory</para>
+ <para><literal>ServerLocator</literal> instances are
created using the <literal
+ >HornetQClient</literal> factory class.</para>
</section>
<section>
<title>ClientSessionFactory</title>
<para>Clients use <literal>ClientSessionFactory</literal>
instances to create <literal
ClientSession</literal> instances.
<literal>ClientSessionFactory</literal>
instances are
basically the connection to a server</para>
- <para> In JMS terms think of them as JMS Connections</para>
+ <para> In JMS terms think of them as JMS Connections</para>
<para><literal>ClientSessionFactory</literal> instances are
created using the <literal
ServerLocator</literal> class.</para>
</section>
@@ -176,11 +171,11 @@
</section>
<warning>
<para>Please note that ClientSession, ClientProducer and ClientConsumer
instances are
- <emphasis>designed to be re-used</emphasis>.</para>
- <para>It's an anti-pattern to create new ClientSession,
ClientProducer and ClientConsumer instances
- for each message you produce or consume. If you do this, your application
will
- perform very poorly. This is discussed further in the section on
performance tuning
- <xref linkend="perf-tuning"/>.</para>
+ <emphasis>designed to be
re-used</emphasis>.</para>
+ <para>It's an anti-pattern to create new ClientSession,
ClientProducer and
+ ClientConsumer instances for each message you produce or consume. If you
do this,
+ your application will perform very poorly. This is discussed further in
the section
+ on performance tuning <xref
linkend="perf-tuning"/>.</para>
</warning>
</section>
<section>