de.hybris.platform.personalizationservices.configuration.impl

Class DefaultCxConfigurationService

java.lang.Object

de.hybris.platform.personalizationservices.configuration.impl.DefaultCxConfigurationService

All Implemented Interfaces:

CxConfigurationService

public class DefaultCxConfigurationService
extends java.lang.Object
implements CxConfigurationService

Default implementation of CxConfigurationService.

Constructor Summary

Constructors

Constructor and Description
DefaultCxConfigurationService()

Method Summary

Modifier and Type	Method and Description
protected boolean	actionExist(java.lang.String actionName)
protected java.util.Set<RecalculateAction>	actionsForAnonymous()
protected CxCatalogLookupType	catalogLookupType()
protected java.util.Set<RecalculateAction>	convertActions(java.util.Set<java.lang.String> actions)
protected java.util.Set<RecalculateAction>	defaultActionsForAnonymous()
java.lang.Integer	getActionResultMaxRepeat() Retrieves number of retires in case of action result load error caused by optimistic locking failure from configuration retrieved with current base site (returned by BaseSiteService).
java.lang.Integer	getActionResultMaxRepeat(BaseSiteModel baseSiteModel) Retrieves number of retires in case of action result load error caused by optimistic locking failure from configuration retrieved with given base site.
java.util.Set<RecalculateAction>	getActionsForAnonymous() Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()
java.util.Set<RecalculateAction>	getActionsForAnonymous(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)
protected BaseSiteService	getBaseSiteService()
java.lang.String	getCalculationProcessName() Retrieves calculation process name for current base site.
java.lang.String	getCalculationProcessName(BaseSiteModel baseSiteModel) Retrieves calculation process name for given base site.
CxCatalogLookupType	getCatalogLookupType() Returns Catalog lookup type configured for default base site.
CxCatalogLookupType	getCatalogLookupType(BaseSiteModel baseSiteModel) Returns Catalog lookup type configured for given base site.
java.util.Optional<CxConfigModel>	getConfiguration() Retrieves configuration with current base site returned by BaseSiteService.
java.util.Optional<CxConfigModel>	getConfiguration(BaseSiteModel baseSiteModel) Retrieves configuration with given base site
protected ConfigurationService	getConfigurationService()
java.util.Set<java.lang.String>	getConsentGivenActions() Retrieves actions which should be called after user gives all required consents for current base site (returned by BaseSiteService) configuration.
java.util.Set<java.lang.String>	getConsentGivenActions(BaseSiteModel baseSiteModel) Retrieves actions which should be called after user gives all required consents for given base site.
java.util.Set<ConsentTemplateModel>	getConsentTemplates() Retrieve ConsentTemplates for personalization for current base site.
java.util.Set<ConsentTemplateModel>	getConsentTemplates(BaseSiteModel baseSiteModel) Retrieve ConsentTemplates for personalization for for given base site.
protected java.util.Optional<BaseSiteModel>	getCurrentBaseSite()
protected CxConfigurationLookupStrategy	getCxConfigurationLookupStrategy()
protected java.lang.Integer	getDefaultActionResultMaxRepeat()
java.util.Set<RecalculateAction>	getDefaultActionsForAnonymous() Returns first set of actions executed for anonymous user for current base site.
java.util.Set<RecalculateAction>	getDefaultActionsForAnonymous(BaseSiteModel baseSiteModel) Returns first set of actions executed for anonymous user for given base site.
protected java.lang.String	getDefaultCalculationProcessName()
protected java.util.Set<java.lang.String>	getDefaultConsentGivenActions()
protected java.math.BigDecimal	getDefaultMinAffinity()
protected java.util.Set<java.lang.String>	getDefaultUserChangedActions()
java.math.BigDecimal	getMinAffinity() Retrieves minimum affinity for user to segment relation from configuration retrieved with current base site (returned by BaseSiteService).
java.math.BigDecimal	getMinAffinity(BaseSiteModel baseSiteModel) Retrieves minimum affinity for user to segment relation from configuration retrieved with given base site.
java.lang.Integer	getMinRequestNumberForAnonymousActions() Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()
java.lang.Integer	getMinRequestNumberForAnonymousActions(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)
java.lang.Long	getMinTimeForAnonymousActions() Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()
java.lang.Long	getMinTimeForAnonymousActions(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)
java.util.Set<CxPeriodicVoterConfigModel>	getPeriodicVoterConfigurations() Retrieves list of periodic configurations with current base site returned by BaseSiteService.
java.util.Set<CxPeriodicVoterConfigModel>	getPeriodicVoterConfigurations(BaseSiteModel baseSiteModel) Retrieves list of periodic configurations with given base site.
java.util.List<CxUrlVoterConfigModel>	getUrlVoterConfigurations() Retrieves list of url voter configurations with current base site returned by BaseSiteService.
java.util.List<CxUrlVoterConfigModel>	getUrlVoterConfigurations(BaseSiteModel baseSiteModel) Retrieves list of url voter configurations with given base site.
java.util.Set<java.lang.String>	getUserChangedActions() Retrieves actions which should be called after user changed event from configuration retrieved with current base site (returned by BaseSiteService).
java.util.Set<java.lang.String>	getUserChangedActions(BaseSiteModel baseSiteModel) Retrieves actions which should be called after user changed event from configuration retrieved with given base site.
<T> T	getValue(CatalogVersionModel catalogVersion, java.util.function.Function<CxConfigModel,T> accessor, T defaultValue) Retrieves configuration attribute value
protected java.lang.Boolean	ignoreOtherActionsForAnonymous()
protected java.lang.Boolean	isDefaultIgnoreRecalcForAnonymous()
java.lang.Boolean	isIgnoreOtherActionsForAnonymous() Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()
java.lang.Boolean	isIgnoreOtherActionsForAnonymous(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)
java.lang.Boolean	isIgnoreRecalcForAnonymous() Deprecated. since 1808 because AnonymousVoter which handled it is not used anymore
java.lang.Boolean	isIgnoreRecalcForAnonymous(BaseSiteModel baseSiteModel) Deprecated. since 1808 because AnonymousVoter which handled it is not used anymore
java.lang.Boolean	isUserSegmentsStoreInSession() Checks if user segments should be stored in session and save to database after session ends
java.lang.Boolean	isUserSegmentsStoreInSession(BaseSiteModel baseSite) Checks if user segments should be stored in session and save to database after session ends
protected java.lang.Integer	minRequestNumberForAnonymousActions()
protected java.lang.Long	minTimeForAnonymousActions()
void	setBaseSiteService(BaseSiteService baseSiteService)
void	setConfigurationService(ConfigurationService configurationService)
void	setCxConfigurationLookupStrategy(CxConfigurationLookupStrategy cxConfigurationLookupStrategy)
protected java.lang.Boolean	userSegmentsStoreInSession()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCxConfigurationService

