[CONF] Apache CXF Documentation > Using the JMSConfigFeature

[confluence]

Using the JMSConfigFeature Page edited by Glen Mazza Comment: Formatting changes to make text more friendly for PDF (Docbook). Changes (34) ... {code} JMSConfiguration options: || Name || Default || Description || | connectionFactory | (mandatory field) | 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 | | wrapInSingleConnectionFactory | true | Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport | | wrapInSingleConnectionFactory | Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport. Default is true. | | reconnectOnException | false | 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. | | targetDestination | JNDI name or provider specific name of a destination. Example for ActiveMQ: \\ test.cxf.jmstransport.queue | | replyDestination | \\ | | destinationResolver | DynamicDestinationResolver | 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. | | transactionManager | none | Reference to a spring transaction manager. This allows to take part in JTA Transactions with your webservice. | | taskExecutor | SimpleAsyncTaskExecutor | Reference to a spring TaskExecutor. This is used in listeners to decide how to handle incoming messages. Default is a spring SimpleAsyncTaskExecutor. | | useJms11 | > CXF 2.1.3: false | true means JMS 1.1 features are used false means only JMS 1.0.2 features are used \\ | | messageIdEnabled | true | | | messageTimestampEnabled | true | | false means only JMS 1.0.2 features are used. Default is false. \\ | | messageIdEnabled | Default is true. | | messageTimestampEnabled | Default is true. | | cacheLevel | -1 | Specify the level of caching that the JMS listener container is allowed to apply. Please check out the java doc of the org.springframework.jms.listenerDefaultMessageListenerContainer for more information. Default is -1. | | pubSubNoLocal | false | true do not receive your own messages when using topics \\ | | pubSubNoLocal | If true, do not receive your own messages when using topics. Default is false. \\ | | receiveTimeout | 0 | How many milliseconds to wait for response messages. 0 (default) means wait indefinitely. | | explicitQosEnabled | false | true If true, means that QoS parameters are set for each message. Default is false. | | deliveryMode | 1 | NON_PERSISTENT = 1 messages will only be kept in memory \\ | deliveryMode | NON_PERSISTENT = 1 (default) messages will be kept only in memory \\ \\ PERSISTENT = 2&nbsp;&nbsp;&nbsp; messages will be persisted to disk \\ | | priority | 4 | Priority for the messages. Default is 4. See your JMS provider doc for details | | timeToLive | 0 | After this time the message will be discarded by the jms provider (default 0). | | sessionTransacted | false | true means JMS transactions are used \\ | | sessionTransacted | If true, means JMS transactions are used. (Default is false). \\ | | concurrentConsumers | 1 | minimum Minimum number of concurrent consumers for listener (default 1). | | maxConcurrentConsumers | 1 | maximum Maximum number of concurrent consumers for listener | (default 1).| | maxConcurrentTasks | 10 | Maximum number of threads that handle the received requests (available from cxf 2.1.4 upwards) | | maxConcurrentTasks | Maximum number of threads that handle the received requests (Default 10). | | messageSelector | | jms selector to filter incoming messages (allows to share a queue) | | subscriptionDurable \\ | false | | | subscriptionDurable \\ | Default false. | | durableSubscriptionName \\ | | | messageType | text | text (default) binary \\ byte \\ | | pubSubDomain | false | false (default) means use queues true means use topics \\ | | jmsProviderTibcoEms | false | 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) | | useMessageIDAsCorrelationID | false | Specifies whether the If true, specifies JMS broker will use the message ID to correlate messages. By default (false) a CXF client will set a generated correlation id instead | \\ Full Content In older CXF version the JMS transport is configured by defining a JMSConduit or JMSDestination. Starting with CXF 2.0.9 and 2.1.3 the JMS transport includes an easier configuration option that is more conformant to the spring dependency injection. Additionally the new configuration has much more options. For example it is not necessary anymore to use JNDI to resolve the connection factory. Instead it can be defined in the spring config. The following example configs use the p-namespace from spring 2.5 but the old spring bean style is also possible. Inside a features element the JMSConfigFeature can be defined. <jaxws:client id="CustomerService" xmlns:customer="http://customerservice.example.com/" serviceName="customer:CustomerServiceService" endpointName="customer:CustomerServiceEndpoint" address="jms://" serviceClass="com.example.customerservice.CustomerService"> <jaxws:features> <bean xmlns="http://www.springframework.org/schema/beans" class="org.apache.cxf.transport.jms.JMSConfigFeature" p:jmsConfig-ref="jmsConfig"/> </jaxws:features> </jaxws:client> In the above example it references a bean "jmsConfig" where the whole configuration for the JMS transport can be done. A jaxws Endpoint can be defined in the same way: <jaxws:endpoint xmlns:customer="http://customerservice.example.com/" id="CustomerService" address="jms://" serviceName="customer:CustomerServiceService" endpointName="customer:CustomerServiceEndpoint" implementor="com.example.customerservice.impl.CustomerServiceImpl"> <jaxws:features> <bean class="org.apache.cxf.transport.jms.JMSConfigFeature" p:jmsConfig-ref="jmsConfig" /> </jaxws:features> </jaxws:endpoint> The JMSConfiguration bean needs at least a reference to a conncection factory and a target destination. <bean id="jmsConfig" class="org.apache.cxf.transport.jms.JMSConfiguration" p:connectionFactory-ref="jmsConnectionFactory" p:targetDestination="test.cxf.jmstransport.queue" /> If your ConnectionFactory does not cache connections you should wrap it in a spring SingleConnectionFactory. This is necessary because the JMS Transport creates a new connection for each message and the SingleConnectionFactory is needed to cache this connection. <bean id="jmsConnectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory"> <property name="targetConnectionFactory"> <bean class="org.apache.activemq.ActiveMQConnectionFactory"> <property name="brokerURL" value="tcp://localhost:61616" /> </bean> </property> </bean> JMSConfiguration options: Name Description connectionFactory 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 wrapInSingleConnectionFactory Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport. Default is true. reconnectOnException 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. targetDestination JNDI name or provider specific name of a destination. Example for ActiveMQ: test.cxf.jmstransport.queue replyDestination destinationResolver 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. transactionManager Reference to a spring transaction manager. This allows to take part in JTA Transactions with your webservice. taskExecutor Reference to a spring TaskExecutor. This is used in listeners to decide how to handle incoming messages. Default is a spring SimpleAsyncTaskExecutor. useJms11 true means JMS 1.1 features are used false means only JMS 1.0.2 features are used. Default is false. messageIdEnabled Default is true. messageTimestampEnabled Default is true. cacheLevel Specify the level of caching that the JMS listener container is allowed to apply. Please check out the java doc of the org.springframework.jms.listenerDefaultMessageListenerContainer for more information. Default is -1. pubSubNoLocal If true, do not receive your own messages when using topics. Default is false. receiveTimeout How many milliseconds to wait for response messages. 0 (default) means wait indefinitely. explicitQosEnabled If true, means that QoS parameters are set for each message. Default is false. deliveryMode NON_PERSISTENT = 1 (default) messages will be kept only in memory PERSISTENT = 2    messages will be persisted to disk priority Priority for the messages. Default is 4. See your JMS provider doc for details timeToLive After this time the message will be discarded by the jms provider (default 0). sessionTransacted If true, means JMS transactions are used. (Default is false). concurrentConsumers Minimum number of concurrent consumers for listener (default 1). maxConcurrentConsumers Maximum number of concurrent consumers for listener (default 1). maxConcurrentTasks Maximum number of threads that handle the received requests (Default 10). messageSelector jms selector to filter incoming messages (allows to share a queue) subscriptionDurable Default false. durableSubscriptionName   messageType text (default) binary byte pubSubDomain false (default) means use queues true means use topics jmsProviderTibcoEms 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) useMessageIDAsCorrelationID If true, specifies JMS broker will use the message ID to correlate messages. By default (false) a CXF client will set a generated correlation id instead Change Notification Preferences View Online | View Changes | Add Comment