Configuration Descriptor: Cache

Owned by kiran.kumari@intellectdesign.com (Unlicensed)
Last updated: Mar 19, 2019 by Ravikumar Babu CTOO (Unlicensed)

This key contains the bundle name of the property file that provides the configuration specific to Cache Management:

Config Key

Mandatory/ Optional

Type

Purpose

CACHE_CONFIG_FILE

Mandatory

String

This key is used to provide the name of the cache configuration file, which contains the list of cache handlers. The cache handlers are to be executed for loading the application data to the cache. This is the resource locator URL (like a fully defined class name) for the path to the Cache configuration XML file. This file is loaded from the class path.

EHCACHE_CONFIG_FILE

Mandatory

String

This key is used to provide the name of the EH cache configuration file. The Canvas framework uses the EH Cache library internally for in-memory caching of large result sets having need for sorting, filtering, or grouping based on user needs.

CACHE_PROXY_MODE

Mandatory

String

This key indicates the nature of proxy to be used for the Cache to connect to its handler. The following three values can be used for this key:

  • local – This value indicates a co-deployment, which is used to connect directly.
  • remote – This value indicates that the data builder is on a remote VM and needs an EJB call.
  • http – This value is same as 'remote', except that the remote hop is done using an Http call instead of EJB.

The following is a sample cache configuration file cacheconfig.properties (as per the name given in the default descriptor):

# The Cache Configuration xml path 
# Provide the path to the cache configuration file name (loadable through class path)
CACHE_CONFIG_FILE = cacheconfig.xml 

# Provide the path to the Eh Cache configuration file name (loadable through class path)
EHCACHE_CONFIG_FILE = CTEhcache.xml 

# This indicates the nature of proxy to be used for the Cache to connect to its handler.
# Possible values are:
# 'local' - indicates a co-deploymnet. Just connect directly.
# 'remote' - indicates that the data builder is on a remote VM and needs a EJB call.
# 'http' - same as remote except that the remote hop is done using a Http call instead of EJB.
CACHE_PROXY_MODE = local