[jboss-cvs] JBossAS SVN: r63375 - in branches/Branch_4_2/ejb3/docs/tutorial: mdb_deployment_descriptor and 1 other directory.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Wed Jun 6 15:24:13 EDT 2007 

Author: bdecoste
Date: 2007-06-06 15:24:12 -0400 (Wed, 06 Jun 2007)
New Revision: 63375

Modified:
   branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.html
   branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.wiki
   branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.html
   branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.wiki
Log:
[EJBTHREE-809] updated MDB documentation

Modified: branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.html
===================================================================
--- branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.html	2007-06-06 12:59:16 UTC (rev 63374)
+++ branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.html	2007-06-06 19:24:12 UTC (rev 63375)
@@ -3,19 +3,58 @@
 <p>
 <h2>Message Drive Beans</h2>
 
-This example shows you how to implement an MDB with EJB 3.0.
 </p><p>
+<h3>The MDB</h3>
+
+This example shows you how to implement an MDB with EJB 3.0 using annotations.
 </p><p>
-You configure properties by using the @MessageDriven(activationConfig) attribute with a bunch
-of @ActivationConfigProperty.  All properties that you can set are defined in this file.  Internally
-this is the class that is created to hold config information.
+Take a look at <a href="src/org/jboss/tutorial/mdb/bean/ExampleMDB.java">ExampleMDB.java</a>. The @MessageDriven
+annotation defines the bean as an MDB. The <tt>activationConfig</tt> attribute contains much of the 
+MDB configuration via @ActivationConfigProperty annotations. Also notice that the MDB source contains
+properties for <tt>destinationType</tt> and <tt>destination</tt>.
 </p><p>
-<a href="http://cvs.sourceforge.net/viewcvs.py/jboss/jboss-ejb3/src/main/org/jboss/ejb3/mdb/MDBConfig.java?rev=1.1&view=markup">MDBConfig.java</a>
+The following is the list of standard Activation Config Properties available from the JCA1.5
+specification. Also listed are the respective types and default values where defined.
 </p><p>
-Take a look at <a href="src/org/jboss/tutorial/mdb/bean/ExampleMDB.java">ExampleMDB.java</a>.
+<pre>
+String destination - the jndi name of the Queue or Topic - MANDATORY
+String destinationType - the type of destination valid values are javax.jms.Queue or javax.jms.Topic
+String messageSelector - the message selector of the subscription 
+int acknowledgeMode - the type of acknowledgement when not using transacted jms - valid values AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE - default is AUTO_ACKNOWLEDGE
+String clientID - the client id of the connection
+boolean subscriptionDurability - whether topic subscriptions are durable - valid values Durable or NonDurable - default is NonDurable
+String subscriptionName - the subsription name of the topic subscription
+</pre>
 </p><p>
-The <a href="queue-example-service.xml">queue-example-service.xml</a> file defines the queue.  This is the same in regular JBoss.
+The following is the list of Activation Config Properties available as JBoss extensions.
+Also listed are the respective types and default values where defined.
 </p><p>
