Page Comparison

The JDBC message store can be used to store and retrieve messages more messages more efficiently in comparison with other message stores.

The JDBC The JDBC message store implementation store implementation is a variation of the already existing synapse message store implementation and is designed in a manner similar to the WSO2 ESB JMS message store. The JDBC The JDBC message store uses a JDBC connector to connect to external relational databases.

The advantages of using a JDBC a JDBC message store instead of any other message store are as follows:

Easy to connect – connect – You only need to have a have a JDBC connector to connect to an external relational database.
Quick transactions – JDBC message stores are capable of handling a large number of transactions per second.
Ability to work with a high capacity for a long period of time – Since JDBC Stores stores use databases as the medium to store data, it can store a large volume of data and is capable of handling data for a longer period of time.

Configuring the JDBC message store

The syntax of the JDBC message store can be different depending on whether you connect to the database using a connection pool, or using a datasource. Click on the relevant tab to view the syntax based on how you want to connect to the database.

Localtabgroup

Localtab

active	true
title	Syntax to connect using a connection pool

Code Block

language	xml

<messageStore class="org.apache.synapse.message.store.jdbc.JDBCMessageStore" name="MyStore">
     
	<parameter name="store.jdbc.driver"/>
	<parameter name="store.jdbc.connection.url"/>
	<parameter name="store.jdbc.username"/>
	<parameter name="store.jdbc.password"/>
	<parameter name="store.jdbc.table"/>
     
</messageStore>

Following are the parameters that should be specified and the description for each:

Parameter

Name

Value

Description	Required
`store.jdbc.driver`

the

The class name of the database driver.	YES
`store.jdbc.connection.url`	The database URL.	YES
`store.jdbc.username`	The user name to access the database.	YES
`store.jdbc.password`	The password to access the database.	NO
`store.jdbc.table`	Table name of the database. If not specified, it is assumed that a table named `jdbc_message_store` exists.	NO

Localtab

title	Syntax to connect using an external datasource

Code Block

language	xml

<messageStore class="org.apache.synapse.message.store.jdbc.JDBCMessageStore" name="MyStore">

	<parameter name="store.jdbc.dsName"/>
	<parameter name="store.jdbc.table"/>

</messageStore>

Following are the parameters that should be specified and the description for each:

Parameter

Name

Value

Description	Required
`store.jdbc.dsName`	The name of the datasource to be looked up	YES
`store.jdbc.table`	The table name of the database. If not specified, it is assumed that a table named `jdbc_message_store` exists.	NO

UI Configuration

The UI of the JDBC Message Store that is displayed can vary depending on whether you connect to the database using a connection pool, or using a datasource. Click on the relevant tab to view the UI that is displayed based on how you want to connect to the database.

Localtabgroup

Localtab

title	Connect to the database via a connection pool

When adding a JDBC message store, if you select Pool as the Connection Information, the following screen appears:

Image RemovedImage Added

Following are descriptions of the fields that are displayed:

Field	Description
Name	The name of the message store
Database Table	The name of the database table. If not specified, the value will be set to `jdbc_message_store`.
Driver	The class name of the database driver.
Url	The JDBC URL of the database that the data will be written to.
User	The user name used to connect to the database.
Password	The password used to connect to the database.

Localtab

title	Connect to the database via an external datasource

When adding a JDBC message store, if you select Carbon Datasource as the Connection Information, the following screen appears:

Image RemovedImage Added

To make sure that the datasource appears in the Datasource Name list, you need to expose it as a JNDI datasource. For information on configuring a JNDI datasources, see Configuring a JNDI Datasource

Following are descriptions of the fields that are displayed:

Field	Description
Name	The name for the message store
Database Table	The name of the database table. If not specified, the value will be set to `jdbc_message_store`

.


Datasource Name	The class name of the datasource.

Example

Initially you need to setup a database to suite for this.

DB Scripts to create table :

For MySQL :

Sample scenario

In this sample:

The client sends requests to a proxy service.
The proxy service stores the messages in a JDBC message store.
The back-end service is invoked by a message forwarding processor, which picks the messages stored in the JDBC message store.

Prerequisites:

For H2 :

Setup the database.

