Connector for commercetools Manual / Version 2512.1
Table Of Contents
cache.capacities
| |
| Type |
Map<String,Long>
|
| Description |
Number of cache entries per cache class until cache eviction takes place. The keys must match the cache classes as defined by the cache keys. Please refer to javadoc of com.coremedia.cache.CacheKey. |
cache.capacities.contenthub.children
| |
| Type |
Long
|
| Default | 1000 |
| Description |
Sets the cache size for the getChildren call in content hub. |
cache.capacities.contenthub.object
| |
| Type |
Long
|
| Default | 1000 |
| Description |
Sets the cache size for the content hub objects which includes items as well as folders. |
cache.capacities.contenthub.rootfolder
| |
| Type |
Long
|
| Default | 20 |
| Description |
Sets the cache size for the content hub root folders (adapters). |
cache.timeout-seconds
| |
| Type |
Map<String,Long>
|
| Description |
TTL in seconds until certain cache entries are invalidated. |
commercetools.api.api-url
| |
| Type |
String
|
| Description |
The base URL, with protocol and port (if needed), to access the commercetools API. |
commercetools.api.auth-url
| |
| Type |
String
|
| Description |
The absolute URL, with protocol and port (if needed), used for authorization at the commercetools system. |
commercetools.api.client-id
| |
| Type |
String
|
| Description |
The unique identifier of the API client. |
commercetools.api.client-secret
| |
| Type |
String
|
| Description |
The confidential client secret. |
commercetools.api.project-key
| |
| Type |
String
|
| Description |
The unique key of the commercetools project. |
commercetools.api.scopes
| |
| Type |
String
|
| Description |
A comma separated list of scopes, the API client should have access to. |
commercetools.default-locale
| |
| Type |
Locale
|
| Description |
The default locale for accessing the commerce system if no locale parameter was passed into request. |
commercetools.product-data-version
| |
| Type |
com.coremedia.commerce.adapter.commercetools.config.ProductDataVersion
|
| Default | staged |
| Description |
The version of the product data. Can be current for published data or staged for preview. |
commercetools.search-enable-language-fallback
| |
| Type |
Boolean
|
| Default | true |
| Description |
True if language of locale shall be used in search requests. |
commercetools.search-max-result-size
| |
| Type |
Integer
|
| Default | 500 |
| Description |
Maximum search result size. |
commercetools.single-value-search-facets
| |
| Type |
List<String>
|
| Description |
List of facet keys. These facets only support single values to be selected. |
entities.circuit-breaker-names
| |
| Type |
Map<String,String>
|
| Description |
Mapping of data lookup keys (cache classes) to circuit breaker names. Mapping to 'none' disables circuit breakers for the mapped data lookup keys. Example: Mapping 'product' to 'products' will use a separate circuit breaker named 'products' for product calls. The new circuit breaker can have its own configuration via 'resilience4j.circuitbreaker.instances.products.*'. Mapping 'product' to 'none' will disable the circuit breaker for product requests. By default, all data lookup keys not mapped here use the configured default circuit breaker name. For circuit breaker configuration options and their defaults see the resilience4j documentation and its Spring Boot starter example. For example, in application.properties: resilience4j.circuitbreaker.configs.default.slow-call-duration-threshold=30s resilience4j.circuitbreaker.configs.default.minimum-number-of-calls=10 Note that 'resilience4j.circuitbreaker.configs.default' is only applied automatically to circuit breakers that are looked up by name without an explicit 'resilience4j.circuitbreaker.instances.*' entry - as is the case for the 'base' circuit breaker. A circuit breaker that is explicitly declared under 'resilience4j.circuitbreaker.instances.*' does not automatically inherit this config; reference it via 'base-config=default' if needed. This mechanism can also be used to define multiple named config templates (e.g. a 'fast' and a 'slow' group) and link individual circuit breakers to them via 'base-config'. |
entities.default-circuit-breaker-name
| |
| Type |
String
|
| Default | base |
| Description |
Circuit breaker name used for data lookup keys without an explicit mapping. |
entities.disable-circuit-breakers
| |
| Type |
Boolean
|
| Default | false |
| Description |
Disable circuit breakers and cache failed calls in cache class failed. Note that this is a global switch and different from disabling circuit breakers for individual data lookup keys by mapping them to the well-known circuit breaker named 'none'. |
entities.exponential-backoff.factor
| |
| Type |
Double
|
| Default | 1.5 |
| Description |
The factor to be applied to the delay to compute the next delay. |
entities.exponential-backoff.initial-delay
| |
| Type |
Duration
|
| Default | 2s |
| Description |
The initial delay of the backoff. |
entities.instance-counting-cache-classes
| |
| Type |
Map<String,Boolean>
|
| Description |
Base adapter cache classes which are mapped to true in this map are used as-is and their capacity is configured in number of cached instances. By default, all base-adapter cache classes are enlarged by adding the '.heap' suffix and their capacity is configured in bytes. |
entities.message-store.files
| |
| Type |
Map<String,Long>
|
| Description |
The number of request/response pairs to cache persistently. The keys must be valid cache classes as configured for the data lookup service, e.g., catalog, catalogs, category, categories, etc. |
entities.message-store.root
| |
| Type |
org.springframework.core.io.Resource
|
| Description |
Root resource to persistently store messages. If this property is not set, no messages will be persisted. Configure a value to enable persistent caching of messages. |
entities.products.register-parent-dependency
| |
| Type |
Boolean
|
| Default | true |
| Description |
Controls if a parent dependency is registered for a non-base product so that it is invalidated together with its base product. |
entities.recompute-on-invalidation
| |
| Type |
Boolean
|
| Default | false |
| Description |
Whether to recompute entities proactively on invalidation. |
entities.send-invalidations
| |
| Type |
Boolean
|
| Default | true |
| Description |
Whether or not to propagate invalidations of entities to the clients. |
metadata.additional-metadata
| |
| Type |
Map<String,String>
|
| Description |
Map of additional metadata. Can be used as customization hook. All properties starting with "metadata.additional-metadata.*" are transmitted to the generic client on the CMS side. |
metadata.custom-attributes-format
| |
| Type |
com.coremedia.commerce.adapter.base.entities.CustomAttributesFormat
|
| Description |
Format of the custom attribute values. The keys are always plain strings. Used to identify the deserialization format on the CMS side. |
metadata.custom-entity-param-names
| |
| Type |
Collection<String>
|
| Description |
List of parameter names, which values need to be transmitted with every entity request from the CMS side. |
metadata.replacement-tokens
| |
| Type |
Map<String,String>
|
| Description |
Map of key value pairs. Used as replacement map for example for link building in the generic client on the CMS side. |
metadata.vendor
| |
| Type |
String
|
| Description |
Name of the vendor. Used to identify the connected vendor on the CMS side. |
Table 7.1. Commercetools Commerce Adapter related Properties