+<pre>
+boolean isTopic - sets the destinationType - default is false
+String providerAdapterJNDI - the jndi name of the jms provider - default java:/DefaultJMSProvider
+String user - the user id used to connect to the jms server
+String pass - the password of the user
+int maxMessages - read this number of messages before delivering messages to the mdb (each message is delivered individually on the same thread in an attempt to avoid context excessive context switching) - default 1
+int minSession - the minimum number of jms sessions that are available to concurrently deliver messages to this mdb - default 1
+int maxSession - the maximum number of jms sessions that can concurrently deliver messages to this mdb - default 15
+long reconnectInterval - the length of time in seconds between attempts to (re-)connect to the jms provider - default 10 seconds
+long keepAlive - the length of time in milliseconds that sessions over the minimum are kept alive - default is 60 seconds
+booleam sessionTransacted - whether the sessions are transacted - default is true
+boolean useDLQ - whether to use a DLQ handler - valid values true or false - default is true
+String dLQHandler - the org.jboss.resource.adapter.jms.inflow.DLQHandler implementation class name - default org.jboss.resource.adapter.jms.inflow.dlq.GenericDLQHandler
+int dLQMaxResent - the maximum number of times a message is redelivered before it is sent to the DLQ - default 5
+String dLQUser - the user id used to make the dlq connection to the jms server
+String dLQPassword - the password of the DLQUser
+String dLQClientID - the client id of the dlq connection - default is null
+boolean redeliverUnspecified - whether to attempt to redeliver a message in an unspecified transaction context - default is true
+int transactionTimeout - time in seconds for the transaction timeout - default is the timeout set for the resource manager
+</pre>
+</p><p>
+<h3> The Destination</h3>
+
+The <a href="queue-example-service.xml">queue-example-service.xml</a> file defines the Queue.  There are no changes for deploying 
+an EJB3 ready Destination as a standard Destination.
+</p><p>
 <h4>Building and Running</h4>
 
 To build and run the example, make sure you have <tt>ejb3.deployer</tt> installed in JBoss 4.0.x and have JBoss running.  See the reference manual on how to install EJB 3.0.  

Modified: branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.wiki
===================================================================
--- branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.wiki	2007-06-06 12:59:16 UTC (rev 63374)
+++ branches/Branch_4_2/ejb3/docs/tutorial/mdb/mdb.wiki	2007-06-06 19:24:12 UTC (rev 63375)
@@ -1,17 +1,54 @@
 !!!Message Drive Beans
-This example shows you how to implement an MDB with EJB 3.0.
 
+!!The MDB
+This example shows you how to implement an MDB with EJB 3.0 using annotations.
 
-You configure properties by using the @MessageDriven(activationConfig) attribute with a bunch
-of @ActivationConfigProperty.  All properties that you can set are defined in this file.  Internally
-this is the class that is created to hold config information.
+Take a look at [ExampleMDB.java|src/org/jboss/tutorial/mdb/bean/ExampleMDB.java]. The @MessageDriven
+annotation defines the bean as an MDB. The {{activationConfig}} attribute contains much of the 
+MDB configuration via @ActivationConfigProperty annotations. Also notice that the MDB source contains
+properties for {{destinationType}} and {{destination}}.
 