If you are setting up a MySQL database, the DB script to create the required table is as follows:

Code Block

language	sql

CREATE TABLE jdbc_message_store(
indexId BIGINT( 20 ) NOT NULL AUTO_INCREMENT ,
msg_id VARCHAR( 200 ) NOT NULL ,
message BLOB NOT NULL ,
PRIMARY KEY ( indexId )
)

If you are setting up a H2 database, the DB script to create the required table is as follows:

Code Block

language	sql

CREATE TABLE jdbc_message_store(
indexId BIGINT( 20 ) NOT NULL AUTO_INCREMENT ,
msg_id VARCHAR( 200 ) NOT NULL ,
message BLOB NOT NULL ,
PRIMARY KEY ( indexId )
)

Info

title

- Note
  You can create a similar

SQL script according to your database type.You need to put

- script based on the database you want to set up.
Add the relevant database driver into the repository/components/lib folder.

This sample is based on a MySQL database name “sampleDB” and table “jdbc_message_store”.

Configure the sample

Create a proxy service that stores messages to the JDBC message store.
Create a JDBC message store.

Create a message forwarding processor to consumes the messages stored in the message store.

Code Block

language	xml
title	Sample configuration that uses a MySQL database named sampleDB and the database table jdbc_message_store

<proxy xmlns="http://ws.apache.org/ns/synapse"
      name="MessageStoreProxy"
      transports="https http"
      startOnLoad="true"
      trace="disable">
  <description/>
  <target>
     <inSequence>
        <property name="FORCE_SC_ACCEPTED" value="true" scope="axis2"/>
        <property name="OUT_ONLY" value="true"/>
        <property name="target.endpoint" value="StockQuoteServiceEp"/>
        <store messageStore="SampleStore"/>
     </inSequence>
  </target>
  <publishWSDL uri="http://localhost:9000/services/SimpleStockQuoteService?wsdl"/>
</proxy>
 
<messageStore xmlns="http://ws.apache.org/ns/synapse"
             class="org.apache.synapse.message.store.impl.jdbc.JDBCMessageStore"
             name="SampleStore">
  <parameter name="store.jdbc.password"/>
  <parameter name="store.jdbc.username">root</parameter>
  <parameter name="store.jdbc.driver">com.mysql.jdbc.Driver</parameter>
  <parameter name="store.jdbc.table">jdbc_message_store</parameter>
  <parameter name="store.jdbc.connection.url">jdbc:mysql://localhost:3306/sampleDB</parameter>
</messageStore>
 
<messageProcessor xmlns="http://ws.apache.org/ns/synapse"
                 class="org.apache.synapse.message.processor.impl.forwarder.ScheduledMessageForwardingProcessor"
                 name="ScheduledProcessor"
                 messageStore="SampleStore">
  <parameter name="max.delivery.attempts">5</parameter>
  <parameter name="interval">10</parameter>
  <parameter name="is.active">true</parameter>
</messageProcessor>

Use axis2 client as follows to send messages to the proxy:

ant stockquote

Configure the back-end service

Deploy the SimpleStockQuoteService client by navigating to <ESB_HOME>/samples/axis2Server/src/SimpleStockQuoteService, and running the ant command in the command prompt or shell script. This will build the sample and deploy the service for you. For more information on sample back-end services, see Deploying sample back-end services.
WSO2 ESB comes with a default Axis2 server, which you can use as the back-end service for this sample. To start the Axis2 server, navigate to<ESB_HOME>/samples/axis2server and run axis2Server.sh (on Linux) or axis2Server.bat (on Windows).
Point your browser to http://localhost:9000/services/SimpleStockQuoteService?wsdl and verify that the service is running.

Execute the sample

To invoke the proxy service, navigate to <ESB_HOME>/repository/samples/axis2client/ directory, and execute the following command:

Code Block
ant stockquote -Daddurl=http://localhost:8280/services/MessageStoreProxy

Refer documentation on working with axis2-stockquote client.

Versions Compared

Old Version 6

New Version 7

Key

Configuring the JDBC message store

UI Configuration

Example

Sample scenario

Prerequisites:

Configure the sample

Configure the back-end service

Execute the sample