Element Summary

Element	Description	Class
component	A jms component	org.apache.servicemix.jms.JmsComponent
configuration		org.apache.servicemix.jms.JmsConfiguration
consumer		org.apache.servicemix.jms.endpoints.JmsConsumerEndpoint
endpoint	A jms endpoint	org.apache.servicemix.jms.JmsEndpoint
jca-consumer		org.apache.servicemix.jms.endpoints.JmsJcaConsumerEndpoint
provider	A Spring-based JMS provider endpoint	org.apache.servicemix.jms.endpoints.JmsProviderEndpoint
soap-consumer		org.apache.servicemix.jms.endpoints.JmsSoapConsumerEndpoint
soap-provider		org.apache.servicemix.jms.endpoints.JmsSoapProviderEndpoint

Element Detail

Element: component

Element	Type	Description
authenticationService	<spring:bean/>
configuration	configuration
endpoints	(consumer \| endpoint \| jca-consumer \| provider \| soap-consumer \| soap-provider)*
keystoreManager	<spring:bean/>

Element: configuration

Attribute	Type	Description
authenticationServiceName	xs:string
jndiConnectionFactoryName	xs:string
jndiInitialContextFactory	xs:string
jndiProviderUrl	xs:string
keystoreManagerName	xs:string
password	xs:string
processorName	xs:string
userName	xs:string

Element	Type	Description
authenticationService	<spring:bean/>
connectionFactory	<spring:bean/>	Default ConnectionFactory to use in a spring configuration.
keystoreManager	<spring:bean/>

Element: consumer

Attribute	Type	Description
cacheLevel	xs:integer
clientId	xs:string
concurrentConsumers	xs:integer
destinationName	xs:string
durableSubscriptionName	xs:string
endpoint	xs:string
idleTaskExecutionLimit	xs:integer	Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in case of dynamic scheduling; see the "maxConcurrentConsumers" setting). Within each task execution, a number of message reception attempts (according to the "maxMessagesPerTask" setting) will each wait for an incoming message (according to the "receiveTimeout" setting). If all of those receive attempts in a given task return without a message, the task is considered idle with respect to received messages. Such a task may still be rescheduled; however, once it reached the specified "idleTaskExecutionLimit", it will shut down (in case of dynamic scaling). Raise this limit if you encounter too frequent scaling up and down. With this limit being higher, an idle consumer will be kept around longer, avoiding the restart of a consumer once a new load of messages comes in. Alternatively, specify a higher "maxMessagePerTask" and/or "receiveTimeout" value, which will also lead to idle consumers being kept around for a longer time (while also increasing the average execution time of each scheduled task). This property is only used for consumers whose `listenerType` property is set to `default`.
interfaceName	xs:QName
jms102	xs:boolean
listenerType	xs:string
maxConcurrentConsumers	xs:integer	Specifies the maximum number of concurrent consumers created by the listener. If this setting is higher than "concurrentConsumers", the listener container will dynamically schedule new consumers at runtime, provided that enough incoming messages are encountered. Once the load goes down again, the number of consumers will be reduced to the standard level ("concurrentConsumers") again. This property is only used for consumers whose `listenerType` property is set to `default`.
maxMessagesPerTask	xs:integer
messageSelector	xs:string
pubSubDomain	xs:boolean
pubSubNoLocal	xs:boolean
receiveTimeout	xs:long
recoveryInterval	xs:long
replyDeliveryMode	xs:integer
replyDestinationName	xs:string
replyExplicitQosEnabled	xs:boolean
replyPriority	xs:integer
replyTimeToLive	xs:long
service	xs:QName
sessionAcknowledgeMode	xs:integer
stateless	xs:boolean
subscriptionDurable	xs:boolean
synchronous	xs:boolean
targetEndpoint	xs:string
targetInterface	xs:QName
targetOperation	xs:QName
targetService	xs:QName
targetUri	xs:string
transacted	xs:string

Element	Type	Description
component	component
connectionFactory	<spring:bean/>
definition	<spring:bean/>
description	<spring:bean/>
destination	<spring:bean/>
destinationChooser	<spring:bean/>
destinationResolver	<spring:bean/>
exceptionListener	<spring:bean/>
marshaler	<spring:bean/>
replyDestination	<spring:bean/>
replyProperties	<spring:bean/>
serverSessionFactory	<spring:bean/>
serviceUnit	<spring:bean/>
store	<spring:bean/>
storeFactory	<spring:bean/>
useMessageIdInResponse	<spring:bean/>

Element: endpoint

