[jboss-cvs] JBoss Messaging SVN: r6850 - trunk/docs/user-manual/en/modules.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Mon May 18 12:42:14 EDT 2009


Author: ataylor
Date: 2009-05-18 12:42:14 -0400 (Mon, 18 May 2009)
New Revision: 6850

Modified:
   trunk/docs/user-manual/en/modules/configuration-index.xml
Log:
added defaults

Modified: trunk/docs/user-manual/en/modules/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/modules/configuration-index.xml	2009-05-18 16:37:13 UTC (rev 6849)
+++ trunk/docs/user-manual/en/modules/configuration-index.xml	2009-05-18 16:42:14 UTC (rev 6850)
@@ -7,15 +7,17 @@
         <title>jbm-configuration.xml</title>
         <table frame="border">
             <title>Server Configuration</title>
-            <tgroup cols="3">
+            <tgroup cols="4">
                 <colspec colname="c1" colnum="1"/>
                 <colspec colname="c2" colnum="2"/>
                 <colspec colname="c3" colnum="3"/>
+                <colspec colname="newCol4" colnum="4"/>
                 <thead>
                     <row>
                         <entry>Element Name</entry>
                         <entry>Element Type</entry>
                         <entry>Description</entry>
+                        <entry>Default</entry>
                     </row>
                 </thead>
                 <tbody>
@@ -23,18 +25,21 @@
                         <entry>clustered</entry>
                         <entry>Boolean</entry>
                         <entry>True means that the server is clustered</entry>
+                        <entry>false</entry>
                     </row>
                     <row>
                         <entry>enable-file-deployment</entry>
                         <entry>Boolean</entry>
                         <entry>True means that the server will load configuration from the
                             configuration files</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="enable.persistence">enable-persistence</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that the server will use the file based journal for
                             persistence.</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="server.scheduled.thread.pool"
@@ -42,28 +47,34 @@
                         <entry>Integer</entry>
                         <entry>The number of threads that the main scheduled thread pool
                             has.</entry>
+                        <entry>5</entry>
                     </row>
                     <row>
                         <entry><link linkend="server.scheduled.thread.pool"
                                 >thread-pool-max-size</link></entry>
                         <entry>Integer</entry>
-                        <entry>The number of threads that the main thread pool has</entry>
+                        <entry>The number of threads that the main thread pool has. -1 means no
+                            limit</entry>
+                        <entry>-1</entry>
                     </row>
                     <row>
                         <entry>security-enabled</entry>
                         <entry>Boolean</entry>
                         <entry>True means that security is enabled</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry>security-invalidation-interval</entry>
                         <entry>Long</entry>
                         <entry>How long, in milli seconds, to wait before invalidating the security
                             cache</entry>
+                        <entry>10000</entry>
                     </row>
                     <row>
                         <entry>wild-card-routing-enabled</entry>
                         <entry>Boolean</entry>
                         <entry>True means that the server supports wild card routing</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="management.core.configuration"
@@ -71,6 +82,7 @@
                         <entry>String</entry>
                         <entry>The name of the management address to send management messages
                             too.</entry>
+                        <entry>jbm.management</entry>
                     </row>
                     <row>
                         <entry><link linkend="management.notifications.core.configuration"
@@ -78,6 +90,7 @@
                         <entry>String</entry>
                         <entry>The name of the address that consumers bind to to receive management
                             notifications</entry>
+                        <entry>jbm.notifications</entry>
                     </row>
                     <row>
                         <entry><link linkend="management.replication"
@@ -85,6 +98,7 @@
                         <entry>String</entry>
                         <entry>The password used to for replicating management operations between
                             clustered nodes</entry>
+                        <entry>CHANGE ME!!</entry>
                     </row>
                     <row>
                         <entry><link linkend="management.replication"
@@ -92,30 +106,35 @@
                         <entry>Long</entry>
                         <entry>How long, in milli seconds, to wait for a reply to a management
                             request</entry>
