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

DATAGEODE-197 - Prepare Region configuration using SDG XML Namespace Parsers to accept AEQ and GatewaySender IDs for association.

Browse Source
This commit is contained in:
John Blum
2019-07-15 17:52:17 -07:00
parent 0c441d1889
commit 6c7bdfc877
6 changed files with 162 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/main/java/org/springframework/data/gemfire/config/xml/AbstractRegionParser.java
View File

@@ -59,7 +59,6 @@ abstract class AbstractRegionParser extends AbstractSingleBeanDefinitionParser {
return getRegionFactoryClass();
}
/* (non-Javadoc) */
protected abstract Class<?> getRegionFactoryClass();
/**
@@ -67,20 +66,24 @@ abstract class AbstractRegionParser extends AbstractSingleBeanDefinitionParser {
*/
@Override
protected String getParentName(Element element) {
String regionTemplate = element.getAttribute("template");
return StringUtils.hasText(regionTemplate) ? regionTemplate : super.getParentName(element);
}
/* (non-Javadoc) */
protected boolean isRegionTemplate(Element element) {
String localName = element.getLocalName();
return (localName != null && localName.endsWith("-template"));
return localName != null && localName.endsWith("-template");
}
/* (non-Javadoc) */
protected boolean isSubRegion(Element element) {
String localName = element.getParentNode().getLocalName();
return (localName != null && localName.endsWith("region"));
return localName != null && localName.endsWith("region");
}
/**
@@ -88,8 +91,11 @@ abstract class AbstractRegionParser extends AbstractSingleBeanDefinitionParser {
*/
@Override
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
super.doParse(element, builder);
builder.setAbstract(isRegionTemplate(element));
doParseRegion(element, parserContext, builder, isSubRegion(element));
}

2
src/main/java/org/springframework/data/gemfire/config/xml/LocalRegionParser.java
View File

