Skip to content

Commit

Permalink
Apply eviction to caching-defined Regions using @EnableEviction annot…
Browse files Browse the repository at this point in the history 
…ation configuration.

Resolves gh-519.
  • Loading branch information
@jxblum
jxblum committed Jul 14, 2021
1 parent 9d65677 commit 999e52f
Show file tree
Hide file tree
Showing 3 changed files with 195 additions and 63 deletions.
1 change: 0 additions & 1 deletion ...eode/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEviction.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
* limitations under the License.
*
*/

package org.springframework.data.gemfire.config.annotation;

import java.lang.annotation.Documented;
Expand Down
198 changes: 142 additions & 56 deletions ...c/main/java/org/springframework/data/gemfire/config/annotation/EvictionConfiguration.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
package org.springframework.data.gemfire.config.annotation;

import static org.springframework.data.gemfire.config.annotation.EnableEviction.EvictionPolicy;
import static org.springframework.data.gemfire.util.ArrayUtils.nullSafeArray;
import static org.springframework.data.gemfire.util.CollectionUtils.nullSafeIterable;
import static org.springframework.data.gemfire.util.RuntimeExceptionFactory.newIllegalArgumentException;
import static org.springframework.data.gemfire.util.RuntimeExceptionFactory.newIllegalStateException;

import java.lang.annotation.Annotation;
Expand All @@ -30,8 +27,10 @@
import java.util.Set;
import java.util.function.Supplier;

import org.apache.geode.cache.AttributesMutator;
import org.apache.geode.cache.EvictionAttributes;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.RegionAttributes;
import org.apache.geode.cache.util.ObjectSizer;

import org.springframework.beans.BeansException;
Expand All @@ -41,6 +40,8 @@
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportAware;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.gemfire.PeerRegionFactoryBean;
Expand All @@ -51,7 +52,10 @@
import org.springframework.data.gemfire.eviction.EvictionActionType;
import org.springframework.data.gemfire.eviction.EvictionAttributesFactoryBean;
import org.springframework.data.gemfire.eviction.EvictionPolicyType;
import org.springframework.data.gemfire.util.ArrayUtils;
import org.springframework.data.gemfire.util.CollectionUtils;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