+                        <entry>5000</entry>
                     </row>
                     <row>
                         <entry><link linkend="management.jmx.configuration"
                                 >jmx-management-enabled</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that the management API is available via JMX</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.counters"
                                 >message-counter-enabled</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that message counters are enabled</entry>
+                        <entry>false</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.counters"
                                 >message-counter-sample-period</link></entry>
                         <entry>Long</entry>
                         <entry>The sample period to use for message counters</entry>
+                        <entry>10000</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.counters"
                                 >message-counter-max-day-history</link></entry>
                         <entry>Integer</entry>
                         <entry>How many days to keep message counter history</entry>
+                        <entry>10</entry>
                     </row>
                     <row>
                         <entry><link linkend="dead.connections"
@@ -123,6 +142,7 @@
                         <entry>Long</entry>
                         <entry>How often, in milli seconds, to scan for failed connections on the
                             server </entry>
+                        <entry>1000</entry>
                     </row>
                     <row>
                         <entry><link linkend="dead.connections"
@@ -130,39 +150,46 @@
                         <entry>Long</entry>
                         <entry>If set, this will override how long to keep a connection alive
                             without receiving a ping. </entry>
+                        <entry>-1</entry>
                     </row>
                     <row>
                         <entry>transaction-timeout</entry>
                         <entry>Long</entry>
                         <entry>How long before a transaction can be removed from the resource
                             manager after create time</entry>
+                        <entry>60000</entry>
                     </row>
                     <row>
                         <entry>transaction-timeout-scan-period</entry>
                         <entry>Long</entry>
                         <entry>How often, in milli seconds, to scan for timeout transactions</entry>
+                        <entry>1000</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.expiry.reaper"
                                 >message-expiry-scan-period</link></entry>
                         <entry>Long</entry>
                         <entry>How often, in milli seconds, to scan for expired messages</entry>
+                        <entry>30000</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.expiry.reaper"
                                 >message-expiry-thread-priority</link></entry>
                         <entry>Integer</entry>
                         <entry>The priority of the thread expiring messages</entry>
+                        <entry>3</entry>
                     </row>
                     <row>
                         <entry><link linkend="duplicate.id.cache">id-cache-size</link></entry>
                         <entry>Integer</entry>
                         <entry>The size of the cache for pre creating message id's</entry>
+                        <entry>2000</entry>
                     </row>
                     <row>
                         <entry><link linkend="duplicate.id.cache">persist-id-cache</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that id's are persisted to the journal</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="queue.activation.timeout"
@@ -170,12 +197,14 @@
                         <entry>Long</entry>
                         <entry>After failout occurs, this time specifies how long to wait for
                             consumers to re attach before commencing delivery</entry>
+                        <entry>30000</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.live.backup">backup</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that this server is a back up to another node in the a
                             cluster</entry>
+                        <entry>false</entry>
                     </row>
                     <row>
                         <entry>persist-delivery-count-before-delivery</entry>
@@ -183,6 +212,7 @@
                         <entry>True means that the delivery count is persisted before delivery.
                             False means that this only happens after a message has been
                             cancelled.</entry>
+                        <entry>false</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.live.backup"
@@ -190,11 +220,13 @@
                         <entry>String</entry>
                         <entry>The name of the remoting connector to use for the backup node
                             when.</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="paging.main.config">paging-directory</link></entry>
                         <entry>String</entry>
                         <entry>The directory to store paged messages in</entry>
+                        <entry>data/paging</entry>
                     </row>
                     <row>
                         <entry><link linkend="paging.main.config"
@@ -202,18 +234,21 @@
                         <entry>Long</entry>
                         <entry>JBoss Messaging enters into global page mode as soon as the total
                             memory consumed by messages hits this value</entry>
+                        <entry>10 * 1024 * 1024</entry>
                     </row>
                     <row>
                         <entry><link linkend="paging.main.config"
                                 >paging-max-global-size-bytes</link></entry>
                         <entry>Long</entry>
                         <entry>The watermark used to determine when we start depaging</entry>
