| FUSE ESB 4.2 XML Configuration Reference | ||||||
| SUMMARY: DOCUMENTATION | ELEMENTS | ATTRIBUTES | FRAMES | NO FRAMES | ||||||
http://servicemix.apache.org/jms/1.0)>http://servicemix.apache.org/jms/1.0)
A Spring-based JMS consumer optimized for handling SOAP messages
| Nested Element Summary | |||||||||||||||||||||||||||||||
| sequence |
|
||||||||||||||||||||||||||||||
| Attribute Summary | |
integer | cacheLevel
Specifies the level of caching allowed by the listener. |
string | clientId
Specifies the JMS client id for a shared <code>Connection</code> created and used by this listener. |
string | component
|
integer | concurrentConsumers
Specifies the number of concurrent consumers created by the listener. |
string | connectionFactory
Specifies the <code>ConnectionFactory</code> used by the endpoint. |
string | destination
Specifies the JMS <code>Destination</code> used to receive messages. |
string | destinationChooser
Specifies a class implementing logic for choosing reply destinations. |
string | destinationName
Specifies a string identifying the JMS destination used to recieve messages. |
string | destinationResolver
Specifies the class implementing logic for converting strings into destinations. |
string | durableSubscriptionName
Specifies the name used to register the durable subscription. |
string | endpoint
The name of the endpoint. |
string | exceptionListener
Specifies an <code>ExceptionListener</code> to notify in case of a <code>JMSException</code> is thrown by the registered message listener or the invocation infrastructure. |
ID | id
|
integer | idleTaskExecutionLimit
Specifies the limit for idle executions of a receive task, not having received any message within its execution. |
QName | interfaceName
The qualified name of the interface exposed by the endpoint. |
boolean | jms102
Specifies if the consumer uses JMS 1.0.2 compliant APIs. |
string | listenerType
Specifies the type of Spring JMS message listener to use. |
string | marshaler
Specifies the class implementing the message marshaler. |
integer | maxConcurrentConsumers
Specifies the maximum number of concurrent consumers created by the listener. |
integer | maxMessagesPerTask
Specifies the number of attempts to receive messages per task. |
string | messageSelector
Specifies the message selector string to use. |
boolean | pubSubDomain
Specifies if the destination is a topic. |
boolean | pubSubNoLocal
Specifies if messages published by the listener's <code>Connection</code> are suppressed. |
long | receiveTimeout
Specifies the timeout for receiving a message in milliseconds. |
long | recoveryInterval
Specifies the interval, in milliseconds, between attempts to recover after a failed listener set-up. |
integer | replyDeliveryMode
Specifies the JMS delivery mode used for the reply. |
string | replyDestination
Specifies the JMS <code>Destination</code> for the replies. |
string | replyDestinationName
Specifies the name of the JMS destination to use for the reply. |
boolean | replyExplicitQosEnabled
Specifies if the QoS values specified for the endpoint are explicitly used when the reply is sent. |
integer | replyPriority
Specifies the JMS message priority of the reply. |
string | replyProperties
Specifies custom properties to be placed in the reply's JMS header. |
long | replyTimeToLive
Specifies the number of milliseconds the reply message is valid. |
string | serverSessionFactory
Specifies the <code>ServerSessionFactory</code> to use. |
QName | service
The qualified name of the service the endpoint exposes. |
string | serviceUnit
|
integer | sessionAcknowledgeMode
Specifies the acknowledgment mode that is used when creating a <code>Session</code> to send a message. |
boolean | stateless
Specifies if the consumer retains state information about the message exchange while it is in process. |
string | store
Specifies the persistent store used to store JBI exchanges that are waiting to be processed. |
string | storeFactory
Specifies the store factory used to create the store. |
boolean | subscriptionDurable
Specifies if the listener uses a durable subscription to listen for messages. |
boolean | synchronous
Specifies if the consumer will block while waiting for a response. |
string | targetEndpoint
the name of the endpoint to which requests are sent |
QName | targetInterface
the QName of the interface to which requests are sent |
QName | targetOperation
the QName of the operation to which requests are sent |
QName | targetService
the QName of the service to which requests are sent |
string | targetUri
|
string | transacted
Specifies the type of transaction used to wrap the message exchanges. |
boolean | useJbiWrapper
Specifies if the endpoint expects SOAP messages to be wrapped in the JBI wrapper. |
string | useMessageIdInResponse
Specifies if the request message's ID is used as the reply's correlation ID. |
boolean | validateWsdl
Specifies if the WSDL is checked WSI-BP compliance. |
string | wsdl
Specifies the WSDL document describing the service's interface. |
| Attribute Detail |
Specifies the level of caching allowed by the listener. Valid values are
0 through 3. The values map to the following:
<ul>
<li>0 - <code>CACHE_NONE</code></li>
<li>1 - <code>CACHE_CONNECTION</code></li>
<li>2 - <code>CACHE_SESSION</code></li>
<li>3 - <code>CACHE_CONSUMER</code></li>
</ul>
The default is <code>CACHE_NONE</code>.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to <code>default</code>.
Defined with global type integer
Specifies the JMS client id for a shared <code>Connection</code> created and used by
this listener.
Defined with global type string
Defined with global type string
Specifies the number of concurrent consumers created by the listener.
This property is only used for consumers whose <code>listenerType</code>
property is set to either <code>simple</code> or <code>default</code>.
Defined with global type integer
Specifies the <code>ConnectionFactory</code> used by the endpoint.
Defined with global type string
Specifies the JMS <code>Destination</code> used to receive messages.
Defined with global type string
Specifies a class implementing logic for choosing reply destinations.
Defined with global type string
Specifies a string identifying the JMS destination used to recieve
messages. The destination is resolved using the
<code>DesitinationResolver</code>.
Defined with global type string
Specifies the class implementing logic for converting strings into
destinations. The default is <code>DynamicDestinationResolver</code>.
Defined with global type string
Specifies the name used to register the durable subscription.
Defined with global type string
The name of the endpoint.
Defined with global type string
Specifies an <code>ExceptionListener</code> to notify in case of a
<code>JMSException</code> is thrown by the registered message listener or
the invocation infrastructure.
Defined with global type string
Defined with global type ID
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 <code>listenerType</code>
property is set to <code>default</code>.
Defined with global type integer
The qualified name of the interface exposed by the endpoint.
Defined with global type QName
Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to <code>false</code>.
Defined with global type boolean
Specifies the type of Spring JMS message listener to use. Valid values
are: <code>default</code>, <code>simple</code>, and <code>server</code>.
Defined with global type string
Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is <code>DefaultConsumerMarshaler</code>.
Defined with global type string
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 <code>listenerType</code>
property is set to <code>default</code>.
Defined with global type integer
Specifies the number of attempts to receive messages per task. The
default is -1 which specifies an unlimited number of attempts.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to either <code>default</code> or <code>simple</code>.
Defined with global type integer
Specifies the message selector string to use. The message selector string
should conform to the descrition in the JMS spec.
Defined with global type string
Specifies if the destination is a topic. <code>true</code> means the
destination is a topic. <code>false</code> means the destination is a
queue.
Defined with global type boolean
Specifies if messages published by the listener's <code>Connection</code>
are suppressed. The default is <code>false</code>.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to either <code>default</code> or <code>simple</code>.
Defined with global type boolean
Specifies the timeout for receiving a message in milliseconds. Defaults
to 1000.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to <code>default</code>.
Defined with global type long
Specifies the interval, in milliseconds, between attempts to recover after
a failed listener set-up. Defaults to 5000.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to <code>default</code>.
Defined with global type long
Specifies the JMS delivery mode used for the reply. Defaults to
2(<code>PERSISTENT</code>).
Defined with global type integer
Specifies the JMS <code>Destination</code> for the replies. If this value
is not set the endpoint will use the <code>destinationChooser</code>
property or the <code>replyDestinationName</code> property to determine
the desitination to use.
Defined with global type string
Specifies the name of the JMS destination to use for the reply. The
actual JMS destination is resolved using the
<code>DestinationResolver</code> specified by the
<code>.destinationResolver</code> property.
Defined with global type string
Specifies if the QoS values specified for the endpoint are explicitly
used when the reply is sent. The default is <code>false</code>.
Defined with global type boolean
Specifies the JMS message priority of the reply. Defaults to 4.
Defined with global type integer
Specifies custom properties to be placed in the reply's JMS header.
Defined with global type string
Specifies the number of milliseconds the reply message is valid. The
default is unlimited.
Defined with global type long
Specifies the <code>ServerSessionFactory</code> to use. The default is
<code>SimpleServerSessionFactory</code>.<br/>
This property only effects consumers whose <code>listenerType</code>
property is set to <code>server</code>.
Defined with global type string
The qualified name of the service the endpoint exposes.
Defined with global type QName
Defined with global type string
Specifies the acknowledgment mode that is used when creating a
<code>Session</code> to send a message. Deafults to
<code>Session.AUTO_ACKNOWLEDGE</code>.
Defined with global type integer
Specifies if the consumer retains state information about the message
exchange while it is in process.
Defined with global type boolean
Specifies the persistent store used to store JBI exchanges that are
waiting to be processed. The store will be automatically created if not
set and the endpoint's <code>stateless</code> property is set to
<code>false</code>.
Defined with global type string
Specifies the store factory used to create the store.
If none is set and the endpoint's <code>stateless</code> property is set
to <code>false</code>, a {@link MemoryStoreFactory} will be created
and used instead.
Defined with global type string
Specifies if the listener uses a durable subscription to listen for
messages. Defaults to <code>false</code>.
Defined with global type boolean
Specifies if the consumer will block while waiting for a response. This
means the consumer can only process one message at a time. Defaults to
<code>true</code>.
Defined with global type boolean
the name of the endpoint to which requests are sent
Defined with global type string
the QName of the interface to which requests are sent
Defined with global type QName
the QName of the operation to which requests are sent
Defined with global type QName
the QName of the service to which requests are sent
Defined with global type QName
Defined with global type string
Specifies the type of transaction used to wrap the message exchanges.
Valid values are <code>none</code>, <code>xa</code>, and <code>jms</code>.
Defined with global type string
Specifies if the endpoint expects SOAP messages to be wrapped in the JBI
wrapper. Defaults to <code>true</code>.
Defined with global type boolean
Specifies if the request message's ID is used as the reply's correlation
ID. The default behavior is to use the request's correlation ID. Setting
this to <code>true</code> means the request's message ID will be used
instead.
Defined with global type string
Specifies if the WSDL is checked WSI-BP compliance. Defaults to
<code>true</code>.
Defined with global type boolean
Specifies the WSDL document describing the service's interface.
Defined with global type string
| FUSE ESB 4.2 XML Configuration Reference | ||||||
| SUMMARY: DOCUMENTATION | ELEMENTS | ATTRIBUTES | FRAMES | NO FRAMES | ||||||