services.moleculer.cacher

Class Cacher

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Middleware

services.moleculer.cacher.Cacher

Direct Known Subclasses:

DistributedCacher, MemoryCacher, OHCacher

public abstract class Cacher
extends Middleware

Base superclass of all Cacher implementations.

See Also:

MemoryCacher, OHCacher, RedisCacher

Field Summary

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Constructor Summary

Constructors

Constructor and Description
Cacher()

Method Summary

Modifier and Type	Method and Description
protected void	appendToKey(java.lang.StringBuilder key, io.datatree.Tree tree)
protected void	appendTree(java.lang.StringBuilder key, java.lang.Object source)
abstract io.datatree.Promise	clean(java.lang.String match) Cleans this cache.
abstract io.datatree.Promise	del(java.lang.String key) Deletes a content from this cache.
abstract io.datatree.Promise	get(java.lang.String key) Gets a cached content by a key.
java.lang.String	getCacheKey(java.lang.String name, io.datatree.Tree params, java.lang.String... keys) Creates a cacher-specific key by name and params.
Action	install(Action action, io.datatree.Tree config)
protected void	serializeKey(java.lang.StringBuilder key, io.datatree.Tree params, java.lang.String... keys)
abstract io.datatree.Promise	set(java.lang.String key, io.datatree.Tree value, int ttl) Sets a content by key into the cache.

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class java.lang.Object

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

Constructor Detail

Cacher

public Cacher()

Method Detail

install

public Action install(Action action,
                      io.datatree.Tree config)

Specified by:

install in class Middleware

getCacheKey

public java.lang.String getCacheKey(java.lang.String name,
                                    io.datatree.Tree params,
                                    java.lang.String... keys)

Creates a cacher-specific key by name and params. Concatenates the name and params.

Parameters:

name - qualified name of the action

params - input (key) structure (~JSON)

keys - optional array of keys (eg. "id")

Returns:

generated cache key

serializeKey

protected void serializeKey(java.lang.StringBuilder key,
                            io.datatree.Tree params,
                            java.lang.String... keys)

appendToKey

protected void appendToKey(java.lang.StringBuilder key,
                           io.datatree.Tree tree)

appendTree

protected void appendTree(java.lang.StringBuilder key,
                          java.lang.Object source)

get

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

Gets a cached content by a key.

Parameters:

key - cache key

Returns:

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

set

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

Sets a content by key into the cache.

Parameters:

key - cache key

value - new value

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

Returns:

Promise with empty value

del

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

Deletes a content from this cache.

Parameters:

key - cache key

Returns:

Promise with empty value

clean

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

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

Parameters:

match - regex

Returns:

Promise with empty value