WSO2 Open Banking Distributed Cache

Info

This is only available as a WSO2 Update from WSO2 Open Banking API Manager Accelerator Level 3.0.0.25 and WSO2 Open Banking Identity Server Accelerator Level 3.0.0.48 onwards. For more information on updating, see Getting WSO2 Updates.

WSO2 Open Banking Distributed Cache is a caching service that creates a clustered cache among one or more WSO2 API Manager or Identity Server instances. Distributed Cache is based on the Hazelcast IMDG library. This cache can be used as a single instance cache as well.

There are two types of network configurations to recognize clustered members:

  • TCP-IP
  • Multicast

Distributed Cache Configurations

Configure the deployment.toml file of the instance based on your caching requirements.

  • <IS_HOME>/repository/conf/deployment.toml or
  • <APIM_HOME>/repository/conf/deployment.toml

Common configurations

[open_banking.distributed_cache]
enabled=true
host_name="localhost"
port=5701
discovery_mechanism="Multicast"
Configuration name Type Default Value Description
enabled boolean false Set this to true to enable distributed cache. Otherwise, distributed caching functionality is disabled.
host_name string "localhost" The hostname of the cache instance.
port integer 5701 The port on which the cluster is hosted.
discovery_mechanism string "Multicast" This checks the discovery mechanism of the cache cluster. If it is set to “TCP” it will be TCP-IP, if it is set to “Multicast” discovery mechanism will be Multicast. If not configured, the default value is “Multicast”.

TCP configurations

If open_banking.distributed_cache.discovery_mechanism is set to TCP,

[open_banking.distributed_cache]
discovery_mechanism="TCP"
members=["192.168.1.0-7", "localhost:5703"]
Configuration name Type Default Value Description
members string array null Add the Public address (HostName: Port) of the members as a string array. Public addresses can be given in ranges (as the example above). If not configured, there won't be any default members.

Multicast configurations

If open_banking.distributed_cache.discovery_mechanism is set to Multicast,

[open_banking.distributed_cache]
discovery_mechanism="Multicast"
multicast_group="224.2.2.3"
multicast_port=54321
trusted_interfaces=["192.168.1.*", "192.168.1.100-110"]
Configuration name Type Default Value Description
multicast_group string "224.2.2.3" The multicast group of the cluster.
multicast_port integer 54321 The multicast port.
trusted_interfaces string array null The IP addresses of trusted members in a multicast. You can configure an IP range as well.

Hazelcast property Configurations

[open_banking.distributed_cache.properties]
max_heartbeat=600
max_master_confirmation=900
merge_first_run_delay=60
merge_next_run_delay=30
logging_type="none"
Configuration name Type Default Value Description
max_heartbeat integer 600 Time in seconds after which the clustered member assumes the client is dead and closes its connections with the client.
max_master_confirmation integer 900 Max timeout of master confirmation from other nodes. This is calculated in seconds.
merge_first_run_delay integer 60 The inital run delay of split brain/merge process in seconds.
merge_next_run_delay integer 30 Run interval of split brain/merge process in seconds.
logging_type string “none” Specify logging framework type to send logging events. For example, “none”, “jdk”, “log4j”, “log4j2”, “slf4j”
Top