---
schema_version: "1"
id: b226bc26f3129cd0c8bc37688ce9b1ddd2132c14f97cbf6736c67d8f24cf1da8
title: Set Up a Caching Strategy
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/mule-runtime/4.11/cache-scope-strategy.md
canonical_url: https://docs.mulesoft.com/mule-runtime/4.11/cache-scope-strategy
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 0478581588e2f15ce844b37829644b186ee838a8ef64c3044e80ed7c4843d8d8
description: MuleSoft Documentation Site
release: "4.11"
latest: false
---
---
product: Mule Runtime
version: 4.11
---

# Set Up a Caching Strategy

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

You can create a caching strategy from a Cache scope properties panel or a Global Elements
configuration in Anypoint Studio. After you create a strategy, a Cache component in your flow can
reference it.

You can configure the cache size, expiration time, and maximum allowed entries by setting these
values in the object store that you define or reference from the caching strategy.

Follow these steps to configure a caching strategy:

1.  Open the caching strategy configuration window.

    You can open it from the Cache scope properties panel or the **Caching Strategies** option in
    the Global Elements tab within Studio:

    ![A Caching Strategy setup with options for object store and event key generation](/mulesoft/current/en-us/mule-runtime/4.11/_images/mruntime-caching-strategy.png)

2.  Define the **Name** of the caching strategy.

3.  Define the **ObjectStore** to use by selecting any of the following options:

    - **Edit Inline**  
      Use this option to create an Object Store configuration specific for this caching strategy.

    - **Global Reference**  
      Use this option either to select an existing Object Store, or to create a new global Object
      Store that can be referenced by this caching strategy and any other component in your
      application.

4.  Select a mechanism for generating a key used for storing events within the caching strategy:

    - **Default**

    - **Key Expression**

      A DataWeave expression (for example, `keyGenerationExpression="#[vars.requestId]"`).

      Note that for two requests that are the same ("equal"), you need to generate the same key.
      Otherwise, you can get wrong results.

    - **Key Generator**

      Requires you to implement the `com.mulesoft.mule.runtime.cache.api.key.MuleEventKeyGenerator`
      interface.

5.  (Optional) Open the **Advanced** tab in the properties window to configure advanced settings:

    ![A configuration panel for a caching strategy showing settings for cache behavior and response generator](/mulesoft/current/en-us/mule-runtime/4.11/_images/mruntime-caching-strategy-advanced.png)

    - Select or create a **Response Generator**.

      Note that this step requires that you implement the
      `com.mulesoft.mule.runtime.cache.api.response.ResponseGenerator` interface.

    - Select the **Event Copy Strategy**:

      - **Simple event copy strategy**

        Data is immutable. This is the default value.

      - **Serializable event copy strategy**

        Data is mutable.

## Synchronized Access to a Cache

By default, Mule synchronizes access to a cache to avoid unexpected results if multiple message
processors (on the same or different Mule instances) use the cache at the same time.

Consider a scenario where two message processors attempt to retrieve a value from a cache but do not
find the value in the cache. So each message processor calculates the value independently and
inserts it into the cache. If access to the cache is not synchronized, the value inserted by the
second message processor overwrites the value inserted by the first message processor. If the values
are different, then two different results are obtained for the same input, with only the last one
stored in the cache.

In some scenarios this outcome is valid, but it can be a problem if the application requires cache
coherence. Synchronizing the caching strategy ensures this coherence. A synchronized cache is locked
when it is being modified by a message processor. In the previous scenario, a locked cache forces
the second message processor to wait until the first message processor has calculated the value, and
then it retrieves the value from the cache.

You can disable cache synchronization by defining the `synchronized` property in the
`<ee:object-store-caching-strategy>` element and setting it to `false`.

> [!IMPORTANT] Synchronization affects performance, and the impact is most severe in cluster mode.

## Example Caching Strategy

The following XML snippet shows the configuration of a caching strategy that synchronizes access to
the cache, and defines a persistent Object Store to store the cached responses. The caching strategy
is then referenced by a Cache scope:

```xml
<!-- Caching strategy definition -->
<ee:object-store-caching-strategy name="Caching_Strategy" doc:name="Caching Strategy">
  <!-- Object Store defined for the caching strategy-->
  <os:private-object-store
    alias="CachingStrategy_ObjectStore"
    maxEntries="100"
    entryTtl="10"
    expirationInterval="5"
    config-ref="ObjectStore_Config" />
</ee:object-store-caching-strategy>

<!-- Cache scope referencing the strategy-->
<ee:cache doc:name="Cache" cachingStrategy-ref="Caching_Strategy">
      <!-- Some processing logic to cache-->
</ee:cache>
```

## See Also

- [Cache Scope](https://docs.mulesoft.com/mule-runtime/4.11/cache-scope)

- [Configure the Cache Scope](https://docs.mulesoft.com/mule-runtime/4.11/cache-scope-to-configure)

- [Object Store Configuration](https://docs.mulesoft.com/mule-runtime/4.11/mule-object-stores#object-store-config)

- [Global Elements](https://docs.mulesoft.com/mule-runtime/4.11/global-elements)