Author: buildbot Date: Fri Dec 5 23:46:52 2014 New Revision: 931598 Log: Production update by buildbot for cxf
Modified: websites/production/cxf/content/cache/docs.pageCache websites/production/cxf/content/docs/using-the-jmsconfigfeature.html Modified: websites/production/cxf/content/cache/docs.pageCache ============================================================================== Binary files - no diff available. Modified: websites/production/cxf/content/docs/using-the-jmsconfigfeature.html ============================================================================== --- websites/production/cxf/content/docs/using-the-jmsconfigfeature.html (original) +++ websites/production/cxf/content/docs/using-the-jmsconfigfeature.html Fri Dec 5 23:46:52 2014 @@ -189,7 +189,7 @@ Apache CXF -- Using the JMSConfigFeature server = svrFactory.create(); } ]]></script> -</div></div><h2 id="UsingtheJMSConfigFeature-JMSConfigurationoptions">JMSConfiguration options</h2><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>connectionFactory</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Mandatory field. Reference to a bean that defines a jms ConnectionFactory. Remember to wrap the connectionFactory like described above when not using a pooling ConnectionFactory</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>wrapInSingleConnectionFactory</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport. Default is true.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>reconnectOnException</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>(</span><strong>deprecated</strong><span>) </span>If wrapping the connectionFactory with a Spring SingleConnectionFactory and reconnectOnException is true, will create a new connection if there is an exception thrown, otherwise will not try to reconnect if the there is an exception thrown. Default is false. From CXF 3.0.0, CXF always <span style="line-height: 1.4285715;">reconnect on exceptions</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>targetDestination</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>JNDI name or provider specific name of a destination. Example for ActiveMQ: <br clear="none" class="atl-forced-newline"> test.cxf.jmstransport.queue</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>destinationResolver</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a Spring DestinationResolver. This allows to define how destination names are resolved to jms Destinations. By default a DynamicDestinationResolver is used. It resolves destinations using the jms providers features. If you reference a JndiDestinationResolver you can resolve the destination names using JNDI.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>transactionManager</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a spring transaction manager. This allows to take part in JTA Transactions with your webservice.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>taskExecutor</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Reference to a spring TaskExecutor. This is used in listeners to decide how to handle incoming messages. Default is a spring SimpleAsyncTaskExecutor.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>useJms11</p></ td><td colspan="1" rowspan="1" class="confluenceTd"><p>This option was removed since CXF 3.0.0.</p><p>true means JMS 1.1 features are used <br clear="none" class="atl-forced-newline"> false means only JMS 1.0.2 features are used. Default is false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageIdEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default is true. <span>This option was removed since CXF 3.0.0.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageTimestampEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default is true. <span>This option was removed since CXF 3.0.0.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cacheLevel</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0.</span></p><p>Specify the level of caching that the JMS listener container is allowed to apply. <br clear="none" class="at l-forced-newline"> Please check out the java doc of the org.springframework.jms.listenerDefaultMessageListenerContainer for more information. Default is -1.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pubSubNoLocal</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, do not receive your own messages when using topics. Default is false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>receiveTimeout</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>How many milliseconds to wait for response messages. 0 (default) means wait indefinitely. since CXF 3.0, the default value is changed to 60000 (60 seconds)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>explicitQosEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, means that QoS parameters are set for each message. Default is false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>deliveryMode</p></td>< td colspan="1" rowspan="1" class="confluenceTd"><p>NON_PERSISTENT = 1 messages will be kept only in memory <br clear="none" class="atl-forced-newline"> <br clear="none" class="atl-forced-newline"> PERSISTENT = 2 <span>(default)</span>  messages will be persisted to disk</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>priority</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Priority for the messages. Default is 4. See your JMS provider doc for details</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeToLive</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>After this time the message will be discarded by the jms provider (default 0).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>sessionTransacted</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, means JMS transactions are used. (Default is false).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <p>concurrentConsumers</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Minimum number of concurrent consumers for listener (default 1).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxConcurrentConsumers</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Maximum number of concurrent consumers for listener (default 1).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxConcurrentTasks</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>(<strong>deprecated</strong>) Maximum number of threads that handle the received requests (Default 10).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageSelector</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>jms selector to filter incoming messages (allows to share a queue)</p></t d></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>subscriptionDurable</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>durableSubscriptionName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>text (default) <br clear="none" class="atl-forced-newline"> binary <br clear="none" class="atl-forced-newline"> byte</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pubSubDomain</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false (default) means use queues <br clear="none" class="atl-forced-newline"> true means use topics</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>jmsProviderTibcoEms</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>true means that the jms provid er is Tibco EMS. Default is false. Currently this activates that the principal in the SecurityContext is populated from the header JMS_TIBCO_SENDER. (available from cxf version 2.2.6)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">maxSuspendedContinuations</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since CXF 3.0.0</strong>, The max suspended continuations that the JMS destination could have, if the current suspended continuations number exceeds the max value, the <span style="line-height: 1.4285715;">JMSListenerContainer will be stopped. </span>The default value is -1, which means disable this feature.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">reconnectPercentOfMax</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since CXF 3.0.0, </strong>If the <span>JMSListenerContainer is stopped due to the current suspended continuation exceeds the max value, the JMSListenerContainer will be restarted when the current suspended continuation below the value of (<span>maxSuspendedContinuations*<span>reconnectPercentOfMax/100).</span></span></span> The default value is 70.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createSecurityContext</td><td colspan="1" rowspan="1" class="confluenceTd"><p>true (default) means create user security context for incoming messages.</p></td></tr></tbody></table></div></div> +</div></div><h2 id="UsingtheJMSConfigFeature-JMSConfigurationoptions">JMSConfiguration options</h2><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>connectionFactory</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Mandatory field. Reference to a bean that defines a jms ConnectionFactory. Remember to wrap the connectionFactory like described above when not using a pooling ConnectionFactory</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>wrapInSingleConnectionFactory</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport. Default is true.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>reconnectOnException</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>(</span><strong>deprecated</strong><span>) </span>If wrapping the connectionFactory with a Spring SingleConnectionFactory and reconnectOnException is true, will create a new connection if there is an exception thrown, otherwise will not try to reconnect if the there is an exception thrown. Default is false. From CXF 3.0.0, CXF always <span style="line-height: 1.4285715;">reconnect on exceptions</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>targetDestination</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>JNDI name or provider specific name of a destination. Example for ActiveMQ: <br clear="none" class="atl-forced-newline"> test.cxf.jmstransport.queue</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>destinationResolver</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a Spring DestinationResolver. This allows to define how destination names are resolved to jms Destinations. By default a DynamicDestinationResolver is used. It resolves destinations using the jms providers features. If you reference a JndiDestinationResolver you can resolve the destination names using JNDI.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>transactionManager</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a spring transaction manager. This allows to take part in JTA Transactions with your webservice.  You can also register a spring JMS Transaction Manager to have local transactions.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>taskExecutor</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Reference to a spring TaskExecutor. This is used in listeners to decide how to handle incoming messages. Default is a spring SimpleAsyncTaskExec utor.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>useJms11</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>This option was removed since CXF 3.0.0.</p><p>true means JMS 1.1 features are used <br clear="none" class="atl-forced-newline"> false means only JMS 1.0.2 features are used. Default is false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageIdEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default is true. <span>This option was removed since CXF 3.0.0.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageTimestampEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default is true. <span>This option was removed since CXF 3.0.0.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>cacheLevel</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0.</span></p><p>Specify the level o f caching that the JMS listener container is allowed to apply. <br clear="none" class="atl-forced-newline"> Please check out the java doc of the org.springframework.jms.listenerDefaultMessageListenerContainer for more information. Default is -1.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pubSubNoLocal</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, do not receive your own messages when using topics. Default is false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>receiveTimeout</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>How many milliseconds to wait for response messages. 0 (default) means wait indefinitely. since CXF 3.0, the default value is changed to 60000 (60 seconds)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>explicitQosEnabled</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, means that QoS parameters are set for each message. Default is false.</p ></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p>deliveryMode</p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p>NON_PERSISTENT = 1 messages will be kept only in >memory <br clear="none" class="atl-forced-newline"> <br clear="none" >class="atl-forced-newline"> PERSISTENT = >2 <span>(default)</span>  messages will be persisted to >disk</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p>priority</p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p>Priority for the messages. Default is 4. See your JMS >provider doc for details</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p>timeToLive</p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p>After this time the message will be discarded by the >jms provider (default 0).</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p>sessionTransacted</p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p>If true, means JMS transactions are use d. (Default is false).   In 2.7.x you will also need to register a JMS Transaction Manager with JMSConfiguration in order for transactions to be enabled.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>concurrentConsumers</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Minimum number of concurrent consumers for listener (default 1).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxConcurrentConsumers</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>Maximum number of concurrent consumers for listener (default 1).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>maxConcurrentTasks</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>This option was removed since CXF 3.0.0. </span>(<strong>deprecated</strong>) Maximum number of threads that handle the received requests (D efault 10).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageSelector</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>jms selector to filter incoming messages (allows to share a queue)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>subscriptionDurable</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Default false.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>durableSubscriptionName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>messageType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>text (default) <br clear="none" class="atl-forced-newline"> binary <br clear="none" class="atl-forced-newline"> byte</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>pubSubDomain</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false (default) means use queues <br clear="none" class="atl-forced-newline"> true means use topics</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>jmsProviderTibcoEms</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>true means that the jms provider is Tibco EMS. Default is false. Currently this activates that the principal in the SecurityContext is populated from the header JMS_TIBCO_SENDER. (available from cxf version 2.2.6)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">maxSuspendedContinuations</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since CXF 3.0.0</strong>, The max suspended continuations that the JMS destination could have, if the current suspended continuations number exceeds the max value, the <span style="line-height: 1.4285715;">JMSListenerContainer will be stopped. </span>The default value is -1, which means disable this feature.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">reconnectPercentOfMax</p>< /td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since CXF 3.0.0, </strong>If the <span>JMSListenerContainer is stopped due to the current suspended continuation exceeds the max value, the JMSListenerContainer will be restarted when the current suspended continuation below the value of (<span>maxSuspendedContinuations*<span>reconnectPercentOfMax/100).</span></span></span> The default value is 70.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">createSecurityContext</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>(Since 2.7.14, 3.0.3)</strong> true (default) means create user security context for incoming messages.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">propogateExceptions</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>(Since 2.7.15) 2.7.x only</strong> true (default) means that any exceptions occurring while processing the incoming message will be propagated.  This setting is only relevant when a transaction manager and sessionTransacted are set.</td></tr></tbody></table></div></div> </div> <!-- Content --> </td>