Attribute	Type	Description
defaultMep	xs:string
defaultOperation	xs:QName
destinationStyle	xs:string	Used to select the destination type used with the jmsProviderDestinationName. Can be `queue` or `topic`.
endpoint	xs:string
initialContextFactory	xs:string	The class name of the JNDI InitialContextFactory to use.
interfaceName	xs:QName
jmsProviderDestinationName	xs:string	The name of the destination create by a call to `Session.createQueue` or `Session.createTopic`. This property is used when `destination` and `jndiDestinationName` are both `null`.
jmsProviderReplyToName	xs:string	The name of the reply destination create by a call to `Session.createQueue` or `Session.createTopic`. This property is used when `jndiReplyToName` is `null`. Optional: a temporary queue will be used if a replyTo is not provided.
jndiConnectionFactoryName	xs:string	The name of the JMS ConnectionFactory to lookup in JNDI. Used if `connectionFactory` is `null`
jndiDestinationName	xs:string	The name of the JMS Destination to lookup in JNDI. Used if `destination` is `null`.
jndiProviderURL	xs:string	The provider URL used to create the JNDI context.
jndiReplyToName	xs:string	The name of the JMS Reply-to destination to lookup in JNDI. Optional: a temporary queue will be used if a replyTo is not provided.
needJavaIdentifiers	xs:boolean
processorName	xs:string	Specifies the processor family to use for this endpoint. Can be: `multiplexing` (default) `standard` `jca`
role	xs:string	The role of this endpoint. Must be `consumer` or `provider`.
roleAsString	xs:string
rollbackOnError	xs:boolean
service	xs:QName
soap	xs:boolean
soapVersion	xs:string
synchronous	xs:boolean	For a JCA consumer endpoint, indicates if the JBI exchange should be sent synchronously or asynchronously. This changes the transaction boundary.
targetEndpoint	xs:string
targetInterfaceName	xs:QName
targetService	xs:QName
useMsgIdInResponse	xs:boolean	Determines whether for a request/response pattern, the message id of the request message should be used as the correlation id in the response or the correlation id of the request.

Element	Type	Description
activationSpec	<spring:bean/>	The ActivatioSpec to use on this JCA consumer endpoint.
bootstrapContext	<spring:bean/>	The BootstrapContext to use for a JCA consumer endpoint.
connectionFactory	<spring:bean/>	A configured ConnectionFactory to use on this endpoint.
definition	<spring:bean/>
description	<spring:bean/>
destination	<spring:bean/>	A configured Destination to use on this endpoint.
marshaler	<spring:bean/>
policies	(<spring:bean/>)*
resourceAdapter	<spring:bean/>	The ResourceAdapter to use on this JCA consumer endpoint.
serviceUnit	<spring:bean/>
store	<spring:bean/>
storeFactory	<spring:bean/>
wsdlResource	<spring:bean/>

Element: jca-consumer

Attribute	Type	Description
endpoint	xs:string
interfaceName	xs:QName
jms102	xs:boolean
pubSubDomain	xs:boolean
replyDeliveryMode	xs:integer
replyDestinationName	xs:string
replyExplicitQosEnabled	xs:boolean
replyPriority	xs:integer
replyTimeToLive	xs:long
service	xs:QName
stateless	xs:boolean
synchronous	xs:boolean
targetEndpoint	xs:string
targetInterface	xs:QName
targetOperation	xs:QName
targetService	xs:QName
targetUri	xs:string

Element	Type	Description
activationSpec	<spring:bean/>
bootstrapContext	<spring:bean/>
connectionFactory	<spring:bean/>
definition	<spring:bean/>
description	<spring:bean/>
destinationChooser	<spring:bean/>
destinationResolver	<spring:bean/>
marshaler	<spring:bean/>
replyDestination	<spring:bean/>
replyProperties	<spring:bean/>
resourceAdapter	<spring:bean/>
serviceUnit	<spring:bean/>
store	<spring:bean/>
storeFactory	<spring:bean/>
useMessageIdInResponse	<spring:bean/>

Element: provider

