> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-framework/module-development/capabilities/cache-providers.md).

# Cache Providers

{% hint style="warning" %}
Cache providers require **Java**. There is no BoxLang-only mechanism for registering custom cache backends.
{% endhint %}

Cache providers enable custom caching backends (Redis, Couchbase, custom stores) for BoxLang's caching system.

## Creating a Cache Provider

Implement the `ICacheProvider` interface and register via ServiceLoader:

**File:** `src/main/java/ortus/boxlang/modules/mymodule/cache/MyCacheProvider.java`

```java
import ortus.boxlang.runtime.cache.providers.ICacheProvider;
import ortus.boxlang.runtime.scopes.Key;

public class MyCacheProvider implements ICacheProvider {

    @Override
    public Key getName() {
        return Key.of( "MyCache" );
    }

    @Override
    public void configure( IStruct config ) {
        // Configure provider from settings
    }

    @Override
    public Object get( Key key ) {
        // Retrieve from your cache
    }

    @Override
    public void put( Key key, Object value, Long timeout ) {
        // Store in your cache
    }

    @Override
    public void clear( Key key ) {
        // Remove from your cache
    }

    // ... other ICacheProvider methods
}
```

**ServiceLoader Config:** `src/main/resources/META-INF/services/ortus.boxlang.runtime.cache.providers.ICacheProvider`

```
ortus.boxlang.modules.mymodule.cache.MyCacheProvider
```

## Usage

Once registered, users can configure your cache provider in `boxlang.json`:

```json
{
  "caches": {
    "custom": {
      "provider": "MyCache",
      "properties": {
        "maxObjects": 1000,
        "defaultTimeout": 3600
      }
    }
  }
}
```

```js
// Use the custom cache
cachePut( "myKey", "myValue", 60, "custom" )
result = cacheGet( "myKey", "custom" )
```

## Next Steps

* [Services](/boxlang-framework/module-development/capabilities/services.md) — Global runtime services (Java only)
* [Schedulers](/boxlang-framework/module-development/capabilities/schedulers.md) — Scheduled task management (Java only)
* [JDBC Drivers](/boxlang-framework/module-development/capabilities/jdbc-drivers.md) — Database driver registration (Java only)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-framework/module-development/capabilities/cache-providers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.