This documentation is for WSO2 Enterprise Service Bus version 4.9.0 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

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

...

Code Block
languagehtml/xml
<inboundEndpoint xmlns="http://ws.apache.org/ns/synapse" name="jms" sequence="request" onError="fault" protocol="jms" suspend="false">
      <parameters>
         <parameter name="interval">1000</parameter>
         <parameter name="coordination">true</parameter> 
         <parameter name="transport.jms.Destination">ordersQueue</parameter>
         <parameter name="transport.jms.CacheLevel">1<>3</parameter>
         <parameter name="transport.jms.ConnectionFactoryJNDIName">QueueConnectionFactory</parameter>
         <parameter name="sequential">true</parameter>
         <parameter name="java.naming.factory.initial">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
         <parameter name="java.naming.provider.url">tcp://localhost:61616</parameter>
         <parameter name="transport.jms.SessionAcknowledgement">AUTO_ACKNOWLEDGE</parameter>
         <parameter name="transport.jms.SessionTransacted">false</parameter>
         <parameter name="transport.jms.ConnectionFactoryType">queue</parameter>
      </parameters>
   </inboundEndpoint>

...

Parameter Name

Description

Required

Possible Values

Default Value

java.naming.factory.initial

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

Yes

A valid class name

-

java.naming.provider.url

The URL of the JNDI provider.

Yes

A valid URL

-

transport.jms.ConnectionFactoryJNDIName

The JNDI name of the connection factory.

Yes

-

-

sequential

Whether the messages need to be polled and injected sequentially or not.Yes
true, false
true

transport.jms.ConnectionFactoryType

The type of the connection factory.

No

queue, topic

queue

transport.jms.Destination

The JNDI name of the destination.

No

-

The defaults value is the service name.

transport.jms.SessionTransacted

Whether the JMS session should be transacted or not.

No

true , false

true if the transactionality is local.

transport.jms.SessionAcknowledgement

The JMS session acknowledgment mode.

No

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

AUTO_ACKNOWLEDGE

transport.jms.CacheLevel

The JMS resource cache level.

No

0 - none, 1 - connection, 2 - session, 3 - consumer

Info
titleNote

To subscribe to topics, set the value of transport.jms.CacheLevel to 3.

0

transport.jms.UserName

The JMS connection username.

No

-

-

transport.jms.Password

The JMS connection password.

No

-

-

transport.jms.JMSSpecVersion

The JMS API version.

No

1.1 , 1.0.2b

1.1

transport.jms.SubscriptionDurableWhether the connection factory is subscription durable or not.Notrue, falsefalse
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.MessageSelector

Message selector implementation.

No



transport.jms.ReceiveTimeout

The time to wait for a JMS message during polling.
Set this parameter value to a negative integer to wait indefinitely. Set it to zero to prevent waiting.
NoThe number of milliseconds to wait.1
transport.jms.ContentTypeHow the inbound listener should determine the content type of received messages. Priority is always given to the JMS message type.NoA simple string value, in which case the transport listener assumes that the received messages always have the specified content type, or a set of rules. For more information, see http://axis.apache.org/axis2/java/transports/jms.html#Service_configuration.-
transport.jms.ContentTypePropertyGet the content type from message propertyNocontentType-
transport.jms.ReplyDestinationThe destination that the response generated by the back-end service is stored.No-ReplyTo from the message

transport.jms.PubSubNoLocal

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

No

true, false

false

transport.jms.retry.duration

The retry interval to reconnect to the JMS server.

No

Retry interval in miliseconds.

transport.jms.RetriesBeforeSuspension

Note
titleNote

This parameter is introduced via the WUM update for WSO2 ESB 4.9.0, released on the 9th of January 2018.
Note that you can deploy a WUM update into production only if you have a paid subscription. If you do not have a paid subscription, you can use this parameter when the next version of the product is released.

The number of consecutive mediation failures after which polling should be suspended.NoSpecify any positive numerical value based on your requirement. Polling will be suspended when the mediation failure count reaches the specified value. -

transport.jms.PollingSuspensionPeriod

Note
titleNote

This parameter is introduced via the WUM update for WSO2 ESB 4.9.0, released on the 9th of January 2018.
Note that you can
deploy a WUM update into production only if you have a paid subscription. If you do not have a paid subscription, you can use this parameter when the next version of the product is released.

The period of time that polling is to be suspended when the transport.jms.RetriesBeforeSuspension parameter is set.NoSpecify a required time period in milliseconds.60000

...

titleNote

...

Samples

For a sample that demonstrates how one way message bridging from JMS to HTTP can be done using the JMS inbound endpoint, see Sample 901: Inbound Endpoint JMS Protocol Sample.