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

Interface ConfigurationClientBase

All Known Subinterfaces:

ConfigurationClient

public interface ConfigurationClientBase

Specifies REST APIs for CPS calls to create, update and release a configuration runtime object

Method Summary

Modifier and Type	Method	Description
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>>	createDefaultConfiguration(CPSCreateConfigInput createConfigInput, java.lang.String lang, java.lang.String sapPassport, java.lang.String autoCleanup)	Create a configuration runtime object
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>>	createRuntimeConfigurationFromExternal(java.lang.String sapPassport, CPSExternalConfiguration externalConfiguration, java.lang.String autoCleanup)	Create a configuration runtime object based on a external representation
rx.Observable	deleteConfiguration(java.lang.String cfgId, java.lang.String eTag, java.lang.String sapPassport)	Release a configuration runtime object
rx.Observable	deleteConfiguration(java.lang.String cfgId, java.lang.String sessionCookieAsString, java.lang.String cfCookieAsString, java.lang.String eTag, java.lang.String sapPassport)	Release a configuration runtime object
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>>	getConfiguration(java.lang.String cfgId, java.lang.String lang, java.lang.String sapPassport)	Get a configuration runtime object
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>>	getConfiguration(java.lang.String cfgId, java.lang.String lang, java.lang.String sessionCookieAsString, java.lang.String cfCookieAsString, java.lang.String sapPassport)	Get a configuration runtime object
rx.Observable<CPSExternalConfiguration>	getExternalConfiguration(java.lang.String cfgId, java.lang.String sapPassport)	Get the external representation of a configuration runtime object
rx.Observable<CPSExternalConfiguration>	getExternalConfiguration(java.lang.String cfgId, java.lang.String sessionCookieAsString, java.lang.String cfCookieAsString, java.lang.String sapPassport)	Get the external representation of a configuration runtime object
rx.Observable	updateConfiguration(CPSCharacteristicInput characteristicInput, java.lang.String cfgId, java.lang.String itemId, java.lang.String csticId, java.lang.String eTag, java.lang.String sapPassport)	Updates a configuration runtime object
rx.Observable	updateConfiguration(CPSCharacteristicInput characteristicInput, java.lang.String cfgId, java.lang.String itemId, java.lang.String csticId, java.lang.String sessionCookieAsString, java.lang.String cfCookieAsString, java.lang.String eTag, java.lang.String sapPassport)	Updates a configuration runtime object

Method Detail

updateConfiguration

@PATCH
@Produces("application/json")
@Path("/configurations/{cfgId}/items/{itemId}/characteristics/{csticId}")
rx.Observable updateConfiguration(CPSCharacteristicInput characteristicInput,
                                  @PathParam("cfgId")
                                  java.lang.String cfgId,
                                  @PathParam("itemId")
                                  java.lang.String itemId,
                                  @PathParam("csticId")
                                  java.lang.String csticId,
                                  @HeaderParam("Cookie")
                                  java.lang.String sessionCookieAsString,
                                  @HeaderParam("Cookie")
                                  java.lang.String cfCookieAsString,
                                  @HeaderParam("If-Match")
                                  java.lang.String eTag,
                                  @HeaderParam("SAP-PASSPORT")
                                  java.lang.String sapPassport)

Updates a configuration runtime object

Parameters:

characteristicInput - Changes to a characteristic

cfgId - ID of runtime object

itemId - ID of item that carries the characteristics to be changed

csticId - ID of characteristic (language independent name)

sessionCookieAsString - Cookie identifying the session

cfCookieAsString - Cookie identifying the node

eTag - eTag id for optimistic locking

sapPassport - SAP passport as string

Returns:

Response. The observable cannot be specified, otherwise the charon method invocation fails

updateConfiguration

@PATCH
@Produces("application/json")
@Path("/configurations/{cfgId}/items/{itemId}/characteristics/{csticId}")
rx.Observable updateConfiguration(CPSCharacteristicInput characteristicInput,
                                  @PathParam("cfgId")
                                  java.lang.String cfgId,
                                  @PathParam("itemId")
                                  java.lang.String itemId,
                                  @PathParam("csticId")
                                  java.lang.String csticId,
                                  @HeaderParam("If-Match")
                                  java.lang.String eTag,
                                  @HeaderParam("SAP-PASSPORT")
                                  java.lang.String sapPassport)

Updates a configuration runtime object

Parameters:

characteristicInput - Changes to a characteristic

cfgId - ID of runtime object

itemId - ID of item that carries the characteristics to be changed

csticId - ID of characteristic (language independent name)

eTag - eTag id for optimistic locking

sapPassport - SAP passport as string

Returns:

Response. The observable cannot be specified, otherwise the charon method invocation fails

getConfiguration

@GET
@Produces("application/json")
@Path("/configurations/{cfgId}")
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> getConfiguration(@PathParam("cfgId")
                                                                                java.lang.String cfgId,
                                                                                @HeaderParam("Accept-Language")
                                                                                java.lang.String lang,
                                                                                @HeaderParam("Cookie")
                                                                                java.lang.String sessionCookieAsString,
                                                                                @HeaderParam("Cookie")
                                                                                java.lang.String cfCookieAsString,
                                                                                @HeaderParam("SAP-PASSPORT")
                                                                                java.lang.String sapPassport)

Get a configuration runtime object

Parameters:

cfgId - ID of runtime object

lang - language in which language-dependent fields are returned (e.g. conflict texts)

