com.github.wuic.engine.core

Class AbstractCacheEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.HeadEngine

com.github.wuic.engine.core.AbstractCacheEngine

All Implemented Interfaces:

Comparable<Engine>

Direct Known Subclasses:

ScheduledCacheEngine

public abstract class AbstractCacheEngine
extends HeadEngine

This class is an abstraction of an engine which reads from a cache the nuts associated to a workflow to be processed. If an entry exists, then the nuts are returned and no more engine is executed. Otherwise, the chain is executed and the result is put in the cache.

The engine could be configured to be in best effort mode. In that case, if the result of the request is not already in the cache, it just call only the mandatory operations in the chain to deliver as fast as possible a response to the client. All operations are done asynchronously and result is added to the cache when finished. This mode allows to not increase response time for the user when he is the first to send the request even if nuts are not fully processed.

The cache itself is abstract here and it needs to be provided by subclass.

Since:

0.4.0

Version:

1.3

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCacheEngine.CacheResult Represents the value to be cached.

Constructor Summary

Constructors

Constructor and Description
AbstractCacheEngine(Boolean work, Boolean be) Builds a new engine.

Method Summary

Methods

Modifier and Type	Method and Description
EngineType	getEngineType() Gets the type of engine.
abstract AbstractCacheEngine.CacheResult	getFromCache(EngineRequest.Key request) Gets the list of nuts associated to the specified request from the cache.
List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
ConvertibleNut	parse(EngineRequest request, String path) Parses the given request and returns the nut associated to the given path.
abstract void	putToCache(EngineRequest.Key request, AbstractCacheEngine.CacheResult nuts) Puts the given list of nuts associated to the specified request to the cache.
abstract void	removeFromCache(EngineRequest.Key request) Removes the given list of nuts associated to the specified request from the cache.
Boolean	works() Returns a flag indicating if the engine is configured to do something or not.

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

AbstractCacheEngine

public AbstractCacheEngine(Boolean work,
                   Boolean be)

Builds a new engine.

Parameters:

work - if cache should be activated or not

be - apply best effort

Method Detail

internalParse

public List<ConvertibleNut> internalParse(EngineRequest request)
                                   throws WuicException

Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.

Specified by:

internalParse in class Engine

Parameters:

request - the request with files to parse

Returns:

the parsed files

Throws:

WuicException - if any kind of error occurs

works

public Boolean works()

Returns a flag indicating if the engine is configured to do something or not.

Specified by:

works in class Engine

Returns:

true is something will be done, false otherwise

getEngineType

public EngineType getEngineType()

Gets the type of engine.

Specified by:

getEngineType in class Engine

Returns:

the type of process done by with engine

parse

public ConvertibleNut parse(EngineRequest request,
                   String path)
                     throws WuicException

Parses the given request and returns the nut associated to the given path.

Specified by:

parse in class HeadEngine

Parameters:

request - the request

path - the nut name

Returns:

the associated nut

Throws:

WuicException - if request could not be executed successfully

putToCache

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

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

Parameters:

request - the request key

nuts - the nuts

removeFromCache

public abstract void removeFromCache(EngineRequest.Key request)

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

Parameters:

request - request key

getFromCache

public abstract AbstractCacheEngine.CacheResult getFromCache(EngineRequest.Key request)

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

Parameters:

request - the request key

Returns:

the list of nuts