Package de.hybris.platform.sap.productconfig.runtime.cps.impl

Class CPSConfigurationProvider

    • Constructor Detail

      • CPSConfigurationProvider

        public CPSConfigurationProvider()

    • Method Detail

      • createDefaultConfiguration

        public ConfigModel createDefaultConfiguration​(KBKey kbKey)
        Description copied from interface: ConfigurationProvider
        Creates a default configuration for the required knowledge base. The knowledge base (KB) can be identified e.g. via the product code or via the KB name, version and logical system.
        Specified by:
        createDefaultConfiguration in interface ConfigurationProvider
        Parameters:
        kbKey - Information needed to identify a knowledge base
        Returns:
        The configurable product with default configuration

      • createConfigurationFromExternalSource

        public ConfigModel createConfigurationFromExternalSource​(KBKey kbKey,
                                                         java.lang.String extConfig)
        Description copied from interface: ConfigurationProvider
        Creates a configuration from an XML string containing the configuration in external format.

        This API requires the KB related attributes as part of the external configuration to be available, they are directly forwarded to the configuration engine.
        Specified by:
        createConfigurationFromExternalSource in interface ConfigurationProvider
        Parameters:
        kbKey - Information needed to create a knowledge base
        extConfig - External configuration as XML string
        Returns:
        Configuration model

      • releaseSession

        public void releaseSession​(java.lang.String configId)
        Description copied from interface: ConfigurationProvider
        Releases the configuration sessions identified by the provided ID and all associated resources. Accessing the session afterwards is not possible anymore.
        Specified by:
        releaseSession in interface ConfigurationProvider
        Parameters:
        configId - session id

      • createConfigurationFromExternalSource

        public ConfigModel createConfigurationFromExternalSource​(Configuration extConfig)
        Description copied from interface: ConfigurationProvider
        Creates a configuration from the configuration in external format which can be provided from outside, e.g. from the configuration prepared in the back end.

        This API does _not_ force the KB related attributes to be existing. In case only the product ID is provided, a matching KB version is determined.
        Specified by:
        createConfigurationFromExternalSource in interface ConfigurationProvider
        Parameters:
        extConfig - External configuration in external format
        Returns:
        Configuration model

      • findKbId

        protected java.lang.Integer findKbId​(KBKey kbKey)
        This method is only intended for situations where product and date are provided as part of the KB key. If this is not the case, an exception is thrown
        Parameters:
        kbKey -
        Returns:
        KB ID

      • setConfigModelConverter

        public void setConfigModelConverter​(Converter<CPSConfiguration,​ConfigModel> configModelConverter)
        Set converter, target: (engine independent) models
        Parameters:
        configModelConverter -

      • getCharonFacade

        protected CharonFacade getCharonFacade()

      • setCharonFacade

        public void setCharonFacade​(CharonFacade charonFacade)
        Parameters:
        charonFacade - the charonFacade to set

      • isKbForDateExists

        public boolean isKbForDateExists​(java.lang.String productCode,
                                 java.util.Date kbDate)
        Specified by:
        isKbForDateExists in interface ConfigurationProvider
        Returns:
        true only if a valid KBVersion exists for the given product and date.

      • isKbVersionExists

        public boolean isKbVersionExists​(KBKey kbKey)
        Specified by:
        isKbVersionExists in interface ConfigurationProvider
        Returns:
        returns true only if the KB version identified by the the given KBKey is known by the underlying configuration engine.

      • isKbVersionValid

        public boolean isKbVersionValid​(KBKey kbKey)
        Specified by:
        isKbVersionValid in interface ConfigurationProvider
        Returns:
        returns true only if the KB version identified by the the given KBKey is known by the underlying configuration engine and if it is still valid on the given date.

      • setCharonKbDeterminationFacade

        public void setCharonKbDeterminationFacade​(CharonKbDeterminationFacade charonKbDeterminationFacade)
        Parameters:
        charonKbDeterminationFacade - the charonKbDeterminationFacade to set

      • setExternalConfigurationFromVariantStrategy

        public void setExternalConfigurationFromVariantStrategy​(ExternalConfigurationFromVariantStrategy externalConfigurationFromVariantStrategy)
        Parameters:
        externalConfigurationFromVariantStrategy -

      • retrieveConfigurationFromVariant

        public ConfigModel retrieveConfigurationFromVariant​(java.lang.String baseProductCode,
                                                    java.lang.String variantProductCode)
        Description copied from interface: ConfigurationProvider
        Get configuration for the base product, initialized with given configuration of the variant
        Specified by:
        retrieveConfigurationFromVariant in interface ConfigurationProvider
        Returns:
        The pre-filled configuration model

      • setConfigurationChangeAdapter

        public void setConfigurationChangeAdapter​(CPSConfigurationChangeAdapter configurationChangeAdapter)
        Parameters:
        configurationChangeAdapter - the configurationChangeAdapter to set

      • changeConfiguration

        public java.lang.String changeConfiguration​(ConfigModel model)
                                     throws ConfigurationEngineException
        Description copied from interface: ConfigurationProvider
        Checks the configuration model for changes since the last update and will send only the changes to the configuration engine, if any. The version of the runtime configuration must be included in the configuration model and the method returns the new version after the update.
        Specified by:
        changeConfiguration in interface ConfigurationProvider
        Parameters:
        model - Updated model
        Returns:
        new configuration runtime version if update successful, otherwise null
        Throws:
        ConfigurationEngineException

      • releaseSession

        public void releaseSession​(java.lang.String configId,
                           java.lang.String version)
        Description copied from interface: ConfigurationProvider
        Releases the configuration sessions identified by the provided ID and all associated resources. Accessing the session afterwards is not possible anymore.
        Specified by:
        releaseSession in interface ConfigurationProvider
        Parameters:
        configId - session id
        version - version of the runtime configuration

      • extractKbKey

        public KBKey extractKbKey​(java.lang.String productCode,
                          java.lang.String externalConfig)
        Description copied from interface: ConfigurationProvider
        extracts the KBKey from the external configuration
        Specified by:
        extractKbKey in interface ConfigurationProvider
        Returns:
        returns the kBKey of the given external config

      • setConfigurationModificationHandler

        public void setConfigurationModificationHandler​(ConfigurationModificationHandler configurationModificationHandler)
        Parameters:
        configurationModificationHandler - the configurationModificationHandler to set