blob: 7e5182d51bc02593c8ef7f654276b4ca23c79086 [file] [log] [blame]
<div class="wiki-content maincontent"><p>An Activation Spec is used to configure the message delivery to an MDB. The ejb-jar.xml deployment descriptor needs to include a &lt;activation-config&gt; element inside the &lt;message-driven&gt; element like:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">&lt;activation-config&gt;
&lt;activation-config-property&gt;
&lt;activation-config-property-name&gt;destination&lt;/activation-config-property-name&gt;
&lt;activation-config-property-value&gt;queue.testQueue&lt;/activation-config-property-value&gt;
&lt;/activation-config-property&gt;
&lt;activation-config-property&gt;
&lt;activation-config-property-name&gt;destinationType&lt;/activation-config-property-name&gt;
&lt;activation-config-property-value&gt;javax.jms.Queue&lt;/activation-config-property-value&gt;
&lt;/activation-config-property&gt;
&lt;/activation-config&gt;
</pre>
</div></div><p>Here, the value for destination is the physical name of the desired destination. The value for destinationType is the class name that defines the type of destination. It should be javax.jms.Queue or javax.jms.Topic.<br clear="none"> &#160;</p><p>The Activation Spec properties that can be configured are:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Required</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>acknowledgeMode</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Auto-acknowledge</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The JMS Acknowledgement mode to use. Valid values are: Auto-acknowledge or Dups-ok-acknowledge</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>clientId</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>set in resource adapter</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The JMS Client ID to use (only really required for durable topics)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>destinationType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>yes</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The type of destination; a queue or topic</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>destination</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>yes</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The destination name (queue or topic name)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>enableBatch</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Used to enable transaction batching for increased performance</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxMessagesPerBatch</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>10</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The number of messages per transaction batch</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxMessagesPerSessions</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>10</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>This is actually the prefetch size for the subscription. (Yes, badly named).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxSessions</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>10</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of concurrent sessions to use</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageSelector</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The JMS <a shape="rect" href="selectors.html">Message Selector</a> to use on the subscription to perform content based routing filtering the messages</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>noLocal</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Only required for topic subscriptions; indicates if locally published messages should be included in the subscription or not</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>password</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>set in resource adapter</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The password for the JMS connection</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>subscriptionDurability</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>NonDurable</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether or not a durable (topic) subscription is required. Valid values are: Durable or NonDurable</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>subscriptionName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name of the durable subscriber. Only used for durable topics and combined with the clientID to uniquely identify the durable topic subscription</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>userName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>set in resource adapter</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The user for the JMS connection</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>useRAManagedTransaction</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Typically, a resource adapter delivers messages to an endpoint which is managed by a container. Normally, this container likes to be the one that wants to control the transaction that the inbound message is being delivered on. But sometimes, you want to deliver to a simpler container system that will not be controlling the inbound transaction. In these cases, if you set useRAManagedTransaction to true, the resource adapter will commit the transaction if no exception was generated from the MessageListener and rollback if an exception is thrown.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>initialRedeliveryDelay</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>1000</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The delay before redeliveries start. Also configurable on the ResourceAdapter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maximumRedeliveries</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>5</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of redeliveries or -1 for no maximum. Also configurable on the ResourceAdapter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>redeliveryBackOffMultiplier</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>5</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The multiplier to use if exponential back off is enabled. Also configurable on the ResourceAdapter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>redeliveryUseExponentialBackOff</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>no</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To enable exponential backoff. Also configurable on the ResourceAdapter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">useJndi</td><td colspan="1" rowspan="1" class="confluenceTd">no</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">when true, use <span>destination as a jndi name</span></td></tr></tbody></table></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Maximising Throughput of MDBs</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>If you want to maximise throughput of MDBs you should really set the <strong>maxSessions</strong> to something fairly large to increase the concurrency. Then set <strong>maxMessagesPerSessions</strong> to something big (say) 1000.</p><p>This assumes you have large numbers of messages available (say more than <strong>maxSessions</strong> * <strong>maxMessagesPerSession</strong>). Otherwise the <a shape="rect" href="what-is-the-prefetch-limit-for.html">prefetch</a> will end up <a shape="rect" href="i-do-not-receive-messages-in-my-second-consumer.html">starving other consumers</a>.</p><p>So if you don't have that many messages available, but maybe they take a while to process then you might want to set a lower value of <strong>maxMessagesPerSessions</strong></p></div></div></div>