de.hybris.platform.personalizationservices.configuration

Interface CxConfigurationService

All Known Implementing Classes:

DefaultCxConfigurationService

public interface CxConfigurationService

Service which declares operations on database stored configuration and fallback to default property based configuration

Method Summary

Modifier and Type	Method and Description
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 getPeriodicVoterConfigurations() Returns set of actions executed for anonymous user for current base site.
java.util.Set<RecalculateAction>	getActionsForAnonymous(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns set of actions executed for anonymous user for given base site.
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
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.
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.
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 getPeriodicVoterConfigurations() Returns number of subsequent requests after which actions for anonymous user should be executed.
java.lang.Integer	getMinRequestNumberForAnonymousActions(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns number of subsequent requests after which actions for anonymous user should be executed.
java.lang.Long	getMinTimeForAnonymousActions() Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Returns time in [ms] between executing actions for anonymous user.
java.lang.Long	getMinTimeForAnonymousActions(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns time in [ms] between executing actions for anonymous user.
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
java.lang.Boolean	isIgnoreOtherActionsForAnonymous() Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Checks if actions from other voters should be ignored for anonymous user.
java.lang.Boolean	isIgnoreOtherActionsForAnonymous(BaseSiteModel baseSiteModel) Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Checks if actions from other voters should be ignored for anonymous user.
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

Method Detail

getConfiguration

java.util.Optional<CxConfigModel> getConfiguration()

Retrieves configuration with current base site returned by BaseSiteService.

Returns:

configuration for current base site or Optional.empty

getConfiguration

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

Retrieves configuration with given base site

Parameters:

baseSiteModel - base site

Returns:

configuration with given base site or Optional.empty

getValue

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

Retrieves configuration attribute value

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

Since:

6.6

getActionResultMaxRepeat

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). 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.

Returns:

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

getActionResultMaxRepeat

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. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Parameters:

baseSiteModel - base site

Returns:

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

getMinAffinity

java.math.BigDecimal getMinAffinity()

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.

Returns:

minimum affinity for user to segment relation

getMinAffinity

java.math.BigDecimal getMinAffinity(BaseSiteModel baseSiteModel)

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.

Parameters:

baseSiteModel - base site

Returns:

minimum affinity for user to segment relation

getUserChangedActions

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). If there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Returns:

actions which should be called after user changed event

getUserChangedActions

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. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Parameters:

baseSiteModel - base site

Returns:

actions which should be called after user changed event

getConsentGivenActions

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. If there is no configuration for current base site, it falls back to *.property file based configuration retrieval.

Returns:

actions which should be called after user gives required consents

Since:

1811

getConsentGivenActions

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. If there is no configuration for given base site, it falls back to *.property file based configuration retrieval.

Parameters:

baseSiteModel - base site

Returns:

actions which should be called after user gives required consents

Since:

1811

getUrlVoterConfigurations

java.util.List<CxUrlVoterConfigModel> getUrlVoterConfigurations()

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

Returns:

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

getUrlVoterConfigurations

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

Retrieves list of url voter configurations with given base site.

Parameters:

baseSiteModel - base site

Returns:

configuration for current base site

getCalculationProcessName

java.lang.String getCalculationProcessName()

Retrieves calculation process name for current base site.

Returns:

calculation process name

getCalculationProcessName

java.lang.String getCalculationProcessName(BaseSiteModel baseSiteModel)

Retrieves calculation process name for given base site.

Parameters:

baseSiteModel - base site

Returns:

calculation process name

getConsentTemplates

java.util.Set<ConsentTemplateModel> getConsentTemplates()

Retrieve ConsentTemplates for personalization for current base site.

Returns:

consent templates

getConsentTemplates

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

Retrieve ConsentTemplates for personalization for for given base site.

Parameters:

baseSiteModel - base site

Returns:

consent templates

isIgnoreRecalcForAnonymous

@Deprecated
java.lang.Boolean isIgnoreRecalcForAnonymous()

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

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

Returns:

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

Since:

6.4

isIgnoreRecalcForAnonymous

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

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

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

Parameters:

baseSiteModel - base site

Returns:

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

Since:

6.4

getDefaultActionsForAnonymous

java.util.Set<RecalculateAction> getDefaultActionsForAnonymous()

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

Returns:

Set of action names which should be executed for anonymous user

Since:

6.4

getDefaultActionsForAnonymous

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

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

Parameters:

baseSiteModel - base site

Returns:

Set of action names which should be executed for anonymous user

Since:

6.4

getActionsForAnonymous

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

Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Returns set of actions executed for anonymous user for current base site.

Returns:

Set of action names which should be executed for anonymous user

Since:

6.4

getActionsForAnonymous

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

Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns set of actions executed for anonymous user for given base site.

Parameters:

baseSiteModel - base site

Returns:

Set of action names which should be executed for anonymous user

Since:

6.4

getMinRequestNumberForAnonymousActions

@Deprecated
java.lang.Integer getMinRequestNumberForAnonymousActions()

Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Returns number of subsequent requests after which actions for anonymous user should be executed.

Returns:

Minimal number of requests between actions

Since:

6.4

getMinRequestNumberForAnonymousActions

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

Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns number of subsequent requests after which actions for anonymous user should be executed.

Parameters:

baseSiteModel - base site

Returns:

Minimal number of requests between actions

Since:

6.4

getMinTimeForAnonymousActions

@Deprecated
java.lang.Long getMinTimeForAnonymousActions()

Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Returns time in [ms] between executing actions for anonymous user.

Returns:

Minimal time between actions

Since:

6.4

getMinTimeForAnonymousActions

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

Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Returns time in [ms] between executing actions for anonymous user.

Parameters:

baseSiteModel - base site

Returns:

Minimal time between actions

Since:

6.4

isIgnoreOtherActionsForAnonymous

@Deprecated
java.lang.Boolean isIgnoreOtherActionsForAnonymous()

Deprecated. As of release 1808, use getPeriodicVoterConfigurations() Checks if actions from other voters should be ignored for anonymous user.

Returns:

True if other actions should be ignored

Since:

6.4

isIgnoreOtherActionsForAnonymous

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

Deprecated. As of release 1808, use getPeriodicVoterConfigurations(BaseSiteModel) Checks if actions from other voters should be ignored for anonymous user.

Parameters:

baseSiteModel - base site

Returns:

True if other actions should be ignored

Since:

6.4

getCatalogLookupType

CxCatalogLookupType getCatalogLookupType()

Returns Catalog lookup type configured for default base site.

Returns:

how catalogs should be traversed by personalization.

Since:

6.6

getCatalogLookupType

CxCatalogLookupType getCatalogLookupType(BaseSiteModel baseSiteModel)

Returns Catalog lookup type configured for given base site.

Parameters:

baseSiteModel - base site

Returns:

how catalogs should be traversed by personalization.

Since:

6.6

isUserSegmentsStoreInSession

java.lang.Boolean isUserSegmentsStoreInSession()

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

Returns:

True if user segments should be stored in session

Since:

6.7

isUserSegmentsStoreInSession

java.lang.Boolean isUserSegmentsStoreInSession(BaseSiteModel baseSite)

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

Parameters:

baseSite - Base site

Returns:

True if user segments should be stored in session

Since:

6.7

getPeriodicVoterConfigurations

java.util.Set<CxPeriodicVoterConfigModel> getPeriodicVoterConfigurations()

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

Returns:

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

Since:

18.08

getPeriodicVoterConfigurations

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

Retrieves list of periodic configurations with given base site.

Parameters:

baseSiteModel - base site

Returns:

configuration for current base site

Since:

18.08