Redis Components

Apiman components for Redis.

Global Required Parameters

Name Type Description

config.file

String

Path to your Redisson client configuration file.

Components

Cache Store

  • Properties (Servlet)

  • JSON (Vert.x)

apiman-gateway.components.ICacheStoreComponent=io.apiman.gateway.engine.redis.RedisCacheStoreComponent
properties
{
  "components": {
    "ICacheStoreComponent": {
      "class": "io.apiman.gateway.engine.redis.RedisCacheStoreComponent",
      "config": {
        // <config here>
      }
    }
  }
}
json5

Rate Limiter

  • Properties (Servlet)

  • JSON (Vert.x)

apiman-gateway.components.IRateLimiterComponent=io.apiman.gateway.engine.redis.RedisRateLimiterComponent
properties
{
  "components": {
    "IRateLimiterComponent": {
      "class": "io.apiman.gateway.engine.redis.RedisRateLimiterComponent",
      "config": {
        // <config here>
      }
    }
  }
}
json5

Shared State

  • Properties (Servlet)

  • JSON (Vert.x)

apiman-gateway.components.ISharedStateComponent=io.apiman.gateway.engine.redis.RedisSharedStateComponent
properties
{
  "components": {
    "ISharedStateComponent": {
      "class": "io.apiman.gateway.engine.redis.RedisSharedStateComponent",
      "config": {
        // <config here>
      }
    }
  }
}
json5