Attribute	Type	Description
deliveryMode	xs:integer	Specifies the JMS delivery mode used for the reply. Defaults to (2)(`PERSISTENT`).
destinationName	xs:string	Specifies a string identifying the JMS destination used to send messages. The destination is resolved using the `DesitinationResolver`.
endpoint	xs:string
explicitQosEnabled	xs:boolean	Specifies if the QoS values specified for the endpoint are explicitly used when a messages is sent. The default is `false`.
interfaceName	xs:QName
jms102	xs:boolean	Determines if the provider used JMS 1.0.2 compliant APIs.
messageIdEnabled	xs:boolean	Specifies if your endpoint requires JMS message IDs. Setting the `messageIdEnabled` property to `false` causes the endpoint to call its message producer's `setDisableMessageID()` with a value of `true`. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it.
messageTimestampEnabled	xs:boolean	Specifies if your endpoints requires time stamps on its messages. Setting the `messageTimeStampEnabled` property to `false` causes the endpoint to call its message producer's `setDisableMessageTimestamp()` method with a value of `true`. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it.
priority	xs:integer	Specifies the priority assigned to the JMS messages. Defaults to 4.
pubSubDomain	xs:boolean	Specifies if the destination is a topic. `true` means the destination is a topic. `false` means the destination is a queue.
pubSubNoLocal	xs:boolean	Specifies if messages published by the listener's `Connection` are suppressed. The default is `false`.
receiveTimeout	xs:long	Specifies the timeout for receiving a message in milliseconds.
replyDestinationName	xs:string	Sets the name of the reply destination. This property will be used to create the `replyDestination` using the `destinationResolver` when the endpoint starts if the `replyDestination` has not been set.
service	xs:QName
stateless	xs:boolean
timeToLive	xs:long	Specifies the number of milliseconds a message is valid.

Element	Type	Description
connectionFactory	<spring:bean/>	Specifies the `ConnectionFactory` used by the endpoint.
definition	<spring:bean/>
description	<spring:bean/>
destination	<spring:bean/>	Specifies the JMS `Destination` used to send messages.
destinationChooser	<spring:bean/>	Specifies a class implementing logic for choosing the destination used to send messages.
destinationResolver	<spring:bean/>	Specifies the class implementing logic for converting strings into destinations. The default is `DynamicDestinationResolver`.
marshaler	<spring:bean/>	Specifies the class implementing the message marshaler. The message marshaller is responsible for marshalling and unmarshalling JMS messages. The default is `DefaultProviderMarshaler`.
replyDestination	<spring:bean/>	Sets the reply destination. This JMS destination will be used as the default destination for the response messages when using an InOut JBI exchange. It will be used if the `replyDestinationChooser` does not return any value.
replyDestinationChooser	<spring:bean/>	Specifies a class implementing logic for choosing the destination used to recieve replies.
serviceUnit	<spring:bean/>
store	<spring:bean/>	Sets the store used to store JBI exchanges that are waiting for a response JMS message. The store will be automatically created if not set.
storeFactory	<spring:bean/>	Sets the store factory used to create the store. If none is set, a {@link MemoryStoreFactory} will be created and used instead.

Element: soap-consumer

Attribute	Type	Description
cacheLevel	xs:integer
clientId	xs:string
concurrentConsumers	xs:integer
destinationName	xs:string
durableSubscriptionName	xs:string
endpoint	xs:string
idleTaskExecutionLimit	xs:integer	Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in case of dynamic scheduling; see the "maxConcurrentConsumers" setting). Within each task execution, a number of message reception attempts (according to the "maxMessagesPerTask" setting) will each wait for an incoming message (according to the "receiveTimeout" setting). If all of those receive attempts in a given task return without a message, the task is considered idle with respect to received messages. Such a task may still be rescheduled; however, once it reached the specified "idleTaskExecutionLimit", it will shut down (in case of dynamic scaling). Raise this limit if you encounter too frequent scaling up and down. With this limit being higher, an idle consumer will be kept around longer, avoiding the restart of a consumer once a new load of messages comes in. Alternatively, specify a higher "maxMessagePerTask" and/or "receiveTimeout" value, which will also lead to idle consumers being kept around for a longer time (while also increasing the average execution time of each scheduled task). This property is only used for consumers whose `listenerType` property is set to `default`.
interfaceName	xs:QName
jms102	xs:boolean
listenerType	xs:string
maxConcurrentConsumers	xs:integer	Specifies the maximum number of concurrent consumers created by the listener. If this setting is higher than "concurrentConsumers", the listener container will dynamically schedule new consumers at runtime, provided that enough incoming messages are encountered. Once the load goes down again, the number of consumers will be reduced to the standard level ("concurrentConsumers") again. This property is only used for consumers whose `listenerType` property is set to `default`.
maxMessagesPerTask	xs:integer
messageSelector	xs:string
pubSubDomain	xs:boolean
pubSubNoLocal	xs:boolean
receiveTimeout	xs:long
recoveryInterval	xs:long
replyDeliveryMode	xs:integer
replyDestinationName	xs:string
replyExplicitQosEnabled	xs:boolean
replyPriority	xs:integer
replyTimeToLive	xs:long
service	xs:QName
sessionAcknowledgeMode	xs:integer
stateless	xs:boolean
subscriptionDurable	xs:boolean
synchronous	xs:boolean
targetEndpoint	xs:string
targetInterface	xs:QName
targetOperation	xs:QName
targetService	xs:QName
targetUri	xs:string
transacted	xs:string
useJbiWrapper	xs:boolean
validateWsdl	xs:boolean

