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

Class CharonFacadeImpl

java.lang.Object

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

All Implemented Interfaces:

CharonFacade

public class CharonFacadeImpl
extends java.lang.Object
implements CharonFacade

Default implementation of CharonFacade. This bean has prototype scope

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	AUTO_CLEAN_UP_FALSE
protected static java.lang.String	ETAG_NOT_FOUND
static java.lang.String	PASSPORT_CREATE_CONFIG
static java.lang.String	PASSPORT_CREATE_FROM_EXT_CONFIG
static java.lang.String	PASSPORT_DELETE_CONFIG
static java.lang.String	PASSPORT_GET_CONFIG
static java.lang.String	PASSPORT_GET_EXT_CONFIG
static java.lang.String	PASSPORT_UPDATE_CONFIG

Constructor Summary

Constructors

Constructor	Description
CharonFacadeImpl()

Method Summary

Modifier and Type	Method	Description
protected CPSCreateConfigInput	assembleCreateDefaultConfigurationRequest(KBKey kbKey)
protected CPSExternalConfiguration	convertFromStringToStructured(java.lang.String externalConfiguration)
protected CPSCharacteristicInput	createCharacteristicInput(CPSCharacteristic characteristic)
CPSConfiguration	createConfigurationFromExternal(CPSExternalConfiguration externalConfigStructured)	Deprecated, for removal: This API element is subject to removal in a future version. since 18.11.0 - use CharonFacade.createConfigurationFromExternal(CPSExternalConfiguration, String) instead
CPSConfiguration	createConfigurationFromExternal(CPSExternalConfiguration externalConfigStructured, java.lang.String contextProduct)	Creates a new runtime configuration from the external typed representation of the configuration
CPSConfiguration	createConfigurationFromExternal(java.lang.String externalConfiguration)	Deprecated, for removal: This API element is subject to removal in a future version. since 18.11.0 - use CharonFacade.createConfigurationFromExternal(String, String) instead
CPSConfiguration	createConfigurationFromExternal(java.lang.String externalConfiguration, java.lang.String contextProduct)	Creates a new runtime configuration from the external representation of the configuration
CPSConfiguration	createDefaultConfiguration(KBKey kbKey)	Create default configuration and handle cookies
protected java.lang.String	encode(java.lang.String requestParam)
protected ApiRegistryClientService	getApiRegistryClientService()
protected java.lang.String	getAutoCleanUpFlag()
protected CPSCache	getCache()
protected ConfigurationClientBase	getClient()
protected CommerceExternalConfigurationStrategy	getCommerceExternalConfigurationStrategy()
CPSConfiguration	getConfiguration(java.lang.String configId)	Gets configuration, sends cookies along with request.
protected CPSConfigurationParentReferenceStrategy	getConfigurationParentReferenceStrategy()
protected CPSContextSupplier	getContextSupplier()
java.lang.String	getExternalConfiguration(java.lang.String configId)	Retrieves the external representation for a given runtime configuration
protected I18NService	getI18NService()
protected KnowledgebaseKeyComparator	getKbKeyComparator()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected ProductConfigurationPassportService	getPassportService()
protected RequestErrorHandler	getRequestErrorHandler()
protected CPSResponseAttributeStrategy	getResponseStrategy()
protected rx.Scheduler	getScheduler()
protected java.lang.String	handleUpdateOwnCharacteristics(org.apache.commons.lang.mutable.MutableBoolean updateWasDone, CPSItem item, java.lang.String cfgId, java.lang.String currentVersion, java.lang.String itemId)
protected java.lang.String	handleUpdateSubItems(org.apache.commons.lang.mutable.MutableBoolean updateWasDone, CPSItem item, java.lang.String cfgId, java.lang.String currentVersion)
protected CPSExternalConfiguration	placeGetExternalConfigurationRequest(java.lang.String configId)
void	releaseSession(java.lang.String configId, java.lang.String version)	Deletes the session for the specified runtime configuration on the client
protected CPSConfiguration	retrieveConfiguration(java.lang.String configId)
protected CPSConfiguration	retrieveConfigurationAndSaveResponseAttributes(rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> rawResponse)
protected CPSConfiguration	retrieveConfigurationFromClient(java.lang.String configId)
void	setApiRegistryClientService(ApiRegistryClientService apiRegistryClientService)
void	setCache(CPSCache cache)
void	setClient(ConfigurationClientBase newClient)	Sets charon client from outside.
void	setCommerceExternalConfigurationStrategy(CommerceExternalConfigurationStrategy commerceExternalConfigurationStrategy)
void	setConfigurationParentReferenceStrategy(CPSConfigurationParentReferenceStrategy configurationParentReferenceStrategy)
void	setContextSupplier(CPSContextSupplier contextSupplier)
void	setI18NService(I18NService i18nService)
void	setKbKeyComparator(KnowledgebaseKeyComparator kbKeyComparator)
protected void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
void	setPassportService(ProductConfigurationPassportService sapPassportService)
void	setRequestErrorHandler(RequestErrorHandler requestErrorHandler)
void	setResponseStrategy(CPSResponseAttributeStrategy responseStrategy)
protected void	traceJsonRequestBody(java.lang.String prefix, java.lang.Object obj)
java.lang.String	updateConfiguration(CPSConfiguration configuration)	Updates configuration, sends cookies along with request.
protected java.lang.String	updateConfiguration(java.lang.String cfgId, java.lang.String version, java.lang.String itemId, java.lang.String csticId, CPSCharacteristicInput changes)
protected java.lang.String	updateCPSCharacteristic(org.apache.commons.lang.mutable.MutableBoolean updateWasDone, CPSItem item, java.lang.String cfgId, java.lang.String currentVersion, java.lang.String itemId)

