Skip to main content

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

This option was removed since CXF 3.0.0. Will wrap the connectionFactory with a Spring SingleConnectionFactory, which can improve the performance of the jms transport. Default is true.

reconnectOnException

(deprecated) 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 reconnect on exceptions

targetDestination

JNDI name or provider specific name of a destination. Example for ActiveMQ: test.cxf.jmstransport.queue

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. You can also register a spring JMS Transaction Manager to have local transactions.

taskExecutor

This option was removed since CXF 3.0.0. Reference to a Spring TaskExecutor. This is used in listeners to decide how to handle incoming messages. Default is a Spring SimpleAsyncTaskExecutor.

useJms11

This option was removed since CXF 3.0.0. 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. This option was removed since CXF 3.0.0.

messageTimestampEnabled

Default is true. This option was removed since CXF 3.0.0.

cacheLevel

This option was removed since CXF 3.0.0. Specify the level of caching that the JMS listener container is allowed to apply. (Default is -1) Please check out the java doc of the org.springframework. jms.listener. DefaultMessageListenerContainer for more information

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. since CXF 3.0, the default value is changed to 60000 (60 seconds)

explicitQosEnabled

If true, means that QoS parameters are set for each message. (Default is false.)

deliveryMode

NON_PERSISTENT = 1 messages will only be kept in memory

PERSISTENT = 2 (default) 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 is 0.

sessionTransacted

If true, means JMS transactions are used. 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.

concurrentConsumers

This option was removed since CXF 3.0.0. Minimum number of concurrent consumers for listener (default is 1).

maxConcurrentConsumers

This option was removed since CXF 3.0.0. Maximum number of concurrent consumers for listener (default 1).

maxConcurrentTasks

This option was removed since CXF 3.0.0. (deprecated) 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 is 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)

maxSuspendedContinuations

Since CXF 3.0.0, The max suspended continuations that the JMS destination could have, if the current suspended continuations number exceeds the max value, the JMSListenerContainer will be stopped. The default value is -1, which means disable this feature.

reconnectPercentOfMax

Since CXF 3.0.0, If the 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 (maxSuspendedContinuations*reconnectPercentOfMax/100). The default value is 70.

createSecurityContext

(Since 2.7.14, 3.0.3) true (default) means create user security context for incoming messages.

propogateExceptions

(Since 2.7.15) 2.7.x only 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.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!