WSO2 Message Broker JMS Event Receiver

WSO2 Message Broker (MB) JMS event receiver is an internal event receiver that comes with WSO2 products by default . You can configure it with map, XML, JSON, and text input mapping types.

Prerequisites

Follow the steps below to set up the prerequisites before starting the configurations.

Download and install WSO2 Message Broker (MB). For instructions on WSO2 MB, go to Message Broker documentation.
Configure WSO2 CEP by adding relevant libraries to support JMS transport.
Open the <CEP_HOME>/repository/conf/jndi.properties file and register a connection factory by entering relevant details in the register some connection factories section. Below is a sample for a connection factory named TopicConnectionFactory( the "carbon" is the name of the virtually hosted node in WSO2 MB).
connectionfactory.TopicConnectionFactory=amqp://admin:admin@clientid/carbon?brokerlist='tcp://localhost:5672'

Creating a WSO2 MB JMS event receiver

For instructions on creating a WSO2 MB JMS event receiver, see Receiving Events .

Configuring adapter properties

Specify the Adapter Properties, when creating a WSO2 MB JMS event receiver using the management console as shown below.

WSO2 MB JMS input event adapter properties

After entering the above adapter properties, select the Event Stream to which you want to map the incoming events, and the Message Format which you want to apply on the receiving events. Also, click Advanced to define custom input mappings based on the Message Format you selected. For more information on custom input mapping types, see Input Mapping Types.

You can also define the respective adapter properties of the event receiver based on the transport type within the <from> element of the event receiver configuration in the <PRODUCT_HOME>/repository/deployment/server/eventreceivers/ directory as follows.

<eventReceiver name="WSO2MBJMSInputEventAdapter" statistics="disable" trace="disable" xmlns="http://wso2.org/carbon/eventreceiver">
    <from eventAdapterType="jms">
        <property name="java.naming.factory.initial">org.wso2.andes.jndi.PropertiesFileInitialContextFactory</property>
        <property name="java.naming.provider.url">repository/conf/jndi.properties</property>
        <property name="transport.jms.DestinationType">topic</property>
        <property name="transport.jms.SubscriptionDurable">false</property>
        <property name="transport.jms.Destination">test_topic</property>
        <property name="transport.jms.ConnectionFactoryJNDIName">TopicConnectionFactory</property>
        <property encrypted="true" name="transport.jms.Password">P2ve4G8+qF7JXkiGnP9/Ew5GXALEWTu7znEwxZGYa/MQMaQBRfsXiP094fn9U+0rntdBMitXU9o7h5uV3m5h97Po8WTJRpnFBV5YCGZEO+ELSg6twY3386MipwFhFMrbUMKamI2sXksDRcogojWKtoHNmODnt8Ud1dh0LK5zqec=        </property>
        <property name="transport.jms.UserName">jms-user</property>
        <property name="transport.jms.DurableSubscriberName">subscriber</property>
        <property name="jms.properties">SessionTransacted:false</property>
    </from>
    .....................
</eventReceiver>

The above adapter properties are described below.

Adapter Property	Description	Configuration file property	Example
Topic/Queue Name	Valid name for the JMS topic. WSO2 CEP/DAS sends and receives messages by subscribing to a topic or using named queues.	transport.jms.Destination	`WSO2MBJMSInputEventAdapter`
JNDI Initial Context Factory Class	JNDI initial context factory class. The class must implement the `java.naming.spi.InitialContextFactory` interface.	java.naming.factory.initial	`org.wso2.andes.jndi.PropertiesFileInitialContextFactory`
JNDI Provider URL	URL of the JNDI provider.	java.naming.provider.url	`repository/conf/jndi.properties`
The JMS connection password	A valid password for the JMS connection.	transport.jms.Password	`jms-password`
The JMS connection username	A valid username for the JMS connection.	transport.jms.UserName	`jms-user`
Connection Factory JNDI Name	The JNDI name of the connection factory.	transport.jms.ConnectionFactoryJNDIName	`TopicConnectionFactory`
Destination Type	Define the sort order for messages that arrive on a specific destination.	transport.jms.DestinationType	`topic/queue`
Enable Durable Subscription	Whether the subscription is durable or not.	transport.jms.SubscriptionDurable	`true/false`
Durable Subscriber Name	A valid name of the durable subscriber (If any value added, Durable subscription will be enabled).	transport.jms.DurableSubscriberName	`subscriber`
JMS Properties	Valid property and value pairs to denote Axis2 JMS properties (e.g. "property1: value1, property2: value2") For more information on Axis2 JMS properties, go to Apache AXIS2 Transports Documentation.	jms.properties	`SessionTransacted:false`

Related samples

For more information on WSO2 MB event receiver type, see the following sample.

Sample 0013 - Receiving Map, Text Events via JMS Transport - WSO2 MB