Methods inherited from class java.lang.Object

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

Field Detail

ETAG_NOT_FOUND

protected static final java.lang.String ETAG_NOT_FOUND

See Also:

Constant Field Values

AUTO_CLEAN_UP_FALSE

protected static final java.lang.String AUTO_CLEAN_UP_FALSE

See Also:

Constant Field Values

PASSPORT_CREATE_CONFIG

public static final java.lang.String PASSPORT_CREATE_CONFIG

See Also:

Constant Field Values

PASSPORT_CREATE_FROM_EXT_CONFIG

public static final java.lang.String PASSPORT_CREATE_FROM_EXT_CONFIG

See Also:

Constant Field Values

PASSPORT_UPDATE_CONFIG

public static final java.lang.String PASSPORT_UPDATE_CONFIG

See Also:

Constant Field Values

PASSPORT_GET_CONFIG

public static final java.lang.String PASSPORT_GET_CONFIG

See Also:

Constant Field Values

PASSPORT_GET_EXT_CONFIG

public static final java.lang.String PASSPORT_GET_EXT_CONFIG

See Also:

Constant Field Values

PASSPORT_DELETE_CONFIG

public static final java.lang.String PASSPORT_DELETE_CONFIG

See Also:

Constant Field Values

Constructor Detail

CharonFacadeImpl

public CharonFacadeImpl()

Method Detail

getPassportService

protected ProductConfigurationPassportService getPassportService()

Returns:

the passportService

getApiRegistryClientService

protected ApiRegistryClientService getApiRegistryClientService()

getCommerceExternalConfigurationStrategy

protected CommerceExternalConfigurationStrategy getCommerceExternalConfigurationStrategy()

Returns:

the commerceExternalConfigurationStrategy

createDefaultConfiguration

public CPSConfiguration createDefaultConfiguration(KBKey kbKey)

Description copied from interface: CharonFacade

Create default configuration and handle cookies

Specified by:

createDefaultConfiguration in interface CharonFacade

Parameters:

kbKey - key of the knowledgebase

Returns:

runtime configuration

assembleCreateDefaultConfigurationRequest

protected CPSCreateConfigInput assembleCreateDefaultConfigurationRequest(KBKey kbKey)

getExternalConfiguration

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

Description copied from interface: CharonFacade

Retrieves the external representation for a given runtime configuration

Specified by:

getExternalConfiguration in interface CharonFacade

Parameters:

configId - id of the runtime configuration

Returns:

external representation of the runtime configuration

Throws:

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

placeGetExternalConfigurationRequest

