de.hybris.platform.btg.dao.impl

Class DefaultResultDataCachingBTGDao

java.lang.Object

de.hybris.platform.btg.dao.impl.DefaultResultDataCachingBTGDao

All Implemented Interfaces:

BTGDao, ResultDataCachingBtgDao, BTGInvalidationDataContainer<BTGAbstractResultModel>, Dao

public class DefaultResultDataCachingBTGDao
extends Object
implements ResultDataCachingBtgDao, BTGInvalidationDataContainer<BTGAbstractResultModel>

A BTGDao implementation that adds caching of BTGResults.
Session scope result will be NOT be stored in database (only in cache). 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 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	DefaultResultDataCachingBTGDao.BtgResultChangedEvaluator<T extends BTGItemModel> Helper interface used to encapsulate a call to one of the BTGDao.isXXXResultChanged(...) methods.

Constructor Summary

Constructors

Constructor and Description
DefaultResultDataCachingBTGDao()

Method Summary

Modifier and Type	Method and Description
protected void	cacheResultData(BTGResultCacheKey key, BTGAbstractResultData data)
protected BTGConditionResultModel	convertConditionResultData(BTGConditionResultData conditionResultData)
protected BTGAbstractResultData	convertConditionResultModel(BTGConditionResultModel conditionResultModel)
protected BTGRuleResultModel	convertRuleResultData(BTGRuleResultData ruleResultData)
protected BTGAbstractResultData	convertRuleResultModel(BTGRuleResultModel ruleResultModel)
protected BTGSegmentResultModel	convertSegmentResultData(BTGSegmentResultData segmentResultData)
protected BTGSegmentResultData	convertSegmentResultModel(BTGSegmentResultModel segmentResultModel)
BTGConditionResultModel	createConditionResult(UserModel user, BTGExpressionModel condition, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new condition evaluation result
protected BTGConditionResultModel	createConditionResultModel(UserModel user, BTGExpressionModel condition, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced)
protected BTGResultCacheKey	createKey(BTGAbstractResultModel resultModel)
BTGRuleResultModel	createRuleResult(UserModel user, BTGRuleModel rule, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new rule evaluation result
protected BTGRuleResultModel	createRuleResultModel(UserModel user, BTGRuleModel rule, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced)
BTGSegmentResultModel	createSegmentResult(UserModel user, BTGSegmentModel segment, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced) Creates new segment evaluation result
protected BTGSegmentResultModel	createSegmentResultModel(UserModel user, BTGSegmentModel segment, BTGResultScope scope, boolean result, String jaloSessionId, boolean forced)
protected List<BTGConditionResultData>	findAndRemoveConditionResultEntries(UserModel user, String sessionId, BTGRuleModel rule)
protected List<BTGRuleResultData>	findAndRemoveRuleResultEntries(UserModel user, String sessionId, BTGSegmentModel segment)
protected List<BTGSegmentResultData>	findAndRemoveSegmentResultEntries(UserModel user)
protected 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
protected <T> T	getModel(PK pk) Method return model or null if any exception appeared
protected ModelService	getModelService()
protected ConcurrentMap<BTGResultCacheKey,BTGAbstractResultData>	getResultMap()
Collection<BTGSegmentModel>	getSegments(Collection<CMSSiteModel> websites, BTGConditionEvaluationScope scope, Collection<CatalogVersionModel> catalogVersions) Return segments for specified arguments
protected SessionService	getSessionService()
boolean	isConditionResultChanged(UserModel user, BTGConditionModel condition, BTGResultScope resultScope, boolean newResult, String jaloSessionId) Inspects BTGConditionResultModel for the given BTGConditionModel and UserModel.
boolean	isInvalidated(BTGAbstractResultModel resultModel)
protected boolean	isInvalidatedWhenNoCacheEntryExists()
protected boolean	isResultChangedInternal(boolean newResult, BTGResultCacheKey key, DefaultResultDataCachingBTGDao.BtgResultChangedEvaluator resultChangedEvaluator) This method encapsulates logic for checking if evaluation results has changed.
protected boolean	isResultStoredInDatabase(String scope)
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 user, String sessionId, UserModel destUser, 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.
protected void	moveSessionRuleResults(BTGRuleModel rule, BTGRuleResultData ruleResultEntry, UserModel user, String sessionId, UserModel destUser, BTGResultScope resultScope)
protected void	moveSessionSegmentResults(BTGSegmentModel segment, BTGSegmentResultData segmentResultEntry, UserModel user, String sessionId, UserModel destUser, BTGEvaluationContext destContext)
protected void	populateAbstractResultData(BTGAbstractResultData data, BTGAbstractResultModel model)
protected void	populateAbstractResultModel(BTGAbstractResultModel model, BTGAbstractResultData data)
void	saveConditionResult(BTGConditionResultModel conditionResult)
void	saveRuleResult(BTGRuleResultModel ruleResult)
void	saveSegmentResult(BTGSegmentResultModel segmentResult)
void	setBtgDao(BTGDao btgDao)
void	setInvalidated(BTGAbstractResultModel resultModel, boolean invalidated)
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

DefaultResultDataCachingBTGDao

public DefaultResultDataCachingBTGDao()

Method Detail

getResultMap

protected ConcurrentMap<BTGResultCacheKey,BTGAbstractResultData> getResultMap()

isInvalidated

public boolean isInvalidated(BTGAbstractResultModel resultModel)

Specified by:

isInvalidated in interface BTGInvalidationDataContainer<BTGAbstractResultModel>

createKey

protected BTGResultCacheKey createKey(BTGAbstractResultModel resultModel)

isInvalidatedWhenNoCacheEntryExists

protected boolean isInvalidatedWhenNoCacheEntryExists()

setInvalidated

public void setInvalidated(BTGAbstractResultModel resultModel,
                           boolean invalidated)

Specified by:

setInvalidated in interface BTGInvalidationDataContainer<BTGAbstractResultModel>

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

convertSegmentResultData

protected BTGSegmentResultModel convertSegmentResultData(BTGSegmentResultData segmentResultData)

getModel

protected <T> T getModel(PK pk)

Method return model or null if any exception appeared

populateAbstractResultData

protected void populateAbstractResultData(BTGAbstractResultData data,
                                          BTGAbstractResultModel model)

isResultStoredInDatabase

protected boolean isResultStoredInDatabase(String scope)

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

convertRuleResultData

protected BTGRuleResultModel convertRuleResultData(BTGRuleResultData ruleResultData)

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

convertConditionResultData

protected BTGConditionResultModel convertConditionResultData(BTGConditionResultData conditionResultData)

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

isResultChangedInternal

protected boolean isResultChangedInternal(boolean newResult,
                                          BTGResultCacheKey key,
                                          DefaultResultDataCachingBTGDao.BtgResultChangedEvaluator resultChangedEvaluator)

This method encapsulates logic for checking if evaluation results has changed.

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

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

createSegmentResultModel

protected BTGSegmentResultModel createSegmentResultModel(UserModel user,
                                                         BTGSegmentModel segment,
                                                         BTGResultScope scope,
                                                         boolean result,
                                                         String jaloSessionId,
                                                         boolean forced)

cacheResultData

protected void cacheResultData(BTGResultCacheKey key,
                               BTGAbstractResultData data)

convertSegmentResultModel

protected BTGSegmentResultData convertSegmentResultModel(BTGSegmentResultModel segmentResultModel)

populateAbstractResultModel

protected void populateAbstractResultModel(BTGAbstractResultModel model,
                                           BTGAbstractResultData data)

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

createRuleResultModel

protected BTGRuleResultModel createRuleResultModel(UserModel user,
                                                   BTGRuleModel rule,
                                                   BTGResultScope scope,
                                                   boolean result,
                                                   String jaloSessionId,
                                                   boolean forced)

convertRuleResultModel

protected BTGAbstractResultData convertRuleResultModel(BTGRuleResultModel ruleResultModel)

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

createConditionResultModel

protected BTGConditionResultModel createConditionResultModel(UserModel user,
                                                             BTGExpressionModel condition,
                                                             BTGResultScope scope,
                                                             boolean result,
                                                             String jaloSessionId,
                                                             boolean forced)

convertConditionResultModel

protected BTGAbstractResultData convertConditionResultModel(BTGConditionResultModel conditionResultModel)

saveSegmentResult

public void saveSegmentResult(BTGSegmentResultModel segmentResult)

Specified by:

saveSegmentResult in interface ResultDataCachingBtgDao

saveRuleResult

public void saveRuleResult(BTGRuleResultModel ruleResult)

Specified by:

saveRuleResult in interface ResultDataCachingBtgDao

saveConditionResult

public void saveConditionResult(BTGConditionResultModel conditionResult)

Specified by:

saveConditionResult in interface ResultDataCachingBtgDao

moveSessionResults

public void moveSessionResults(UserModel user,
                               String sessionId,
                               UserModel destUser,
                               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:

user - the source user

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

destUser - the destination user

destContext - the destination context

findAndRemoveSegmentResultEntries

protected List<BTGSegmentResultData> findAndRemoveSegmentResultEntries(UserModel user)

moveSessionSegmentResults

protected void moveSessionSegmentResults(BTGSegmentModel segment,
                                         BTGSegmentResultData segmentResultEntry,
                                         UserModel user,
                                         String sessionId,
                                         UserModel destUser,
                                         BTGEvaluationContext destContext)

findAndRemoveRuleResultEntries

protected List<BTGRuleResultData> findAndRemoveRuleResultEntries(UserModel user,
                                                                 String sessionId,
                                                                 BTGSegmentModel segment)

moveSessionRuleResults

protected void moveSessionRuleResults(BTGRuleModel rule,
                                      BTGRuleResultData ruleResultEntry,
                                      UserModel user,
                                      String sessionId,
                                      UserModel destUser,
                                      BTGResultScope resultScope)

findAndRemoveConditionResultEntries

protected List<BTGConditionResultData> findAndRemoveConditionResultEntries(UserModel user,
                                                                           String sessionId,
                                                                           BTGRuleModel rule)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getBtgDao

protected BTGDao getBtgDao()

setBtgDao

public void setBtgDao(BTGDao btgDao)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)