@@ -13,13 +13,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.gemfire.config.xml;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.data.gemfire.LocalRegionFactoryBean;
import org.springframework.data.gemfire.RegionAttributesFactoryBean;
import org.w3c.dom.Element;
/**

288
src/main/java/org/springframework/data/gemfire/config/xml/ParsingUtils.java
View File

@@ -13,7 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.gemfire.config.xml;
import java.util.List;
@@ -21,6 +20,7 @@ import java.util.List;
import org.apache.geode.cache.LossAction;
import org.apache.geode.cache.MembershipAttributes;
import org.apache.geode.cache.ResumptionAction;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.RuntimeBeanReference;
@@ -36,6 +36,7 @@ import org.springframework.data.gemfire.expiration.ExpirationAttributesFactoryBe
import org.springframework.data.gemfire.util.SpringUtils;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;
/**
@@ -101,7 +102,7 @@ abstract class ParsingUtils {
}
static void setPropertyValue(BeanDefinitionBuilder builder, BeanDefinition source, String propertyName,
boolean withDependsOn) {
boolean addDependsOn) {
PropertyValue propertyValue = source.getPropertyValues().getPropertyValue(propertyName);
@@ -109,7 +110,7 @@ abstract class ParsingUtils {
builder.addPropertyValue(propertyValue.getName(), propertyValue.getValue());
if (withDependsOn && propertyValue.getValue() instanceof RuntimeBeanReference) {
if (addDependsOn && propertyValue.getValue() instanceof RuntimeBeanReference) {
builder.addDependsOn(((RuntimeBeanReference) propertyValue.getValue()).getBeanName());
}
}
@@ -122,19 +123,21 @@ abstract class ParsingUtils {
static Object getBeanReference(Element element, ParserContext parserContext, String refAttributeName) {
String refAttributeValue = element.getAttribute(refAttributeName);
Object returnValue = null;
if (StringUtils.hasText(refAttributeValue)) {
if (!DomUtils.getChildElements(element).isEmpty()) {
parserContext.getReaderContext().error(String.format(
"Use either the '%1$s' attribute or a nested bean declaration for '%2$s' element, but not both.",
refAttributeName, element.getLocalName()), element);
String message = String.format(
"Use either the [%1$s] attribute or a nested bean declaration for [%2$s] element, not both",
refAttributeName, element.getLocalName());
parserContext.getReaderContext().error(message, element);
}
returnValue = new RuntimeBeanReference(refAttributeValue);
return null;
}
return returnValue;
return new RuntimeBeanReference(refAttributeValue);
}
static Object parseRefOrNestedCustomElement(Element element, ParserContext parserContext,
@@ -202,15 +205,18 @@ abstract class ParsingUtils {
// parse nested bean definition
if (childElements.size() == 1) {
return parserContext.getDelegate().parsePropertySubElement(
childElements.get(0), builder.getRawBeanDefinition());
return parserContext.getDelegate()
.parsePropertySubElement(childElements.get(0), builder.getRawBeanDefinition());
}
else {
// TODO also triggered when there are no child elements; need to change the message...
if (single) {
parserContext.getReaderContext().error(String.format(
"The element '%1$s' does not support multiple nested bean definitions.",
element.getLocalName()), element);
String message = String.format("The element [%s] does not support multiple, nested bean definitions",
element.getLocalName());
parserContext.getReaderContext().error(message, element);
}
}
@@ -223,6 +229,17 @@ abstract class ParsingUtils {
return list;
}
static void parseCompressor(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element compressorElement = DomUtils.getChildElementByTagName(element, "compressor");
if (compressorElement != null) {
regionAttributesBuilder.addPropertyValue("compressor", parseRefOrSingleNestedBeanDeclaration(
compressorElement, parserContext, regionAttributesBuilder));
}
}
/**
* Parses the eviction sub-element. Populates the given attribute factory with the proper attributes.
*
@@ -238,8 +255,8 @@ abstract class ParsingUtils {
if (evictionElement != null) {
BeanDefinitionBuilder evictionAttributesBuilder = BeanDefinitionBuilder.genericBeanDefinition(
EvictionAttributesFactoryBean.class);
BeanDefinitionBuilder evictionAttributesBuilder =
BeanDefinitionBuilder.genericBeanDefinition(EvictionAttributesFactoryBean.class);
setPropertyValue(evictionElement, evictionAttributesBuilder, "action");
setPropertyValue(evictionElement, evictionAttributesBuilder, "threshold");
@@ -249,8 +266,8 @@ abstract class ParsingUtils {
if (objectSizerElement != null) {
Object sizer = parseRefOrNestedBeanDeclaration(objectSizerElement, parserContext,
evictionAttributesBuilder);
Object sizer =
parseRefOrNestedBeanDeclaration(objectSizerElement, parserContext, evictionAttributesBuilder);
evictionAttributesBuilder.addPropertyValue("objectSizer", sizer);
}
@@ -264,52 +281,6 @@ abstract class ParsingUtils {
return false;
}
/**
* Parses the subscription sub-element. Populates the given attribute factory with the proper attributes.
*
* @param element the XML element being parsed.
* @param parserContext the context used while parsing the XML document.
* @param regionAttributesBuilder the Region Attributes builder.
* @return true if parsing actually occurred, false otherwise.
*/
@SuppressWarnings("unused")
static boolean parseSubscription(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element subscriptionElement = DomUtils.getChildElementByTagName(element, "subscription");
if (subscriptionElement != null) {
BeanDefinitionBuilder subscriptionAttributesBuilder =
BeanDefinitionBuilder.genericBeanDefinition(SubscriptionAttributesFactoryBean.class);
setPropertyValue(subscriptionElement, subscriptionAttributesBuilder, "type", "interestPolicy");
regionAttributesBuilder.addPropertyValue("subscriptionAttributes",
subscriptionAttributesBuilder.getBeanDefinition());
return true;
}
return false;
}
static void parseTransportFilters(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
Element transportFilterElement = DomUtils.getChildElementByTagName(element, "transport-filter");
if (transportFilterElement != null) {
builder.addPropertyValue("transportFilters", parseRefOrNestedBeanDeclaration(transportFilterElement,
parserContext,
builder));
}
}
static void parseStatistics(Element element, BeanDefinitionBuilder regionAttributesBuilder) {
setPropertyValue(element, regionAttributesBuilder, "statistics", "statisticsEnabled");
}
/**
* Parses the expiration sub-elements. Populates the given attribute factory with proper attributes.
*
@@ -321,25 +292,87 @@ abstract class ParsingUtils {
static boolean parseExpiration(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
boolean result = parseExpiration(element, "region-ttl", "regionTimeToLive",
regionAttributesBuilder);
boolean result = parseRegionEntryExpiration(element, "region-ttl", "regionTimeToLive", regionAttributesBuilder);
result |= parseExpiration(element, "region-tti", "regionIdleTimeout", regionAttributesBuilder);
result |= parseExpiration(element, "entry-ttl", "entryTimeToLive", regionAttributesBuilder);
result |= parseExpiration(element, "entry-tti", "entryIdleTimeout", regionAttributesBuilder);
result |= parseCustomExpiration(element, parserContext, "custom-entry-ttl", "customEntryTimeToLive",
regionAttributesBuilder);
result |= parseCustomExpiration(element, parserContext, "custom-entry-tti", "customEntryIdleTimeout",
regionAttributesBuilder);
result |= parseRegionEntryExpiration(element, "region-tti", "regionIdleTimeout", regionAttributesBuilder);
result |= parseRegionEntryExpiration(element, "entry-ttl", "entryTimeToLive", regionAttributesBuilder);
result |= parseRegionEntryExpiration(element, "entry-tti", "entryIdleTimeout", regionAttributesBuilder);
result |= parseCustomExpiration(element, parserContext, "custom-entry-ttl", "customEntryTimeToLive", regionAttributesBuilder);
result |= parseCustomExpiration(element, parserContext, "custom-entry-tti", "customEntryIdleTimeout", regionAttributesBuilder);
if (result) {
// enable statistics
regionAttributesBuilder.addPropertyValue("statisticsEnabled", Boolean.TRUE);
}
return result;
}
private static boolean parseRegionEntryExpiration(Element rootElement, String elementName, String propertyName,
BeanDefinitionBuilder regionAttributesBuilder) {
Element expirationElement = DomUtils.getChildElementByTagName(rootElement, elementName);
if (expirationElement != null) {
BeanDefinitionBuilder expirationAttributesBuilder =
BeanDefinitionBuilder.genericBeanDefinition(ExpirationAttributesFactoryBean.class);
setPropertyValue(expirationElement, expirationAttributesBuilder, "action");
setPropertyValue(expirationElement, expirationAttributesBuilder, "timeout");
regionAttributesBuilder.addPropertyValue(propertyName, expirationAttributesBuilder.getBeanDefinition());
return true;
}
return false;
}
private static boolean parseCustomExpiration(Element rootElement, ParserContext parserContext, String elementName,
String propertyName, BeanDefinitionBuilder regionAttributesBuilder) {
Element expirationElement = DomUtils.getChildElementByTagName(rootElement, elementName);
if (expirationElement != null) {
Object customExpiry =
parseRefOrSingleNestedBeanDeclaration(expirationElement, parserContext, regionAttributesBuilder);
regionAttributesBuilder.addPropertyValue(propertyName, customExpiry);
return true;
}
return false;
}
@SuppressWarnings({ "deprecation", "unused" })
static void parseMembershipAttributes(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element membershipAttributes = DomUtils.getChildElementByTagName(element, "membership-attributes");
if (membershipAttributes != null) {
String[] requiredRoles =
StringUtils.commaDelimitedListToStringArray(membershipAttributes.getAttribute("required-roles"));
String lossActionValue = membershipAttributes.getAttribute("loss-action");
LossAction lossAction = StringUtils.hasText(lossActionValue)
? LossAction.fromName(lossActionValue.toUpperCase().replace("-", "_"))
: LossAction.NO_ACCESS;
String resumptionActionValue = membershipAttributes.getAttribute("resumption-action");
ResumptionAction resumptionAction = StringUtils.hasText(resumptionActionValue)
? ResumptionAction.fromName(resumptionActionValue.toUpperCase().replace("-", "_"))
: ResumptionAction.REINITIALIZE;
regionAttributesBuilder.addPropertyValue("membershipAttributes",
new MembershipAttributes(requiredRoles, lossAction, resumptionAction));
}
}
@SuppressWarnings("unused")
static void parseOptionalRegionAttributes(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
@@ -367,34 +400,6 @@ abstract class ParsingUtils {
}
}
@SuppressWarnings({ "deprecation", "unused" })
static void parseMembershipAttributes(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element membershipAttributes = DomUtils.getChildElementByTagName(element, "membership-attributes");
if (membershipAttributes != null) {
String[] requiredRoles = StringUtils.commaDelimitedListToStringArray(
membershipAttributes.getAttribute("required-roles"));
String lossActionValue = membershipAttributes.getAttribute("loss-action");
LossAction lossAction = (StringUtils.hasText(lossActionValue)
? LossAction.fromName(lossActionValue.toUpperCase().replace("-", "_"))
: LossAction.NO_ACCESS);
String resumptionActionValue = membershipAttributes.getAttribute("resumption-action");
ResumptionAction resumptionAction = (StringUtils.hasText(resumptionActionValue)
? ResumptionAction.fromName(resumptionActionValue.toUpperCase().replace("-", "_"))
: ResumptionAction.REINITIALIZE);
regionAttributesBuilder.addPropertyValue("membershipAttributes",
new MembershipAttributes(requiredRoles, lossAction, resumptionAction));
}
}
static void parseScope(Element element, BeanDefinitionBuilder builder) {
String scopeAttributeValue = element.getAttribute("scope");
@@ -404,19 +409,33 @@ abstract class ParsingUtils {
}
}
private static boolean parseExpiration(Element rootElement, String elementName, String propertyName,
static void parseStatistics(Element element, BeanDefinitionBuilder regionAttributesBuilder) {
setPropertyValue(element, regionAttributesBuilder, "statistics", "statisticsEnabled");
}
/**
* Parses the subscription sub-element. Populates the given attribute factory with the proper attributes.
*
* @param element the XML element being parsed.
* @param parserContext the context used while parsing the XML document.
* @param regionAttributesBuilder the Region Attributes builder.
* @return true if parsing actually occurred, false otherwise.
*/
@SuppressWarnings("unused")
static boolean parseSubscription(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element expirationElement = DomUtils.getChildElementByTagName(rootElement, elementName);
Element subscriptionElement = DomUtils.getChildElementByTagName(element, "subscription");
if (expirationElement != null) {
if (subscriptionElement != null) {
BeanDefinitionBuilder expirationAttributesBuilder =
BeanDefinitionBuilder.genericBeanDefinition(ExpirationAttributesFactoryBean.class);
BeanDefinitionBuilder subscriptionAttributesBuilder =
BeanDefinitionBuilder.genericBeanDefinition(SubscriptionAttributesFactoryBean.class);
setPropertyValue(expirationElement, expirationAttributesBuilder, "action");
setPropertyValue(expirationElement, expirationAttributesBuilder, "timeout");
regionAttributesBuilder.addPropertyValue(propertyName, expirationAttributesBuilder.getBeanDefinition());
setPropertyValue(subscriptionElement, subscriptionAttributesBuilder, "type", "interestPolicy");
regionAttributesBuilder.addPropertyValue("subscriptionAttributes",
subscriptionAttributesBuilder.getBeanDefinition());
return true;
}
@@ -424,32 +443,13 @@ abstract class ParsingUtils {
return false;
}
private static boolean parseCustomExpiration(Element rootElement, ParserContext parserContext, String elementName,
String propertyName, BeanDefinitionBuilder regionAttributesBuilder) {
static void parseTransportFilters(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
Element expirationElement = DomUtils.getChildElementByTagName(rootElement, elementName);
Element transportFilterElement = DomUtils.getChildElementByTagName(element, "transport-filter");
if (expirationElement != null) {
Object customExpiry =
parseRefOrSingleNestedBeanDeclaration(expirationElement, parserContext, regionAttributesBuilder);
regionAttributesBuilder.addPropertyValue(propertyName, customExpiry);
return true;
}
return false;
}
static void parseCompressor(Element element, ParserContext parserContext,
BeanDefinitionBuilder regionAttributesBuilder) {
Element compressorElement = DomUtils.getChildElementByTagName(element, "compressor");
if (compressorElement != null) {
regionAttributesBuilder.addPropertyValue("compressor", parseRefOrSingleNestedBeanDeclaration(
compressorElement, parserContext, regionAttributesBuilder));
if (transportFilterElement != null) {
builder.addPropertyValue("transportFilters",
parseRefOrNestedBeanDeclaration(transportFilterElement, parserContext, builder));
}
}
@@ -457,8 +457,11 @@ abstract class ParsingUtils {
static void assertGemFireFeatureAvailable(Element element, ParserContext parserContext) {
if (GemfireUtils.isGemfireFeatureUnavailable(element)) {
parserContext.getReaderContext().error(String.format("'%1$s' is not supported in %2$s v%3$s",
element.getLocalName(), GemfireUtils.GEMFIRE_NAME, GemfireUtils.GEMFIRE_VERSION), element);
String message = String.format("[%1$s] is not supported in %2$s v%3$s",
element.getLocalName(), GemfireUtils.GEMFIRE_NAME, GemfireUtils.GEMFIRE_VERSION);
parserContext.getReaderContext().error(message, element);
}
}
@@ -487,13 +490,14 @@ abstract class ParsingUtils {
if (GemfireUtils.isGemfireFeatureUnavailable(feature)) {
String messagePrefix = (attributeName != null)
? String.format("Attribute '%1$s' of element '%2$s'", attributeName, elementName)
: String.format("Element '%1$s'", elementName);
String messagePrefix = attributeName != null
? String.format("Attribute [%1$s] of element [%2$s]", attributeName, elementName)
: String.format("Element [%s]", elementName);
parserContext.getReaderContext()
.error(String.format("%1$s requires GemFire version 7 or later. The current version is %2$s.",
messagePrefix, GemfireUtils.GEMFIRE_VERSION), null);
String message = String.format("%1$s requires Pivotal GemFire version 7 or later. Current version is %2$s.",
messagePrefix, GemfireUtils.GEMFIRE_VERSION);
parserContext.getReaderContext().error(message, null);
}
}
}

2
src/main/java/org/springframework/data/gemfire/config/xml/PartitionedRegionParser.java
View File

@@ -13,7 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.gemfire.config.xml;
import java.util.List;
@@ -30,6 +29,7 @@ import org.springframework.data.gemfire.RegionAttributesFactoryBean;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;
/**

2
src/main/java/org/springframework/data/gemfire/config/xml/ReplicatedRegionParser.java
View File

@@ -13,13 +13,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.gemfire.config.xml;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.data.gemfire.RegionAttributesFactoryBean;
import org.springframework.data.gemfire.ReplicatedRegionFactoryBean;
import org.w3c.dom.Element;
/**

5
src/main/resources/org/springframework/data/gemfire/config/spring-geode-2.2.xsd
View File

@@ -592,7 +592,7 @@ Comma-delimited list of Server endpoints used by this Pool in the form of: host1
<xsd:annotation>
<xsd:appinfo>
<tool:annotation>
<tool:exports type="org.apache.geode.cache.Region" />
<tool:exports type="org.apache.geode.cache.Region"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
@@ -2703,8 +2703,7 @@ must implement org.apache.geode.cache.execute.Function
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:any namespace="##other" processContents="skip"
minOccurs="0" maxOccurs="unbounded">
<xsd:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation><![CDATA[
Inner bean definition of the remote function.