org.springframework.data.gemfire.config.annotation.CompressionConfiguration Maven / Gradle / Ivy
/*
* Copyright 2017-2020 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.data.gemfire.config.annotation;
import static java.util.Arrays.stream;
import static org.springframework.data.gemfire.util.ArrayUtils.nullSafeArray;
import static org.springframework.data.gemfire.util.CollectionUtils.asSet;
import static org.springframework.data.gemfire.util.CollectionUtils.nullSafeIterable;
import java.lang.annotation.Annotation;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import org.apache.geode.cache.Region;
import org.apache.geode.compression.Compressor;
import org.apache.geode.compression.SnappyCompressor;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportAware;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.gemfire.ResolvableRegionFactoryBean;
import org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport;
import org.springframework.data.gemfire.util.CollectionUtils;
import org.springframework.data.gemfire.util.SpringUtils;
import org.springframework.util.StringUtils;
/**
* The {@link CompressionConfiguration} class is a Spring {@link ImportAware} implementation capable of
* enabling Pivotal GemFire/Apache Geode cache {@link Region Regions} data compression.
*
* @author John Blum
* @see org.apache.geode.cache.Region
* @see org.springframework.beans.factory.config.BeanFactoryPostProcessor
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.ImportAware
* @see org.springframework.data.gemfire.config.annotation.EnableCompression
* @see org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport
* @since 2.0.2
*/
@Configuration
@SuppressWarnings("unused")
public class CompressionConfiguration extends AbstractAnnotationConfigSupport implements ImportAware {
protected static final String SNAPPY_COMPRESSOR_BEAN_NAME = "SnappyCompressor";
private String compressorBeanName = SNAPPY_COMPRESSOR_BEAN_NAME;
private Set regionNames = new HashSet<>();
/**
* Returns the {@link EnableCompression} {@link Annotation} {@link Class} type.
*
* @return the {@link EnableCompression} {@link Annotation} {@link Class} type.
* @see org.springframework.data.gemfire.config.annotation.EnableOffHeap
* @see java.lang.annotation.Annotation
*/
@Override
protected Class getAnnotationType() {
return EnableCompression.class;
}
public void setCompressorBeanName(String compressorBeanName) {
this.compressorBeanName = compressorBeanName;
}
protected String resolveCompressorBeanName() {
return Optional.ofNullable(this.compressorBeanName)
.filter(StringUtils::hasText)
.orElse(SNAPPY_COMPRESSOR_BEAN_NAME);
}
public void setRegionNames(String[] regionNames) {
setRegionNames(asSet(nullSafeArray(regionNames, String.class)));
}
public void setRegionNames(Iterable regionNames) {
this.regionNames = CollectionUtils.addAll(this.regionNames, nullSafeIterable(regionNames));
}
protected Set resolveRegionNames() {
return Collections.unmodifiableSet(this.regionNames);
}
@Override
public void setImportMetadata(AnnotationMetadata importingClassMetadata) {
if (isAnnotationPresent(importingClassMetadata)) {
AnnotationAttributes enableCompressionAttributes = getAnnotationAttributes(importingClassMetadata);
setCompressorBeanName(resolveProperty(cacheCompressionProperty("compressor-bean-name"),
enableCompressionAttributes.getString("compressorBeanName")));
setRegionNames(resolveProperty(cacheCompressionProperty("region-names"),
String[].class, enableCompressionAttributes.getStringArray("regionNames")));
}
}
@Bean(SNAPPY_COMPRESSOR_BEAN_NAME)
Compressor snappyCompressor() {
return new SnappyCompressor();
}
@Bean
BeanFactoryPostProcessor regionCompressionBeanFactoryPostProcessor() {
String resolvedCompressorBeanName = resolveCompressorBeanName();
return beanFactory ->
stream(nullSafeArray(beanFactory.getBeanDefinitionNames(), String.class)).forEach(beanName ->
Optional.of(beanFactory.getBeanDefinition(beanName))
.filter(beanDefinition -> isTargetedRegionBean(beanName, beanDefinition, beanFactory))
.ifPresent(beanDefinition -> SpringUtils.setPropertyReference(
beanDefinition, "compressor", resolvedCompressorBeanName)));
}
private boolean isTargetedRegionBean(String beanName, BeanDefinition beanDefinition,
ConfigurableListableBeanFactory beanFactory) {
return isNamedRegion(beanName, beanDefinition, beanFactory) && isRegionBean(beanDefinition, beanFactory);
}
private boolean isRegionBean(BeanDefinition beanDefinition, ConfigurableListableBeanFactory beanFactory) {
return Optional.ofNullable(beanDefinition)
.flatMap(it -> resolveBeanClass(it, beanFactory.getBeanClassLoader()))
.filter(beanClass -> ResolvableRegionFactoryBean.class.isAssignableFrom(beanClass))
.isPresent();
}
private boolean isNamedRegion(String beanName, BeanDefinition beanDefinition,
ConfigurableListableBeanFactory beanFactory) {
Set resolvedRegionNames = resolveRegionNames();
return CollectionUtils.isEmpty(resolvedRegionNames)
|| CollectionUtils.containsAny(resolvedRegionNames, resolveBeanNames(beanName, beanDefinition, beanFactory));
}
private Collection resolveBeanNames(String beanName, BeanDefinition beanDefinition,
ConfigurableListableBeanFactory beanFactory) {
Collection beanNames = new HashSet<>();
beanNames.add(beanName);
Collections.addAll(beanNames, beanFactory.getAliases(beanName));
PropertyValue regionName = beanDefinition.getPropertyValues().getPropertyValue("regionName");
if (regionName != null) {
Object regionNameValue = regionName.getValue();
if (regionNameValue != null) {
beanNames.add(regionNameValue.toString());
}
}
return beanNames;
}
}