ramu11 commented on code in PR #2046: URL: https://github.com/apache/camel-spring-boot/pull/2046#discussion_r4303151878
########## core/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/statestore/SpringCacheKeyValueRepository.java: ########## @@ -0,0 +1,161 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.spring.boot.statestore; + +import java.time.Duration; +import java.util.Set; +import java.util.concurrent.atomic.AtomicBoolean; + +import org.apache.camel.spi.KeyValueRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cache.Cache; +import org.springframework.cache.CacheManager; +import org.springframework.util.Assert; + +/** + * An Apache Camel {@link KeyValueRepository} adapter backed by Spring's {@link CacheManager}[cite: 2]. + * + * <h3>Design Constraints & Backend Behavior:</h3> + * <ul> + * <li><strong>TTL Support:</strong> Spring Cache has no standard per-entry TTL API[cite: 2]. Providing a TTL argument + * triggers a single {@code WARN} log per repository instance and stores the entry without expiration[cite: 2]. + * Users requiring TTL must configure it at the underlying provider/CacheManager spec level (e.g., Caffeine spec)[cite: 2].</li> + * <li><strong>Atomicity:</strong> Only {@code putIfAbsent} delegates directly to Spring Cache's {@code Cache.putIfAbsent()} + * (with provider-dependent atomicity). Conditional operations like {@code replace} and conditional {@code delete} + * rely on SPI default implementations (non-atomic check-then-act via {@code get} and {@code put}/{@code evict}).</li> + * <li><strong>Enumeration:</strong> {@link #keys()} and {@link #size()} intentionally throw + * {@link UnsupportedOperationException} as Spring Cache does not provide a portable key enumeration API[cite: 2].</li> Review Comment: addressed ########## core/camel-spring-boot/src/main/java/org/apache/camel/spring/boot/statestore/SpringCacheKeyValueRepository.java: ########## @@ -0,0 +1,161 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.spring.boot.statestore; + +import java.time.Duration; +import java.util.Set; +import java.util.concurrent.atomic.AtomicBoolean; + +import org.apache.camel.spi.KeyValueRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.cache.Cache; +import org.springframework.cache.CacheManager; +import org.springframework.util.Assert; + +/** + * An Apache Camel {@link KeyValueRepository} adapter backed by Spring's {@link CacheManager}[cite: 2]. + * + * <h3>Design Constraints & Backend Behavior:</h3> + * <ul> + * <li><strong>TTL Support:</strong> Spring Cache has no standard per-entry TTL API[cite: 2]. Providing a TTL argument + * triggers a single {@code WARN} log per repository instance and stores the entry without expiration[cite: 2]. + * Users requiring TTL must configure it at the underlying provider/CacheManager spec level (e.g., Caffeine spec)[cite: 2].</li> + * <li><strong>Atomicity:</strong> Only {@code putIfAbsent} delegates directly to Spring Cache's {@code Cache.putIfAbsent()} + * (with provider-dependent atomicity). Conditional operations like {@code replace} and conditional {@code delete} + * rely on SPI default implementations (non-atomic check-then-act via {@code get} and {@code put}/{@code evict}).</li> + * <li><strong>Enumeration:</strong> {@link #keys()} and {@link #size()} intentionally throw + * {@link UnsupportedOperationException} as Spring Cache does not provide a portable key enumeration API[cite: 2].</li> + * <li><strong>Scope & Multi-Store:</strong> Bound to a specific cache name (defaulting to {@code camel-kvr}). + * When auto-configured as a single singleton bean, the State Store component shares this repository instance + * across endpoints, resulting in a shared cache unless separate instances are explicitly bound per endpoint via backend references.</li> + * </ul> + */ +public class SpringCacheKeyValueRepository implements KeyValueRepository { + + private static final Logger LOG = LoggerFactory.getLogger(SpringCacheKeyValueRepository.class); + private static final String DEFAULT_CACHE_NAME = "camel-kvr"; + + private final CacheManager cacheManager; + private final String cacheName; + private final AtomicBoolean ttlWarningLogged = new AtomicBoolean(false); + + public SpringCacheKeyValueRepository(CacheManager cacheManager) { + this(cacheManager, DEFAULT_CACHE_NAME); + } + + public SpringCacheKeyValueRepository(CacheManager cacheManager, String cacheName) { + Assert.notNull(cacheManager, "CacheManager must not be null"); + Assert.hasText(cacheName, "CacheName must not be empty"); + this.cacheManager = cacheManager; + this.cacheName = cacheName; + } + + public String getCacheName() { + return cacheName; + } + + private Cache getCache() { + Cache cache = cacheManager.getCache(cacheName); + if (cache == null) { + throw new IllegalStateException(String.format("Spring Cache '%s' not found in CacheManager of type %s", + cacheName, cacheManager.getClass().getName())); + } + return cache; + } + + @Override + public void start() { + // Lifecycle start hook (managed externally by Spring CacheManager container) + } + + @Override + public void stop() { + // Lifecycle stop hook (managed externally by Spring CacheManager container) + } + + @Override + public Object get(String key) { + Cache.ValueWrapper wrapper = getCache().get(key); + return wrapper != null ? wrapper.get() : null; + } + + @Override + public Object put(String key, Object value) { + return put(key, value, null); + } + + @Override + public Object put(String key, Object value, Duration ttl) { + checkTtl(ttl); + Cache cache = getCache(); + Cache.ValueWrapper oldWrapper = cache.get(key); + Object oldValue = oldWrapper != null ? oldWrapper.get() : null; + cache.put(key, value); + return oldValue; + } + + @Override + public Object putIfAbsent(String key, Object value) { + return putIfAbsent(key, value, null); + } + + @Override + public Object putIfAbsent(String key, Object value, Duration ttl) { + checkTtl(ttl); + Cache.ValueWrapper existing = getCache().putIfAbsent(key, value); + return existing != null ? existing.get() : null; + } + + @Override + public Object delete(String key) { + Cache cache = getCache(); + Cache.ValueWrapper oldWrapper = cache.get(key); + Object oldValue = oldWrapper != null ? oldWrapper.get() : null; + cache.evict(key); Review Comment: Done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
