Add RegionConfigurer to register a SD CrudRepository as a Region CacheLoader to handle cache misses in Inline Caching.
This commit is contained in:
John Blum
@@ -0,0 +1,175 @@
|
||||
/*
|
||||
* Copyright 2019 the original author or authors.
|
||||
*
|
||||
* Licensed 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
|
||||
*
|
||||
* https://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.springframework.geode.cache;
|
||||
|
||||
import java.util.function.Predicate;
|
||||
|
||||
import org.apache.geode.cache.CacheLoader;
|
||||
import org.apache.geode.cache.Region;
|
||||
|
||||
import org.springframework.data.gemfire.PeerRegionFactoryBean;
|
||||
import org.springframework.data.gemfire.client.ClientRegionFactoryBean;
|
||||
import org.springframework.data.gemfire.config.annotation.RegionConfigurer;
|
||||
import org.springframework.data.repository.CrudRepository;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Spring Data {@link RegionConfigurer} implementation used to adapt and register a Spring Data {@link CrudRepository}
|
||||
* as a {@link CacheLoader} for a targeted {@link Region}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @param <T> {@link Class type} of the persistent entity.
|
||||
* @param <ID> {@link Class type} of the persistent entity identifier (ID).
|
||||
* @see java.util.function.Predicate
|
||||
* @see org.apache.geode.cache.CacheLoader
|
||||
* @see org.apache.geode.cache.Region
|
||||
* @see org.springframework.data.gemfire.PeerRegionFactoryBean
|
||||
* @see org.springframework.data.gemfire.client.ClientRegionFactoryBean
|
||||
* @see org.springframework.data.gemfire.config.annotation.RegionConfigurer
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
* @since 1.1.0
|
||||
*/
|
||||
public class RepositoryCacheLoaderRegionConfigurer<T, ID> implements RegionConfigurer {
|
||||
|
||||
/**
|
||||
* Factory method used to construct a new instance of {@link RepositoryCacheLoaderRegionConfigurer} initialized with
|
||||
* the given Spring Data {@link CrudRepository} used to load {@link Region} values on cache misses as well as
|
||||
* the given {@link Predicate} used to identify/qualify the {@link Region} on which the {@link CrudRepository}
|
||||
* will be registered and used as a {@link CacheLoader}.
|
||||
*
|
||||
* @param <T> {@link Class type} of the persistent entity.
|
||||
* @param <ID> {@link Class type} of the persistent entity identifier (ID).
|
||||
* @param repository {@link CrudRepository} used to load {@link Region} values on cache misses.
|
||||
* @param regionBeanName {@link Predicate} used to identify/qualify the {@link Region} on which
|
||||
* the {@link CrudRepository} will be registered and used as a {@link CacheLoader}.
|
||||
* @return a new instance of {@link RepositoryCacheLoaderRegionConfigurer}.
|
||||
* @throws IllegalArgumentException if {@link CrudRepository} is {@literal null}.
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
* @see java.util.function.Predicate
|
||||
* @see #RepositoryCacheLoaderRegionConfigurer(CrudRepository, Predicate)
|
||||
*/
|
||||
public static <T, ID> RepositoryCacheLoaderRegionConfigurer<T, ID> create(CrudRepository<T, ID> repository,
|
||||
Predicate<String> regionBeanName) {
|
||||
|
||||
return new RepositoryCacheLoaderRegionConfigurer<>(repository, regionBeanName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Factory method used to construct a new instance of {@link RepositoryCacheLoaderRegionConfigurer} initialized with
|
||||
* the given Spring Data {@link CrudRepository} used to load {@link Region} values on cache misses as well as
|
||||
* the given {@link String} identifying/qualifying the {@link Region} on which the {@link CrudRepository}
|
||||
* will be registered and used as a {@link CacheLoader}.
|
||||
*
|
||||
* @param <T> {@link Class type} of the persistent entity.
|
||||
* @param <ID> {@link Class type} of the persistent entity identifier (ID).
|
||||
* @param repository {@link CrudRepository} used to load {@link Region} values on cache misses.
|
||||
* @param regionBeanName {@link String} containing the bean name identifying/qualifying the {@link Region}
|
||||
* on which the {@link CrudRepository} will be registered and used as a {@link CacheLoader}.
|
||||
* @return a new instance of {@link RepositoryCacheLoaderRegionConfigurer}.
|
||||
* @throws IllegalArgumentException if {@link CrudRepository} is {@literal null}.
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
* @see java.lang.String
|
||||
* @see #create(CrudRepository, Predicate)
|
||||
*/
|
||||
public static <T, ID> RepositoryCacheLoaderRegionConfigurer<T, ID> create(CrudRepository<T, ID> repository,
|
||||
String regionBeanName) {
|
||||
|
||||
return create(repository, Predicate.isEqual(regionBeanName));
|
||||
}
|
||||
|
||||
private final CrudRepository<T, ID> repository;
|
||||
|
||||
private final Predicate<String> regionBeanName;
|
||||
|
||||
/**
|
||||
* Constructs a new instance of {@link RepositoryCacheLoaderRegionConfigurer} initialized with the given Spring Data
|
||||
* {@link CrudRepository} used to load {@link Region} values on cache misses as well as the given {@link Predicate}
|
||||
* used to identify/qualify the {@link Region} on which the {@link CrudRepository} will be registered
|
||||
* and used as a {@link CacheLoader}.
|
||||
*
|
||||
* @param repository {@link CrudRepository} used to load {@link Region} values on cache misses.
|
||||
* @param regionBeanName {@link Predicate} used to identify/qualify the {@link Region} on which
|
||||
* the {@link CrudRepository} will be registered and used as a {@link CacheLoader}.
|
||||
* @throws IllegalArgumentException if {@link CrudRepository} is {@literal null}.
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
* @see java.util.function.Predicate
|
||||
*/
|
||||
public RepositoryCacheLoaderRegionConfigurer(CrudRepository<T, ID> repository, Predicate<String> regionBeanName) {
|
||||
|
||||
Assert.notNull(repository, "CrudRepository is required");
|
||||
|
||||
this.repository = repository;
|
||||
|
||||
this.regionBeanName = regionBeanName != null
|
||||
? regionBeanName
|
||||
: beanName -> false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the configured {@link Predicate} used to identify/qualify the {@link Region}
|
||||
* on which the {@link CrudRepository} will be registered as a {@link CacheLoader} for cache misses.
|
||||
*
|
||||
* @return the configured {@link Predicate} used to identify/qualify the {@link Region}
|
||||
* targeted for the {@link CacheLoader} registration.
|
||||
* @see java.util.function.Predicate
|
||||
*/
|
||||
protected Predicate<String> getRegionBeanName() {
|
||||
return this.regionBeanName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the configured Spring Data {@link CrudRepository} adapted/wrapped as a {@link CacheLoader}
|
||||
* and used to load {@link Region} values on cache misses.
|
||||
*
|
||||
* @return the configured {@link CrudRepository} used to load {@link Region} values on cache misses.
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
*/
|
||||
protected CrudRepository<T, ID> getRepository() {
|
||||
return this.repository;
|
||||
}
|
||||
|
||||
@Override
|
||||
@SuppressWarnings("unchecked")
|
||||
public void configure(String beanName, ClientRegionFactoryBean<?, ?> bean) {
|
||||
|
||||
if (getRegionBeanName().test(beanName)) {
|
||||
bean.setCacheLoader(newRepositoryCacheLoader());
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@SuppressWarnings("unchecked")
|
||||
public void configure(String beanName, PeerRegionFactoryBean<?, ?> bean) {
|
||||
|
||||
if (getRegionBeanName().test(beanName)) {
|
||||
bean.setCacheLoader(newRepositoryCacheLoader());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new instance of {@link RepositoryCacheLoader} adapting the {@link CrudRepository}
|
||||
* as an instance of a {@link CacheLoader}.
|
||||
*
|
||||
* @return a new {@link RepositoryCacheLoader}.
|
||||
* @see org.springframework.geode.cache.RepositoryCacheLoader
|
||||
* @see org.springframework.data.repository.CrudRepository
|
||||
* @see org.apache.geode.cache.CacheLoader
|
||||
* @see #getRepository()
|
||||
*/
|
||||
protected RepositoryCacheLoader newRepositoryCacheLoader() {
|
||||
return new RepositoryCacheLoader<>(getRepository());
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user