Spring/spring-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAGEODE-168 - Configure GatewayReceivers with Annotations.

Browse Source 
Adds the EnableGatewayReceiver annotation to the SDG Annotation based configuraiton model to configure a GatewayReceiver.

Resolves gh-7.
This commit is contained in:
Udo Kohlmeyer
2018-12-20 09:44:55 -08:00
committed by John Blum
parent 247236efe5
commit f8dac4bf4a
9 changed files with 916 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAnnotationConfigSupport.java
View File

@@ -66,6 +66,7 @@ import org.slf4j.LoggerFactory;
* with Spring Data GemFire or Spring Data Geode.
*
* @author John Blum
* @author Udo Kohlmeyer
* @see java.lang.ClassLoader
* @see org.springframework.beans.factory.BeanClassLoaderAware
* @see org.springframework.beans.factory.BeanFactory
@@ -770,6 +771,10 @@ public abstract class AbstractAnnotationConfigSupport
return String.format("%1$s%2$s", serviceProperty("http."), propertyNameSuffix);
}
protected String gatewayReceiverProperty(String propertyNameSuffix) {
return String.format("%1$s%2$s", propertyName("gateway.receiver."), propertyNameSuffix);
}
/**
* Returns the fully-qualified {@link String property name}.
*

6
src/main/java/org/springframework/data/gemfire/wan/AbstractWANComponentFactoryBean.java
View File

@@ -40,7 +40,7 @@ import org.springframework.util.StringUtils;
public abstract class AbstractWANComponentFactoryBean<T>
implements BeanNameAware, DisposableBean, FactoryBean<T>, InitializingBean {
protected final Cache cache;
protected Cache cache;
protected final Logger logger = LoggerFactory.getLogger(getClass());
@@ -53,6 +53,10 @@ public abstract class AbstractWANComponentFactoryBean<T>
this.cache = cache;
}
public void setCache(Cache cache) {
this.cache = cache;
}
@Override
public void setBeanName(String beanName) {
this.beanName = beanName;

21
src/main/java/org/springframework/data/gemfire/wan/GatewayReceiverFactoryBean.java
View File

@@ -15,14 +15,19 @@
*/
package org.springframework.data.gemfire.wan;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.wan.GatewayReceiver;
import org.apache.geode.cache.wan.GatewayReceiverFactory;
import org.apache.geode.cache.wan.GatewayTransportFilter;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.gemfire.util.CollectionUtils;
import org.springframework.data.gemfire.wan.annotation.EnableGatewayReceiverConfigurer;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
@@ -31,6 +36,7 @@ import org.springframework.util.StringUtils;
*
* @author David Turanski
* @author John Blum
* @author Udo Kohlmeyer
* @see org.springframework.context.SmartLifecycle
* @see org.springframework.data.gemfire.wan.AbstractWANComponentFactoryBean
* @see org.apache.geode.cache.Cache
@@ -50,11 +56,15 @@ public class GatewayReceiverFactoryBean extends AbstractWANComponentFactoryBean<
private Integer socketBufferSize;
private Integer startPort;
@Autowired
private List<GatewayTransportFilter> transportFilters;
private String bindAddress;
private String hostnameForSenders;
@Autowired
private EnableGatewayReceiverConfigurer gatewayReceiverConfigurer;
/**
* Constructs an instance of the {@link GatewayReceiverFactoryBean} class initialized with a reference to
* the GemFire {@link Cache} used to configure and initialize a GemFire {@link GatewayReceiver}.
@@ -89,6 +99,9 @@ public class GatewayReceiverFactoryBean extends AbstractWANComponentFactoryBean<
protected void doInit() throws Exception {
GatewayReceiverFactory gatewayReceiverFactory = cache.createGatewayReceiverFactory();
Optional.of(gatewayReceiverConfigurer)
.ifPresent(gatewayReceiverConfigurer1 -> gatewayReceiverConfigurer1.configure("GatewayReceiver",this));
if (StringUtils.hasText(bindAddress)) {
gatewayReceiverFactory.setBindAddress(bindAddress);
}
@@ -161,4 +174,12 @@ public class GatewayReceiverFactoryBean extends AbstractWANComponentFactoryBean<
public void setTransportFilters(List<GatewayTransportFilter> transportFilters) {
this.transportFilters = transportFilters;
}
public Collection<? extends GatewayTransportFilter> getTransportFilters() {
return Collections.unmodifiableList(transportFilters);
}
public void setGatewayReceiverConfigurer(EnableGatewayReceiverConfigurer gatewayReceiverConfigurer) {
this.gatewayReceiverConfigurer = gatewayReceiverConfigurer;
}
}

88
src/main/java/org/springframework/data/gemfire/wan/annotation/EnableGatewayReceiver.java Normal file
View File

@@ -0,0 +1,88 @@
package org.springframework.data.gemfire.wan.annotation;
import org.springframework.context.annotation.Import;
import java.lang.annotation.*;
/**
* The EnableGatewayReceiver annotation creates a {@link org.apache.geode.cache.wan.GatewayReceiver}
* within GemFire/Geode {@link org.apache.geode.cache.Cache}
*
* @author Udo Kohlmeyer
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.Import
* @see org.apache.geode.cache.wan.GatewayTransportFilter
* @see org.apache.geode.cache.wan.GatewayReceiver
* @see org.apache.geode.cache.Cache
* @since 2.2.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Import(EnableGatewayReceiverConfiguration.class)
@SuppressWarnings("unused")
public @interface EnableGatewayReceiver {
/**
* A boolean to allow the GatewayReceiver to be created without being started after creation.
* If the manualStart is set to {@literal true} then the system will create the GatewayReceiver but not start it.
* It then becomes the responsibility of the operator to start the GatewayReceiver at a later stage.
* If set to {@literal false} the GatewayReceiver will start automatically after creation.
* Default is {@value EnableGatewayReceiverConfiguration#DEFAULT_MANUAL_START}
*/
boolean manualStart() default EnableGatewayReceiverConfiguration.DEFAULT_MANUAL_START;
/**
* The starting port number that GatewayReceiver will use when selecting a port to run on. This range of port numbers
* is bounded by the {startPort} and {endPort}.
* Default is {@value EnableGatewayReceiverConfiguration#DEFAULT_START_PORT}
*/
int startPort() default EnableGatewayReceiverConfiguration.DEFAULT_START_PORT;
/**
* The end port number that GatewayReceiver will use when selecting a port to run on. This range of port numbers
* is bounded by the {startPort} and {endPort}.
* Default is {@value EnableGatewayReceiverConfiguration#DEFAULT_END_PORT}
*/
int endPort() default EnableGatewayReceiverConfiguration.DEFAULT_END_PORT;
/**
* An integer value in milliseconds representing the maximum time which a {@link org.apache.geode.cache.wan.GatewayReceiver}
* will wait to receive a ping back from a {@link org.apache.geode.cache.wan.GatewaySender} before the {@link org.apache.geode.cache.wan.GatewayReceiver}
* believes the sender to be not available.
* Default value is {@value EnableGatewayReceiverConfiguration#DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS}
*/
int maximumTimeBetweenPings() default EnableGatewayReceiverConfiguration.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS;
/**
* The socket buffer size for the {@link org.apache.geode.cache.wan.GatewayReceiver}. This setting is in bytes
* Default value is {@value EnableGatewayReceiverConfiguration#DEFAULT_SOCKET_BUFFER_SIZE}
*/
int socketBufferSize() default EnableGatewayReceiverConfiguration.DEFAULT_SOCKET_BUFFER_SIZE;
/**
* An in-order list of {@link org.apache.geode.cache.wan.GatewayTransportFilter} to be applied to
* {@link org.apache.geode.cache.wan.GatewayReceiver}
* Default value is {@value {}}
*/
String[] transportFilters() default {};
/**
* The IP address or hostname that the {@link org.apache.geode.cache.wan.GatewayReceiver} communication socket will be bound to.
* An empty String will cause the underlying socket to bind to 0.0.0.0
* Default value is {@value EnableGatewayReceiverConfiguration#DEFAULT_BIND_ADDRESS}
*/
String bindAddress() default EnableGatewayReceiverConfiguration.DEFAULT_BIND_ADDRESS;
/**
* The hostname or IP Address that the {@link org.apache.geode.cache.wan.GatewaySender} will use to connect and communicate with the
* {@link org.apache.geode.cache.wan.GatewayReceiver}. An empty String will cause the system to expose the hostname
* to the {@link org.apache.geode.cache.wan.GatewaySender}. Generally this property is set when there are multiple
* network interfaces or when they are designated as "internal" or "public" network interfaces. In a cloud environment
* the notion of external and internal network interfaces exist and generally the "externally"/outwardly facing network
* interface is used.
* Default value is {@value EnableGatewayReceiverConfiguration#DEFAULT_HOSTNAME_FOR_SENDERS}
*/
String hostnameForSenders() default EnableGatewayReceiverConfiguration.DEFAULT_HOSTNAME_FOR_SENDERS;
}

