META-INF.mule-jms.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-transport-jms Show documentation
Show all versions of mule-transport-jms Show documentation
A Mule transport for Jms Connectivity.
The newest version!
The JMS transport provides support for sending messages via JMS queues.
JMS
JMS Transport
The connector element configures a generic connector for sending and receiving messages over JMS queues.
Reference to the connection factory, which is required for non-vendor JMS configurations.
The custom-connector element configures a custom connector for sending and receiving messages over JMS queues.
Reference to the redelivery handler.
The acknowledgement mode to use: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, or DUPS_OK_ACKNOWLEDGE.
The ID of the JMS client.
Whether to make all topic subscribers durable.
If set to true, a subscriber will not receive messages that were published by its own connection.
If set to true, the JMS provider logs the message to stable storage as it is sent so that it can be recovered if delivery is unsuccessful.
A client marks a message as persistent if it feels that the application will have problems if the message is lost in transit. A client marks a message as non-persistent if an occasional lost message is tolerable. Clients use delivery mode to tell a JMS provider how to balance message transport reliability/throughput.
Delivery mode only covers the transport of the message to its destination. Retention of a message at the destination until its receipt is acknowledged is not guaranteed by a PERSISTENT delivery mode. Clients should assume that message retention policies are set administratively. Message retention policy governs the reliability of message delivery from destination to message consumer. For example, if a client's message storage space is exhausted, some messages as defined by a site specific message retention policy may be dropped.
A message is guaranteed to be delivered once-and-only-once by a JMS Provider if the delivery mode of the messge is persistent and if the destination has a sufficient message retention policy.
If set to true, the message's QoS headers are honored. If false (the default), the connector settings override the message headers.
The maximum number of times to try to redeliver a message. Use -1 to accept messages with any redelivery count.
The maximum number of queue messages prefetch. Use -1 for the vendor default
Whether to cache and re-use the JMS session and producer object instead of recreating them for each request. The default behaviour is to cache JMS Sessions and Producers (previous to 3.6, the default behaviuor was to not cache them). NOTE: This is NOT supported with XA transactions or JMS 1.0.2b.
Whether to create a consumer right when the connection is created instead of using lazy instantiation in the poll loop.
The JMS specification to use: 1.0.2b (the default) or 1.1
The user name for the connection
The password for the connection
The number of concurrent consumers that will be used to receive JMS messages. (Note: If you use this attribute, you should not configure the 'numberOfConcurrentTransactedReceivers', which has the same effect.)
The initial factory class to use when connecting to JNDI.
DEPRECATED: use jndiNameResolver-ref propertie to configure this value.
The URL to use when connecting to JNDI.
DEPRECATED: use jndiNameResolver-ref propertie to configure this value.
Reference to a Map that contains additional provider properties.
DEPRECATED: use jndiNameResolver-ref propertie to configure this value.
The name to use when looking up the connection factory from JNDI.
Set this attribute to true if you want to look up queues or topics from JNDI instead of creating them from the session.
If set to true, Mule fails when a topic or queue cannot be retrieved from JNDI. If set to false, Mule will create a topic or queue from the JMS session if the JNDI lookup fails.
If this is set to false (the default), when Mule performs request/response calls a temporary destination
will automatically be set up to receive a response from the remote JMS call.
Some application servers, like WebSphere AS, don't allow certain methods to be called on JMS objects,
effectively limiting available features. Embedded mode tells Mule to avoid those whenever possible. Default is false.
Optional reference to the connection factory. A default connection factory is provided for vendor-specific JMS configurations.
The activemq-connector element configures an ActiveMQ version of the JMS connector.
The activemq-xa-connector element configures an ActiveMQ version of the JMS connector with XA transaction support.
The URL used to connect to the JMS server. If not set, the default is vm://localhost?broker.persistent=false&broker.useJmx=false.
The mulemq-connector element configures a MuleMQ version of the JMS connector.
The mulemq-xa-connector element configures a MuleMQ version of the JMS XA connector.
The URL used to connect to the JMS server. If not set, the default is nsp://localhost:9000. When connecting to a cluster separate urls with a comma.
Specifies the type of write handler the client will use to send events to the realm. This can be either standard, direct or queued. Unless specified, standard is used. For better latencies use direct, however, this will impact CPU since each write is not buffered but flushed directly. The queued handler will improve CPU and may give better overall throughput since there will be some buffering between client and server. The best of both options is the standard, which attempts to write directly but will back off and buffer the IO flushes when throughput increases and impacts CPU.
Sets whether each write to the store will also call sync on the file system to ensure all data is written to the disk, default is false.
Sets the size of the write sync batch, default is 50, range is 1 to Integer.MAX_VALUE.
Sets the time interval between sync batches, default is 20 milliseconds, range is 1 to Integer.MAX_VALUE.
Sets that the default channel/queue capacity setting which will prevent publishing of further events once topic or queue is full, default is 5000, valid range is 1 to Integer.MAX_VALUE.
Specifies the maximum number of unacknowledged events a connection will keep in memory before beginning to remove the oldest, default is 100, range is 1 to Integer.MAX_VALUE.
All JMS Topics require this setting to be true, however, if you wish to use different channel types with different fanout engines (in MULEMQ+ only), this can be set to false.
When using queues, this specifies the number of messages that the server will send in each block between acknowledgments, default is 100, range is 1 to Integer.MAX_VALUE.
When auto acknowledgment mode is selected, rather than ack each event, each nth event will be acknowledged, default is 50, range is 1 to Integer.MAX_VALUE.
Allows more than 1 durable subscriber on a topic sharing the same name, with only 1 consuming the events. When the first durable disconnects, the second will take over and so on. Default is false.
With multiple RNAMEs, the ability to randomize the RNAMEs is useful for load balancing between cluster nodes.
Indicates the maximum number of threads each connection will use to deliver asynchronous events, default is 30, range is 1 to Integer.MAX_VALUE
Indicates whether the client connection will be disconnected when the cluster fails, which will cause automatic reconnect to occur, default is true.
The maximum number of attempts a connection will try to connect to a realm on startup, default is 2, 0 is infinite, range is Integer.MIN_VALUE to Integer.MAX_VALUE
This indicates the size of the map of redelivered events to store for each consumer, once this limit is reached the oldest will be removed, default is 100, range is 1 to 100
If a transacted session commit fails, if this is true, the commit will be retried until either it succeeds or fails with a transaction timeout, default is false.
if this is true, the session will be multiplexed on a single connection else a new socket is created for each session, default is false.
The weblogic-connector element configures a WebLogic version of the JMS connector.
The websphere-connector element configures a WebSphere version of the JMS connector.
The transaction element configures a transaction. Transactions allow a series of operations to be grouped together so that they can be rolled back if a failure occurs. Set the action (such as ALWAYS_BEGIN or JOIN_IF_POSSIBLE) and the timeout setting for the transaction.
The client-ack-transaction element configures a client acknowledgment transaction, which is identical to a transaction but with message acknowledgements. There is no notion of rollback with client acknowledgement, but this transaction can be useful for controlling how messages are consumed from a destination.
The jmsmessage-to-object-transformer element configures a transformer that converts a JMS message into an object by extracting the message payload.
The object-to-jmsmessage-transformer element configures a transformer that converts an object into one of five types of JMS messages, depending on the object passed in: java.lang.String -> javax.jms.TextMessage, byte[] -> javax.jms.BytesMessage, java.util.Map (primitive types) -> javax.jms.MapMessage, java.io.InputStream (or java.util.List of primitive types) -> javax.jms.StreamMessage, and java.lang.Serializable including java.util.Map, java.util.List, and java.util.Set objects that contain serializable objects (including primitives) -> javax.jms.ObjectMessage.
The inbound-endpoint element configures an endpoint on which JMS messages are received.
(As of 2.2.2) Allows the name for the durable topic subscription to be specified.
The number of milliseconds that a transacted message receiver will wait for an incoming message inside an active XA transaction.
When no polling timeout is configured, the transaction timeout will be used instead. This attribute is ignored when no XA transaction is configured.
NOTE: this value must be considered when the transaction timeout is configured. This means that the transaction timeout must be large enough to cover the polling timeout and the message processing times.
The inbound-endpoint element configures an endpoint to which JMS messages are sent.
The endpoint element configures a global JMS endpoint definition.
The queue name. This attribute cannot be used with the topic attribute (the two are exclusive).
The topic name. The "topic:" prefix will be added automatically. This attribute cannot be used with the queue attribute (the two are exclusive).
If this is set to false (the default), when Mule performs request/response calls a temporary destination
will automatically be set up to receive a response from the remote JMS call.
Sets a selector on the underlying JMS transport. It is not a standard Mule filter and cannot be combined with other filters.
The expression to search for in the property.
The property-filter element configures a filter that allows you to filter messages based on a JMS property.
The name of the JMS property.
The class type of the JMS property.
The expression to search for in the property.
The regular expression pattern to search for in the property. In most cases, if you set both the expression and pattern attributes, only the pattern is used.
A placeholder for jndi-name-resolver strategy elements.
A service to resolve JNDI names.
A deafult strategy to resolve JNDI names.
The initial factory class to use when connecting to JNDI.
The URL to use when connecting to JNDI.
Reference to a Map that contains additional provider properties.
Reference to a javax.naming.spi.InitialContextFactory implementation that will be used to create the JDNI context.
A custom strategy to resolve JNDI names.
Spring-style property element for custom configuration.
An implementation of the LifecycleAdapter interface.
DEPRECATED: This element is deprecated from Mule 3.6. This can still but used in 3.6, but it not necessary given that from Mule 3.6 JMS connections cache Sessions/Producers by default when a CachingConnectionFactory has not been configured explicitly.
Identifies the pool so that a connector can reference it.
Defines the maximum amount of connections that can be in the pool.
NOTE: This cache size is the maximum limit for the number of cached Sessions per session acknowledgement type (auto, client, dups_ok, transacted).
As a consequence, the actual number of cached Sessions may be up to four times as high as the specified value - in the unlikely case of mixing and matching different acknowledgement types.
Indicates whether to cache JMS MessageProducers for the JMS connection. Default is true
Reference to the connection factory
The user name for the connection
The password for the connection
© 2015 - 2025 Weber Informatics LLC | Privacy Policy