| <div class="wiki-content maincontent"><p>The ActiveMQ Resource Adapter allows you to configure several properties that:</p> |
| <ul><li>sets the options used for connection used for inbound message delivery</li><li>sets the default options used for the outbound connection factory objects.</li></ul> |
| |
| |
| <p>The 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> ServerUrl </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> tcp://localhost:61616 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The URI to connect to the broker on </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> defaultUser </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> User name </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> defaultPassword </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Password </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> null </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS client ID to use </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> UseInboundSession </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> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> BrokerXmlConfig </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The ActiveMQ XML config file to use to deploy an embedded broker. E.g. to configure via an XML configuration file then use <strong>xbean:activemq.xml</strong> or to configure via a <a shape="rect" href="broker-configuration-uri.xml">Broker Configuration URI</a> (to avoid using Spring, XBean and XML) then use <strong>broker:(tcp://localhost:61616)</strong> </p></td></tr></tbody></table></div> |
| |
| |
| <h4 id="ResourceAdapterProperties-Performancerelatedsettings">Performance related settings</h4> |
| |
| <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> AllPrefetchValues </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Sets all the prefetch values in one setting </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> DurableTopicPrefetch </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 100 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The maximum number of messages sent to a consumer on a durable topic until acknowledgements are received </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> QueuePrefetch </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 maximum number of messages sent to a consumer on a queue until acknowledgements are received </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> InputStreamPrefetch </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> 100 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The maximum number of messages sent to a consumer on a JMS stream until acknowledgements are received </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> TopicPrefetch </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> no </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Short.MAX_VALUE - 1 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The maximum number of messages sent to a consumer on a non-durable topic until acknowledgements are received </p></td></tr></tbody></table></div> |
| |
| |
| <h4 id="ResourceAdapterProperties-Redeliveryproperties">Redelivery properties</h4> |
| |
| <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> 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 ActivationSpec. </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 ActivationSpec. </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 ActivationSpec. </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 ActivationSpec. </p></td></tr></tbody></table></div> |
| |
| |
| <h4 id="ResourceAdapterProperties-ServerUrl">ServerUrl</h4> |
| |
| <p>The URL to the ActiveMQ server that you want this connection to connect to. If using an embedded broker, this value should be 'vm://localhost' if using the auto-created embedded broker, otherwise if you explicitly create a broker (e.g. using one of the <a shape="rect" href="how-do-i-embed-a-broker-inside-a-connection.xml">embedded broker</a> techniques), then this value should be 'vm://brokerName', where brokerName is replaced by the broker's name.</p> |
| |
| <h4 id="ResourceAdapterProperties-UserName">UserName</h4> |
| |
| <p>The default user name that will be used to establish connections to the ActiveMQ server.</p> |
| |
| <h4 id="ResourceAdapterProperties-Password">Password</h4> |
| |
| <p>The default password that will be used to log the default user into the ActiveMQ server.</p> |
| |
| <h4 id="ResourceAdapterProperties-Clientid">Clientid</h4> |
| |
| <p>The client id that will be set on the connection that is established to the ActiveMQ server.</p> |
| |
| <h4 id="ResourceAdapterProperties-UseInboundSession">UseInboundSession</h4> |
| |
| <p>Boolean to configure if outbound connections should reuse the inbound connection's session for sending messages.</p> |
| |
| <h4 id="ResourceAdapterProperties-BrokerXmlConfig">BrokerXmlConfig</h4> |
| |
| <p>Sets the XML configuration file used to configure the embedded ActiveMQ broker via Spring if using embedded mode. If this property is omitted then no embedded broker is used and you must <a shape="rect" href="run-broker.xml">run the broker</a> in a separate process or deployment unit.</p> |
| |
| <p>BrokerXmlConfig is the filename which is assumed to be on the classpath unless a URL is specified. So a value of foo/bar.xml would be assumed to be on the classpath whereas file:dir/file.xml would use the file system. Any valid URL string is supported. </p></div> |
| |
