Package de.hybris.platform.sap.productconfig.services.ssc.strategies.lifecycle.impl

Class DefaultConfigurationLifecycleStrategyImpl

java.lang.Object

de.hybris.platform.sap.productconfig.services.strategies.lifecycle.impl.SessionServiceAware

de.hybris.platform.sap.productconfig.services.ssc.strategies.lifecycle.impl.DefaultConfigurationLifecycleStrategyImpl

All Implemented Interfaces:

ConfigurationLifecycleStrategy

public class DefaultConfigurationLifecycleStrategyImpl
extends SessionServiceAware
implements ConfigurationLifecycleStrategy

Default implementation of the ConfigurationLifecycleStrategy. It uses the hybris session to store any data and hence delegates to the SessionAccessService.

Constructor Summary

Constructors

Constructor	Description
DefaultConfigurationLifecycleStrategyImpl()

Method Summary

Modifier and Type	Method	Description
ConfigModel	createConfigurationFromExternalSource(Configuration extConfig)	Creates a configuration from the configuration in external format which can be provided from outside, e.g.
ConfigModel	createConfigurationFromExternalSource(KBKey kbKey, java.lang.String extConfig)	Creates a configuration from an XML string containing the configuration in external format.
ConfigModel	createDefaultConfiguration(KBKey kbKey)	Creates a default configuration for the required knowledge base.
protected ConfigurationProvider	getConfigurationProvider()
protected ProviderFactory	getProviderFactory()
boolean	isConfigForCurrentUser(java.lang.String configId)	Checks whether the given configuration may be accessed by the current user
boolean	isConfigKnown(java.lang.String configId)	Checks whether the given configuration is persisted/known. In case configuration was created by an external system, it may not be known, but may still be processed within hybris.
void	releaseExpiredSessions(java.lang.String sessionId)	Releases sessions identified by the provided ID.
void	releaseSession(java.lang.String configId)	Releases the configuration sessions identified by the provided ID and all associated resources.
ConfigModel	retrieveConfigurationFromVariant(java.lang.String baseProductCode, java.lang.String variantProductCode)	Get configuration for the base product, initialized with given configuration of the variant
ConfigModel	retrieveConfigurationModel(java.lang.String configId)	Retrieve the current state of the configuration model for the requested configId.
ConfigModel	retrieveConfigurationModel(java.lang.String configId, ConfigurationRetrievalOptions options)	Retrieve the current state of the configuration model for the requested configId.
java.lang.String	retrieveExternalConfiguration(java.lang.String configId)	Retrieve the current state of the configuration for the requested configId as an XML string containing the configuration in external format.
void	setProviderFactory(ProviderFactory providerFactory)
boolean	updateConfiguration(ConfigModel model)	Checks the configuration model for changes since the last update and will send only the changes to the configuration engine, if any.
void	updateUserLinkToConfiguration(java.lang.String userSessionId)	Updates ProductConfigurationModel, after user loged in.

Methods inherited from class de.hybris.platform.sap.productconfig.services.strategies.lifecycle.impl.SessionServiceAware

getSessionAccessService, setSessionAccessService

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfigurationLifecycleStrategyImpl

public DefaultConfigurationLifecycleStrategyImpl()

Method Detail

createDefaultConfiguration

public ConfigModel createDefaultConfiguration(KBKey kbKey)

Description copied from interface: ConfigurationLifecycleStrategy

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 ConfigurationLifecycleStrategy

Parameters:

kbKey - Information needed to identify a knowledge base

Returns:

The configurable product with default configuration

updateConfiguration

public boolean updateConfiguration(ConfigModel model)
                            throws ConfigurationEngineException

Description copied from interface: ConfigurationLifecycleStrategy

Checks the configuration model for changes since the last update and will send only the changes to the configuration engine, if any.

Specified by:

updateConfiguration in interface ConfigurationLifecycleStrategy

Parameters:

model - Updated model

Returns:

true, only if it was necessary to send an updare to the configuration egnine

Throws:

ConfigurationEngineException

updateUserLinkToConfiguration

public void updateUserLinkToConfiguration(java.lang.String userSessionId)

Description copied from interface: ConfigurationLifecycleStrategy

Updates ProductConfigurationModel, after user loged in.

Specified by:

updateUserLinkToConfiguration in interface ConfigurationLifecycleStrategy