protected CPSExternalConfiguration placeGetExternalConfigurationRequest(java.lang.String configId)
                                                                 throws ConfigurationEngineException

Throws:

ConfigurationEngineException

createConfigurationFromExternal

@Deprecated(since="1811",
            forRemoval=true)
public CPSConfiguration createConfigurationFromExternal(java.lang.String externalConfiguration)

Deprecated, for removal: This API element is subject to removal in a future version.

since 18.11.0 - use CharonFacade.createConfigurationFromExternal(String, String) instead

Description copied from interface: CharonFacade

Creates a new runtime configuration from the external representation of the configuration

Specified by:

createConfigurationFromExternal in interface CharonFacade

Parameters:

externalConfiguration - external representation of the configuration

Returns:

runtime configuration based on the external representation

createConfigurationFromExternal

@Deprecated(since="1811",
            forRemoval=true)
public CPSConfiguration createConfigurationFromExternal(CPSExternalConfiguration externalConfigStructured)

Deprecated, for removal: This API element is subject to removal in a future version.

since 18.11.0 - use CharonFacade.createConfigurationFromExternal(CPSExternalConfiguration, String) instead

Description copied from interface: CharonFacade

Creates a new runtime configuration from the external typed representation of the configuration

Specified by:

createConfigurationFromExternal in interface CharonFacade

Parameters:

externalConfigStructured - The structured external configuration

Returns:

Runtime representation

createConfigurationFromExternal

public CPSConfiguration createConfigurationFromExternal(java.lang.String externalConfiguration,
                                                        java.lang.String contextProduct)

Description copied from interface: CharonFacade

Creates a new runtime configuration from the external representation of the configuration

Specified by:

createConfigurationFromExternal in interface CharonFacade

Parameters:

externalConfiguration - external representation of the configuration

contextProduct - context product

Returns:

runtime configuration based on the external representation

createConfigurationFromExternal

public CPSConfiguration createConfigurationFromExternal(CPSExternalConfiguration externalConfigStructured,
                                                        java.lang.String contextProduct)

Description copied from interface: CharonFacade

Creates a new runtime configuration from the external typed representation of the configuration

Specified by:

createConfigurationFromExternal in interface CharonFacade

Parameters:

externalConfigStructured - structured external configuration

contextProduct - context product

Returns:

Runtime representation

getAutoCleanUpFlag

protected java.lang.String getAutoCleanUpFlag()

convertFromStringToStructured

protected CPSExternalConfiguration convertFromStringToStructured(java.lang.String externalConfiguration)

releaseSession

public void releaseSession(java.lang.String configId,
                           java.lang.String version)

Description copied from interface: CharonFacade

Deletes the session for the specified runtime configuration on the client

Specified by:

releaseSession in interface CharonFacade

Parameters:

configId - id of the runtime configuration to be deleted

version - version of the runtime configuration to be deleted

updateConfiguration

public java.lang.String updateConfiguration(CPSConfiguration configuration)
                                     throws ConfigurationEngineException

Description copied from interface: CharonFacade

Updates configuration, sends cookies along with request. The cookies are handled internally and received from the CPSResponseAttributeStrategy

Specified by:

updateConfiguration in interface CharonFacade

Parameters:

configuration - runtime configuration that includes only the updates

Returns:

version of the updated runtime configuration

Throws:

ConfigurationEngineException - when service call fails

updateCPSCharacteristic

protected java.lang.String updateCPSCharacteristic(org.apache.commons.lang.mutable.MutableBoolean updateWasDone,
                                                   CPSItem item,
                                                   java.lang.String cfgId,
                                                   java.lang.String currentVersion,
                                                   java.lang.String itemId)
                                            throws ConfigurationEngineException

Throws:

ConfigurationEngineException

handleUpdateSubItems

protected java.lang.String handleUpdateSubItems(org.apache.commons.lang.mutable.MutableBoolean updateWasDone,
                                                CPSItem item,
                                                java.lang.String cfgId,
                                                java.lang.String currentVersion)
                                         throws ConfigurationEngineException

Throws:

ConfigurationEngineException

handleUpdateOwnCharacteristics

