DATAGEODE-136 - Adding AsCacheWriter

Author: Udo Kohlmeyer

spring-data-geode/src/main/java/org/springframework/data/gemfire/config/annotation/AsCacheWriter.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2016-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.data.gemfire.config.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.data.gemfire.eventing.config.CacheWriterEventType;
+
+/**
+ * Used to declare a concrete method as a CacheWriter event handler
+ *
+ * @author Udo Kohlmeyer
+ * @since 2.3.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface AsCacheWriter {
+
+	/**
+	 * An array of {@link CacheWriterEventType} that control what region CRUD events need to be observed
+	 * {@link CacheWriterEventType} and {@link RegionCacheWriterEventType} cannot be set on the same method. As they
+	 * are mutually exclusive and require that the implementing method uses {@link org.apache.geode.cache.RegionEvent} or
+	 * {@link org.apache.geode.cache.EntryEvent}
+	 */
+	CacheWriterEventType[] eventTypes() default {};
+
+	/**
+	 * An array for {@link org.apache.geode.cache.Region} names which this {@link org.apache.geode.cache.CacheWriter}
+	 * will be link to. Not declaring any regions will result in the CacheWriter to be configured against all defined
+	 * regions.
+	 */
+	String[] regions() default {};
+}

spring-data-geode/src/main/java/org/springframework/data/gemfire/config/annotation/AsRegionEventListener.java

@@ -24,9 +24,12 @@
 
 import org.springframework.data.gemfire.eventing.config.CacheListenerEventType;
 import org.springframework.data.gemfire.eventing.config.RegionCacheListenerEventType;
+import org.springframework.data.gemfire.eventing.config.CacheWriterEventType;
+import org.springframework.data.gemfire.eventing.config.RegionCacheWriterEventType;
 
 /**
- * Used to declare a concrete method as a RegionEventListener event handler, which handles {@link org.apache.geode.cache.Region}
+ * Used to declare a concrete method as a RegionEventListener event handler,
+ * which handles {@link org.apache.geode.cache.Region}
  *
  * @author Udo Kohlmeyer
  * @since 2.3.0
@@ -41,10 +44,18 @@
 	 * are mutually exclusive and require that the implementing method uses {@link org.apache.geode.cache.RegionEvent} or
 	 * {@link org.apache.geode.cache.EntryEvent}
 	 */
-	RegionCacheListenerEventType[] regionEventTypes() default {};
+	RegionCacheListenerEventType[] regionListenerEventTypes() default {};
 
 	/**
-	 * An array for {@link org.apache.geode.cache.Region} names which this {@link org.apache.geode.cache.CacheListener}
+	 * An array of {@link RegionCacheWriterEventType} that control what region events need to be observed.
+	 * {@link CacheWriterEventType} and {@link RegionCacheWriterEventType} cannot be set on the same method. As they
+	 * are mutually exclusive and require that the implementing method uses {@link org.apache.geode.cache.RegionEvent} or
+	 * {@link org.apache.geode.cache.EntryEvent}
+	 */
+	RegionCacheWriterEventType[] regionWriterEventTypes() default {};
+
+	/**
+	 * An array for {@link org.apache.geode.cache.Region} names which this {@link org.apache.geode.cache.CacheWriter}
 	 * will be link to. Not declaring any regions will result in the CacheListener to be configured against all defined
 	 * regions.
 	 */

spring-data-geode/src/main/java/org/springframework/data/gemfire/eventing/config/EnableEventProcessing.java renamed to spring-data-geode/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEventProcessing.java

@@ -15,7 +15,7 @@
  *
  */
 
-package org.springframework.data.gemfire.eventing.config;
+package org.springframework.data.gemfire.config.annotation;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
@@ -25,22 +25,30 @@
 import java.lang.annotation.Target;
 
 import org.springframework.context.annotation.Import;