Expand All @@ -60,22 +64,22 @@
* Eviction policy configuration on cache {@link Region Regions}.
*
* @author John Blum
* @see org.apache.geode.cache.EvictionAttributes
* @see org.apache.geode.cache.Region
* @see org.apache.geode.cache.util.ObjectSizer
* @see org.springframework.beans.factory.config.BeanPostProcessor
* @see org.springframework.context.ApplicationContext
* @see org.springframework.context.ApplicationContextAware
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.ImportAware
* @see PeerRegionFactoryBean
* @see org.springframework.data.gemfire.PeerRegionFactoryBean
* @see org.springframework.data.gemfire.ResolvableRegionFactoryBean
* @see org.springframework.data.gemfire.client.ClientRegionFactoryBean
* @see org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport
* @see org.springframework.data.gemfire.eviction.EvictionActionType
* @see org.springframework.data.gemfire.eviction.EvictionAttributesFactoryBean
* @see org.springframework.data.gemfire.eviction.EvictionPolicyType
* @see org.apache.geode.cache.EvictionAttributes
* @see org.apache.geode.cache.Region
* @see org.apache.geode.cache.util.ObjectSizer
* @since 1.9.0
*/
@Configuration
Expand All @@ -94,7 +98,7 @@ public class EvictionConfiguration extends AbstractAnnotationConfigSupport
* @see java.lang.Class
*/
@Override
protected Class<? extends Annotation> getAnnotationType() {
protected @NonNull Class<? extends Annotation> getAnnotationType() {
return EnableEviction.class;
}

Expand All @@ -115,15 +119,17 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
* @inheritDoc
*/
@Override
public void setImportMetadata(AnnotationMetadata importMetadata) {
public void setImportMetadata(@NonNull AnnotationMetadata importMetadata) {

if (isAnnotationPresent(importMetadata)) {

AnnotationAttributes enableEvictionAttributes = getAnnotationAttributes(importMetadata);

AnnotationAttributes[] policies = enableEvictionAttributes.getAnnotationArray("policies");

for (AnnotationAttributes evictionPolicyAttributes : nullSafeArray(policies, AnnotationAttributes.class)) {
for (AnnotationAttributes evictionPolicyAttributes :
ArrayUtils.nullSafeArray(policies, AnnotationAttributes.class)) {

this.evictionPolicyConfigurer =
ComposableEvictionPolicyConfigurer.compose(this.evictionPolicyConfigurer,
EvictionPolicyMetaData.from(evictionPolicyAttributes, this.applicationContext));
Expand Down Expand Up @@ -173,23 +179,47 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro
};
}

@SuppressWarnings("unused")
@EventListener(ContextRefreshedEvent.class)
public void evictionContextRefreshedListener(@NonNull ContextRefreshedEvent event) {

ApplicationContext applicationContext = event.getApplicationContext();

for (Region<?, ?> region : applicationContext.getBeansOfType(Region.class).values()) {
getEvictionPolicyConfigurer().configure(region);
}
}

/**
* {@link EvictionPolicyConfigurer} configures the Eviction policy of a GemFire {@link Region}.
* {@link EvictionPolicyConfigurer} configures the Eviction policy of an Apache Geode {@link Region}.
*
* @see java.lang.FunctionalInterface
*/
@FunctionalInterface
protected interface EvictionPolicyConfigurer {

/**
* Configure the Eviction policy on the given SDG {@link PeerRegionFactoryBean} or {@link ClientRegionFactoryBean}
* used to create a GemFire {@link Region}.
* Configure the Eviction policy on the given SDG {@link ClientRegionFactoryBean}
* or {@link PeerRegionFactoryBean} used to create an Apache Geode {@link Region}.
*
* @param regionFactoryBean {@link PeerRegionFactoryBean} or {@link ClientRegionFactoryBean} used to create
* a GemFire {@link Region}.
* @param regionBean {@link ClientRegionFactoryBean} or {@link PeerRegionFactoryBean} used to create
* an Apache Geode {@link Region}.
* @return the given {@code regionFactoryBean}.
* @see PeerRegionFactoryBean
* @see org.springframework.data.gemfire.PeerRegionFactoryBean
* @see org.springframework.data.gemfire.client.ClientRegionFactoryBean
*/
Object configure(Object regionFactoryBean);
Object configure(Object regionBean);

/**
* Configures the Eviction policy of the given Apache Geode {@link Region}.
*
* @param region {@link Region} on which to configure the Eviction policy.
* @return the given {@link Region}.
* @see org.apache.geode.cache.Region
*/
default Region<?, ?> configure(Region<?, ?> region) {
return region;
}
}

/**
Expand All @@ -201,9 +231,6 @@ protected interface EvictionPolicyConfigurer {
*/
protected static class ComposableEvictionPolicyConfigurer implements EvictionPolicyConfigurer {

private final EvictionPolicyConfigurer one;
private final EvictionPolicyConfigurer two;

/**
* Composes the array of {@link EvictionPolicyConfigurer} objects into a single
* {@link EvictionPolicyConfigurer} implementation using the Composite Software Design Pattern.
Expand All @@ -215,8 +242,8 @@ protected static class ComposableEvictionPolicyConfigurer implements EvictionPol
* @see #compose(Iterable)
*/
@SuppressWarnings("unused")
protected static EvictionPolicyConfigurer compose(EvictionPolicyConfigurer[] array) {
return compose(Arrays.asList(nullSafeArray(array, EvictionPolicyConfigurer.class)));
protected static @Nullable EvictionPolicyConfigurer compose(EvictionPolicyConfigurer[] array) {
return compose(Arrays.asList(ArrayUtils.nullSafeArray(array, EvictionPolicyConfigurer.class)));
}

/**
Expand All @@ -229,11 +256,11 @@ protected static EvictionPolicyConfigurer compose(EvictionPolicyConfigurer[] arr
* @see org.springframework.data.gemfire.config.annotation.EvictionConfiguration.EvictionPolicyConfigurer
* @see #compose(EvictionPolicyConfigurer, EvictionPolicyConfigurer)
*/
protected static EvictionPolicyConfigurer compose(Iterable<EvictionPolicyConfigurer> iterable) {
protected static @Nullable EvictionPolicyConfigurer compose(Iterable<EvictionPolicyConfigurer> iterable) {

EvictionPolicyConfigurer current = null;

for (EvictionPolicyConfigurer evictionPolicyConfigurer : nullSafeIterable(iterable)) {
for (EvictionPolicyConfigurer evictionPolicyConfigurer : CollectionUtils.nullSafeIterable(iterable)) {
current = compose(current, evictionPolicyConfigurer);
}

Expand All @@ -249,13 +276,17 @@ protected static EvictionPolicyConfigurer compose(Iterable<EvictionPolicyConfigu
* @return an {@link EvictionPolicyConfigurer} object implementation composed of
* multiple {@link EvictionPolicyConfigurer} objects using the Composite Software Design Pattern.
*/
protected static EvictionPolicyConfigurer compose(EvictionPolicyConfigurer one, EvictionPolicyConfigurer two) {
protected static @Nullable EvictionPolicyConfigurer compose(@Nullable EvictionPolicyConfigurer one,
@Nullable EvictionPolicyConfigurer two) {

return one == null ? two
: (two == null ? one
: new ComposableEvictionPolicyConfigurer(one, two));
: two == null ? one
: new ComposableEvictionPolicyConfigurer(one, two);
}

private final EvictionPolicyConfigurer one;
private final EvictionPolicyConfigurer two;

/**
* Constructs a new instance of the {@link ComposableEvictionPolicyConfigurer} initialized with the two
* {@link EvictionPolicyConfigurer} objects.
Expand All @@ -273,19 +304,24 @@ private ComposableEvictionPolicyConfigurer(EvictionPolicyConfigurer one, Evictio
* @inheritDoc
*/
@Override
public Object configure(Object regionFactoryBean) {
return this.two.configure(this.one.configure(regionFactoryBean));
public Object configure(Object regionBean) {
return this.two.configure(this.one.configure(regionBean));
}

/**
* @inheritDoc
*/
@Override
public Region<?, ?> configure(Region<?, ?> region) {
return this.two.configure(this.one.configure(region));
}
}

@SuppressWarnings("unused")
protected static class EvictionPolicyMetaData implements EvictionPolicyConfigurer {

protected static final String[] ALL_REGIONS = new String[0];

private final EvictionAttributes evictionAttributes;

private final Set<String> regionNames = new HashSet<>();

protected static EvictionPolicyMetaData from(@NonNull AnnotationAttributes evictionPolicyAttributes,
@NonNull ApplicationContext applicationContext) {

Expand Down Expand Up @@ -347,6 +383,10 @@ protected static Integer resolveThreshold(int maximum, EvictionPolicyType type)
return EvictionPolicyType.HEAP_PERCENTAGE.equals(type) ? null : maximum;
}

private final EvictionAttributes evictionAttributes;

private final Set<String> regionNames = new HashSet<>();

/**
* Constructs an instance of {@link EvictionPolicyMetaData} initialized with the given
* {@link EvictionAttributes} applying to all {@link Region Regions}.
Expand All @@ -371,25 +411,11 @@ protected EvictionPolicyMetaData(EvictionAttributes evictionAttributes) {
*/
protected EvictionPolicyMetaData(EvictionAttributes evictionAttributes, String[] regionNames) {

this.evictionAttributes = Optional.ofNullable(evictionAttributes).orElseThrow(() ->
newIllegalArgumentException("EvictionAttributes are required"));

Collections.addAll(this.regionNames, nullSafeArray(regionNames, String.class));
}
Assert.notNull(evictionAttributes, "EvictionAttributes must not be null");

/**
* Returns an instance of the {@link EvictionAttributes} specifying the Eviction policy configuration
* captured in this Eviction policy meta-data.
*
* @return an instance of the {@link EvictionAttributes} specifying the {@link Region}
* Eviction policy configuration.
* @throws IllegalStateException if the {@link EvictionAttributes} were not properly initialized.
* @see org.apache.geode.cache.EvictionAttributes
*/
protected EvictionAttributes getEvictionAttributes() {
this.evictionAttributes = evictionAttributes;

return Optional.ofNullable(this.evictionAttributes).orElseThrow(() ->
newIllegalStateException("EvictionAttributes was not properly configured and initialized"));
Collections.addAll(this.regionNames, ArrayUtils.nullSafeArray(regionNames, String.class));
}

/**
Expand All @@ -401,10 +427,23 @@ protected EvictionAttributes getEvictionAttributes() {
* @see #resolveRegionName(Object)
* @see #accepts(Supplier)
*/
protected boolean accepts(Object regionFactoryBean) {
protected boolean accepts(@Nullable Object regionFactoryBean) {
return isRegionFactoryBean(regionFactoryBean) && accepts(() -> resolveRegionName(regionFactoryBean));
}

/**
* Determines whether the given {@link Region} is accepted for Eviction policy configuration.
*
* @param region {@link Region} evaluated for Eviction policy configuration.
* @return a boolean value indicating whether the given {@link Region} is accepted for
* Eviction policy configuration.
* @see org.apache.geode.cache.Region
* @see #accepts(Supplier)
*/
protected boolean accepts(@Nullable Region<?, ?> region) {
return region != null && accepts(() -> region.getName());
}

/**
* Determine whether the {@link Region} identified by name is accepted for Eviction policy configuration.
*
Expand All @@ -425,7 +464,7 @@ protected boolean accepts(Supplier<String> regionName) {
protected String resolveRegionName(Object regionFactoryBean) {

return regionFactoryBean instanceof ResolvableRegionFactoryBean
? ((ResolvableRegionFactoryBean) regionFactoryBean).resolveRegionName()
? ((ResolvableRegionFactoryBean<?, ?>) regionFactoryBean).resolveRegionName()
: null;
}

Expand All @@ -447,12 +486,59 @@ protected EvictingRegionFactoryBean setEvictionAttributes(EvictingRegionFactoryB
return regionFactoryBean;
}

/**
* Returns an instance of the {@link EvictionAttributes} specifying the Eviction policy configuration
* captured in this Eviction policy meta-data.
*
* @return an instance of the {@link EvictionAttributes} specifying the {@link Region}
* Eviction policy configuration.
* @throws IllegalStateException if the {@link EvictionAttributes} were not properly initialized.
* @see org.apache.geode.cache.EvictionAttributes
*/
protected EvictionAttributes getEvictionAttributes() {

return Optional.ofNullable(this.evictionAttributes).orElseThrow(() ->
newIllegalStateException("EvictionAttributes was not properly configured and initialized"));
}

/**
* @inheritDoc
*/
@Override
public Object configure(Object regionFactoryBean) {
public Object configure(Object regionBean) {

return accepts(regionBean)
? setEvictionAttributes((EvictingRegionFactoryBean) regionBean)
: regionBean;
}

/**
* @inheritDoc
*/
@Override
public Region<?, ?> configure(Region<?, ?> region) {

Optional.ofNullable(region)
.filter(this::accepts)
.filter(this::isDefaultEvictionEntryMaximum)
.map(Region::getAttributesMutator)
.map(AttributesMutator::getEvictionAttributesMutator)
.ifPresent(evictionAttributesMutator ->
evictionAttributesMutator.setMaximum(getEvictionAttributes().getMaximum()));

return region;
}

private boolean isDefaultEvictionEntryMaximum(Region<?, ?> region) {
return region != null && isDefaultEvictionEntryMaximum(region.getAttributes());
}

private boolean isDefaultEvictionEntryMaximum(RegionAttributes<?, ?> regionAttributes) {
return regionAttributes != null && isDefaultEvictionEntryMaximum(regionAttributes.getEvictionAttributes());
}

return accepts(regionFactoryBean)
? setEvictionAttributes((EvictingRegionFactoryBean) regionFactoryBean)
: regionFactoryBean;
private boolean isDefaultEvictionEntryMaximum(EvictionAttributes evictionAttributes) {
return EvictionAttributes.DEFAULT_ENTRIES_MAXIMUM == evictionAttributes.getMaximum();
}
}
}
Loading

0 comments on commit 999e52f

Please sign in to comment.