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

Interface CharonFacade

All Known Implementing Classes:

CharonFacadeImpl

public interface CharonFacade

Facade around charon REST accesses

Method Summary

Modifier and Type	Method	Description
CPSConfiguration	createConfigurationFromExternal(CPSExternalConfiguration externalConfigStructured)	Deprecated, for removal: This API element is subject to removal in a future version. since 18.11.0 - use createConfigurationFromExternal(CPSExternalConfiguration, String)
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 createConfigurationFromExternal(String, String)
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
CPSConfiguration	getConfiguration(java.lang.String configId)	Gets configuration, sends cookies along with request.
java.lang.String	getExternalConfiguration(java.lang.String configId)	Retrieves the external representation for a given runtime configuration
void	releaseSession(java.lang.String configId, java.lang.String version)	Deletes the session for the specified runtime configuration on the client
java.lang.String	updateConfiguration(CPSConfiguration configuration)	Updates configuration, sends cookies along with request.

Method Detail

createDefaultConfiguration

CPSConfiguration createDefaultConfiguration(KBKey kbKey)

Create default configuration and handle cookies

Parameters:

kbKey - key of the knowledgebase

Returns:

runtime configuration

getExternalConfiguration

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

Retrieves the external representation for a given runtime configuration

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

createConfigurationFromExternal

@Deprecated(since="1811",
            forRemoval=true)
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 createConfigurationFromExternal(String, String)

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

Parameters:

externalConfiguration - external representation of the configuration

Returns:

runtime configuration based on the external representation

releaseSession

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

Deletes the session for the specified runtime configuration on the client

Parameters:

configId - id of the runtime configuration to be deleted

version - version of the runtime configuration to be deleted

createConfigurationFromExternal

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

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

since 18.11.0 - use createConfigurationFromExternal(CPSExternalConfiguration, String)

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

Parameters:

externalConfigStructured - The structured external configuration

Returns:

Runtime representation

updateConfiguration

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

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

Parameters:

configuration - runtime configuration that includes only the updates

Returns:

version of the updated runtime configuration

Throws:

ConfigurationEngineException - when service call fails

getConfiguration

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

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

Parameters:

configId - configuration id

Returns:

current state of the runtime configuration

Throws:

ConfigurationEngineException - when service call fails

createConfigurationFromExternal

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

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

Parameters:

externalConfiguration - external representation of the configuration

contextProduct - context product

Returns:

runtime configuration based on the external representation

createConfigurationFromExternal

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

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

Parameters:

externalConfigStructured - structured external configuration

contextProduct - context product

Returns:

Runtime representation