services.moleculer.cacher

Class JCacheCacher

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Middleware

services.moleculer.cacher.Cacher

services.moleculer.cacher.DistributedCacher

services.moleculer.cacher.JCacheCacher

All Implemented Interfaces:

MetricConstants, MoleculerLifecycle

public class JCacheCacher
extends DistributedCacher

JSR-107 JCache is a standardized caching API that is Java 6 compatible and introduced in JEE 8. WARNING! Core JCache API does NOT support entry-level TTL parameter! If you need this feature use RedisCacher, MemoryCacher, or OHCacher. JCache is implemented by various caching solutions:

• Apache Ignite
• Hazelcast
• Oracle Coherence
• Couchbase (https://github.com/couchbaselabs/couchbase-java-cache)
• Terracotta Ehcache
• Infinispan
• Blazing Cache
• Cache2k
• Caffeine
• WebSphere eXtreme Scale

Required dependency:

// https://mvnrepository.com/artifact/javax.cache/cache-api
compile group: 'javax.cache', name: 'cache-api', version: '1.1.1'

See Also:

MemoryCacher, OHCacher, RedisCacher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>>	cacheConfigurations Optional cache configurations by cache regions
protected javax.cache.CacheManager	cacheManager
protected boolean	closeEmptyPartitions Close empty caches
protected MetricCounter	counterClean
protected MetricCounter	counterDel
protected MetricCounter	counterFound
protected MetricCounter	counterGet
protected MetricCounter	counterSet
protected javax.cache.configuration.Configuration<java.lang.String,byte[]>	defaultConfiguration Default cache cconfiguration
protected java.util.HashMap<java.lang.String,javax.cache.Cache<java.lang.String,byte[]>>	partitions
protected java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock	readLock
protected Serializer	serializer
protected java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock	writeLock

Fields inherited from class services.moleculer.cacher.DistributedCacher

CONTENT, hashers, maxParamsLength

Fields inherited from class services.moleculer.cacher.Cacher

metrics

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Fields inherited from interface services.moleculer.metrics.MetricConstants

MOLECULER_CACHER_CLEAN_TIME, MOLECULER_CACHER_CLEAN_TIME_DESC, MOLECULER_CACHER_CLEAN_TOTAL, MOLECULER_CACHER_CLEAN_TOTAL_DESC, MOLECULER_CACHER_DEL_TIME, MOLECULER_CACHER_DEL_TIME_DESC, MOLECULER_CACHER_DEL_TOTAL, MOLECULER_CACHER_DEL_TOTAL_DESC, MOLECULER_CACHER_EXPIRED_TOTAL, MOLECULER_CACHER_EXPIRED_TOTAL_DESC, MOLECULER_CACHER_FOUND_TOTAL, MOLECULER_CACHER_FOUND_TOTAL_DESC, MOLECULER_CACHER_GET_TIME, MOLECULER_CACHER_GET_TIME_DESC, MOLECULER_CACHER_GET_TOTAL, MOLECULER_CACHER_GET_TOTAL_DESC, MOLECULER_CACHER_SET_TIME, MOLECULER_CACHER_SET_TIME_DESC, MOLECULER_CACHER_SET_TOTAL, MOLECULER_CACHER_SET_TOTAL_DESC, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL_DESC, MOLECULER_EVENT_BROADCAST_TOTAL, MOLECULER_EVENT_BROADCAST_TOTAL_DESC, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL_DESC, MOLECULER_EVENT_EMIT_TOTAL, MOLECULER_EVENT_EMIT_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_ACTIVE, MOLECULER_EVENT_RECEIVED_ACTIVE_DESC, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_TIME, MOLECULER_EVENT_RECEIVED_TIME_DESC, MOLECULER_EVENT_RECEIVED_TOTAL, MOLECULER_EVENT_RECEIVED_TOTAL_DESC, MOLECULER_EXECUTOR, MOLECULER_REQUEST_ACTIVE, MOLECULER_REQUEST_ACTIVE_DESC, MOLECULER_REQUEST_ERROR_TOTAL, MOLECULER_REQUEST_ERROR_TOTAL_DESC, MOLECULER_REQUEST_LEVELS, MOLECULER_REQUEST_LEVELS_DESC, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL_DESC, MOLECULER_REQUEST_TIME, MOLECULER_REQUEST_TIME_DESC, MOLECULER_REQUEST_TIMEOUT_TOTAL, MOLECULER_REQUEST_TIMEOUT_TOTAL_DESC, MOLECULER_REQUEST_TOTAL, MOLECULER_REQUEST_TOTAL_DESC, MOLECULER_SCHEDULER, MOLECULER_TRANSIT_CONNECTED, MOLECULER_TRANSIT_CONNECTED_DESC, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL_DESC, MOLECULER_TRANSIT_REQUESTS_ACTIVE, MOLECULER_TRANSIT_REQUESTS_ACTIVE_DESC, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL_DESC

Constructor Summary

Constructors

Constructor and Description
JCacheCacher()
JCacheCacher(javax.cache.CacheManager cacheManager)
JCacheCacher(java.net.URI uri)

Method Summary

Modifier and Type	Method and Description
void	addCacheConfiguration(java.lang.String partition, javax.cache.configuration.Configuration<java.lang.String,byte[]> configuration)
protected static void	clean(javax.cache.Cache<java.lang.String,byte[]> partition, java.lang.String match)
io.datatree.Promise	clean(java.lang.String match) Cleans this cache.
io.datatree.Promise	del(java.lang.String key) Deletes a content from this cache.
io.datatree.Promise	get(java.lang.String key) Gets a cached content by a key.
java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>>	getCacheConfigurations()
io.datatree.Promise	getCacheKeys() Lists all keys of cached entries.
javax.cache.CacheManager	getCacheManager()
javax.cache.configuration.Configuration<java.lang.String,byte[]>	getDefaultConfiguration()
protected javax.cache.Cache<java.lang.String,byte[]>	getPartition(java.lang.String prefix)
boolean	isCloseEmptyPartitions()
protected int	partitionPosition(java.lang.String key, boolean throwErrorIfMissing)
void	removeCacheConfiguration(java.lang.String partition)
io.datatree.Promise	set(java.lang.String key, io.datatree.Tree value, int ttl) Sets a content by key into the cache.
void	setCacheConfigurations(java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>> cacheConfigurations)
void	setCacheManager(javax.cache.CacheManager cacheManager)
void	setCloseEmptyPartitions(boolean closeEmptyCaches)
void	setDefaultConfiguration(javax.cache.configuration.Configuration<java.lang.String,byte[]> defaultConfiguration)
void	started(ServiceBroker broker) Initializes cacher instance.
void	stopped()

Methods inherited from class services.moleculer.cacher.DistributedCacher

getCacheKey, getMaxParamsLength, setMaxParamsLength

Methods inherited from class services.moleculer.cacher.Cacher

appendToKey, appendTree, install, isCachingDisabledByTheContext, serializeKey

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

partitions

protected final java.util.HashMap<java.lang.String,javax.cache.Cache<java.lang.String,byte[]>> partitions

cacheManager

protected javax.cache.CacheManager cacheManager

serializer

protected Serializer serializer

closeEmptyPartitions

protected boolean closeEmptyPartitions

Close empty caches

defaultConfiguration

protected javax.cache.configuration.Configuration<java.lang.String,byte[]> defaultConfiguration

Default cache cconfiguration

cacheConfigurations

protected java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>> cacheConfigurations

Optional cache configurations by cache regions

readLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock readLock

writeLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock writeLock

counterGet

protected MetricCounter counterGet

counterSet

protected MetricCounter counterSet

counterDel

protected MetricCounter counterDel

counterClean

protected MetricCounter counterClean

counterFound

protected MetricCounter counterFound

Constructor Detail

JCacheCacher

public JCacheCacher()

JCacheCacher

public JCacheCacher(java.net.URI uri)

JCacheCacher

public JCacheCacher(javax.cache.CacheManager cacheManager)

Method Detail

started

public void started(ServiceBroker broker)
             throws java.lang.Exception

Initializes cacher instance.

Specified by:

started in interface MoleculerLifecycle

Overrides:

started in class Cacher

Parameters:

broker - parent ServiceBroker

Throws:

java.lang.Exception

stopped

public void stopped()

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class MoleculerComponent

get

public io.datatree.Promise get(java.lang.String key)

Description copied from class: Cacher

Gets a cached content by a key.

Specified by:

get in class Cacher

Parameters:

key - cache key

Returns:

Promise with cached value (or null, the returned Promise also can be null)

getPartition

protected javax.cache.Cache<java.lang.String,byte[]> getPartition(java.lang.String prefix)

set

public io.datatree.Promise set(java.lang.String key,
                               io.datatree.Tree value,
                               int ttl)

Description copied from class: Cacher

Sets a content by key into the cache.

Specified by:

set in class Cacher

Parameters:

key - cache key

value - new value

ttl - optional TTL of entry (0 == use default TTL)

Returns:

Promise with empty value

del

public io.datatree.Promise del(java.lang.String key)

Description copied from class: Cacher

Deletes a content from this cache.

Specified by:

del in class Cacher

Parameters:

key - cache key

Returns:

Promise with empty value

clean

public io.datatree.Promise clean(java.lang.String match)

Description copied from class: Cacher

Cleans this cache. Removes every key by a match string. The default match string is "**".

Specified by:

clean in class Cacher

Parameters:

match - regex

Returns:

Promise with empty value

clean

protected static final void clean(javax.cache.Cache<java.lang.String,byte[]> partition,
                                  java.lang.String match)
                           throws java.lang.Exception

Throws:

java.lang.Exception

partitionPosition

protected int partitionPosition(java.lang.String key,
                                boolean throwErrorIfMissing)

getCacheKeys

public io.datatree.Promise getCacheKeys()

Lists all keys of cached entries.

Specified by:

getCacheKeys in class Cacher

Returns:

a Tree object with a "keys" array.

addCacheConfiguration

public void addCacheConfiguration(java.lang.String partition,
                                  javax.cache.configuration.Configuration<java.lang.String,byte[]> configuration)

removeCacheConfiguration

public void removeCacheConfiguration(java.lang.String partition)

getCacheManager

public javax.cache.CacheManager getCacheManager()

setCacheManager

public void setCacheManager(javax.cache.CacheManager cacheManager)

isCloseEmptyPartitions

public boolean isCloseEmptyPartitions()

setCloseEmptyPartitions

public void setCloseEmptyPartitions(boolean closeEmptyCaches)

getDefaultConfiguration

public javax.cache.configuration.Configuration<java.lang.String,byte[]> getDefaultConfiguration()

setDefaultConfiguration

public void setDefaultConfiguration(javax.cache.configuration.Configuration<java.lang.String,byte[]> defaultConfiguration)

getCacheConfigurations

public java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>> getCacheConfigurations()

setCacheConfigurations

public void setCacheConfigurations(java.util.Map<java.lang.String,javax.cache.configuration.Configuration<java.lang.String,byte[]>> cacheConfigurations)