Overview¶

This is the main documentation for the gora-jcache module. gora-jcache module enables Hazelcast JCache caching support for Gora. This implementation is based on Hazelcast JCache provider. This dataStore can act as wrapped caching layer for any other persistent Apache Gora persistent dataStore.

gora.properties¶

• gora.cache.datastore.default ( Mandatory ) - Caching dataStore to be used with persistent dataStore. If JCache dataStore is used as caching store assigned value should be org.apache.gora.jcache.store.JCacheStore

• gora.datastore.default ( Mandatory ) - Persistent back-end dataStore to be used with JCache caching dataStore.

• gora.datastore.jcache.provider ( Mandatory ) - Two possible values, whether to start JCache dataStore in Server mode or Client mode,

  • Server Mode com.hazelcast.cache.impl.HazelcastServerCachingProvider
  • Client Mode com.hazelcast.client.cache.impl.HazelcastClientCachingProvider

• gora.datastore.jcache.hazelcast.config - If JCache datastore is started in,

  • Server Mode This property to should point to Hazelcast Cluster member network configuration file related to forming Hazelcast cluster using members. Please see Network configuration.
  • Client Mode This property to should point s to Hazelcast client configuration file related to connecting related to already formed Hazelcast cluster. Please see Client configuration ( Mandatory )

• jcache.auto.create.cache - Whether force creating the cache at time JCache dataStore creation. Default is set to false.

• jcache.cache.inmemory.format - In memory for format for persistent bean resides in cache. Possible values, BINARY, OBJECT, NATIVE Please see In memory format.

• jcache.read.through.enable - Whether to fetch a missing cache entry from backend persistent dataStore. Default value is true.

• jcache.write.through.enable - Whether to push change of a cache entry to backend persistent dataStore. Default value is true.

• jcache.statistics.enable - Statistics like cache hits and misses are collected. Default value is false.

• jcache.management.enable - JMX beans are enabled and collected statistics are exposed over the beans.It doesn't automatically enables statistics collection. Default is set to false. Default JMX port opens on 9999.

• jcache.store.by.value.enable - Whether to store key and values of data beans in means of store by value or store by reference. Default is true that means store by value.

• jcache.cache.namespace - Cache manager scope URI. This will allow different cache manager instances to share data among them if they are aligned with same scope. On opposite having two different scopes means such that each cache manager can isolate each other’s owned caches without any conflict. Please see Scopes and Namespaces

• jcache.expire.policy - Cache entry expiry policy. Possible values ACCESSED, CREATED, MODIFIED, TOUCHED Please see JCache expiry policy

• jcache.expire.policy.duration - Cache entry expiry timeout in seconds.

• jcache.eviction.policy - Cache entry eviction policy. Possible values LRU, LFU, NONE, RANDOM Please see Hazelcast eviction policy

• jcache.eviction.max.size.policy - Measure of maximum cache size to apply eviction policy. ENTRY_COUNT, USED_NATIVE_MEMORY_SIZE, USED_NATIVE_MEMORY_PERCENTAGE, FREE_NATIVE_MEMORY_SIZE, FREE_NATIVE_MEMORY_PERCENTAGE

• jcache.eviction.size - Maximum size as integer as a measure of max size policy criteria.