+import org.springframework.data.gemfire.eventing.config.AsCacheListenerBeanPostProcessorRegistrar;
+import org.springframework.data.gemfire.eventing.config.AsCacheWriterBeanPostProcessorRegistrar;
+import org.springframework.data.gemfire.eventing.config.PojoCacheListenerWrapper;
+import org.springframework.data.gemfire.eventing.config.PojoCacheWriterWrapper;
 
 /**
  * Enables GemFire annotated EventHandler implementations. These implementation will include {@link org.apache.geode.cache.CacheListener},
  * {@link org.apache.geode.cache.CacheWriter}, {@link org.apache.geode.cache.TransactionListener} and {@link org.apache.geode.cache.CacheLoader}
  *
- * This annotation results in the container discovering any beans that are annotated with {code}@AsCacheListener{code},
- * wraps them in a {@link PojoCacheListenerWrapper} and register them with the corresponding {@link org.apache.geode.cache.Region}.
- *
+ * This annotation results in the container discovering any beans that are annotated with:
+ * <ul><
+ * <li>	{code}@AsCacheListener{code},wraps them in a {@link PojoCacheListenerWrapper}</li>
+ * <li>	{code}@AsCacheWriter{code},wraps them in a {@link PojoCacheWriterWrapper}</li>
+ * <li></li>and register them with the corresponding {@link org.apache.geode.cache.Region}.
+ *</ul>
  * @author Udo Kohlmeyer
  * @since 2.3.0
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Inherited
 @Documented
-@Import(AsCacheListenerBeanPostProcessorRegistrar.class)
+@Import({ AsCacheListenerBeanPostProcessorRegistrar.class,
+		  AsCacheWriterBeanPostProcessorRegistrar.class})
 @SuppressWarnings("unused")
 public @interface EnableEventProcessing {
 

spring-data-geode/src/main/java/org/springframework/data/gemfire/config/support/CacheListenerPostProcessor.java

@@ -23,7 +23,6 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
-import java.lang.reflect.Modifier;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
@@ -40,63 +39,43 @@
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.annotation.AnnotationAttributes;
-import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.data.gemfire.config.annotation.AsCacheListener;
 import org.springframework.data.gemfire.config.annotation.AsRegionEventListener;
 import org.springframework.data.gemfire.eventing.EventProcessorUtils;
 import org.springframework.data.gemfire.eventing.config.CacheListenerEventType;
 import org.springframework.data.gemfire.eventing.config.PojoCacheListenerWrapper;
 import org.springframework.data.gemfire.eventing.config.PojoRegionEventCacheListenerWrapper;
 import org.springframework.data.gemfire.eventing.config.RegionCacheListenerEventType;
-import org.springframework.data.gemfire.util.ArrayUtils;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.ReflectionUtils;
 
 /**
  * A {@link BeanPostProcessor} to create and register {@link CacheListener}, annotated with {@link AsCacheListener}
  * and {@link AsRegionEventListener} onto the configured {@link Region}s
  */
