[jboss-cvs] JBoss Messaging SVN: r6911 - trunk/docs/user-manual/en.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed May 20 05:49:23 EDT 2009
Author: ataylor
Date: 2009-05-20 05:49:23 -0400 (Wed, 20 May 2009)
New Revision: 6911
Modified:
trunk/docs/user-manual/en/appserver-integration.xml
Log:
reformatted code and tables for appserver integration doc
Modified: trunk/docs/user-manual/en/appserver-integration.xml
===================================================================
--- trunk/docs/user-manual/en/appserver-integration.xml 2009-05-20 09:17:39 UTC (rev 6910)
+++ trunk/docs/user-manual/en/appserver-integration.xml 2009-05-20 09:49:23 UTC (rev 6911)
@@ -15,15 +15,18 @@
>META-INF/ra.xml</literal>.</para>
<para>The configuration will look something like the following:</para>
<programlisting><resourceadapter>
- <resourceadapter-class>org.jboss.messaging.ra.JBMResourceAdapter</resourceadapter-class>
+ <resourceadapter-class>org.jboss.messaging.ra.JBMResourceAdapter</resourceadapter
+ -class>
<config-property>
<description>The transport type</description>
<config-property-name>ConnectorClassName</config-property-name>
<config-property-type>java.lang.String</config-property-type>
- <config-property-value>org.jboss.messaging.core.remoting.impl.invm.InVMConnectorFactory</config-property-value>
+ <config-property-value>org.jboss.messaging.core.remoting.impl.invm.InVMConnectorF
+ actory</config-property-value>
</config-property>
<config-property>
- <description>The transport configuration. These values must be in the form of key=val;key=val;</description>
+ <description>The transport configuration. These values must be in the form of key
+ =val;key=val;</description>
<config-property-name>ConnectionParameters</config-property-name>
<config-property-type>java.lang.String</config-property-type>
<config-property-value>jbm.remoting.invm.serverid=0</config-property-value>
@@ -37,7 +40,8 @@
<outbound-resourceadapter>
<connection-definition>
- <managedconnectionfactory-class>org.jboss.messaging.ra.JBMManagedConnectionFactory</managedconnectionfactory-class>
+ <managedconnectionfactory-class>org.jboss.messaging.ra.JBMManagedConnection
+ Factory</managedconnectionfactory-class>
<config-property>
<description>The default session type</description>
@@ -46,21 +50,27 @@
<config-property-value>javax.jms.Queue</config-property-value>
</config-property>
<config-property>
- <description>Try to obtain a lock within specified number of seconds; less than or equal to 0 disable this functionality</description>
+ <description>Try to obtain a lock within specified number of seconds; less
+ than or equal to 0 disable this functionality</description>
<config-property-name>UseTryLock</config-property-name>
<config-property-type>java.lang.Integer</config-property-type>
<config-property-value>0</config-property-value>
</config-property>
- <connectionfactory-interface>org.jboss.messaging.ra.JBMConnectionFactory</connectionfactory-interface>
- <connectionfactory-impl-class>org.jboss.messaging.ra.JBMConnectionFactoryImpl</connectionfactory-impl-class>
+ <connectionfactory-interface>org.jboss.messaging.ra.JBMConnectionFactory
+ </connectionfactory-interface>
+ <connectionfactory-impl-class>org.jboss.messaging.ra.JBMConnectionFactoryImpl
+ </connectionfactory-impl-class>
<connection-interface>javax.jms.Session</connection-interface>
- <connection-impl-class>org.jboss.messaging.ra.JBMSession</connection-impl-class>
+ <connection-impl-class>org.jboss.messaging.ra.JBMSession
+ </connection-impl-class>
</connection-definition>
<transaction-support>XATransaction</transaction-support>
<authentication-mechanism>
- <authentication-mechanism-type>BasicPassword</authentication-mechanism-type>
- <credential-interface>javax.resource.spi.security.PasswordCredential</credential-interface>
+ <authentication-mechanism-type>BasicPassword
+ </authentication-mechanism-type>
+ <credential-interface>javax.resource.spi.security.PasswordCredential
+ </credential-interface>
</authentication-mechanism>
<reauthentication-support>false</reauthentication-support>
</outbound-resourceadapter>
@@ -70,7 +80,8 @@
<messagelistener>
<messagelistener-type>javax.jms.MessageListener</messagelistener-type>
<activationspec>
- <activationspec-class>org.jboss.messaging.ra.inflow.JBMActivationSpec</activationspec-class>
+ <activationspec-class>org.jboss.messaging.ra.inflow.JBMActivationSpec
+ </activationspec-class>
<required-config-property>
<config-property-name>destination</config-property-name>
</required-config-property>
@@ -105,9 +116,9 @@
<table frame="topbot" border="2">
<title>Global Configuration Properties</title>
<tgroup cols="3">
- <colspec colname="c1" colnum="1" colwidth="0.55*"/>
- <colspec colname="c2" colnum="2" colwidth="0.31*"/>
- <colspec colname="c3" colnum="3" colwidth="2.14*"/>
+ <colspec colname="c1" colnum="1"/>
+ <colspec colname="c2" colnum="2"/>
+ <colspec colname="c3" colnum="3"/>
<thead>
<row>
<entry>Property Name</entry>
@@ -118,176 +129,186 @@
<tbody>
<row>
<entry>ConnectorClassName</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The Connector class name see <xref
linkend="configuring-transports"/> for info on available
connectors</entry>
</row>
<row>
<entry>ConnectionParameters</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The transport configuration. These values must be in the form of
key=val;key=val; and will be specific to the connector used</entry>
</row>
<row>
<entry>UseXA</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>True will enable XA transactions</entry>
</row>
<row>
<entry>UserName</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The user name to use when making a connection </entry>
</row>
<row>
<entry>Password</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The password to use when making a connection</entry>
</row>
<row>
<entry>BackUpTransportType</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The back up transport to use on failure.</entry>
</row>
<row>
<entry>TransportConfiguration</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The back up transport configuration</entry>
</row>
<row>
<entry>DiscoveryGroupAddress</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The discovery group address to use to autodetect a server</entry>
</row>
<row>
<entry>DiscoveryGroupPort</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The port to use for discovery</entry>
</row>
<row>
<entry>DiscoveryRefreshTimeout</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>The timeout, in milli seconds, to refresh.</entry>
</row>
<row>
<entry>DiscoveryInitialWaitTimeout</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>The initial time to wait for discovery.</entry>
</row>
<row>
<entry>LoadBalancingPolicyClassName</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The load balancing policy class to use.</entry>
</row>
<row>
<entry>PingPeriod</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>The period, in milliseconds, to ping the server for
failure.</entry>
</row>
<row>
<entry>ConnectionTTL</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>The time to live for the connection.</entry>
</row>
<row>
<entry>CallTimeout</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>the call timeout, in milli seconds, for each packet sent.</entry>
</row>
<row>
<entry>DupsOKBatchSize</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The batch size of message acks to use if Dups ok is used.</entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>continued..</para>
+ <informaltable frame="topbot">
+ <tgroup cols="3">
+ <colspec colname="c1" colnum="1"/>
+ <colspec colname="c2" colnum="2"/>
+ <colspec colname="c3" colnum="3"/>
+ <tbody>
<row>
<entry>TransactionBatchSize</entry>
- <entry>java.lang.Integer</entry>
- <entry>The batch size to use for sending messages within a
+ <entry>integer</entry>
+ <entry>The batch size to use for sending messages within a
transaction</entry>
</row>
<row>
<entry>ConsumerWindowSize</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The window size for the consumers internal buffer.</entry>
</row>
<row>
<entry>ConsumerMaxRate</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The max rate a consumer can receive.</entry>
</row>
<row>
<entry>ProducerWindowSize</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The window size for the sending of messages.</entry>
</row>
<row>
<entry>ProducerMaxRate</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The max rate a producer can send messages.</entry>
</row>
<row>
<entry>MinLargeMessageSize</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The size a message can be, in bytes, before it is sent as a multi
part large message.</entry>
</row>
<row>
<entry>BlockOnAcknowledge</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>If true then block on acknowledge of messages.</entry>
</row>
<row>
<entry>BlockOnNonPersistentSend</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>If true then block when sending non persistent messages</entry>
</row>
<row>
<entry>BlockOnPersistentSend</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>If true then block when sending persistent messages</entry>
</row>
<row>
<entry>AutoGroup</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>If true then auto group messages</entry>
</row>
<row>
<entry>MaxConnections</entry>
- <entry>java.lang.Integer</entry>
+ <entry>integer</entry>
<entry>The max number of connections.</entry>
</row>
<row>
<entry>PreAcknowledge</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>Whether to pre acknowledge messages before sending to
consumer</entry>
</row>
<row>
<entry>RetryInterval</entry>
- <entry>java.lang.Long</entry>
+ <entry>long</entry>
<entry>How long to wait , in milli seconds, before retrying a failed
connection</entry>
</row>
<row>
<entry>RetryIntervalMultiplier</entry>
- <entry>java.lang.Double</entry>
+ <entry>double</entry>
<entry>Used for calculating the retry interval</entry>
</row>
<row>
<entry>FailoverOnServerShutdown</entry>
- <entry>java.lang.Boolean</entry>
+ <entry>boolean</entry>
<entry>If true client will reconnect to another server if
available</entry>
</row>
<row>
<entry>ClientID</entry>
- <entry>java.lang.String</entry>
+ <entry>String</entry>
<entry>The client ID of the connection</entry>
</row>
</tbody>
</tgroup>
- </table>
+ </informaltable>
</section>
<section>
<title>Adapter Outbound configuration</title>
@@ -303,10 +324,15 @@
<jndi-name>RemoteJmsXA</jndi-name>
<xa-transaction/>
<rar-name>jms-ra.rar</rar-name>
- <connection-definition>org.jboss.messaging.ra.JBMConnectionFactory</connection-definition>
- <config-property name="SessionDefaultType" type="java.lang.String">javax.jms.Topic</config-property>
- <config-property name="ConnectorClassName" type="java.lang.String">org.jboss.messaging.integration.transports.netty.NettyConnectorFactory</config-property>
- <config-property name="ConnectionParameters" type="java.lang.String">jbm.remoting.netty.port=5445</config-property>
+ <connection-definition>org.jboss.messaging.ra.JBMConnectionFactory
+</connection-definition>
+ <config-property name="SessionDefaultType" type="String">javax.jms.Topic
+ </config-property>
+ <config-property name="ConnectorClassName" type="String">
+ org.jboss.messaging.integration.transports.netty.NettyConnectorFactory
+ </config-property>
+ <config-property name="ConnectionParameters" type="String">
+ jbm.remoting.netty.port=5445</config-property>
<max-pool-size>20</max-pool-size>
</tx-connection-factory></programlisting>
<para>In this example the connection factory will be bound to JNDI with the name
@@ -335,11 +361,17 @@
<programlisting>@MessageDriven(name = "MessageMDBExample",
activationConfig =
{
- @ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Queue"),
- @ActivationConfigProperty(propertyName = "destination", propertyValue = "queue/testQueue"),
- @ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge"),
- @ActivationConfigProperty(propertyName = "ConnectorClassName", propertyValue = "org.jboss.messaging.integration.transports.netty.NettyConnectorFactory"),
- @ActivationConfigProperty(propertyName = "ConnectionParameters", propertyValue = "jbm.remoting.netty.port=5545")
+ @ActivationConfigProperty(propertyName = "destinationType",
+ propertyValue = "javax.jms.Queue"),
+ @ActivationConfigProperty(propertyName = "destination",
+ propertyValue = "queue/testQueue"),
+ @ActivationConfigProperty(propertyName = "acknowledgeMode",
+ propertyValue = "Auto-acknowledge"),
+ @ActivationConfigProperty(propertyName = "ConnectorClassName",
+ propertyValue =
+ "org.jboss.messaging.integration.transports.netty.NettyConnectorFactory"),
+ @ActivationConfigProperty(propertyName = "ConnectionParameters",
+ propertyValue = "jbm.remoting.netty.port=5545")
})
public class MDBRemoteExample implements MessageListener
{
@@ -375,8 +407,10 @@
round robin look ups for connection factories and give load balanced connections.</para>
<para>To use it use the following properties when connecting to JNDI.</para>
<programlisting>Hashtable<String, String> jndiParameters = new Hashtable<String, String>();
-jndiParameters.put("java.naming.factory.initial", "org.jnp.interfaces.NamingContextFactory");
-jndiParameters.put("java.naming.factory.url.pkgs=", "org.jboss.naming:org.jnp.interfaces");
+jndiParameters.put("java.naming.factory.initial",
+ "org.jnp.interfaces.NamingContextFactory");
+jndiParameters.put("java.naming.factory.url.pkgs=",
+ "org.jboss.naming:org.jnp.interfaces");
initialContext = new InitialContext(jndiParameters);</programlisting>
<para>For more information visit <ulink
@@ -448,8 +482,10 @@
</property>
</bean>
- <!-- SourceCFF describes the ConnectionFactory used to connect to the source destination -->
- <bean name="SourceCFF" class="org.jboss.messaging.jms.bridge.impl.JNDIConnectionFactoryFactory">
+ <!-- SourceCFF describes the ConnectionFactory used to connect to the
+ source destination -->
+ <bean name="SourceCFF"
+ class="org.jboss.messaging.jms.bridge.impl.JNDIConnectionFactoryFactory">
<constructor>
<parameter>
<inject bean="JNDI" />
@@ -458,8 +494,10 @@
</constructor>
</bean>
- <!-- TargetCFF describes the ConnectionFactory used to connect to the target destination -->
- <bean name="TargetCFF" class="org.jboss.messaging.jms.bridge.impl.JNDIConnectionFactoryFactory">
+ <!-- TargetCFF describes the ConnectionFactory used to connect to the
+ target destination -->
+ <bean name="TargetCFF"
+ class="org.jboss.messaging.jms.bridge.impl.JNDIConnectionFactoryFactory">
<constructor>
<parameter>
<inject bean="JNDI" />
@@ -469,7 +507,8 @@
</bean>
<!-- SourceDestinationFactory describes the Destination used as the source -->
- <bean name="SourceDestinationFactory" class="org.jboss.messaging.jms.bridge.impl.JNDIDestinationFactory">
+ <bean name="SourceDestinationFactory"
+ class="org.jboss.messaging.jms.bridge.impl.JNDIDestinationFactory">
<constructor>
<parameter>
<inject bean="JNDI" />
@@ -479,7 +518,8 @@
</bean>
<!-- TargetDestinationFactory describes the Destination used as the target -->
- <bean name="TargetDestinationFactory" class="org.jboss.messaging.jms.bridge.impl.JNDIDestinationFactory">
+ <bean name="TargetDestinationFactory"
+ class="org.jboss.messaging.jms.bridge.impl.JNDIDestinationFactory">
<constructor>
<parameter>
<inject bean="JNDI" />
@@ -492,8 +532,8 @@
<!-- to connect to the sources and targets JMS resrouces -->
<bean name="JNDI" class="java.util.Hashtable">
<constructor class="java.util.Map">
- <map class="java.util.Hashtable" keyClass="java.lang.String"
- valueClass="java.lang.String">
+ <map class="java.util.Hashtable" keyClass="String"
+ valueClass="String">
<entry>
<key>java.naming.factory.initial</key>
<value>org.jnp.interfaces.NamingContextFactory</value>
@@ -652,54 +692,51 @@
depending on your specific application.</para>
</note>
</section>
-
<section>
- <title>Example</title>
- <para>The <literal>javaee/jms-bridge</literal> example shows
- how to configure and use a JMS Bridge to send messages to the source destination
- and consume them from the target destination.</para>
+ <title>Example</title>
+ <para>The <literal>javaee/jms-bridge</literal> example shows how to configure and
+ use a JMS Bridge to send messages to the source destination and consume them
+ from the target destination.</para>
</section>
-
</section>
- </section>
-
- <section id="xa-recovery">
- <title>XA Recovery</title>
- <para><emphasis>XA recovery</emphasis> deals with system or application failures to ensure that
- of a transaction are applied consistently to all resources affected by the transaction,
- even if any of the application processes or the machine hosting them crash or
- lose network connectivity. For more information on XA Recovery, refer to
- <ulink url="http://www.jboss.org/community/wiki/JBossTransactions">JBoss Transactions</ulink>.</para>
-
- <para>When JBoss Messaging is integrated with JBoss AS, it can take advantage of JBoss Transactions
- to provide recovery of messaging resources. If messages are involved in a XA transaction, in the
- event of a server crash, the recovery manager will ensure that the transactions are recovered
- and the messages will either be committed or rolled back (depending on the transaction outcome)
- when the server is restarted.</para>
-
- <section>
- <title>XA Recovery Configuration</title>
- <para>To enable JBoss Messaging's XA Recovery, the following property must be added to
- the <literal>jta</literal> section of <literal>conf/jbossts-properties.xml</literal> of JBoss AS profiles:</para>
- <programlisting>
+ </section>
+ <section id="xa-recovery">
+ <title>XA Recovery</title>
+ <para><emphasis>XA recovery</emphasis> deals with system or application failures to ensure
+ that of a transaction are applied consistently to all resources affected by the
+ transaction, even if any of the application processes or the machine hosting them crash
+ or lose network connectivity. For more information on XA Recovery, refer to <ulink
+ url="http://www.jboss.org/community/wiki/JBossTransactions">JBoss
+ Transactions</ulink>.</para>
+ <para>When JBoss Messaging is integrated with JBoss AS, it can take advantage of JBoss
+ Transactions to provide recovery of messaging resources. If messages are involved in a
+ XA transaction, in the event of a server crash, the recovery manager will ensure that
+ the transactions are recovered and the messages will either be committed or rolled back
+ (depending on the transaction outcome) when the server is restarted.</para>
+ <section>
+ <title>XA Recovery Configuration</title>
+ <para>To enable JBoss Messaging's XA Recovery, the following property must be added to
+ the <literal>jta</literal> section of <literal>conf/jbossts-properties.xml</literal>
+ of JBoss AS profiles:</para>
+ <programlisting>
<properties depends="arjuna" name="jta">
...
<property name="com.arjuna.ats.jta.recovery.XAResourceRecovery.JBMESSAGING1"
- value="org.jboss.messaging.jms.server.recovery.MessagingXAResourceRecovery;java:/XAConnectionFactory"/>
+ value=
+"org.jboss.messaging.jms.server.recovery.MessagingXAResourceRecovery;java:/XAConnectionFactory"/>
</properties>
</programlisting>
-
- <para>This informs the recovery manager that it can recovers JBoss Messaging XA
- Resources using the <literal>XAConnectionFactory</literal> bound to <literal>java:/XAConnectionFactory</literal> in JNDI.
- A ConnectionFactory must have been configured with this JNDI name in <literal>jbm-jms.xml</literal> (see <xref linkend="using-jms.server.configuration" />).</para>
- </section>
-
- <section>
- <title>Example</title>
- <para>The <literal>javaee/xarecovery</literal> example shows
- how to configure XA Recovery and recover messages after a server crash.</para>
- </section>
-
- </section>
+ <para>This informs the recovery manager that it can recovers JBoss Messaging XA
+ Resources using the <literal>XAConnectionFactory</literal> bound to <literal
+ >java:/XAConnectionFactory</literal> in JNDI. A ConnectionFactory must have been
+ configured with this JNDI name in <literal>jbm-jms.xml</literal> (see <xref
+ linkend="using-jms.server.configuration"/>).</para>
+ </section>
+ <section>
+ <title>Example</title>
+ <para>The <literal>javaee/xarecovery</literal> example shows how to configure XA
+ Recovery and recover messages after a server crash.</para>
+ </section>
+ </section>
</chapter>
More information about the jboss-cvs-commits
mailing list