Package 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 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

      • 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

      • 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:
        1808

      • 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:
        1808