See the following table for the cache parameters each CA Gateway API supports and their default value.

API

Main YAML parameter

expire-after-access

expire-after-write

expire-after-unit

expire-after-value

initial-capacity

maximum-size

ca-capabilities-cache

ca-capabilities-cache

false 

false



10

500

caInformation 

ca-information-cache

false

false


60 (with internal eviction policy)

10

500

CMPv2 enrollment

cmp-transaction-cache

(Not supported)

true

SECONDS

10

2

2

profile

profile-cache

false

false



20

100

profiles

profiles-cache

false

false



20

100

requestedProperties  

requested-properties-cache

false

false


60 (with internal eviction policy)

20

100

subjectBuilder 

subject-builder-cache

false

false



20

100

subjectDNCache 

subject-dn-cache

false

false



2000

10000

For example:

caches:
ca-information-cache:
enabled: true
maximum-size: 500
initial-capacity: 10
expire-after-write: true
expire-after-value: 60
expire-after-unit: SECONDS
profiles-cache:
enabled: false
maximum-size: 100
initial-capacity: 20
expire-after-access: true
expire-after-value: 10
expire-after-unit: SECONDS

See below for a description of each parameter.

Setting the following parameters is an expert-level configuration.

Enabled parameter

All API caches support the enabled boolean parameter to enable or disable the cache.

Expiry start parameters

If you want to configure the expiry of an API cache, select the event that triggers the expiry countdown. 

Parameter

Event

expire-after-access​

The most recent event among: ​cache creation, most recent cache replacement, latest cache access.

expire-after-write

The most recent event among: ​cache creation, most recent cache replacement.

These parameters are mutually incompatible. When both are set to True, the expire-after-access parameter takes precedence.

Expiry period parameters

After selecting the event that triggers the cache expiry, use the following parameters to set the timeout.

Parameter

Value

expire-after-unit

The time unit for the expiry period: SECONDS, MINUTES, HOURS

expire-after-value

The number of time units before removing an entry from the API cache. 

CA Gateway will disable cache expiry for the selected API unless:

  • Either the expire-after-access​​ or the expire-after-write parameters are set to True.
  • Both the expire-after-unit and expire-after-value parameters are configured.

Cache size parameters

Use the following parameters to set the size of a cache API.

Parameter

Value

initial-capacity

The initial number of entries in the API cache.

maximum-size

The maximum number of entries supported by the API cache.