Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Java Message Service (JMS) transport in WSO2 Enterprise Integrator(WSO2 EI) allows you to easily send and receive messages to queues and topics of any JMS service that implements the JMS specification.

...

Parameter Name

Description

Required

Possible Values

Default Value

java.naming.factory.initial

JNDI initial context factory class. The class must implement the java.naming.spi.InitialContextFactory interface.

Yes

A valid class name

org.apache.activemq.jndi.ActiveMQInitialContextFactory

java.naming.provider.url

URL of the JNDI provider.

Yes

A valid URL

tcp://localhost:61616

java.naming.security.principal

JNDI Username.

No



java.naming.security.credentials

JNDI password.

No



transport.Transactionality

Preferred mode of Preferredmodeof transactionality.

Note
titleNote

In WSO2 EI, JMS transactions only work with either the Callout mediator or the Call mediator in blocking mode.

No

none: Disables transactions in the JMS transport

local: Enables local JMS session transactions

jta: Enables global JTA transactions

none

transport.UserTxnJNDIName

JNDI name to be used to require user transaction.

No


java:comp/UserTransaction

transport.CacheUserTxn

Whether caching for user transactions should be enabled or not.

No

true, false

true

transport.jms.SessionTransacted

Whether the JMS session should be transacted or not.

No

true, false

true if transactionality is 'local'

transport.jms.SessionAcknowledgement

JMS session acknowledgment mode.

No

  • AUTO_ACKNOWLEDGE: The session automatically acknowledges the consumer receipt of messages when message processing has finished.
  • CLIENT_ACKNOWLEDGE: The consumer acknowledges all messages delivered so far by the session. If the consumer falls behind in its processing, a large number of unacknowledged messages can build up.
  • DUPS_OK_ACKNOWLEDGE: The session lazily acknowledges the delivery of messages to the consumer. Lazy means that the consumer can delay acknowledgement to the server until a convenient time. During a delay, the server might redeliver messages. This mode reduces session overhead but the consumer can receive duplicate messages should JMS fail,
  • SESSION_TRANSACTED: The session is a related group of consumed or produced messages that are treated as a single unit of work.

Also see JMS Message Delivery Reliability and Acknowledgement Patterns.

AUTO_ACKNOWLEDGE

transport.jms.ConnectionFactoryJNDIName

The JNDI name of the connection factory.

Yes

QueueConnectionFactory, TopicConnectionFactory

ConnectionFactory

transport.jms.ConnectionFactoryType

Type of the connection factory.

No

queue, topic

queue

transport.jms.JMSSpecVersion

JMS API version.

No

1.1, 1.0.2b

1.1

transport.jms.UserName

The JMS connection username.

No



transport.jms.Password

The JMS connection password.

No



transport.jms.Destination

The JNDI name of the destination.

No


Defaults to service nameDefaultstoservicename

transport.jms.DestinationType

Type of the destination.

No

queue, topic

queue

transport.jms.DefaultReplyDestination

JNDI name of the default reply destination.

No



transport.jms.DefaultReplyDestinationType

Type of the reply destination.

No

queue, topic

Defaults to the type of the destination

transport.jms.MessageSelector

Message selector implementation.

No



transport.jms.SubscriptionDurable

Whether the connection factory is subscription durable or not.

No

true, false

false

transport.jms.DurableSubscriberClientIDThe ClientId parameter when using durable subscriptions

Required if the value specified as transport.jms.SubscriptionDurable is true.



transport.jms.DurableSubscriberName

The name of the durable subscriber.

Required if the value specified as transport.jms.SubscriptionDurable is true .



transport.jms.PubSubNoLocal

Whether the messages should be published by the same connection they were received.

No

true, false

false

transport.jms.CacheLevel

The cache level, with which JMS objects should be cached at

start up

startup. You can configure this in the <EI_HOME>/conf/axis2/axis2.xml file

, if WSO2 EI acts as a producer. Else, you can configure as a proxy service parameter, if WSO2 EI acts as a consumer.

.

Following are the possible values for this parameter and the description of each:

  • none - None of the JMS objects will be cached.
  • connection -  JMS connection objects will be cached.
  • session -  JMS connection and session objects will be cached.
  • consumer - JMS connection, session and consumer objects will be cached.
  • producer - JMS connection, session and producer objects will be cached.
  • auto - An appropriate cache level will be used based on the transaction strategy. 


Info

The following is available as a WUM update for WSO2 EI from the 8th of August, 2018: In addition to defining the cache level in the axis2.xml file, you can define it in the endpoint reference from a proxy service as shown below:

Code Block
<endpoint>
   <address uri="jms:/example.MyQueue?transport.jms.ConnectionFactoryJNDIName=QueueConnectionFactory&java.naming.factory.initial=org.wso2.andes.jndi.PropertiesFileInitialContextFactory&java.naming.provider.url=repository/conf/jndi.properties&transport.jms.DestinationType=queue&transport.jms.CacheLevel=producer"/>
</endpoint>

See the instructions for getting WUM updates.


No

none, connection, session, consumer, producer, auto

auto

transport.jms.ReceiveTimeout

Time to wait for a JMS message during polling. Set this parameter value to a negative integer to wait indefinitely. Set to zero to prevent waiting.

No

Number of milliseconds to wait

1000 ms

transport.jms.ConcurrentConsumers

Number of concurrent Numberofconcurrent threads to be started to consume messages when polling.

No

Any positive integer - For topics this Fortopicsthis must be always 1

1

transport.jms.MaxConcurrentConsumers

Maximum number of Maximumnumberof concurrent threads to use during polling.

No

Any positive integer - For topics this Fortopicsthis must be always 1

1

transport.jms.IdleTaskLimit

The number of idle runs per thread before it dies out.

No

Any positive integer

10

transport.jms.MaxMessagesPerTask

The maximum number of successful message receipts per thread.

No

Any positive integer - Use -1 to indicate infinity

-1

transport.jms.InitialReconnectDuration

Initial reconnection attempts duration in milliseconds.

No

Any positive integer

10000 ms

transport.jms.ReconnectProgressFactor

Factor by which the reconnection duration will be increased.

No

Any positive integer

2

transport.jms.MaxReconnectDuration

Maximum reconnection duration in milliseconds.

No


3600000 ms (1 hr)

transport.jms.ReconnectIntervalReconnection interval in milliseconds.No
>3600000 ms (1 hr)

transport.jms.MaxJMSConnections

Maximum cached JMS connections in the producer level.

No

Any positive integer value 

10

transport.jms.MaxConsumeErrorRetriesBeforeDelay

Number of retries Numberofretries on consume errors before sleep delay kicks in.

No

Any positive integer value 

20

transport.jms.ConsumeErrorDelay

Sleep delay when a consume error is whenaconsumeerroris encountered (in milliseconds).

No

Any positive integer value 

100 ms

transport.jms.ConsumeErrorProgression

Factor by which the consume error retry sleep will be increased.

No

Any positive integer value 

2.0

transport.jms.MaxConsumeErrorRetryCount

The maximum number of times the consumer should retry upon receiving a consumer error. You need to introduce this parameter only if the Broker has issues in notifying the Exception Listeners about the exceptions occurred.

NoAny positive integer value -1

...