213
src/main/java/org/springframework/data/gemfire/wan/annotation/EnableGatewayReceiverConfiguration.java Normal file
View File

@@ -0,0 +1,213 @@
package org.springframework.data.gemfire.wan.annotation;
import org.apache.geode.cache.wan.GatewayReceiver;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.factory.config.BeanReference;
import org.springframework.beans.factory.config.RuntimeBeanReference;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.ManagedList;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.data.gemfire.config.annotation.support.AbstractAnnotationConfigSupport;
import org.springframework.data.gemfire.config.xml.GemfireConstants;
import org.springframework.data.gemfire.wan.GatewayReceiverFactoryBean;
import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.Optional;
/**
* Spring {@link Configuration} class used to construct, configure and initialize a {@link GatewayReceiver} instance
* in a Spring application context.
*
* @author Udo Kohlmeyer
* @see org.apache.geode.cache.wan.GatewayReceiver
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.data.gemfire.wan.annotation.EnableGatewayReceiver
* @since 2.2.0
*/
public class EnableGatewayReceiverConfiguration extends AbstractAnnotationConfigSupport
implements ImportBeanDefinitionRegistrar {
static final boolean DEFAULT_MANUAL_START = GatewayReceiver.DEFAULT_MANUAL_START;
static final int DEFAULT_START_PORT = GatewayReceiver.DEFAULT_START_PORT;
static final int DEFAULT_END_PORT = GatewayReceiver.DEFAULT_END_PORT;
static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS = GatewayReceiver.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS;
static final int DEFAULT_SOCKET_BUFFER_SIZE = GatewayReceiver.DEFAULT_SOCKET_BUFFER_SIZE;
static final String DEFAULT_BIND_ADDRESS = GatewayReceiver.DEFAULT_BIND_ADDRESS;
static final String DEFAULT_HOSTNAME_FOR_SENDERS = GatewayReceiver.DEFAULT_HOSTNAME_FOR_SENDERS;
private final String START_PORT_LITERAL = "startPort";
private final String END_PORT_LITERAL = "END_PORT_LITERAL";
private final String MANUAL_START_LITERAL = "manualStart";
private final String MAXIMUM_TIME_BETWEEN_PINGS_LITERAL = "maximumTimeBetweenPings";
private final String SOCKET_BUFFER_SIZE_LITERAL = "socketBufferSize";
private final String BIND_ADDRESS_LITERAL = "bindAddress";
private final String HOSTNAME_FOR_SENDERS_LITERAL = "hostnameForSenders";
private final String TRANSPORT_FILTERS_LITERAL = "transportFilters";
@Override
protected Class<? extends Annotation> getAnnotationType() {
return org.springframework.data.gemfire.wan.annotation.EnableGatewayReceiver.class;
}
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
if (importingClassMetadata.hasAnnotation(getAnnotationTypeName())) {
AnnotationAttributes enableGatewayReceiverAttributes =
AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(getAnnotationTypeName()));
registerGatewayReceiverBeanDefinition(enableGatewayReceiverAttributes, registry);
}
}
/**
* Configures a {@link GatewayReceiver} from the {@link EnableGatewayReceiver} annotation, "spring.data.gemfire.gateway.receiver.*"
* properties and {@link EnableGatewayReceiverConfigurer}
*
* @param enableGatewayReceiverAttributes
* @param registry
*/
private void registerGatewayReceiverBeanDefinition(AnnotationAttributes enableGatewayReceiverAttributes,
BeanDefinitionRegistry registry) {
BeanDefinitionBuilder gatewayReceiverBeanBuilder =
BeanDefinitionBuilder.genericBeanDefinition(GatewayReceiverFactoryBean.class);
String gatewayReceiverBeanName = "GatewayReceiver";
configureBeanFromAnnotatedProperties(enableGatewayReceiverAttributes, gatewayReceiverBeanBuilder,
gatewayReceiverBeanName);
configureBeanBuilderFromPropertiesOrWithDefaultValues(gatewayReceiverBeanBuilder);
registerGatewayTransportFilterDependencies(enableGatewayReceiverAttributes, gatewayReceiverBeanBuilder);
registry.registerBeanDefinition(gatewayReceiverBeanName, gatewayReceiverBeanBuilder.getBeanDefinition());
}
/**
* Configures GatewayReceiver {@link BeanDefinitionBuilder} using value populated on {@link EnableGatewayReceiver}.
* If no values are provided, values are set to defaults
*
* @param enableGatewayReceiverAttributes
* @param gatewayReceiverBeanBuilder
* @param gatewayReceiverBeanName
*/
private void configureBeanFromAnnotatedProperties(AnnotationAttributes enableGatewayReceiverAttributes,
BeanDefinitionBuilder gatewayReceiverBeanBuilder, String gatewayReceiverBeanName) {
gatewayReceiverBeanBuilder.addConstructorArgReference(GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME);
gatewayReceiverBeanBuilder.addPropertyValue("beanName", gatewayReceiverBeanName);
gatewayReceiverBeanBuilder.addPropertyReference("cache", GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, START_PORT_LITERAL,
enableGatewayReceiverAttributes.<Integer>getNumber(START_PORT_LITERAL), DEFAULT_START_PORT);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, END_PORT_LITERAL,
enableGatewayReceiverAttributes.<Integer>getNumber(END_PORT_LITERAL), DEFAULT_END_PORT);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, MANUAL_START_LITERAL,
enableGatewayReceiverAttributes.getBoolean(MANUAL_START_LITERAL), DEFAULT_MANUAL_START);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, MAXIMUM_TIME_BETWEEN_PINGS_LITERAL,
enableGatewayReceiverAttributes.<Integer>getNumber(MAXIMUM_TIME_BETWEEN_PINGS_LITERAL),
DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, SOCKET_BUFFER_SIZE_LITERAL,
enableGatewayReceiverAttributes.<Integer>getNumber(SOCKET_BUFFER_SIZE_LITERAL), DEFAULT_SOCKET_BUFFER_SIZE);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, BIND_ADDRESS_LITERAL,
enableGatewayReceiverAttributes.getString(BIND_ADDRESS_LITERAL), DEFAULT_BIND_ADDRESS);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, HOSTNAME_FOR_SENDERS_LITERAL,
enableGatewayReceiverAttributes.getString(HOSTNAME_FOR_SENDERS_LITERAL), DEFAULT_HOSTNAME_FOR_SENDERS);
setPropertyValueIfNotDefault(gatewayReceiverBeanBuilder, TRANSPORT_FILTERS_LITERAL,
resolveTransportBeanReferences(enableGatewayReceiverAttributes.getStringArray(TRANSPORT_FILTERS_LITERAL)),
new ManagedList<BeanReference>());
}
/**
* Configures GatewayReceiver {@link BeanDefinitionBuilder} using properties, defined under "spring.data.gemfire.gateway.receiver.*"
*
* @param gatewayReceiverBeanBuilder
*/
private void configureBeanBuilderFromPropertiesOrWithDefaultValues(
BeanDefinitionBuilder gatewayReceiverBeanBuilder) {
MutablePropertyValues beanPropertyValues = gatewayReceiverBeanBuilder.getRawBeanDefinition()
.getPropertyValues();
configureFromProperties(gatewayReceiverBeanBuilder, START_PORT_LITERAL,
(Integer) beanPropertyValues.getPropertyValue(START_PORT_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, END_PORT_LITERAL,
(Integer) beanPropertyValues.getPropertyValue(END_PORT_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, MANUAL_START_LITERAL,
(Boolean) beanPropertyValues.getPropertyValue(MANUAL_START_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, MAXIMUM_TIME_BETWEEN_PINGS_LITERAL,
(Integer) beanPropertyValues.getPropertyValue(MAXIMUM_TIME_BETWEEN_PINGS_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, SOCKET_BUFFER_SIZE_LITERAL,
(Integer) beanPropertyValues.getPropertyValue(SOCKET_BUFFER_SIZE_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, BIND_ADDRESS_LITERAL,
(String) beanPropertyValues.getPropertyValue(BIND_ADDRESS_LITERAL).getValue());
configureFromProperties(gatewayReceiverBeanBuilder, HOSTNAME_FOR_SENDERS_LITERAL,
(String) beanPropertyValues.getPropertyValue(HOSTNAME_FOR_SENDERS_LITERAL).getValue());
String[] filters = resolveProperty(gatewayReceiverProperty(TRANSPORT_FILTERS_LITERAL), String[].class);
Optional.ofNullable(filters)
.ifPresent(transportFilters ->
{
ManagedList<BeanReference> beanReferences = resolveTransportBeanReferences(transportFilters);
gatewayReceiverBeanBuilder.addPropertyValue(TRANSPORT_FILTERS_LITERAL, beanReferences);
});
}
private void configureFromProperties(BeanDefinitionBuilder gatewayReceiverBeanBuilder, String propertyName,
Integer annotatedPropertyValue) {
Integer propertyValue = resolveProperty(gatewayReceiverProperty(propertyName), annotatedPropertyValue);
gatewayReceiverBeanBuilder.addPropertyValue(propertyName, propertyValue);
}
private void configureFromProperties(BeanDefinitionBuilder gatewayReceiverBeanBuilder, String propertyName,
String annotatedPropertyValue) {
String propertyValue = resolveProperty(gatewayReceiverProperty(propertyName), annotatedPropertyValue);
gatewayReceiverBeanBuilder.addPropertyValue(propertyName, propertyValue);
}
private void configureFromProperties(BeanDefinitionBuilder gatewayReceiverBeanBuilder, String propertyName,
Boolean annotatedPropertyValue) {
Boolean propertyValue = resolveProperty(gatewayReceiverProperty(propertyName), annotatedPropertyValue);
gatewayReceiverBeanBuilder.addPropertyValue(propertyName, propertyValue);
}
private ManagedList<BeanReference> resolveTransportBeanReferences(String[] transportFilters) {
ManagedList<BeanReference> transportFilterBeanReferences = new ManagedList<>();
Optional.ofNullable(transportFilters).ifPresent(transportFilterBeanNames ->
Arrays.stream(transportFilterBeanNames)
.map(RuntimeBeanReference::new)
.forEach(transportFilterBeanReferences::add));
return transportFilterBeanReferences;
}
private void registerGatewayTransportFilterDependencies(AnnotationAttributes annotationAttributes,
BeanDefinitionBuilder gatewayReceiverBeanBuilder) {
String[] transportFilters = (String[]) annotationAttributes.get(TRANSPORT_FILTERS_LITERAL);
Optional.ofNullable(transportFilters).ifPresent(
transportFilerBeanNames -> Arrays.stream(transportFilerBeanNames)
.forEach(gatewayReceiverBeanBuilder::addDependsOn));
}
/* (non-Javadoc) */
private <T> BeanDefinitionBuilder setPropertyValueIfNotDefault(BeanDefinitionBuilder beanDefinitionBuilder,
String propertyName, T value, T defaultValue) {
return (value != null) ?
beanDefinitionBuilder.addPropertyValue(propertyName, value)
: beanDefinitionBuilder.addPropertyValue(propertyName, defaultValue);
}
}

16
src/main/java/org/springframework/data/gemfire/wan/annotation/EnableGatewayReceiverConfigurer.java Normal file
View File

@@ -0,0 +1,16 @@
package org.springframework.data.gemfire.wan.annotation;
import org.springframework.data.gemfire.wan.GatewayReceiverFactoryBean;
public interface EnableGatewayReceiverConfigurer {
/**
* Configuration callback method providing a reference to a {@link GatewayReceiverFactoryBean} used to construct,
* configure and initialize an instance of {@link org.apache.geode.cache.wan.GatewayReceiver}.
*
* @param beanName name of the {@link org.apache.geode.cache.wan.GatewayReceiver} bean declared in the Spring application context.
* @param bean reference to the {@link GatewayReceiverFactoryBean}.
* @see org.springframework.data.gemfire.wan.GatewayReceiverFactoryBean
* @see org.apache.geode.cache.wan.GatewayReceiver
*/
void configure(String beanName, GatewayReceiverFactoryBean bean);
}