• Home
• org.apache.servicemix
• servicemix-jms
• 2013.01
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

rvicemix.servicemix-jms.2013.01.source-code.servicemix-jms.xsd.wiki Maven / Gradle / Ivy

h3. Elements By Type
{anchor:org.apache.servicemix.common.DefaultComponent-types}
h4. The _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ Type Implementations
    | _[|#component-element]_ | {html}JMS JBI binding component{html} |

{anchor:org.apache.servicemix.jms.JmsConfiguration-types}
h4. The _[org.apache.servicemix.jms.JmsConfiguration|#org.apache.servicemix.jms.JmsConfiguration-types]_ Type Implementations
    | _[|#configuration-element]_ | {html}Bean for configuring JMS connections{html} |

{anchor:org.apache.servicemix.jms.JmsEndpointType-types}
h4. The _[org.apache.servicemix.jms.JmsEndpointType|#org.apache.servicemix.jms.JmsEndpointType-types]_ Type Implementations
    | _[|#consumer-element]_ | {html}A Sping-based JMS consumer endpoint.{html} |
    | _[|#endpoint-element]_ | {html}non-Spring JMS endpoint
This JMS endpoint can be either a consumer or a provider
and is optimized to work with SOAP messages.{html} |
    | _[|#jca-consumer-element]_ | {html}A Spring-based JMS consumer that uses JCA to connect to the JMS provider{html} |
    | _[|#provider-element]_ | {html}A Spring-based JMS provider endpoint{html} |
    | _[|#soap-consumer-element]_ | {html}A Spring-based JMS consumer optimized for handling SOAP messages{html} |
    | _[|#soap-provider-element]_ | {html}A Spring-based JMS provider optimized for SOAP messages{html} |


{anchor:component-element}
h3. The _[|#component-element]_ Element
    {html}JMS JBI binding component{html}
h4. Properties
    || Property Name || Type || Description ||
    | authenticationService | _java.lang.Object_ | {html}{html} |
    | configuration | _[org.apache.servicemix.jms.JmsConfiguration|#org.apache.servicemix.jms.JmsConfiguration-types]_ | {html}Specifies the configuration bean used to set up the JMS connections for the endpoints.{html} |
    | endpoints | (_[org.apache.servicemix.jms.JmsEndpointType|#org.apache.servicemix.jms.JmsEndpointType-types]_)\* | {html}Specifies the list of endpoints hosted by the component.{html} |
    | executorFactory | _org.apache.servicemix.executors.ExecutorFactory_ | {html}The executor factory to use to create the executor.
If none is provided, one will be retrieved from the JBI container when the component
is deployed into ServiceMix 3.x, or a default implementation will be used.{html} |
    | keystoreManager | _java.lang.Object_ | {html}{html} |

{anchor:configuration-element}
h3. The _[|#configuration-element]_ Element
    {html}Bean for configuring JMS connections{html}
h4. Properties
    || Property Name || Type || Description ||
    | authenticationService | _java.lang.Object_ | {html}{html} |
    | authenticationServiceName | _java.lang.String_ | {html}{html} |
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Default ConnectionFactory to use in a spring configuration.{html} |
    | jndiConnectionFactoryName | _java.lang.String_ | {html}Specifies the JNDI name used to look up the JMS connection factory.{html} |
    | jndiInitialContextFactory | _java.lang.String_ | {html}Specifies the default JNDI initial conext factory.{html} |
    | jndiProviderUrl | _java.lang.String_ | {html}Specifies the default JNDI provider URL.{html} |
    | keystoreManager | _java.lang.Object_ | {html}{html} |
    | keystoreManagerName | _java.lang.String_ | {html}{html} |
    | password | _java.lang.String_ | {html}Specifies the password used to to create a connection.{html} |
    | processorName | _java.lang.String_ | {html}{html} |
    | userName | _java.lang.String_ | {html}Specifies the user name used to create a connection.{html} |

{anchor:consumer-element}
h3. The _[|#consumer-element]_ Element
    {html}A Sping-based JMS consumer endpoint.{html}
h4. Properties
    || Property Name || Type || Description ||
    | cacheLevel | _int_ | {html}Specifies the level of caching allowed by the listener. Valid values are
0 through 3. The values map to the following:

0 - CACHE_NONE
1 - CACHE_CONNECTION
2 - CACHE_SESSION
3 - CACHE_CONSUMER

The default is CACHE_NONE.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | clientId | _java.lang.String_ | {html}Specifies the JMS client id for a shared Connection created and used by
this listener.{html} |
    | component | _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ | {html}{html} |
    | concurrentConsumers | _int_ | {html}Specifies the number of concurrent consumers created by the listener.
This property is only used for consumers whose listenerType
property is set to either simple or default.{html} |
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Specifies the ConnectionFactory used by the endpoint.{html} |
    | destination | _javax.jms.Destination_ | {html}Specifies the JMS Destination used to receive messages.{html} |
    | destinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing reply destinations.{html} |
    | destinationName | _java.lang.String_ | {html}Specifies a string identifying the JMS destination used to recieve
messages. The destination is resolved using the
DesitinationResolver.{html} |
    | destinationResolver | _org.springframework.jms.support.destination.DestinationResolver_ | {html}Specifies the class implementing logic for converting strings into
destinations. The default is DynamicDestinationResolver.{html} |
    | durableSubscriptionName | _java.lang.String_ | {html}Specifies the name used to register the durable subscription.{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | exceptionListener | _javax.jms.ExceptionListener_ | {html}Specifies an ExceptionListener to notify in case of a
JMSException is thrown by the registered message listener or
the invocation infrastructure.{html} |
    | idleTaskExecutionLimit | _int_ | {html}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.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jms102 | _boolean_ | {html}Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to false.{html} |
    | listenerType | _java.lang.String_ | {html}Specifies the type of Spring JMS message listener to use. Valid values
are: default, simple, and server.{html} |
    | marshaler | _org.apache.servicemix.jms.endpoints.JmsConsumerMarshaler_ | {html}Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is DefaultConsumerMarshaler.{html} |
    | maxConcurrentConsumers | _int_ | {html}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.{html} |
    | maxMessagesPerTask | _int_ | {html}Specifies the number of attempts to receive messages per task. The
default is -1 which specifies an unlimited number of attempts.

This property only effects consumers whose listenerType
property is set to either default or simple.{html} |
    | messageSelector | _java.lang.String_ | {html}Specifies the message selector string to use. The message selector string
should conform to the descrition in the JMS spec.{html} |
    | pubSubDomain | _boolean_ | {html}Specifies if the destination is a topic. true means the
destination is a topic. false means the destination is a
queue.{html} |
    | pubSubNoLocal | _boolean_ | {html}Specifies if messages published by the listener's Connection
are suppressed. The default is false.

This property only effects consumers whose listenerType
property is set to either default or simple.{html} |
    | receiveTimeout | _long_ | {html}Specifies the timeout for receiving a message in milliseconds. Defaults
to 1000.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | recoveryInterval | _long_ | {html}Specifies the interval, in milliseconds, between attempts to recover after
a failed listener set-up. Defaults to 5000.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | replyDeliveryMode | _int_ | {html}Specifies the JMS delivery mode used for the reply. Defaults to
2(PERSISTENT).{html} |
    | replyDestination | _javax.jms.Destination_ | {html}Specifies the JMS Destination for the replies. If this value
is not set the endpoint will use the destinationChooser
property or the replyDestinationName property to determine
the desitination to use.{html} |
    | replyDestinationName | _java.lang.String_ | {html}Specifies the name of the JMS destination to use for the reply. The
actual JMS destination is resolved using the
DestinationResolver specified by the
.destinationResolver property.{html} |
    | replyExplicitQosEnabled | _boolean_ | {html}Specifies if the QoS values specified for the endpoint are explicitly
used when the reply is sent. The default is false.{html} |
    | replyPriority | _int_ | {html}Specifies the JMS message priority of the reply. Defaults to 4.{html} |
    | replyProperties | _java.util.Map_ | {html}Specifies custom properties to be placed in the reply's JMS header.{html} |
    | replyTimeToLive | _long_ | {html}Specifies the number of milliseconds the reply message is valid. The
default is unlimited.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | serviceUnit | _org.apache.servicemix.common.ServiceUnit_ | {html}{html} |
    | sessionAcknowledgeMode | _int_ | {html}Specifies the acknowledgment mode that is used when creating a
Session to send a message. Deafults to
Session.AUTO_ACKNOWLEDGE.{html} |
    | stateless | _boolean_ | {html}Specifies if the consumer retains state information about the message
exchange while it is in process.{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}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 stateless property is set to
false.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Specifies the store factory used to create the store.
If none is set and the endpoint's stateless property is set
to false, a {@link MemoryStoreFactory} will be created
and used instead.{html} |
    | subscriptionDurable | _boolean_ | {html}Specifies if the listener uses a durable subscription to listen for
messages. Defaults to false.{html} |
    | synchronous | _boolean_ | {html}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
true.{html} |
    | targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
    | targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
    | targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
    | targetUri | _java.lang.String_ | {html}

Gets the target URI of the consumer endpoint.
{html} |
    | transacted | _java.lang.String_ | {html}Specifies the type of transaction used to wrap the message exchanges.
Valid values are none, xa, and jms.{html} |
    | useMessageIdInResponse | _java.lang.Boolean_ | {html}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 true means the request's message ID will be used
instead.{html} |

{anchor:endpoint-element}
h3. The _[|#endpoint-element]_ Element
    {html}non-Spring JMS endpoint
This JMS endpoint can be either a consumer or a provider
and is optimized to work with SOAP messages.{html}
h4. Properties
    || Property Name || Type || Description ||
    | activationSpec | _javax.resource.spi.ActivationSpec_ | {html}The ActivationSpec to use on a JCA consumer endpoint.{html} |
    | bootstrapContext | _javax.resource.spi.BootstrapContext_ | {html}The BootstrapContext to use for a JCA consumer endpoint.{html} |
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}A configured ConnectionFactory to use on this endpoint.{html} |
    | defaultMep | _java.net.URI_ | {html}{html} |
    | defaultOperation | _javax.xml.namespace.QName_ | {html}{html} |
    | description | _org.w3c.dom.Document_ | {html}{html} |
    | destination | _javax.jms.Destination_ | {html}A configured Destination to use on this endpoint.{html} |
    | destinationStyle | _java.lang.String_ | {html}Specifies the destination type used with the jmsProviderDestinationName.
Can be queue or topic.{html} |
    | dynamic | _boolean_ | {html}{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | initialContextFactory | _java.lang.String_ | {html}The class name of the JNDI InitialContextFactory to use.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jmsProviderDestinationName | _java.lang.String_ | {html}The name of the destination created by a call to
Session.createQueue or Session.createTopic.
This property is used when destination and
jndiDestinationName are
both null.{html} |
    | jmsProviderReplyToName | _java.lang.String_ | {html}The name of the reply destination created by a call to
Session.createQueue or Session.createTopic.
This property is used when jndiReplyToName is
null. A temporary queue will be used
if a replyTo is not provided.{html} |
    | jndiConnectionFactoryName | _java.lang.String_ | {html}The name of the JMS ConnectionFactory to lookup in JNDI.
Used if connectionFactory is null{html} |
    | jndiDestinationName | _java.lang.String_ | {html}The name of the JMS Destination to lookup in JNDI.
Used if destination is null.{html} |
    | jndiProviderURL | _java.lang.String_ | {html}The provider URL used to create the JNDI context.{html} |
    | jndiReplyToName | _java.lang.String_ | {html}The name of the JMS Reply-to destination to lookup in JNDI.
If this property is not set a temporary replyTo queue is used.{html} |
    | marshaler | _org.apache.servicemix.jms.JmsMarshaler_ | {html}Specifies the class implementing the logic for marshaling and
unmarshaling messages between the JMS destination and the endpoint.
Defaults to DefaultJmsMarshaler.{html} |
    | needJavaIdentifiers | _boolean_ | {html}Indicates if the JMS properties used by the endpoint need to be spec compliant.{html} |
    | policies | (_java.lang.Object_)\* | {html}{html} |
    | processorName | _java.lang.String_ | {html}Specifies the processor family to use for this endpoint.
Can be:

multiplexing (default)
standard
jca
{html} |
    | resourceAdapter | _javax.resource.spi.ResourceAdapter_ | {html}The ResourceAdapter to use on a JCA consumer endpoint.{html} |
    | role | _java.lang.String_ | {html}Specifies the role of this endpoint. Endpoints can be
consumer or provider.{html} |
    | roleAsString | _java.lang.String_ | {html}{html} |
    | rollbackOnError | _boolean_ | {html}Indicates if the JBI exchange is rolled back if an error is encountered.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | soap | _boolean_ | {html}{html} |
    | soapVersion | _java.lang.String_ | {html}{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}Specifies a persistent data store to hold pending exchanges for the
endpoint.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Specifies the factory used to create presistent data stores for this endpoint.{html} |
    | synchronous | _boolean_ | {html}Indicates if a JCA consumer endpoint sends the JBI exchange
synchronously or asynchronously.
This changes the transaction boundary.{html} |
    | targetEndpoint | _java.lang.String_ | {html}{html} |
    | targetInterfaceName | _javax.xml.namespace.QName_ | {html}{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}{html} |
    | useMsgIdInResponse | _boolean_ | {html}Indicates whether the message id of the request message
should be used as the correlation id in the response or the correlation id of the request.{html} |
    | wsdlResource | _org.springframework.core.io.Resource_ | {html}{html} |

{anchor:jca-consumer-element}
h3. The _[|#jca-consumer-element]_ Element
    {html}A Spring-based JMS consumer that uses JCA to connect to the JMS provider{html}
h4. Properties
    || Property Name || Type || Description ||
    | activationSpec | _javax.resource.spi.ActivationSpec_ | {html}Specifies the activation information needed by the endpoint.{html} |
    | bootstrapContext | _javax.resource.spi.BootstrapContext_ | {html}Specifies the BootStrapContext used to start the resource
adapter. If this property is not set, a default
BootstrpContext will be created.{html} |
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Specifies the ConnectionFactory used by the endpoint.{html} |
    | destinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing reply destinations.{html} |
    | destinationResolver | _org.springframework.jms.support.destination.DestinationResolver_ | {html}Specifies the class implementing logic for converting strings into
destinations. The default is DynamicDestinationResolver.{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jms102 | _boolean_ | {html}Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to false.{html} |
    | marshaler | _org.apache.servicemix.jms.endpoints.JmsConsumerMarshaler_ | {html}Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is DefaultConsumerMarshaler.{html} |
    | pubSubDomain | _boolean_ | {html}Specifies if the destination is a topic. true means the
destination is a topic. false means the destination is a
queue.{html} |
    | replyDeliveryMode | _int_ | {html}Specifies the JMS delivery mode used for the reply. Defaults to
2(PERSISTENT).{html} |
    | replyDestination | _javax.jms.Destination_ | {html}Specifies the JMS Destination for the replies. If this value
is not set the endpoint will use the destinationChooser
property or the replyDestinationName property to determine
the desitination to use.{html} |
    | replyDestinationName | _java.lang.String_ | {html}Specifies the name of the JMS destination to use for the reply. The
actual JMS destination is resolved using the
DestinationResolver specified by the
.destinationResolver property.{html} |
    | replyExplicitQosEnabled | _boolean_ | {html}Specifies if the QoS values specified for the endpoint are explicitly
used when the reply is sent. The default is false.{html} |
    | replyPriority | _int_ | {html}Specifies the JMS message priority of the reply. Defaults to 4.{html} |
    | replyProperties | _java.util.Map_ | {html}Specifies custom properties to be placed in the reply's JMS header.{html} |
    | replyTimeToLive | _long_ | {html}Specifies the number of milliseconds the reply message is valid. The
default is unlimited.{html} |
    | resourceAdapter | _javax.resource.spi.ResourceAdapter_ | {html}Specifies the resource adapter used for the endpoint.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | stateless | _boolean_ | {html}Specifies if the consumer retains state information about the message
exchange while it is in process.{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}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 stateless property is set to
false.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Specifies the store factory used to create the store.
If none is set and the endpoint's stateless property is set
to false, a {@link MemoryStoreFactory} will be created
and used instead.{html} |
    | synchronous | _boolean_ | {html}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
true.{html} |
    | targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
    | targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
    | targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
    | targetUri | _java.lang.String_ | {html}

Gets the target URI of the consumer endpoint.
{html} |
    | useMessageIdInResponse | _java.lang.Boolean_ | {html}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 true means the request's message ID will be used
instead.{html} |

{anchor:provider-element}
h3. The _[|#provider-element]_ Element
    {html}A Spring-based JMS provider endpoint{html}
h4. Properties
    || Property Name || Type || Description ||
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Specifies the ConnectionFactory used by the endpoint.{html} |
    | deliveryMode | _int_ | {html}Specifies the JMS delivery mode used for the reply. Defaults to
(2)(PERSISTENT).{html} |
    | destination | _javax.jms.Destination_ | {html}Specifies the JMS Destination used to send messages.{html} |
    | destinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing the destination used
to send messages.{html} |
    | destinationName | _java.lang.String_ | {html}Specifies a string identifying the JMS destination used to send
messages. The destination is resolved using the
DesitinationResolver.{html} |
    | destinationResolver | _org.springframework.jms.support.destination.DestinationResolver_ | {html}Specifies the class implementing logic for converting strings into
destinations. The default is DynamicDestinationResolver.{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | explicitQosEnabled | _boolean_ | {html}Specifies if the QoS values specified for the endpoint are explicitly
used when a messages is sent. The default is false.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jms102 | _boolean_ | {html}Determines if the provider used JMS 1.0.2 compliant APIs.{html} |
    | marshaler | _org.apache.servicemix.jms.endpoints.JmsProviderMarshaler_ | {html}Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is DefaultProviderMarshaler.{html} |
    | messageIdEnabled | _boolean_ | {html}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.{html} |
    | messageTimestampEnabled | _boolean_ | {html}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.{html} |
    | preserveMessageQos | _boolean_ | {html}Specifies whether we want to send message using the QoS settings
specified on the message instead in order to preserve message QoS.
The default is false.{html} |
    | priority | _int_ | {html}Specifies the priority assigned to the JMS messages. Defaults to 4.{html} |
    | pubSubDomain | _boolean_ | {html}Specifies if the destination is a topic. true means the
destination is a topic. false means the destination is a
queue.{html} |
    | pubSubNoLocal | _boolean_ | {html}Specifies if messages published by the listener's Connection
are suppressed. The default is false.{html} |
    | receiveTimeout | _long_ | {html}Specifies the timeout for receiving a message in milliseconds.{html} |
    | replyDestination | _javax.jms.Destination_ | {html}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.{html} |
    | replyDestinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing the destination used
to recieve replies.{html} |
    | replyDestinationName | _java.lang.String_ | {html}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.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}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.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Sets the store factory used to create the store.
If none is set, a {@link MemoryStoreFactory} will be created and used instead.{html} |
    | timeToLive | _long_ | {html}Specifies the number of milliseconds a message is valid.{html} |

{anchor:soap-consumer-element}
h3. The _[|#soap-consumer-element]_ Element
    {html}A Spring-based JMS consumer optimized for handling SOAP messages{html}
h4. Properties
    || Property Name || Type || Description ||
    | cacheLevel | _int_ | {html}Specifies the level of caching allowed by the listener. Valid values are
0 through 3. The values map to the following:

0 - CACHE_NONE
1 - CACHE_CONNECTION
2 - CACHE_SESSION
3 - CACHE_CONSUMER

The default is CACHE_NONE.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | clientId | _java.lang.String_ | {html}Specifies the JMS client id for a shared Connection created and used by
this listener.{html} |
    | component | _[org.apache.servicemix.common.DefaultComponent|#org.apache.servicemix.common.DefaultComponent-types]_ | {html}{html} |
    | concurrentConsumers | _int_ | {html}Specifies the number of concurrent consumers created by the listener.
This property is only used for consumers whose listenerType
property is set to either simple or default.{html} |
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Specifies the ConnectionFactory used by the endpoint.{html} |
    | destination | _javax.jms.Destination_ | {html}Specifies the JMS Destination used to receive messages.{html} |
    | destinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing reply destinations.{html} |
    | destinationName | _java.lang.String_ | {html}Specifies a string identifying the JMS destination used to recieve
messages. The destination is resolved using the
DesitinationResolver.{html} |
    | destinationResolver | _org.springframework.jms.support.destination.DestinationResolver_ | {html}Specifies the class implementing logic for converting strings into
destinations. The default is DynamicDestinationResolver.{html} |
    | durableSubscriptionName | _java.lang.String_ | {html}Specifies the name used to register the durable subscription.{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | exceptionListener | _javax.jms.ExceptionListener_ | {html}Specifies an ExceptionListener to notify in case of a
JMSException is thrown by the registered message listener or
the invocation infrastructure.{html} |
    | idleTaskExecutionLimit | _int_ | {html}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.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jms102 | _boolean_ | {html}Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to false.{html} |
    | listenerType | _java.lang.String_ | {html}Specifies the type of Spring JMS message listener to use. Valid values
are: default, simple, and server.{html} |
    | marshaler | _org.apache.servicemix.jms.endpoints.JmsConsumerMarshaler_ | {html}Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is DefaultConsumerMarshaler.{html} |
    | maxConcurrentConsumers | _int_ | {html}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.{html} |
    | maxMessagesPerTask | _int_ | {html}Specifies the number of attempts to receive messages per task. The
default is -1 which specifies an unlimited number of attempts.

This property only effects consumers whose listenerType
property is set to either default or simple.{html} |
    | messageSelector | _java.lang.String_ | {html}Specifies the message selector string to use. The message selector string
should conform to the descrition in the JMS spec.{html} |
    | policies | (_org.apache.servicemix.soap.api.Policy_)\* | {html}Specifies an array of interceptors used to process SOAP messages.{html} |
    | pubSubDomain | _boolean_ | {html}Specifies if the destination is a topic. true means the
destination is a topic. false means the destination is a
queue.{html} |
    | pubSubNoLocal | _boolean_ | {html}Specifies if messages published by the listener's Connection
are suppressed. The default is false.

This property only effects consumers whose listenerType
property is set to either default or simple.{html} |
    | receiveTimeout | _long_ | {html}Specifies the timeout for receiving a message in milliseconds. Defaults
to 1000.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | recoveryInterval | _long_ | {html}Specifies the interval, in milliseconds, between attempts to recover after
a failed listener set-up. Defaults to 5000.

This property only effects consumers whose listenerType
property is set to default.{html} |
    | replyDeliveryMode | _int_ | {html}Specifies the JMS delivery mode used for the reply. Defaults to
2(PERSISTENT).{html} |
    | replyDestination | _javax.jms.Destination_ | {html}Specifies the JMS Destination for the replies. If this value
is not set the endpoint will use the destinationChooser
property or the replyDestinationName property to determine
the desitination to use.{html} |
    | replyDestinationName | _java.lang.String_ | {html}Specifies the name of the JMS destination to use for the reply. The
actual JMS destination is resolved using the
DestinationResolver specified by the
.destinationResolver property.{html} |
    | replyExplicitQosEnabled | _boolean_ | {html}Specifies if the QoS values specified for the endpoint are explicitly
used when the reply is sent. The default is false.{html} |
    | replyPriority | _int_ | {html}Specifies the JMS message priority of the reply. Defaults to 4.{html} |
    | replyProperties | _java.util.Map_ | {html}Specifies custom properties to be placed in the reply's JMS header.{html} |
    | replyTimeToLive | _long_ | {html}Specifies the number of milliseconds the reply message is valid. The
default is unlimited.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | serviceUnit | _org.apache.servicemix.common.ServiceUnit_ | {html}{html} |
    | sessionAcknowledgeMode | _int_ | {html}Specifies the acknowledgment mode that is used when creating a
Session to send a message. Deafults to
Session.AUTO_ACKNOWLEDGE.{html} |
    | stateless | _boolean_ | {html}Specifies if the consumer retains state information about the message
exchange while it is in process.{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}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 stateless property is set to
false.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Specifies the store factory used to create the store.
If none is set and the endpoint's stateless property is set
to false, a {@link MemoryStoreFactory} will be created
and used instead.{html} |
    | subscriptionDurable | _boolean_ | {html}Specifies if the listener uses a durable subscription to listen for
messages. Defaults to false.{html} |
    | synchronous | _boolean_ | {html}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
true.{html} |
    | targetEndpoint | _java.lang.String_ | {html}the name of the endpoint to which requests are sent{html} |
    | targetInterface | _javax.xml.namespace.QName_ | {html}the QName of the interface to which requests are sent{html} |
    | targetOperation | _javax.xml.namespace.QName_ | {html}the QName of the operation to which requests are sent{html} |
    | targetService | _javax.xml.namespace.QName_ | {html}the QName of the service to which requests are sent{html} |
    | targetUri | _java.lang.String_ | {html}

Gets the target URI of the consumer endpoint.
{html} |
    | transacted | _java.lang.String_ | {html}Specifies the type of transaction used to wrap the message exchanges.
Valid values are none, xa, and jms.{html} |
    | useJbiWrapper | _boolean_ | {html}Specifies if the endpoint expects SOAP messages to be wrapped in the JBI
wrapper. Defaults to true.{html} |
    | useMessageIdInResponse | _java.lang.Boolean_ | {html}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 true means the request's message ID will be used
instead.{html} |
    | validateWsdl | _boolean_ | {html}Specifies if the WSDL is checked WSI-BP compliance. Defaults to
true.{html} |
    | wsdl | _org.springframework.core.io.Resource_ | {html}Specifies the WSDL document describing the service's interface.{html} |

{anchor:soap-provider-element}
h3. The _[|#soap-provider-element]_ Element
    {html}A Spring-based JMS provider optimized for SOAP messages{html}
h4. Properties
    || Property Name || Type || Description ||
    | connectionFactory | _javax.jms.ConnectionFactory_ | {html}Specifies the ConnectionFactory used by the endpoint.{html} |
    | deliveryMode | _int_ | {html}Specifies the JMS delivery mode used for the reply. Defaults to
(2)(PERSISTENT).{html} |
    | destination | _javax.jms.Destination_ | {html}Specifies the JMS Destination used to send messages.{html} |
    | destinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing the destination used
to send messages.{html} |
    | destinationName | _java.lang.String_ | {html}Specifies a string identifying the JMS destination used to send
messages. The destination is resolved using the
DesitinationResolver.{html} |
    | destinationResolver | _org.springframework.jms.support.destination.DestinationResolver_ | {html}Specifies the class implementing logic for converting strings into
destinations. The default is DynamicDestinationResolver.{html} |
    | endpoint | _java.lang.String_ | {html}

Get the endpoint implementation.
{html} |
    | explicitQosEnabled | _boolean_ | {html}Specifies if the QoS values specified for the endpoint are explicitly
used when a messages is sent. The default is false.{html} |
    | interfaceName | _javax.xml.namespace.QName_ | {html}

Get the qualified name of the endpoint interface.
{html} |
    | jms102 | _boolean_ | {html}Determines if the provider used JMS 1.0.2 compliant APIs.{html} |
    | marshaler | _org.apache.servicemix.jms.endpoints.JmsProviderMarshaler_ | {html}Specifies the class implementing the message marshaler. The message
marshaller is responsible for marshalling and unmarshalling JMS messages.
The default is DefaultProviderMarshaler.{html} |
    | messageIdEnabled | _boolean_ | {html}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.{html} |
    | messageTimestampEnabled | _boolean_ | {html}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.{html} |
    | policies | (_org.apache.servicemix.soap.api.Policy_)\* | {html}Specifies an array of interceptors used to process SOAP messages.{html} |
    | preserveMessageQos | _boolean_ | {html}Specifies whether we want to send message using the QoS settings
specified on the message instead in order to preserve message QoS.
The default is false.{html} |
    | priority | _int_ | {html}Specifies the priority assigned to the JMS messages. Defaults to 4.{html} |
    | pubSubDomain | _boolean_ | {html}Specifies if the destination is a topic. true means the
destination is a topic. false means the destination is a
queue.{html} |
    | pubSubNoLocal | _boolean_ | {html}Specifies if messages published by the listener's Connection
are suppressed. The default is false.{html} |
    | receiveTimeout | _long_ | {html}Specifies the timeout for receiving a message in milliseconds.{html} |
    | replyDestination | _javax.jms.Destination_ | {html}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.{html} |
    | replyDestinationChooser | _org.apache.servicemix.jms.endpoints.DestinationChooser_ | {html}Specifies a class implementing logic for choosing the destination used
to recieve replies.{html} |
    | replyDestinationName | _java.lang.String_ | {html}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.{html} |
    | service | _javax.xml.namespace.QName_ | {html}

Get the service qualified name of the endpoint.
{html} |
    | store | _org.apache.servicemix.store.Store_ | {html}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.{html} |
    | storeFactory | _org.apache.servicemix.store.StoreFactory_ | {html}Sets the store factory used to create the store.
If none is set, a {@link MemoryStoreFactory} will be created and used instead.{html} |
    | timeToLive | _long_ | {html}Specifies the number of milliseconds a message is valid.{html} |
    | useJbiWrapper | _boolean_ | {html}Specifies if the endpoint expects SOAP messages to be wrapped in the JBI
wrapper. Defaults to true.{html} |
    | validateWsdl | _boolean_ | {html}Specifies if the WSDL is checked WSI-BP compliance. Defaults to
true.{html} |
    | wsdl | _org.springframework.core.io.Resource_ | {html}Specifies the WSDL document describing the service's interface.{html} |

h3. Element Index
    | _[|#component-element]_ | {html}JMS JBI binding component{html} |
    | _[|#configuration-element]_ | {html}Bean for configuring JMS connections{html} |
    | _[|#consumer-element]_ | {html}A Sping-based JMS consumer endpoint.{html} |
    | _[|#endpoint-element]_ | {html}non-Spring JMS endpoint
This JMS endpoint can be either a consumer or a provider
and is optimized to work with SOAP messages.{html} |
    | _[|#jca-consumer-element]_ | {html}A Spring-based JMS consumer that uses JCA to connect to the JMS provider{html} |
    | _[|#provider-element]_ | {html}A Spring-based JMS provider endpoint{html} |
    | _[|#soap-consumer-element]_ | {html}A Spring-based JMS consumer optimized for handling SOAP messages{html} |
    | _[|#soap-provider-element]_ | {html}A Spring-based JMS provider optimized for SOAP messages{html} |