de.hybris.platform.btg.dao.impl

Class ResultCachingBTGDaoDecorator

java.lang.Object

de.hybris.platform.btg.dao.impl.ResultCachingBTGDaoDecorator

All Implemented Interfaces:

BTGDao, Dao

public class ResultCachingBTGDaoDecorator
extends Object
implements BTGDao

A decorator for BTGDao that adds caching of BTGResults. The cache implemented by this decorator reduces the number of SELECT statements issued when evaluating BTG Segments,Rules and Conditions. It does not reduce the number of BTGResult records stored in a database. Clustering: The cache data is not propagated across cluster nodes. This will work fine if the cluster is configured with "sticky sessions", that is a client's web browser always hits the same cluster node. This will also work if a node crashes and client is redirected to another node. The other node's cache will then just start collecting data for the client, and client may only notice temporary performance drop. This cache will NOT work if used in a cluster configuration that causes a client hit different cluster nodes on subsequent HTTP requests (round-robin, dynamic load-balancing etc.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ResultCachingBTGDaoDecorator.BtgResultObjectProvider<RET extends BTGAbstractResultModel,T extends BTGItemModel> Helper interface used to encapsulate a call to one of the overloaded BTGDao.getLastResult(...) methods.

Constructor Summary

Constructors

Constructor and Description
ResultCachingBTGDaoDecorator()

Method Summary

Modifier and Type	Method and Description
BTGConditionResultModel	createConditionResult(UserModel user, BTGExpressionModel condition, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new condition evaluation result
BTGRuleResultModel	createRuleResult(UserModel user, BTGRuleModel rule, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new rule evaluation result
BTGSegmentResultModel	createSegmentResult(UserModel user, BTGSegmentModel segment, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new segment evaluation result
BTGDao	getBtgDao()
BTGConditionResultModel	getLastResult(UserModel user, BTGConditionModel condition, BTGResultScope resultScope, String jaloSessionId) Return last result entry for condition and user
BTGRuleResultModel	getLastResult(UserModel user, BTGRuleModel rule, BTGResultScope resultScope, String jaloSessionId) Return last result entry for rule and user
BTGSegmentResultModel	getLastResult(UserModel user, BTGSegmentModel segment, BTGResultScope resultScope, String jaloSessionId) Return last result entry for segment and user
<RET extends BTGAbstractResultModel,T extends BTGItemModel> RET	getLastResultInternal(BTGResultCacheKey key, ResultCachingBTGDaoDecorator.BtgResultObjectProvider<RET,T> resultObjectProvider) This method encapsulates an algorithm for doing lookup of BTG results using cache.
ModelService	getModelService()
protected Map<BTGResultCacheKey,PK>	getResultMap(String jaloSessionId)
Collection<BTGSegmentModel>	getSegments(Collection<CMSSiteModel> websites, BTGConditionEvaluationScope scope, Collection<CatalogVersionModel> catalogVersions) Return segments for specified arguments
SessionService	getSessionService()
boolean	isConditionResultChanged(UserModel user, BTGConditionModel condition, BTGResultScope resultScope, boolean newResult, String jaloSessionId) Inspects BTGConditionResultModel for the given BTGConditionModel and UserModel.
boolean	isRuleResultChanged(UserModel user, BTGRuleModel rule, BTGResultScope resultScope, boolean newResult, String jaloSessionId) Inspects BTGRuleResultModel for the given BTGRuleModel and UserModel.
boolean	isSegmentResultChanged(UserModel user, BTGSegmentModel segment, BTGResultScope resultScope, boolean newResult, String jaloSessionId) Inspects BTGSegmentResultModel for the given BTGSegmentModel and UserModel.
void	moveSessionResults(UserModel src, String sessionId, UserModel dest, BTGEvaluationContext destContext) Moves the result data for segments, rules and conditions in the scope of the session with the given session ID to a new user for the given context.
void	setBtgDao(BTGDao btgDao)
void	setModelService(ModelService modelService)
void	setSessionService(SessionService sessionService)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultCachingBTGDaoDecorator

public ResultCachingBTGDaoDecorator()

Method Detail

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getBtgDao

public BTGDao getBtgDao()

setBtgDao

public void setBtgDao(BTGDao btgDao)

getSessionService

public SessionService getSessionService()

Returns:

the sessionService

setSessionService

public void setSessionService(SessionService sessionService)

Parameters:

sessionService - the sessionService to set

getLastResult

public BTGSegmentResultModel getLastResult(UserModel user,
                                           BTGSegmentModel segment,
                                           BTGResultScope resultScope,
                                           String jaloSessionId)

Description copied from interface: BTGDao

Return last result entry for segment and user

Specified by:

getLastResult in interface BTGDao

getLastResult

public BTGRuleResultModel getLastResult(UserModel user,
                                        BTGRuleModel rule,
                                        BTGResultScope resultScope,
                                        String jaloSessionId)

Description copied from interface: BTGDao

Return last result entry for rule and user

Specified by:

getLastResult in interface BTGDao

getLastResult

public BTGConditionResultModel getLastResult(UserModel user,
                                             BTGConditionModel condition,
                                             BTGResultScope resultScope,
                                             String jaloSessionId)

Description copied from interface: BTGDao

Return last result entry for condition and user

Specified by:

getLastResult in interface BTGDao

isSegmentResultChanged

public boolean isSegmentResultChanged(UserModel user,
                                      BTGSegmentModel segment,
                                      BTGResultScope resultScope,
                                      boolean newResult,
                                      String jaloSessionId)

Description copied from interface: BTGDao

Inspects BTGSegmentResultModel for the given BTGSegmentModel and UserModel.

Specified by:

isSegmentResultChanged in interface BTGDao

resultScope - YTODO

Returns:

true if :

there was no evaluation record for the segment and the user
OR

the currentResult is different than the previous one

isRuleResultChanged

public boolean isRuleResultChanged(UserModel user,
                                   BTGRuleModel rule,
                                   BTGResultScope resultScope,
                                   boolean newResult,
                                   String jaloSessionId)

Description copied from interface: BTGDao

Inspects BTGRuleResultModel for the given BTGRuleModel and UserModel.

Specified by:

isRuleResultChanged in interface BTGDao

resultScope - YTODO

Returns:

true if :

there was no evaluation record for the rule and the user
OR

the currentResult is different than the previous one

isConditionResultChanged

public boolean isConditionResultChanged(UserModel user,
                                        BTGConditionModel condition,
                                        BTGResultScope resultScope,
                                        boolean newResult,
                                        String jaloSessionId)

Description copied from interface: BTGDao

Inspects BTGConditionResultModel for the given BTGConditionModel and UserModel.

Specified by:

isConditionResultChanged in interface BTGDao

resultScope - YTODO

newResult - new evaluation result (the most recent one)

jaloSessionId - session identifier

Returns:

true if :

there was no evaluation record for the condition and the user
OR

the newResult is different than the previous one

getSegments

public Collection<BTGSegmentModel> getSegments(Collection<CMSSiteModel> websites,
                                               BTGConditionEvaluationScope scope,
                                               Collection<CatalogVersionModel> catalogVersions)

Description copied from interface: BTGDao

Return segments for specified arguments

Specified by:

getSegments in interface BTGDao

Parameters:

websites - CMSSiteModel

scope - BTGConditionEvaluationScope - Online or Offline

catalogVersions - Catalog versions

Returns:

Segments

moveSessionResults

public void moveSessionResults(UserModel src,
                               String sessionId,
                               UserModel dest,
                               BTGEvaluationContext destContext)

Description copied from interface: BTGDao

Moves the result data for segments, rules and conditions in the scope of the session with the given session ID to a new user for the given context.

Specified by:

moveSessionResults in interface BTGDao

Parameters:

src - the source user

sessionId - the ID of the session for which we want to move the results for

dest - the destination user

destContext - the destination context

createConditionResult

public BTGConditionResultModel createConditionResult(UserModel user,
                                                     BTGExpressionModel condition,
                                                     BTGResultScope scope,
                                                     boolean result,
                                                     String jaloSessionId,
                                                     boolean forced)

Description copied from interface: BTGDao

Creates new condition evaluation result

Specified by:

createConditionResult in interface BTGDao

createRuleResult

public BTGRuleResultModel createRuleResult(UserModel user,
                                           BTGRuleModel rule,
                                           BTGResultScope scope,
                                           boolean result,
                                           String jaloSessionId,
                                           boolean forced)

Description copied from interface: BTGDao

Creates new rule evaluation result

Specified by:

createRuleResult in interface BTGDao

createSegmentResult

public BTGSegmentResultModel createSegmentResult(UserModel user,
                                                 BTGSegmentModel segment,
                                                 BTGResultScope scope,
                                                 boolean result,
                                                 String jaloSessionId,
                                                 boolean forced)

Description copied from interface: BTGDao

Creates new segment evaluation result

Specified by:

createSegmentResult in interface BTGDao

getLastResultInternal

public <RET extends BTGAbstractResultModel,T extends BTGItemModel> RET getLastResultInternal(BTGResultCacheKey key,
                                                                                             ResultCachingBTGDaoDecorator.BtgResultObjectProvider<RET,T> resultObjectProvider)

This method encapsulates an algorithm for doing lookup of BTG results using cache.

getResultMap

protected Map<BTGResultCacheKey,PK> getResultMap(String jaloSessionId)