sessionCookieAsString - Cookie identifying the session

cfCookieAsString - Cookie identifying the node

sapPassport - SAP passport as string

Returns:

Observable wrapping the configuration object

getConfiguration

@GET
@Produces("application/json")
@Path("/configurations/{cfgId}")
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> getConfiguration(@PathParam("cfgId")
                                                                                java.lang.String cfgId,
                                                                                @HeaderParam("Accept-Language")
                                                                                java.lang.String lang,
                                                                                @HeaderParam("SAP-PASSPORT")
                                                                                java.lang.String sapPassport)

Get a configuration runtime object

Parameters:

cfgId - ID of runtime object

lang - language in which language-dependent fields are returned (e.g. conflict texts)

sapPassport - SAP passport as string

Returns:

Observable wrapping the configuration object

createDefaultConfiguration

@POST
@Produces("application/json")
@Path("/configurations")
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> createDefaultConfiguration(CPSCreateConfigInput createConfigInput,
                                                                                          @HeaderParam("Accept-Language")
                                                                                          java.lang.String lang,
                                                                                          @HeaderParam("SAP-PASSPORT")
                                                                                          java.lang.String sapPassport,
                                                                                          @QueryParam("autoCleanup")
                                                                                          java.lang.String autoCleanup)

Create a configuration runtime object

Parameters:

createConfigInput - Data we need to create a default configuration. We typically only provide the product code

lang - language in which language-dependent fields are returned (e.g. conflict texts)

sapPassport - SAP passport as string

autoCleanup - only if true, cleanUp of old configs will be handled by CPS Service. Typically configs will be auto deleted after a certain time. Otherwise configs are persisted forever, unless they are deleted with a delete request.

Returns:

Response wrapping the configuration object

getExternalConfiguration

@GET
@Produces("application/json")
@Path("/externalConfigurations/{cfgId}")
rx.Observable<CPSExternalConfiguration> getExternalConfiguration(@PathParam("cfgId")
                                                                 java.lang.String cfgId,
                                                                 @HeaderParam("Cookie")
                                                                 java.lang.String sessionCookieAsString,
                                                                 @HeaderParam("Cookie")
                                                                 java.lang.String cfCookieAsString,
                                                                 @HeaderParam("SAP-PASSPORT")
                                                                 java.lang.String sapPassport)

Get the external representation of a configuration runtime object

Parameters:

cfgId - ID of runtime object

sessionCookieAsString - Cookie identifying the session

cfCookieAsString - Cookie identifying the server node

sapPassport - SAP passport as string

Returns:

Observable wrapping the external representation of a configuration object

getExternalConfiguration

@GET
@Produces("application/json")
@Path("/externalConfigurations/{cfgId}")
rx.Observable<CPSExternalConfiguration> getExternalConfiguration(@PathParam("cfgId")
                                                                 java.lang.String cfgId,
                                                                 @HeaderParam("SAP-PASSPORT")
                                                                 java.lang.String sapPassport)

Get the external representation of a configuration runtime object

Parameters:

cfgId - ID of runtime object

sapPassport - SAP passport as string

Returns:

Observable wrapping the external representation of a configuration object

createRuntimeConfigurationFromExternal

@POST
@Produces("application/json")
@Path("/externalConfigurations")
rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> createRuntimeConfigurationFromExternal(@HeaderParam("SAP-PASSPORT")
                                                                                                      java.lang.String sapPassport,
                                                                                                      CPSExternalConfiguration externalConfiguration,
                                                                                                      @QueryParam("autoCleanup")
                                                                                                      java.lang.String autoCleanup)

Create a configuration runtime object based on a external representation

Parameters:

sapPassport - SAP passport as string

externalConfiguration - External representation of a configuration

autoCleanup - only if true, cleanUp of old configs will be handled by CPS Service. Typically configs will be auto deleted after a certain time. Otherwise configs are persisted forever, unless they are deleted with a delete request.

Returns:

Response wrapping the configuration object

deleteConfiguration

@DELETE
@Produces("application/json")
@Path("/configurations/{cfgId}")
rx.Observable deleteConfiguration(@PathParam("cfgId")
                                  java.lang.String cfgId,
                                  @HeaderParam("Cookie")
                                  java.lang.String sessionCookieAsString,
                                  @HeaderParam("Cookie")
                                  java.lang.String cfCookieAsString,
                                  @HeaderParam("If-Match")
                                  java.lang.String eTag,
                                  @HeaderParam("SAP-PASSPORT")
                                  java.lang.String sapPassport)

Release a configuration runtime object

Parameters:

cfgId - ID of runtime object

sessionCookieAsString - Cookie identifying the session

cfCookieAsString - Cookie identifying the server node

eTag - eTag id for optimistic locking

sapPassport - SAP passport as string

Returns:

Response. The observable cannot be specified, otherwise the charon method invocation fails

deleteConfiguration

@DELETE
@Produces("application/json")
@Path("/configurations/{cfgId}")
rx.Observable deleteConfiguration(@PathParam("cfgId")
                                  java.lang.String cfgId,
                                  @HeaderParam("If-Match")
                                  java.lang.String eTag,
                                  @HeaderParam("SAP-PASSPORT")
                                  java.lang.String sapPassport)

Release a configuration runtime object

Parameters:

cfgId - ID of runtime object

eTag - eTag id for optimistic locking

sapPassport - SAP passport as string

Returns:

Response. The observable cannot be specified, otherwise the charon method invocation fails