Parameters:

userSessionId - user session Id

retrieveConfigurationModel

public ConfigModel retrieveConfigurationModel(java.lang.String configId)
                                       throws ConfigurationEngineException

Description copied from interface: ConfigurationLifecycleStrategy

Retrieve the current state of the configuration model for the requested configId.

Specified by:

retrieveConfigurationModel in interface ConfigurationLifecycleStrategy

Parameters:

configId - Unique configuration ID

Returns:

The actual configuration

Throws:

ConfigurationEngineException - Service has failed, e.g. because session timed out

retrieveConfigurationModel

public ConfigModel retrieveConfigurationModel(java.lang.String configId,
                                              ConfigurationRetrievalOptions options)
                                       throws ConfigurationEngineException

Description copied from interface: ConfigurationLifecycleStrategy

Retrieve the current state of the configuration model for the requested configId.

Specified by:

retrieveConfigurationModel in interface ConfigurationLifecycleStrategy

Parameters:

configId - Unique configuration ID

options - options to consider while reading the configuration, such as additional/updated variant conditions for pricing

Returns:

The actual configuration

Throws:

ConfigurationEngineException - Service has failed, e.g. because session timed out

retrieveExternalConfiguration

public java.lang.String retrieveExternalConfiguration(java.lang.String configId)
                                               throws ConfigurationEngineException

Description copied from interface: ConfigurationLifecycleStrategy

Retrieve the current state of the configuration for the requested configId as an XML string containing the configuration in external format.

Specified by:

retrieveExternalConfiguration in interface ConfigurationLifecycleStrategy

Parameters:

configId - Unique configuration ID

Returns:

The actual configuration as XML string

Throws:

ConfigurationEngineException - Service has failed, e.g. because session timed out

createConfigurationFromExternalSource

public ConfigModel createConfigurationFromExternalSource(Configuration extConfig)

Description copied from interface: ConfigurationLifecycleStrategy

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 ConfigurationLifecycleStrategy

Parameters:

extConfig - External configuration in external format

Returns:

Configuration model

createConfigurationFromExternalSource

public ConfigModel createConfigurationFromExternalSource(KBKey kbKey,
                                                         java.lang.String extConfig)

Description copied from interface: ConfigurationLifecycleStrategy

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 ConfigurationLifecycleStrategy

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: ConfigurationLifecycleStrategy

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 ConfigurationLifecycleStrategy

Parameters:

configId - id of the config session

releaseExpiredSessions

public void releaseExpiredSessions(java.lang.String sessionId)

Description copied from interface: ConfigurationLifecycleStrategy

Releases sessions identified by the provided ID. Accessing the session afterwards is not possible anymore.

Specified by:

releaseExpiredSessions in interface ConfigurationLifecycleStrategy

Parameters:

sessionId - id of the user session

retrieveConfigurationFromVariant

public ConfigModel retrieveConfigurationFromVariant(java.lang.String baseProductCode,
                                                    java.lang.String variantProductCode)

Description copied from interface: ConfigurationLifecycleStrategy

Get configuration for the base product, initialized with given configuration of the variant

Specified by:

retrieveConfigurationFromVariant in interface ConfigurationLifecycleStrategy

Returns:

The pre-filled configuration model

isConfigForCurrentUser

public boolean isConfigForCurrentUser(java.lang.String configId)

Description copied from interface: ConfigurationLifecycleStrategy

Checks whether the given configuration may be accessed by the current user

Specified by:

isConfigForCurrentUser in interface ConfigurationLifecycleStrategy

Parameters:

configId - configuration id

Returns:

true if configuration may be accessed by current user

getConfigurationProvider

protected ConfigurationProvider getConfigurationProvider()

getProviderFactory

protected ProviderFactory getProviderFactory()

setProviderFactory

public void setProviderFactory(ProviderFactory providerFactory)

isConfigKnown

public boolean isConfigKnown(java.lang.String configId)

Description copied from interface: ConfigurationLifecycleStrategy

Checks whether the given configuration is persisted/known.
In case configuration was created by an external system, it may not be known, but may still be processed within hybris.

Specified by:

isConfigKnown in interface ConfigurationLifecycleStrategy

Parameters:

configId - configuration id

Returns:

true if configuration is persisted and known by hybris