Package io.vertigo.datastore.plugins.kvstore.redis

Class RedisKVStorePlugin

java.lang.Object

io.vertigo.datastore.plugins.kvstore.redis.RedisKVStorePlugin

All Implemented Interfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin, KVStorePlugin

public final class RedisKVStorePlugin
extends Object
implements KVStorePlugin

Redis KvStore implementations.

Author:

mlaroche

Constructor Summary

Constructors

Constructor	Description
RedisKVStorePlugin(String collections, Optional<String> connectorNameOpt, List<io.vertigo.connectors.redis.RedisConnector> redisConnectors, io.vertigo.commons.codec.CodecManager codecManager, io.vertigo.core.analytics.AnalyticsManager analyticsManager)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear(KVCollection collection)	Removes all elements from a collection.
int	count(KVCollection collection)
<C> Optional<C>	find(KVCollection collection, String id, Class<C> clazz)	Finds the optional element to which the id is mapped inside the specified collection.
<C> List<C>	findAll(KVCollection collection, int skip, Integer limit, Class<C> clazz)	Finds all elements contained inside the specified collection.
List<KVCollection>	getCollections()	Returns the list of collections managed by this plugin.
void	put(KVCollection collection, String id, Object element)	Adds an element defined by an id in a collection.
boolean	remove(KVCollection collection, String id)	Removes an element defined by an id from a collection.

Methods inherited from class java.lang.Object

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

Constructor Details

RedisKVStorePlugin

@Inject
public RedisKVStorePlugin(String collections,
 Optional<String> connectorNameOpt,
 List<io.vertigo.connectors.redis.RedisConnector> redisConnectors,
 io.vertigo.commons.codec.CodecManager codecManager,
 io.vertigo.core.analytics.AnalyticsManager analyticsManager)

Constructor. Collections syntax : - collections are comma separated a revoir (param étendus - collections may defined TimeToLive and Memory configs with a json like syntax : collName;TTL=10;inMemory - TTL default to -1 meaning eternal

Parameters:

collections - List of collections managed by this plugin (comma separated)

redisConnectors - list of redisConnectors available in the app

codecManager - Codec manager

connectorName - name of the redis connector to use, default is 'main'

Method Details

getCollections

public List<KVCollection> getCollections()

Returns the list of collections managed by this plugin.

Specified by:

getCollections in interface KVStorePlugin

Returns:

list of collections;

remove

public boolean remove(KVCollection collection,
 String id)

Removes an element defined by an id from a collection.

Specified by:

remove in interface KVStorePlugin

Parameters:

collection - the collection

id - the id

Returns:

if element exists before removed

clear

public void clear(KVCollection collection)

Removes all elements from a collection.

Specified by:

clear in interface KVStorePlugin

Parameters:

collection - the collection

put

public void put(KVCollection collection,
 String id,
 Object element)

Adds an element defined by an id in a collection.

Specified by:

put in interface KVStorePlugin

Parameters:

collection - the collection

id - the id

element - the element

find

public <C> Optional<C> find(KVCollection collection,
 String id,
 Class<C> clazz)

Finds the optional element to which the id is mapped inside the specified collection. If the element is not found then an empty option is returned.

Specified by:

find in interface KVStorePlugin

Type Parameters:

C - Element type

Parameters:

collection - the collection

id - the id

clazz - the type of the searched element

Returns:

the option

findAll

public <C> List<C> findAll(KVCollection collection,
 int skip,
 Integer limit,
 Class<C> clazz)

Finds all elements contained inside the specified collection.

Specified by:

findAll in interface KVStorePlugin

Type Parameters:

C - Element type

Parameters:

collection - the collection

skip - the position from which the elements are returned

limit - the limit size of elements

clazz - the type of the searched element

Returns:

the list of elements.

count

public int count(KVCollection collection)

Specified by:

count in interface KVStorePlugin

Parameters:

collection - the collection

Returns:

count of elements into collection