+                        <entry>-1</entry>
                     </row>
                     <row>
                         <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>
                     </row>
                     <row>
                         <entry><link linkend="configuring.bindings.journal"
@@ -221,24 +256,28 @@
                         <entry>Boolean</entry>
                         <entry>True means that the server will create the bindings directory on
                             start up</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
                             >journal-directory</link></entry>
                         <entry>String</entry>
                         <entry>The directory to store the journal files in</entry>
+                        <entry>data/journal</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
                             >create-journal-dir</link></entry>
                         <entry>Boolean</entry>
                         <entry>True means that the journal directory will be created</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
                             >journal-type</link></entry>
                         <entry>ASYNCIO|NIO</entry>
                         <entry>What type of journal to use</entry>
+                        <entry>ASYNCIO</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
@@ -246,6 +285,7 @@
                         <entry>Long</entry>
                         <entry>The journal will try and re use any buffers smaller than this
                             size.</entry>
+                        <entry>1024</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
@@ -253,6 +293,7 @@
                         <entry>Boolean</entry>
                         <entry>If true wait for transaction data to be synced to the journal before
                             returning response to client.</entry>
+                        <entry>true</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
@@ -260,18 +301,21 @@
                         <entry>Boolean</entry>
                         <entry>If true wait for non transaction data to be synced to the journal
                             before returning response to client.</entry>
+                        <entry>false</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
                             >journal-file-size</link></entry>
                         <entry>Long</entry>
                         <entry>The max size, in bytes, each journal file should be</entry>
+                        <entry>10485760</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
                             >journal-min-files</link></entry>
                         <entry>Integer</entry>
                         <entry>How many journal files to pre create</entry>
+                        <entry>2</entry>
                     </row>
                     <row>
                         <entry><link linkend="configuring.message.journal"
@@ -279,67 +323,79 @@
                         <entry>Integer</entry>
                         <entry>The maximum number of write requests that can be in the AIO queue at
                             any one time</entry>
+                        <entry>5000</entry>
                     </row>
                     <row>
                         <entry><link linkend="large.message.configuring"
                                 >large-messages-directory</link></entry>
                         <entry>String</entry>
                         <entry>The directory to store large messages</entry>
+                        <entry>data/largemessages</entry>
                     </row>
                     <row>
                         <entry><link linkend="understanding.connectors">connectors</link></entry>
                         <entry>Connector</entry>
                         <entry>A list of remoting connectors configurations to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="configuring-transports.acceptors"
                             >acceptors</link></entry>
                         <entry>Acceptor</entry>
                         <entry>A list of remoting acceptors to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="clusters.broadcast-groups"
                             >broadcast-groups</link></entry>
                         <entry>BroadcastGroup</entry>
                         <entry>A list of broadcast groups to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="discoverclusters.discovery-groups"
                                 >discovery-groups</link></entry>
                         <entry>DiscoveryGroup</entry>
                         <entry>A list of discovery groups to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="diverts">diverts</link></entry>
                         <entry>Divert</entry>
                         <entry>A list of diverts to use</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="predefined.queues">queues</link></entry>
                         <entry>Queue</entry>
                         <entry>A list of pre configured queues to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="core-bridges">bridges</link></entry>
                         <entry>Bridge</entry>
                         <entry>A list of bridges to create</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="clusters.cluster-connections"
                                 >cluster-connections</link></entry>
                         <entry>ClusterConnection</entry>
                         <entry>A list of cluster connections</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry><link linkend="security.settings.roles"
                             >security-settings</link></entry>
                         <entry>SecuritySetting</entry>
                         <entry>A list of security settings</entry>
+                        <entry/>
                     </row>
                     <row>
                         <entry>address-settings</entry>
                         <entry>AddressSetting</entry>
                         <entry>A list of address settings</entry>
+                        <entry/>
                     </row>
                 </tbody>
             </tgroup>




More information about the jboss-cvs-commits mailing list