Element	Type	Description
component	component
connectionFactory	<spring:bean/>
definition	<spring:bean/>
description	<spring:bean/>
destination	<spring:bean/>
destinationChooser	<spring:bean/>
destinationResolver	<spring:bean/>
exceptionListener	<spring:bean/>
marshaler	<spring:bean/>
policies	(<spring:bean/>)*
replyDestination	<spring:bean/>
replyProperties	<spring:bean/>
serverSessionFactory	<spring:bean/>
serviceUnit	<spring:bean/>
store	<spring:bean/>
storeFactory	<spring:bean/>
useMessageIdInResponse	<spring:bean/>
wsdl	<spring:bean/>

Element: soap-provider

Attribute	Type	Description
deliveryMode	xs:integer	Specifies the JMS delivery mode used for the reply. Defaults to (2)(`PERSISTENT`).
destinationName	xs:string	Specifies a string identifying the JMS destination used to send messages. The destination is resolved using the `DesitinationResolver`.
endpoint	xs:string
explicitQosEnabled	xs:boolean	Specifies if the QoS values specified for the endpoint are explicitly used when a messages is sent. The default is `false`.
interfaceName	xs:QName
jms102	xs:boolean	Determines if the provider used JMS 1.0.2 compliant APIs.
messageIdEnabled	xs:boolean	Specifies if your endpoint requires JMS message IDs. Setting the `messageIdEnabled` property to `false` causes the endpoint to call its message producer's `setDisableMessageID()` with a value of `true`. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it.
messageTimestampEnabled	xs:boolean	Specifies if your endpoints requires time stamps on its messages. Setting the `messageTimeStampEnabled` property to `false` causes the endpoint to call its message producer's `setDisableMessageTimestamp()` method with a value of `true`. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it.
priority	xs:integer	Specifies the priority assigned to the JMS messages. Defaults to 4.
pubSubDomain	xs:boolean	Specifies if the destination is a topic. `true` means the destination is a topic. `false` means the destination is a queue.
pubSubNoLocal	xs:boolean	Specifies if messages published by the listener's `Connection` are suppressed. The default is `false`.
receiveTimeout	xs:long	Specifies the timeout for receiving a message in milliseconds.
replyDestinationName	xs:string	Sets the name of the reply destination. This property will be used to create the `replyDestination` using the `destinationResolver` when the endpoint starts if the `replyDestination` has not been set.
service	xs:QName
stateless	xs:boolean
timeToLive	xs:long	Specifies the number of milliseconds a message is valid.
useJbiWrapper	xs:boolean
validateWsdl	xs:boolean

Element	Type	Description
connectionFactory	<spring:bean/>	Specifies the `ConnectionFactory` used by the endpoint.
definition	<spring:bean/>
description	<spring:bean/>
destination	<spring:bean/>	Specifies the JMS `Destination` used to send messages.
destinationChooser	<spring:bean/>	Specifies a class implementing logic for choosing the destination used to send messages.
destinationResolver	<spring:bean/>	Specifies the class implementing logic for converting strings into destinations. The default is `DynamicDestinationResolver`.
marshaler	<spring:bean/>	Specifies the class implementing the message marshaler. The message marshaller is responsible for marshalling and unmarshalling JMS messages. The default is `DefaultProviderMarshaler`.
policies	(<spring:bean/>)*
replyDestination	<spring:bean/>	Sets the reply destination. This JMS destination will be used as the default destination for the response messages when using an InOut JBI exchange. It will be used if the `replyDestinationChooser` does not return any value.
replyDestinationChooser	<spring:bean/>	Specifies a class implementing logic for choosing the destination used to recieve replies.
serviceUnit	<spring:bean/>
store	<spring:bean/>	Sets the store used to store JBI exchanges that are waiting for a response JMS message. The store will be automatically created if not set.
storeFactory	<spring:bean/>	Sets the store factory used to create the store. If none is set, a {@link MemoryStoreFactory} will be created and used instead.
wsdl	<spring:bean/>