protected java.lang.String handleUpdateOwnCharacteristics(org.apache.commons.lang.mutable.MutableBoolean updateWasDone,
                                                          CPSItem item,
                                                          java.lang.String cfgId,
                                                          java.lang.String currentVersion,
                                                          java.lang.String itemId)
                                                   throws ConfigurationEngineException

Throws:

ConfigurationEngineException

createCharacteristicInput

protected CPSCharacteristicInput createCharacteristicInput(CPSCharacteristic characteristic)

updateConfiguration

protected java.lang.String updateConfiguration(java.lang.String cfgId,
                                               java.lang.String version,
                                               java.lang.String itemId,
                                               java.lang.String csticId,
                                               CPSCharacteristicInput changes)
                                        throws ConfigurationEngineException

Throws:

ConfigurationEngineException

encode

protected java.lang.String encode(java.lang.String requestParam)

getConfiguration

public CPSConfiguration getConfiguration(java.lang.String configId)
                                  throws ConfigurationEngineException

Description copied from interface: CharonFacade

Gets configuration, sends cookies along with request. The cookies are handled internally and received from the CPSResponseAttributeStrategy

Specified by:

getConfiguration in interface CharonFacade

Parameters:

configId - configuration id

Returns:

current state of the runtime configuration

Throws:

ConfigurationEngineException - when service call fails

retrieveConfiguration

protected CPSConfiguration retrieveConfiguration(java.lang.String configId)
                                          throws ConfigurationEngineException

Throws:

ConfigurationEngineException

retrieveConfigurationFromClient

protected CPSConfiguration retrieveConfigurationFromClient(java.lang.String configId)
                                                    throws ConfigurationEngineException

Throws:

ConfigurationEngineException

getKbKeyComparator

protected KnowledgebaseKeyComparator getKbKeyComparator()

setKbKeyComparator

public void setKbKeyComparator(KnowledgebaseKeyComparator kbKeyComparator)

setCommerceExternalConfigurationStrategy

public void setCommerceExternalConfigurationStrategy(CommerceExternalConfigurationStrategy commerceExternalConfigurationStrategy)

Parameters:

commerceExternalConfigurationStrategy -

getRequestErrorHandler

protected RequestErrorHandler getRequestErrorHandler()

setRequestErrorHandler

public void setRequestErrorHandler(RequestErrorHandler requestErrorHandler)

Parameters:

requestErrorHandler - For wrapping the http errors we receive from the REST service call

getClient

protected ConfigurationClientBase getClient()

setClient

public void setClient(ConfigurationClientBase newClient)

Sets charon client from outside. Only used in test environments

Parameters:

newClient - Charon client representing REST calls for product configuration.

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setObjectMapper

protected void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

getScheduler

protected rx.Scheduler getScheduler()

getContextSupplier

protected CPSContextSupplier getContextSupplier()

Returns:

the contextSupplier

setContextSupplier

public void setContextSupplier(CPSContextSupplier contextSupplier)

Parameters:

contextSupplier - the contextSupplier to set

getI18NService

protected I18NService getI18NService()

setI18NService

public void setI18NService(I18NService i18nService)

Parameters:

i18nService - the i18NService to set

getCache

protected CPSCache getCache()

setCache

public void setCache(CPSCache cache)

traceJsonRequestBody

protected void traceJsonRequestBody(java.lang.String prefix,
                                    java.lang.Object obj)

retrieveConfigurationAndSaveResponseAttributes

protected CPSConfiguration retrieveConfigurationAndSaveResponseAttributes(rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> rawResponse)

getResponseStrategy

protected CPSResponseAttributeStrategy getResponseStrategy()

setResponseStrategy

public void setResponseStrategy(CPSResponseAttributeStrategy responseStrategy)

getConfigurationParentReferenceStrategy

protected CPSConfigurationParentReferenceStrategy getConfigurationParentReferenceStrategy()

setConfigurationParentReferenceStrategy

public void setConfigurationParentReferenceStrategy(CPSConfigurationParentReferenceStrategy configurationParentReferenceStrategy)

setApiRegistryClientService

public void setApiRegistryClientService(ApiRegistryClientService apiRegistryClientService)

setPassportService

public void setPassportService(ProductConfigurationPassportService sapPassportService)