Over a million developers have joined DZone.

Mule Caching on Application Boot Up and Mule Registry

DZone's Guide to

Mule Caching on Application Boot Up and Mule Registry

This tutorial explains how to retrieve master data from database and store it while the Mule application starts up.

· Integration Zone ·
Free Resource

Continue to drive demand for API management solutions that address the entire API life cycle and bridge the gap to microservices adoption.  

In this article, we will learn how to retrieve look-up/Master data from database and store/cache it while Mule application starts/boots up. Also, we will learn how to use Mule Registry.

What Are We Doing?

In this example, we are caching simple lookup table data as key/value pair in Java HashMap upon Mule interface boot up and store the HashMap result in Mule Registry that can be accessed from Mule Flow.

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.HashMap;
import org.mule.api.MuleContext;
import org.mule.api.context.MuleContextAware;

import org.mule.api.context.notification.MuleContextNotificationListener;
import org.mule.context.notification.MuleContextNotification;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

public class CacheUtil implements MuleContextNotificationListener<MuleContextNotification>, MuleContextAware {

    public static HashMap<String, String> supplierMappingMap;
    private MuleContext muleContext;

    private String sqlBaseURL;

    private String sqlSupplierSelectStatement;

    public void setMuleContext(MuleContext context) {
        this.muleContext = context;

    public void onNotification(MuleContextNotification notification) {

        LOGGER.info("Executing CacheUtil onNotification()");
        if (notification.getAction() == MuleContextNotification.CONTEXT_STARTING) {

            try {
            } catch (Exception e) {

   public HashMap<String, String> getSupplierID() throws Exception {

        String selectSupplierID = sqlSupplierSelectStatement;
        Connection connection = null;
        PreparedStatement prepStatement = null;
        ResultSet resultSet = null;

        try {

            connection = FinUtil.getDBConnection(sqlBaseURL);
            prepStatement = connection.prepareStatement(selectSupplierID);
            resultSet = prepStatement.executeQuery();
            supplierMappingMap = new HashMap<String, String>();

            while (resultSet.next()) {

If you want to test it quickly, use below hard-coded values.

        supplierMappingMap.put("abc", "012");
        supplierMappingMap.put("ijk", "456");
        supplierMappingMap.put("xyz", "890");

muleContext.getRegistry().registerObject("supplierMappingMap", supplierMappingMap);  

// We can access the Mule registry by
//System.out.println("Mule Registry: " + muleContext.getRegistry().get("supplierMappingMap")); 

        } catch (Exception exception) {
            LOGGER.error("Exception in CacheUtil getSupplierID(): " + exception.getMessage());
        } finally {
return supplierMappingMap;

MuleContextNotificationListener is an observer interface that objects can implement and then register themselves with the Mule manager to be notified when a Manager event occurs. MuleContextNotification is fired when an event such as the mule context start occurs. The payload of this event will always be a reference to the muleContext.

(notification.getAction() == MuleContextNotification.CONTEXT_STARTING)

As we can see, HashMap is defined as static, meaning it is a class level variable (NOT object level) and gets memory only once at the time of class loading. So, when we fetch the values from database and store it in HashMap, the values are retained and can be reused several times. This is memory efficient way of caching the data.

This HashMap can be accessed from other Beans/Java classes by,

HashMap<String, String> supplierMap = CacheUtil.supplierMappingMap;

The reason I am returning the HashMap with the result from DB in getSupplierID() method is to show different ways of accessing app registry in Mule flow.

Now let’s see how we can access this map from Mule flows.

This line of code will store the map object in MuleContext registry, which can be accessed in Mule flows.

 muleContext.getRegistry().registerObject("supplierMappingMap", supplierMappingMap); 

There are multiple ways of accessing the registry data in Mule flows. Please refer to the mule code.




Here is a wonderful article about inner workings of Mule including Registry.

How to Access Newly Added Rows/Data in the Lookup Table

As we can observe from the code, we have used Spring annotation @Component to mark the CacheUtil as a bean. Hence, we can use @Autowired to inject CacheUtil bean from another bean/Java class to invoke getSupplierID() method, so it reloads the rows/data from database table as needed.


private CacheUtil cacheUtil;


@Value annotation:

The easiest way to access properties(key/value pair) from Java layer using spring is through @Value annotation.

Mule Flow:

        <spring:bean id="CacheUtil" name="CacheUtil" class="muleregistry.CacheUtil" />

    <flow name="muleregistryFlow">
        <poll doc:name="Poll">
            <fixed-frequency-scheduler frequency="10000"/>
            <logger level="INFO" doc:name="Logger" message="Flow Started"/>

        <logger message="Key (abc): #[app.registry.get('supplierMappingMap').get('abc')];" level="INFO" doc:name="Logger"/>
        <logger message="Key (xyz): #[app.registry.get('supplierMappingMap').get('xyz')];" level="INFO" doc:name="Logger"/>
        <logger message="#[app.registry.get('CacheUtil').supplierMappingMap];" level="INFO" doc:name="Logger"/>
    <logger message="Method: #[app.registry['CacheUtil'].getSupplierID();]" level="INFO" doc:name="Logger"/>

Without spring bean definition in XML configuration, we get java.lang.NullPointerException


 muleRegistry * default * DEPLOYED *

INFO 2018-06-22 18:55:23,662 [pool-14-thread-1] org.mule.api.processor.LoggerMessageProcessor: Flow Started

INFO 2018-06-22 18:55:23,664 [[muleregistryone].muleregistryoneFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Key (abc): 012;

INFO 2018-06-22 18:55:23,664 [[muleregistryone].muleregistryoneFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Key (xyz): 890;

INFO 2018-06-22 18:55:23,665 [[muleregistryone].muleregistryoneFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Field: {, , };

WARN 2018-06-22 18:55:23,665 [[muleregistryone].muleregistryoneFlow.stage1.02] org.mule.config.spring.SpringRegistry: Spring registry already contains an object named 'supplierMappingMap'. The previous object will be overwritten.

INFO 2018-06-22 18:55:23,666 [[muleregistryone].muleregistryoneFlow.stage1.02] org.mule.api.processor.LoggerMessageProcessor: Method: {, , }


Though Mule registry is not recommended for general purpose data cache, in this scenario, we are storing only less 100 rows of lookup data, which is static in nature. If you have to cache a large volume of data, please use Mule cache scope.

Discover how organizations are modernizing their application architectures for speed and agility from the growing API economy

mule ,caching ,registry ,integration ,tutorial

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}