-[MDBConfig.java|http://cvs.sourceforge.net/viewcvs.py/jboss/jboss-ejb3/src/main/org/jboss/ejb3/mdb/MDBConfig.java?rev=1.1&view=markup]
+The following is the list of standard Activation Config Properties available from the JCA1.5
+specification. Also listed are the respective types and default values where defined.
 
-Take a look at [ExampleMDB.java|src/org/jboss/tutorial/mdb/bean/ExampleMDB.java].
+{{{
+String destination - the jndi name of the Queue or Topic - MANDATORY
+String destinationType - the type of destination valid values are javax.jms.Queue or javax.jms.Topic
+String messageSelector - the message selector of the subscription 
+int acknowledgeMode - the type of acknowledgement when not using transacted jms - valid values AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE - default is AUTO_ACKNOWLEDGE
+String clientID - the client id of the connection
+boolean subscriptionDurability - whether topic subscriptions are durable - valid values Durable or NonDurable - default is NonDurable
+String subscriptionName - the subsription name of the topic subscription
+}}}
 
-The [queue-example-service.xml|queue-example-service.xml] file defines the queue.  This is the same in regular JBoss.
+The following is the list of Activation Config Properties available as JBoss extensions.
+Also listed are the respective types and default values where defined.
 
+{{{
+boolean isTopic - sets the destinationType - default is false
+String providerAdapterJNDI - the jndi name of the jms provider - default java:/DefaultJMSProvider
+String user - the user id used to connect to the jms server
+String pass - the password of the user
+int maxMessages - read this number of messages before delivering messages to the mdb (each message is delivered individually on the same thread in an attempt to avoid context excessive context switching) - default 1
+int minSession - the minimum number of jms sessions that are available to concurrently deliver messages to this mdb - default 1
+int maxSession - the maximum number of jms sessions that can concurrently deliver messages to this mdb - default 15
+long reconnectInterval - the length of time in seconds between attempts to (re-)connect to the jms provider - default 10 seconds
+long keepAlive - the length of time in milliseconds that sessions over the minimum are kept alive - default is 60 seconds
+booleam sessionTransacted - whether the sessions are transacted - default is true
+boolean useDLQ - whether to use a DLQ handler - valid values true or false - default is true
+String dLQHandler - the org.jboss.resource.adapter.jms.inflow.DLQHandler implementation class name - default org.jboss.resource.adapter.jms.inflow.dlq.GenericDLQHandler
+int dLQMaxResent - the maximum number of times a message is redelivered before it is sent to the DLQ - default 5
+String dLQUser - the user id used to make the dlq connection to the jms server
+String dLQPassword - the password of the DLQUser
+String dLQClientID - the client id of the dlq connection - default is null
+boolean redeliverUnspecified - whether to attempt to redeliver a message in an unspecified transaction context - default is true
+int transactionTimeout - time in seconds for the transaction timeout - default is the timeout set for the resource manager
+}}}
+
+!! The Destination
+The [queue-example-service.xml|queue-example-service.xml] file defines the Queue.  There are no changes for deploying 
+an EJB3 ready Destination as a standard Destination.
+
 !Building and Running
 To build and run the example, make sure you have {{ejb3.deployer}} installed in JBoss 4.0.x and have JBoss running.  See the reference manual on how to install EJB 3.0.  
 {{{

Modified: branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.html
===================================================================
--- branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.html	2007-06-06 12:59:16 UTC (rev 63374)
+++ branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.html	2007-06-06 19:24:12 UTC (rev 63375)
@@ -3,19 +3,61 @@
 <p>
 <h2>Message Drive Beans</h2>
 
-This example shows you how to implement an MDB with EJB 3.0.
 </p><p>
+<h3>The MDB</h3>
+
+This example shows you how to implement an MDB with EJB 3.0 using xml deployment descriptors.
 </p><p>
-You configure properties by using the &lt;message-driven&gt; element and sub elements which correspond to the @ActivationConfigProperty annotation.  All 
-properties that you can set are defined in the <a href="META-INF/ejb-jar.xml">ejb-jar.xml</a> and
-<a href="META-INF/jboss.xml">jboss.xml</a> deployment descriptors. 
+Take a look at <a href="src/org/jboss/tutorial/mdb_deployment_descriptor/bean/ExampleMDB.java">ExampleMDB.java</a>,
+<a href="META-INF/ejb-jar.xml">ejb-jar.xml</a>, and <a href="META-INF/jboss.xml">jboss.xml</a>.
+The <tt>&lt;message-driven&gt;</tt> element in <tt>ejb-jar.xml</tt> defines the bean as an MDB. The
+<tt>&lt;activation-config&gt;</tt> and  elements contain much of the MDB configuration via the
+<tt>activation-config-property</tt> elements. The <tt>jboss.xml</tt> descriptor provides the JBoss extensions 
+to the EJB3 specification, such as the Destination JNDI binding via the <tt>&lt;destination-jndi-name&gt;</tt>
+element.
 </p><p>
-<a href="http://cvs.sourceforge.net/viewcvs.py/jboss/jboss-ejb3/src/main/org/jboss/ejb3/mdb/MDBConfig.java?rev=1.1&view=markup">MDBConfig.java</a>
+The following is the list of standard Activation Config Properties available from the JCA1.5
+specification. Also listed are the respective types and default values where defined.
 </p><p>
-Take a look at <a href="src/org/jboss/tutorial/mdb_deployment_descriptor/bean/ExampleMDB.java">ExampleMDB.java</a>.
+<pre>
+String destination - the jndi name of the Queue or Topic - MANDATORY
+String destinationType - the type of destination valid values are javax.jms.Queue or javax.jms.Topic
+String messageSelector - the message selector of the subscription 
+int acknowledgeMode - the type of acknowledgement when not using transacted jms - valid values AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE - default is AUTO_ACKNOWLEDGE
+String clientID - the client id of the connection
+boolean subscriptionDurability - whether topic subscriptions are durable - valid values Durable or NonDurable - default is NonDurable
+String subscriptionName - the subsription name of the topic subscription
+</pre>
 </p><p>
-The <a href="queue-example-service.xml">queue-example-service.xml</a> file defines the queue.  This is the same in regular JBoss.
+The following is the list of Activation Config Properties available as JBoss extensions.
+Also listed are the respective types and default values where defined.
 </p><p>
+<pre>
+boolean isTopic - sets the destinationType - default is false
+String providerAdapterJNDI - the jndi name of the jms provider - default java:/DefaultJMSProvider
+String user - the user id used to connect to the jms server
+String pass - the password of the user
+int maxMessages - read this number of messages before delivering messages to the mdb (each message is delivered individually on the same thread in an attempt to avoid context excessive context switching) - default 1
+int minSession - the minimum number of jms sessions that are available to concurrently deliver messages to this mdb - default 1
+int maxSession - the maximum number of jms sessions that can concurrently deliver messages to this mdb - default 15
+long reconnectInterval - the length of time in seconds between attempts to (re-)connect to the jms provider - default 10 seconds
+long keepAlive - the length of time in milliseconds that sessions over the minimum are kept alive - default is 60 seconds
+booleam sessionTransacted - whether the sessions are transacted - default is true
+boolean useDLQ - whether to use a DLQ handler - valid values true or false - default is true
+String dLQHandler - the org.jboss.resource.adapter.jms.inflow.DLQHandler implementation class name - default org.jboss.resource.adapter.jms.inflow.dlq.GenericDLQHandler
+int dLQMaxResent - the maximum number of times a message is redelivered before it is sent to the DLQ - default 5
+String dLQUser - the user id used to make the dlq connection to the jms server
+String dLQPassword - the password of the DLQUser
+String dLQClientID - the client id of the dlq connection - default is null
+boolean redeliverUnspecified - whether to attempt to redeliver a message in an unspecified transaction context - default is true
+int transactionTimeout - time in seconds for the transaction timeout - default is the timeout set for the resource manager
+</pre>
+</p><p>
+<h3> The Destination</h3>
+
+The <a href="queue-example-service.xml">queue-example-service.xml</a> file defines the Queue.  There are no changes for deploying 
+an EJB3 ready Destination as a standard Destination.
+</p><p>
 <h4>Building and Running</h4>
 
 To build and run the example, make sure you have <tt>ejb3.deployer</tt> installed in JBoss 4.0.x and have JBoss running.  See the reference manual on how to install EJB 3.0.  
@@ -34,10 +76,6 @@
 01:01:20,828 INFO  [STDOUT] Received message
 01:01:20,828 INFO  [STDOUT] ----------------
 </pre>
-</p><p>
-</p><p>
-</p><p>
-</p><p>
 </p>
 </body>
 </html>

Modified: branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.wiki
===================================================================
--- branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.wiki	2007-06-06 12:59:16 UTC (rev 63374)
+++ branches/Branch_4_2/ejb3/docs/tutorial/mdb_deployment_descriptor/mdb.wiki	2007-06-06 19:24:12 UTC (rev 63375)
@@ -1,17 +1,57 @@
 !!!Message Drive Beans
-This example shows you how to implement an MDB with EJB 3.0.
 
+!!The MDB
+This example shows you how to implement an MDB with EJB 3.0 using xml deployment descriptors.
 
-You configure properties by using the <message-driven> element and sub elements which correspond to the @ActivationConfigProperty annotation.  All 
-properties that you can set are defined in the [ejb-jar.xml|META-INF/ejb-jar.xml] and
-[jboss.xml|META-INF/jboss.xml] deployment descriptors. 
+Take a look at [ExampleMDB.java|src/org/jboss/tutorial/mdb_deployment_descriptor/bean/ExampleMDB.java],
+[ejb-jar.xml|META-INF/ejb-jar.xml], and [jboss.xml|META-INF/jboss.xml].
+The {{<message-driven>}} element in {{ejb-jar.xml}} defines the bean as an MDB. The
+{{<activation-config>}} and  elements contain much of the MDB configuration via the
+{{activation-config-property}} elements. The {{jboss.xml}} descriptor provides the JBoss extensions 
+to the EJB3 specification, such as the Destination JNDI binding via the {{<destination-jndi-name>}}
+element.
 
-[MDBConfig.java|http://cvs.sourceforge.net/viewcvs.py/jboss/jboss-ejb3/src/main/org/jboss/ejb3/mdb/MDBConfig.java?rev=1.1&view=markup]
+The following is the list of standard Activation Config Properties available from the JCA1.5
+specification. Also listed are the respective types and default values where defined.
 
-Take a look at [ExampleMDB.java|src/org/jboss/tutorial/mdb_deployment_descriptor/bean/ExampleMDB.java].
+{{{
+String destination - the jndi name of the Queue or Topic - MANDATORY
+String destinationType - the type of destination valid values are javax.jms.Queue or javax.jms.Topic
+String messageSelector - the message selector of the subscription 
+int acknowledgeMode - the type of acknowledgement when not using transacted jms - valid values AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE - default is AUTO_ACKNOWLEDGE
+String clientID - the client id of the connection
+boolean subscriptionDurability - whether topic subscriptions are durable - valid values Durable or NonDurable - default is NonDurable
+String subscriptionName - the subsription name of the topic subscription
+}}}
 
-The [queue-example-service.xml|queue-example-service.xml] file defines the queue.  This is the same in regular JBoss.
+The following is the list of Activation Config Properties available as JBoss extensions.
+Also listed are the respective types and default values where defined.
 
+{{{
+boolean isTopic - sets the destinationType - default is false
+String providerAdapterJNDI - the jndi name of the jms provider - default java:/DefaultJMSProvider
+String user - the user id used to connect to the jms server
+String pass - the password of the user
+int maxMessages - read this number of messages before delivering messages to the mdb (each message is delivered individually on the same thread in an attempt to avoid context excessive context switching) - default 1
+int minSession - the minimum number of jms sessions that are available to concurrently deliver messages to this mdb - default 1
+int maxSession - the maximum number of jms sessions that can concurrently deliver messages to this mdb - default 15
+long reconnectInterval - the length of time in seconds between attempts to (re-)connect to the jms provider - default 10 seconds
+long keepAlive - the length of time in milliseconds that sessions over the minimum are kept alive - default is 60 seconds
+booleam sessionTransacted - whether the sessions are transacted - default is true
+boolean useDLQ - whether to use a DLQ handler - valid values true or false - default is true
+String dLQHandler - the org.jboss.resource.adapter.jms.inflow.DLQHandler implementation class name - default org.jboss.resource.adapter.jms.inflow.dlq.GenericDLQHandler
+int dLQMaxResent - the maximum number of times a message is redelivered before it is sent to the DLQ - default 5
+String dLQUser - the user id used to make the dlq connection to the jms server
+String dLQPassword - the password of the DLQUser
+String dLQClientID - the client id of the dlq connection - default is null
+boolean redeliverUnspecified - whether to attempt to redeliver a message in an unspecified transaction context - default is true
+int transactionTimeout - time in seconds for the transaction timeout - default is the timeout set for the resource manager
+}}}
+
+!! The Destination
+The [queue-example-service.xml|queue-example-service.xml] file defines the Queue.  There are no changes for deploying 
+an EJB3 ready Destination as a standard Destination.
+
 !Building and Running
 To build and run the example, make sure you have {{ejb3.deployer}} installed in JBoss 4.0.x and have JBoss running.  See the reference manual on how to install EJB 3.0.  
 {{{
@@ -29,7 +69,3 @@
 01:01:20,828 INFO  [STDOUT] Received message
 01:01:20,828 INFO  [STDOUT] ----------------
 }}}
-
-
-
-

More information about the jboss-cvs-commits mailing list