com.github.wuic.engine.core

Class MemoryMapCacheEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.HeadEngine

com.github.wuic.engine.core.AbstractCacheEngine

com.github.wuic.engine.core.ScheduledCacheEngine

com.github.wuic.engine.core.MemoryMapCacheEngine

All Implemented Interfaces:

Comparable<Engine>, Runnable

@EngineService(injectDefaultToWorkflow=true,
               isCoreEngine=true)
public class MemoryMapCacheEngine
extends ScheduledCacheEngine

This engine reads from a Map kept in memory the nuts associated to a workflow to be processed.

Since:

0.4.0

Version:

1.1

Author:

Guillaume DROUET

Nested Class Summary

Nested classes/interfaces inherited from class com.github.wuic.engine.core.AbstractCacheEngine

AbstractCacheEngine.CacheResult

Constructor Summary

Constructors

Constructor and Description
MemoryMapCacheEngine(Boolean work, int timeToLiveSeconds, Boolean bestEffort) Builds a new engine.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clears this cache.
AbstractCacheEngine.CacheResult	getFromCache(EngineRequest.Key request) Gets the list of nuts associated to the specified request from the cache.
void	putToCache(EngineRequest.Key request, AbstractCacheEngine.CacheResult nuts) Puts the given list of nuts associated to the specified request to the cache.
void	removeFromCache(EngineRequest.Key request) Removes the given list of nuts associated to the specified request from the cache.

Methods inherited from class com.github.wuic.engine.core.ScheduledCacheEngine

run, setTimeToLive

Methods inherited from class com.github.wuic.engine.core.AbstractCacheEngine

getEngineType, internalParse, parse, works

Methods inherited from class com.github.wuic.engine.HeadEngine

parse, runChains

Methods inherited from class com.github.wuic.engine.Engine

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryMapCacheEngine

@ConfigConstructor
public MemoryMapCacheEngine(@BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.engine.cache")
                                      Boolean work,
                                      @IntegerConfigParam(defaultValue=-1,propertyKey="c.g.wuic.engine.timeToLive")
                                      int timeToLiveSeconds,
                                      @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.engine.bestEffort")
                                      Boolean bestEffort)

Builds a new engine.

Parameters:

work - if cache should be activated or not

timeToLiveSeconds - the time this cache could live

bestEffort - enable best effort mode or not

Method Detail

putToCache

public void putToCache(EngineRequest.Key request,
              AbstractCacheEngine.CacheResult nuts)

Puts the given list of nuts associated to the specified request to the cache.

Specified by:

putToCache in class AbstractCacheEngine

Parameters:

request - the request key

nuts - the nuts

removeFromCache

public void removeFromCache(EngineRequest.Key request)

Removes the given list of nuts associated to the specified request from the cache.

Specified by:

removeFromCache in class AbstractCacheEngine

Parameters:

request - request key

getFromCache

public AbstractCacheEngine.CacheResult getFromCache(EngineRequest.Key request)

Gets the list of nuts associated to the specified request from the cache.

Specified by:

getFromCache in class AbstractCacheEngine

Parameters:

request - the request key

Returns:

the list of nuts

clearCache

public void clearCache()

Clears this cache.

Specified by:

clearCache in class ScheduledCacheEngine