-@Configuration public class CacheListenerPostProcessor implements BeanPostProcessor, BeanFactoryAware {
+@Configuration
+public class CacheListenerPostProcessor extends CallbackPostProcessor
+	implements BeanPostProcessor, BeanFactoryAware {
 
 	private ConfigurableListableBeanFactory beanFactory;
 
-	@Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
-
-		registerAnyDeclaredCacheListenerAnnotatedMethods(bean, AsCacheListener.class);
-		registerAnyDeclaredCacheListenerAnnotatedMethods(bean, AsRegionEventListener.class);
-
-		return bean;
+	@Override
+	protected Class getRegionCallbackClass() {
+		return AsRegionEventListener.class;
 	}
 
-	private <T extends Annotation> void registerAnyDeclaredCacheListenerAnnotatedMethods(Object bean,
-		Class<T> listenerAnnotationClazz) {
-
-		stream(nullSafeArray(ReflectionUtils.getAllDeclaredMethods(bean.getClass()), Method.class)).forEach(method -> {
-
-			Optional<T> cacheListenerAnnotation = Optional.ofNullable(AnnotationUtils
-				.getAnnotation(method, listenerAnnotationClazz));
-
-			cacheListenerAnnotation.ifPresent(asCacheListener -> {
-
-				Assert.isTrue(Modifier.isPublic(method.getModifiers()), String
-					.format("The bean [%s] method [%s] annotated with [%s] must be public", bean.getClass().getName(),
-						method.getName(), listenerAnnotationClazz.getName()));
-
-				AnnotationAttributes cacheListenerAttributes = resolveAnnotationAttributes(asCacheListener);
-
-				registerEventHandlers(bean, listenerAnnotationClazz, method, cacheListenerAttributes);
-
-			});
-		});
+	@Override
+	protected Class getCallbackClass() {
+		return AsCacheListener.class;
 	}
 
-	private <T extends Annotation> void registerEventHandlers(Object bean, Class<T> listenerAnnotationClazz,
+	@Override
+	protected <T extends Annotation> void registerEventHandlers(Object bean, Class<T> listenerAnnotationClazz,
 		Method method, AnnotationAttributes cacheListenerAttributes) {
-		if (listenerAnnotationClazz.isAssignableFrom(AsCacheListener.class)) {
+		if (listenerAnnotationClazz.isAssignableFrom(getCallbackClass())) {
 			registerCacheListenerEventHandler(bean, method, cacheListenerAttributes);
 		}
-		else if (listenerAnnotationClazz.isAssignableFrom(AsRegionEventListener.class)) {
+		else if (listenerAnnotationClazz.isAssignableFrom(getRegionCallbackClass())) {
 			registerRegionEventHandler(bean, method, cacheListenerAttributes);
 		}
 	}
@@ -122,7 +101,7 @@ private void registerCacheListenerEventHandler(Object bean, Method method,
 	private void registerRegionEventHandler(Object bean, Method method,
 		AnnotationAttributes cacheListenerAttributes) {
 		RegionCacheListenerEventType[] eventTypes = (RegionCacheListenerEventType[]) cacheListenerAttributes
-			.get("regionEventTypes");
+			.get("regionListenerEventTypes");
 		registerEventHandlerToRegion(method, cacheListenerAttributes,
 			new PojoRegionEventCacheListenerWrapper(method, bean, eventTypes), RegionEvent.class);
 	}
@@ -142,7 +121,7 @@ private <T extends CacheEvent> void registerEventHandlerToRegion(Method method,
 		String[] regions = getRegionsForEventRegistration(cacheListenerAttributes.getStringArray("regions"),
 			getBeanFactory());
 
-		EventProcessorUtils.validateCacheListenerMethodParameters(method, eventClass);
+		EventProcessorUtils.validateEventHandlerMethodParameters(method, eventClass);
 		EventProcessorUtils.registerCacheListenerToRegions(regions, beanFactory, cacheListener);
 	}
 
@@ -174,11 +153,6 @@ private String[] getRegionsForEventRegistration(String[] regions, ConfigurableLi
 		}
 	}
 
-	private AnnotationAttributes resolveAnnotationAttributes(Annotation annotation) {
-
-		return AnnotationAttributes.fromMap(AnnotationUtils.getAnnotationAttributes(annotation, false, true));
-	}
-
 	/**
 	 * Returns a reference to the containing Spring {@link BeanFactory}.
 	 *
@@ -200,7 +174,9 @@ protected ConfigurableListableBeanFactory getBeanFactory() {
 	 * @see org.springframework.beans.factory.BeanFactoryAware
 	 * @see org.springframework.beans.factory.BeanFactory
 	 */
-	@Override @SuppressWarnings("all") public final void setBeanFactory(BeanFactory beanFactory) throws BeansException {
+	@Override
+	@SuppressWarnings("all")
+	public final void setBeanFactory(BeanFactory beanFactory) throws BeansException {
 
 		Assert.isInstanceOf(ConfigurableListableBeanFactory.class, beanFactory, String
 			.format("BeanFactory [%1$s] must be an instance of %2$s", ObjectUtils.nullSafeClassName(beanFactory),