public DefaultCxConfigurationService()

Method Detail

getConfiguration

public java.util.Optional<CxConfigModel> getConfiguration()

Description copied from interface: CxConfigurationService

Retrieves configuration with current base site returned by BaseSiteService.

Specified by:

getConfiguration in interface CxConfigurationService

Returns:

configuration for current base site or Optional.empty

getConfiguration

public java.util.Optional<CxConfigModel> getConfiguration(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves configuration with given base site

Specified by:

getConfiguration in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

configuration with given base site or Optional.empty

getValue

public <T> T getValue(CatalogVersionModel catalogVersion,
                      java.util.function.Function<CxConfigModel,T> accessor,
                      T defaultValue)

Description copied from interface: CxConfigurationService

Retrieves configuration attribute value

Specified by:

getValue in interface CxConfigurationService

Parameters:

catalogVersion - Catalog version

accessor - Function which returns attribute value from configuration object

defaultValue - Default value of attribute which will be returned in case attribute is not set in configuration or there are conflicting values in configurations related to catalog version (because in current model there can be more than one configuration related to catalog version)

Returns:

configuration attribute value

getActionResultMaxRepeat

public java.lang.Integer getActionResultMaxRepeat()

Description copied from interface: CxConfigurationService

Retrieves number of retires in case of action result load error caused by optimistic locking failure from configuration retrieved with current base site (returned by BaseSiteService). If there is no current base site in session or there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Specified by:

getActionResultMaxRepeat in interface CxConfigurationService

Returns:

number of retires in case of action result load error caused by optimistic

getActionResultMaxRepeat

public java.lang.Integer getActionResultMaxRepeat(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves number of retires in case of action result load error caused by optimistic locking failure from configuration retrieved with given base site. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Specified by:

getActionResultMaxRepeat in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

number of retires in case of action result load error caused by optimistic

getMinAffinity

public java.math.BigDecimal getMinAffinity()

Description copied from interface: CxConfigurationService

Retrieves minimum affinity for user to segment relation from configuration retrieved with current base site (returned by BaseSiteService). If there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Specified by:

getMinAffinity in interface CxConfigurationService

Returns:

minimum affinity for user to segment relation

getMinAffinity

public java.math.BigDecimal getMinAffinity(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves minimum affinity for user to segment relation from configuration retrieved with given base site. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Specified by:

getMinAffinity in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

minimum affinity for user to segment relation

getUserChangedActions

public java.util.Set<java.lang.String> getUserChangedActions()

Description copied from interface: CxConfigurationService

Retrieves actions which should be called after user changed event from configuration retrieved with current base site (returned by BaseSiteService). If there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Specified by:

getUserChangedActions in interface CxConfigurationService

Returns:

actions which should be called after user changed event

getUserChangedActions

public java.util.Set<java.lang.String> getUserChangedActions(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves actions which should be called after user changed event from configuration retrieved with given base site. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Specified by:

getUserChangedActions in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

actions which should be called after user changed event

getConsentGivenActions

public java.util.Set<java.lang.String> getConsentGivenActions()

Description copied from interface: CxConfigurationService

Retrieves actions which should be called after user gives all required consents for current base site (returned by BaseSiteService) configuration. If there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Specified by:

getConsentGivenActions in interface CxConfigurationService

Returns:

actions which should be called after user gives required consents

getConsentGivenActions

public java.util.Set<java.lang.String> getConsentGivenActions(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves actions which should be called after user gives all required consents for given base site. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Specified by:

getConsentGivenActions in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

actions which should be called after user gives required consents

getUrlVoterConfigurations

public java.util.List<CxUrlVoterConfigModel> getUrlVoterConfigurations()

Description copied from interface: CxConfigurationService

Retrieves list of url voter configurations with current base site returned by BaseSiteService.

Specified by:

getUrlVoterConfigurations in interface CxConfigurationService

Returns:

configuration for current base site or Collections.emptyList() if there is no current base site in session.

getUrlVoterConfigurations

public java.util.List<CxUrlVoterConfigModel> getUrlVoterConfigurations(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves list of url voter configurations with given base site.

Specified by:

getUrlVoterConfigurations in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

configuration for current base site

getCalculationProcessName

public java.lang.String getCalculationProcessName()

Description copied from interface: CxConfigurationService

Retrieves calculation process name for current base site.

Specified by:

getCalculationProcessName in interface CxConfigurationService

Returns:

calculation process name

getCalculationProcessName

public java.lang.String getCalculationProcessName(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves calculation process name for given base site.

Specified by:

getCalculationProcessName in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

calculation process name

getConsentTemplates

public java.util.Set<ConsentTemplateModel> getConsentTemplates()

Description copied from interface: CxConfigurationService

Retrieve ConsentTemplates for personalization for current base site.

Specified by:

getConsentTemplates in interface CxConfigurationService

Returns:

consent templates

getConsentTemplates

public java.util.Set<ConsentTemplateModel> getConsentTemplates(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieve ConsentTemplates for personalization for for given base site.

Specified by:

getConsentTemplates in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

consent templates

isIgnoreRecalcForAnonymous

@Deprecated
public java.lang.Boolean isIgnoreRecalcForAnonymous()

Deprecated. since 1808 because AnonymousVoter which handled it is not used anymore

Description copied from interface: CxConfigurationService

Checks if experience recalculation should be ignored for anonymous user for current base site.

Specified by:

isIgnoreRecalcForAnonymous in interface CxConfigurationService

Returns:

true if recalculation should be ignored for anonymous user and false otherwise.

isIgnoreRecalcForAnonymous

@Deprecated
public java.lang.Boolean isIgnoreRecalcForAnonymous(BaseSiteModel baseSiteModel)

Deprecated. since 1808 because AnonymousVoter which handled it is not used anymore

Description copied from interface: CxConfigurationService

Checks if experience recalculation should be ignored for anonymous user for given base site.

Specified by:

isIgnoreRecalcForAnonymous in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

true if recalculation should be ignored for anonymous user and false otherwise.

getDefaultActionsForAnonymous

public java.util.Set<RecalculateAction> getDefaultActionsForAnonymous()

Description copied from interface: CxConfigurationService

Returns first set of actions executed for anonymous user for current base site.

Specified by:

getDefaultActionsForAnonymous in interface CxConfigurationService

Returns:

Set of action names which should be executed for anonymous user

getDefaultActionsForAnonymous

public java.util.Set<RecalculateAction> getDefaultActionsForAnonymous(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Returns first set of actions executed for anonymous user for given base site.

Specified by:

getDefaultActionsForAnonymous in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

Set of action names which should be executed for anonymous user

getActionsForAnonymous

@Deprecated
public java.util.Set<RecalculateAction> getActionsForAnonymous()

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()

Specified by:

getActionsForAnonymous in interface CxConfigurationService

Returns:

Set of action names which should be executed for anonymous user

getActionsForAnonymous

@Deprecated
public java.util.Set<RecalculateAction> getActionsForAnonymous(BaseSiteModel baseSiteModel)

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)

Specified by:

getActionsForAnonymous in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

Set of action names which should be executed for anonymous user

getMinRequestNumberForAnonymousActions

@Deprecated
public java.lang.Integer getMinRequestNumberForAnonymousActions()

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()

Specified by:

getMinRequestNumberForAnonymousActions in interface CxConfigurationService

Returns:

Minimal number of requests between actions

getMinRequestNumberForAnonymousActions

@Deprecated
public java.lang.Integer getMinRequestNumberForAnonymousActions(BaseSiteModel baseSiteModel)

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)

Specified by:

getMinRequestNumberForAnonymousActions in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

Minimal number of requests between actions

getMinTimeForAnonymousActions

@Deprecated
public java.lang.Long getMinTimeForAnonymousActions()

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()

Specified by:

getMinTimeForAnonymousActions in interface CxConfigurationService

Returns:

Minimal time between actions

getMinTimeForAnonymousActions

@Deprecated
public java.lang.Long getMinTimeForAnonymousActions(BaseSiteModel baseSiteModel)

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)

Specified by:

getMinTimeForAnonymousActions in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

Minimal time between actions

isIgnoreOtherActionsForAnonymous

@Deprecated
public java.lang.Boolean isIgnoreOtherActionsForAnonymous()

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations()

Specified by:

isIgnoreOtherActionsForAnonymous in interface CxConfigurationService

Returns:

True if other actions should be ignored

isIgnoreOtherActionsForAnonymous

@Deprecated
public java.lang.Boolean isIgnoreOtherActionsForAnonymous(BaseSiteModel baseSiteModel)

Deprecated. As of release 1808, use CxConfigurationService.getPeriodicVoterConfigurations(BaseSiteModel)

Specified by:

isIgnoreOtherActionsForAnonymous in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

True if other actions should be ignored

getCatalogLookupType

public CxCatalogLookupType getCatalogLookupType()

Description copied from interface: CxConfigurationService

Returns Catalog lookup type configured for default base site.

Specified by:

getCatalogLookupType in interface CxConfigurationService

Returns:

how catalogs should be traversed by personalization.

getCatalogLookupType

public CxCatalogLookupType getCatalogLookupType(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Returns Catalog lookup type configured for given base site.

Specified by:

getCatalogLookupType in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

how catalogs should be traversed by personalization.

isUserSegmentsStoreInSession

public java.lang.Boolean isUserSegmentsStoreInSession()

Description copied from interface: CxConfigurationService

Checks if user segments should be stored in session and save to database after session ends

Specified by:

isUserSegmentsStoreInSession in interface CxConfigurationService

Returns:

True if user segments should be stored in session

isUserSegmentsStoreInSession

public java.lang.Boolean isUserSegmentsStoreInSession(BaseSiteModel baseSite)

Description copied from interface: CxConfigurationService

Checks if user segments should be stored in session and save to database after session ends

Specified by:

isUserSegmentsStoreInSession in interface CxConfigurationService

Parameters:

baseSite - Base site

Returns:

True if user segments should be stored in session

getPeriodicVoterConfigurations

public java.util.Set<CxPeriodicVoterConfigModel> getPeriodicVoterConfigurations()

Description copied from interface: CxConfigurationService

Retrieves list of periodic configurations with current base site returned by BaseSiteService.

Specified by:

getPeriodicVoterConfigurations in interface CxConfigurationService

Returns:

configuration for current base site or Collections.emptyList() if there is no current base site in session.

getPeriodicVoterConfigurations

public java.util.Set<CxPeriodicVoterConfigModel> getPeriodicVoterConfigurations(BaseSiteModel baseSiteModel)

Description copied from interface: CxConfigurationService

Retrieves list of periodic configurations with given base site.

Specified by:

getPeriodicVoterConfigurations in interface CxConfigurationService

Parameters:

baseSiteModel - base site

Returns:

configuration for current base site

getDefaultCalculationProcessName

protected java.lang.String getDefaultCalculationProcessName()

getDefaultActionResultMaxRepeat

protected java.lang.Integer getDefaultActionResultMaxRepeat()

getDefaultMinAffinity

protected java.math.BigDecimal getDefaultMinAffinity()

getDefaultUserChangedActions

protected java.util.Set<java.lang.String> getDefaultUserChangedActions()

getDefaultConsentGivenActions

protected java.util.Set<java.lang.String> getDefaultConsentGivenActions()

isDefaultIgnoreRecalcForAnonymous

protected java.lang.Boolean isDefaultIgnoreRecalcForAnonymous()

getCurrentBaseSite

protected java.util.Optional<BaseSiteModel> getCurrentBaseSite()

defaultActionsForAnonymous

protected java.util.Set<RecalculateAction> defaultActionsForAnonymous()

actionsForAnonymous

protected java.util.Set<RecalculateAction> actionsForAnonymous()

minRequestNumberForAnonymousActions

protected java.lang.Integer minRequestNumberForAnonymousActions()

minTimeForAnonymousActions

protected java.lang.Long minTimeForAnonymousActions()

ignoreOtherActionsForAnonymous

protected java.lang.Boolean ignoreOtherActionsForAnonymous()

catalogLookupType

protected CxCatalogLookupType catalogLookupType()

convertActions

protected java.util.Set<RecalculateAction> convertActions(java.util.Set<java.lang.String> actions)

actionExist

protected boolean actionExist(java.lang.String actionName)

userSegmentsStoreInSession

protected java.lang.Boolean userSegmentsStoreInSession()

getBaseSiteService

protected BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCxConfigurationLookupStrategy

protected CxConfigurationLookupStrategy getCxConfigurationLookupStrategy()

setCxConfigurationLookupStrategy

public void setCxConfigurationLookupStrategy(CxConfigurationLookupStrategy cxConfigurationLookupStrategy)