SGF-588 - Reorganize and repackage additional classes in the SDG API.

src/main/java/org/springframework/data/gemfire/cache/CallableCacheLoaderAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 the original author or authors.
+ * Copyright 2016 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.
@@ -15,7 +15,7 @@
  *
  */
 
-package org.springframework.data.gemfire.support;
+package org.springframework.data.gemfire.cache;
 
 import java.util.concurrent.Callable;
 
@@ -27,17 +27,17 @@ import org.apache.geode.cache.TimeoutException;
 import org.springframework.util.Assert;
 
 /**
- * The CallableCacheLoaderAdapter class is a {@link Callable} and GemFire {@link CacheLoader} implementation that
- * adapts the {@link Callable} interface into an instance of the {@link CacheLoader} interface.  This class is useful
- * in situations where GemFire developers have several {@link CacheLoader} implementations that they wish to use
- * with Spring's Cache Abstraction.
+ * The {@link CallableCacheLoaderAdapter} class is a {@link Callable} and GemFire {@link CacheLoader} implementation
+ * that adapts the {@link Callable} interface into an instance of the {@link CacheLoader} interface.  This class is
+ * useful in situations where GemFire developers have several {@link CacheLoader} implementations that they wish to
+ * use with Spring's Cache Abstraction.
  *
  * @author John Blum
  * @see java.util.concurrent.Callable
  * @see org.apache.geode.cache.CacheLoader
  * @see org.apache.geode.cache.LoaderHelper
  * @see org.apache.geode.cache.Region
- * @since 1.0.0
+ * @since 1.9.0
  */
 @SuppressWarnings("unused")
 public class CallableCacheLoaderAdapter<K, V> implements Callable<V>, CacheLoader<K, V> {
@@ -196,5 +196,4 @@ public class CallableCacheLoaderAdapter<K, V> implements Callable<V>, CacheLoade
 	public V load(LoaderHelper<K, V> loaderHelper) throws CacheLoaderException {
 		return getCacheLoader().load(loaderHelper);
 	}
-
 }

src/main/java/org/springframework/data/gemfire/client/GemfireDataSourcePostProcessor.java

@@ -29,7 +29,7 @@ import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.data.gemfire.function.execution.GemfireOnServersFunctionTemplate;
-import org.springframework.data.gemfire.support.ListRegionsOnServerFunction;
+import org.springframework.data.gemfire.client.function.ListRegionsOnServerFunction;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
@@ -42,7 +42,7 @@ import org.springframework.util.ObjectUtils;
  * @see org.springframework.beans.factory.config.BeanFactoryPostProcessor
  * @see org.springframework.beans.factory.config.ConfigurableListableBeanFactory
  * @see org.springframework.data.gemfire.function.execution.GemfireOnServersFunctionTemplate
- * @see org.springframework.data.gemfire.support.ListRegionsOnServerFunction
+ * @see ListRegionsOnServerFunction
  * @see org.apache.geode.cache.Region
  * @see org.apache.geode.cache.client.ClientCache
  * @see org.apache.geode.cache.client.ClientRegionFactory

src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java

@@ -1,16 +1,20 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2016 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
+ * 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
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      http://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.
  *
- * 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.support;
+package org.springframework.data.gemfire.client.function;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -32,7 +36,7 @@ import org.apache.geode.cache.execute.FunctionContext;
 @SuppressWarnings("serial")
 public class ListRegionsOnServerFunction implements Function {
 
-	private static final long serialVersionUID = 867530169l;
+	private static final long serialVersionUID = 867530169L;
 
 	public static final String ID = ListRegionsOnServerFunction.class.getName();
 
@@ -91,5 +95,4 @@ public class ListRegionsOnServerFunction implements Function {
 	public boolean optimizeForWrite() {
 		return false;
 	}
-
 }

src/main/java/org/springframework/data/gemfire/config/xml/GemfireRegionAutoProxyParser.java

@@ -22,7 +22,7 @@ import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
 import org.springframework.beans.factory.support.ManagedList;
 import org.springframework.beans.factory.xml.BeanDefinitionParser;
 import org.springframework.beans.factory.xml.ParserContext;
-import org.springframework.data.gemfire.support.JSONRegionAdvice;
+import org.springframework.data.gemfire.serialization.json.JSONRegionAdvice;
 import org.springframework.util.StringUtils;
 import org.w3c.dom.Element;
 
@@ -32,7 +32,7 @@ import org.w3c.dom.Element;
  * @author David Turanski
  * @author John Blum
  * @see org.springframework.beans.factory.xml.BeanDefinitionParser
- * @see org.springframework.data.gemfire.support.JSONRegionAdvice
+ * @see JSONRegionAdvice
  */
 class GemfireRegionAutoProxyParser implements BeanDefinitionParser {
 

src/main/java/org/springframework/data/gemfire/config/xml/TransactionManagerParser.java

@@ -21,7 +21,7 @@ import org.springframework.beans.factory.support.AbstractBeanDefinition;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
 import org.springframework.beans.factory.xml.ParserContext;
-import org.springframework.data.gemfire.GemfireTransactionManager;
+import org.springframework.data.gemfire.transaction.GemfireTransactionManager;
 import org.springframework.util.StringUtils;
 import org.w3c.dom.Element;
 
@@ -31,7 +31,7 @@ import org.w3c.dom.Element;
  * @author Costin Leau
  * @author John Blum
  * @see org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser
- * @see org.springframework.data.gemfire.GemfireTransactionManager
+ * @see GemfireTransactionManager
  */
 class TransactionManagerParser extends AbstractSingleBeanDefinitionParser {
 

src/main/java/org/springframework/data/gemfire/dao/GemfireDaoSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2016 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.
@@ -12,9 +12,10 @@
  * 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.support;
+package org.springframework.data.gemfire.dao;
 
 import org.apache.geode.cache.Region;
 import org.springframework.dao.support.DaoSupport;
@@ -23,36 +24,25 @@ import org.springframework.data.gemfire.GemfireTemplate;
 import org.springframework.util.Assert;
 
 /**
- * Convenient super class for GemFire data access objects. Intended for
- * GemfireTemplate usage.
+ * Convenient super class for GemFire Data Access Objects (DAO) implementing the Spring
+ * {@link DaoSupport} abstract class. Intended for use with {@link GemfireTemplate}.
  *
- * <p>Requires a Region to be set, providing a GemfireTemplate based on it to subclasses.
- * Can alternatively be initialized directly via a GemfireTemplate, to reuse the latter's
- * settings.
+ * Requires a GemFire {@link Region} to be set, providing a {@link GemfireTemplate} based on it to subclasses.
+ * Can alternatively be initialized directly via a {@link GemfireTemplate} reusing the template's  settings.
  *
- * <p>This class will create its own GemfireTemplate if an Region reference is passed in.
- * A custom GemfireTemplate instance can be used through overriding <code>createGemfireTemplate</code>.
+ * This class will create its own {@link GemfireTemplate} if a GemFire {@link Region} reference is passed in.
+ * A custom {@link GemfireTemplate} instance can be used through overriding <code>createGemfireTemplate</code>.
  *
  * @author Costin Leau
  * @author John Blum
+ * @see org.apache.geode.cache.Region
  * @see org.springframework.dao.support.DaoSupport
+ * @see org.springframework.data.gemfire.GemfireTemplate
  */
-public class GemfireDaoSupport extends DaoSupport {
+public abstract class GemfireDaoSupport extends DaoSupport {
 
 	private GemfireOperations gemfireTemplate;
 
-	/**
-	 * Sets the GemFire Cache Region to be used by this DAO. Will automatically create
-	 * an instance of the GemfireTemplate for the given Region.
-	 *
-	 * @param region the GemFire Cache Region upon which this DAO operates.
-	 * @see org.apache.geode.cache.Region
-	 * @see #createGemfireTemplate(org.apache.geode.cache.Region)
-	 */
-	public void setRegion(Region<?, ?> region) {
-		this.gemfireTemplate = createGemfireTemplate(region);
-	}
-
 	/**
 	 * Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a GemFire Cache {@link Region}.
 	 *
@@ -73,7 +63,19 @@ public class GemfireDaoSupport extends DaoSupport {
 	 * @see org.springframework.data.gemfire.GemfireTemplate
 	 */
 	public final GemfireOperations getGemfireTemplate() {
-		return gemfireTemplate;
+		return this.gemfireTemplate;
+	}
+
+	/**
+	 * Sets the GemFire Cache Region to be used by this DAO. Will automatically create
+	 * an instance of the GemfireTemplate for the given Region.
+	 *
+	 * @param region the GemFire Cache Region upon which this DAO operates.
+	 * @see org.apache.geode.cache.Region
+	 * @see #createGemfireTemplate(org.apache.geode.cache.Region)
+	 */
+	public void setRegion(Region<?, ?> region) {
+		this.gemfireTemplate = createGemfireTemplate(region);
 	}
 
 	/**
@@ -86,7 +88,7 @@ public class GemfireDaoSupport extends DaoSupport {
 	 * @see org.apache.geode.cache.Region
 	 * @see #setRegion
 	 */
-	protected GemfireOperations createGemfireTemplate(Region<?, ?> region) {
+	protected GemfireTemplate createGemfireTemplate(Region<?, ?> region) {
 		return new GemfireTemplate(region);
 	}
 
@@ -95,7 +97,6 @@ public class GemfireDaoSupport extends DaoSupport {
 	 */
 	@Override
 	protected final void checkDaoConfig() {
-		Assert.state(gemfireTemplate != null, "A GemFire Cache Region or an instance of the GemfireTemplate is required.");
+		Assert.state(gemfireTemplate != null, "A GemFire Cache Region or instance of GemfireTemplate is required");
 	}
-
 }

src/main/java/org/springframework/data/gemfire/serialization/json/JSONRegionAdvice.java

@@ -1,17 +1,21 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2016 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
+ * 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
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      http://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.
  *
- * 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.support;
+package org.springframework.data.gemfire.serialization.json;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -37,7 +41,15 @@ import org.springframework.data.gemfire.GemfireTemplate;
 import org.springframework.util.CollectionUtils;
 
 /**
+ * Spring/AspectJ AOP Aspect to adapt a GemFire {@link Region} to handle JSON data.
+ *
  * @author David Turanski
+ * @author John Blum
+ * @see org.apache.geode.cache.Region
+ * @see org.apache.geode.pdx.JSONFormatter
+ * @see org.apache.geode.pdx.PdxInstance
+ * @see org.aspectj.lang.annotation.Aspect
+ * @see org.aspectj.lang.annotation.Around
  */
 @Aspect
 @SuppressWarnings("unused")
@@ -320,5 +332,4 @@ public class JSONRegionAdvice {
 		}
 
 	}
-
 }

src/main/java/org/springframework/data/gemfire/support/GemfireBeanFactoryLocator.java

@@ -248,6 +248,7 @@ public class GemfireBeanFactoryLocator implements BeanFactoryAware, BeanNameAwar
 	 * the {@link #setBeanName(String)} beanName} property.
 	 *
 	 * @return the single Spring {@link BeanFactory} from the registry.
+	 * @throws IllegalArgumentException if more than Spring {@link BeanFactory} is registered.
 	 * @throws IllegalStateException if the {@link BeanFactory} with the associated
 	 * {@link #setBeanName(String) beanName} is not found.
 	 * @see org.springframework.beans.factory.BeanFactory
@@ -259,9 +260,16 @@ public class GemfireBeanFactoryLocator implements BeanFactoryAware, BeanNameAwar
 	}
 
 	/**
+	 * Attempts to use the Spring {@link BeanFactory} idenified by the given {@code beanFactoryKey}.
 	 *
-	 * @param beanFactoryKey
-	 * @return
+	 * @param beanFactoryKey {@link String} containing the key used to lookup the Spring {@link BeanFactory}.
+	 * @return the Spring {@link BeanFactory} for the given {@code beanFactoryKey}.
+	 * @throws IllegalArgumentException if a Spring {@link BeanFactory} could not be found for {@code beanFactoryKey}.
+	 * @throws IllegalStateException if {@literal useBeanFactoryLocator} was not configured.
+	 * @see org.springframework.beans.factory.BeanFactory
+	 * @see BeanFactoryReference#newBeanFactoryReference(BeanFactory)
+	 * @see #resolveBeanFactory(String)
+	 * @see #resolveSingleBeanFactory()
 	 */
 	public BeanFactory useBeanFactory(String beanFactoryKey) {
 		return newBeanFactoryReference(StringUtils.hasText(beanFactoryKey) ? resolveBeanFactory(beanFactoryKey)
@@ -349,9 +357,9 @@ public class GemfireBeanFactoryLocator implements BeanFactoryAware, BeanNameAwar
 		 * @param beanFactory {@link BeanFactory} reference to store.
 		 * @return a new instance of {@link BeanFactoryReference} initialized with the given {@link BeanFactory}.
 		 * @see org.springframework.beans.factory.BeanFactory
-		 * @see #BeanFactoryReference(BeanFactory)
+		 * @see #GemfireBeanFactoryLocator.BeanFactoryReference(BeanFactory)
 		 */
-		public static BeanFactoryReference newBeanFactoryReference(BeanFactory beanFactory) {
+		protected static BeanFactoryReference newBeanFactoryReference(BeanFactory beanFactory) {
 			return new BeanFactoryReference(beanFactory);
 		}
 
@@ -361,7 +369,7 @@ public class GemfireBeanFactoryLocator implements BeanFactoryAware, BeanNameAwar
 		 * @param beanFactory {@link BeanFactory} reference to store; may be {@literal null}.
 		 * @see org.springframework.beans.factory.BeanFactory
 		 */
-		public BeanFactoryReference(BeanFactory beanFactory) {
+		protected BeanFactoryReference(BeanFactory beanFactory) {
 			this.beanFactory.set(beanFactory);
 		}
 

src/main/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupport.java

@@ -117,7 +117,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor
 	 *
 	 * @return a boolean value indicating whether this {@link Declarable} object has been properly configured
 	 * and initialized by the Spring container.
-	 * @see #doInit(Properties)
+	 * @see #doInit(BeanFactory, Properties)
 	 * @see #assertInitialized()
 	 */
 	protected boolean isInitialized() {
@@ -130,7 +130,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor
 	 *
 	 * @return a boolean value indicating whether this {@link Declarable} object has been properly configured
 	 * and initialized by the Spring container.
-	 * @see #doInit(Properties)
+	 * @see #doInit(BeanFactory, Properties)
 	 * @see #isInitialized()
 	 */
 	protected boolean isNotInitialized() {
@@ -144,7 +144,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor
 	 *
 	 * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's
 	 * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object.
-	 * @see #doInit(Properties)
+	 * @see #doInit(BeanFactory, Properties)
 	 * @see java.util.Properties
 	 */
 	@Override
@@ -188,7 +188,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor
 	 *
 	 * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's
 	 * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object.
-	 * @see #doInit(Properties)
+	 * @see #doInit(BeanFactory, Properties)
 	 * @see java.util.Properties
 	 */
 	protected void doPostInit(Properties parameters) {

src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionCommitException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2016 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.
@@ -12,15 +12,16 @@
  * 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;
+package org.springframework.data.gemfire.transaction;
 
 import org.springframework.transaction.TransactionException;
 
 /**
  * Gemfire-specific subclass of {@link org.springframework.transaction.TransactionException}, indicating a transaction failure at commit time.
- * 
+ *
  * @author Costin Leau
  */
 @SuppressWarnings("serial")

src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2013 the original author or authors.
+ * Copyright 2016 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.
@@ -12,9 +12,10 @@
  * 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;
+package org.springframework.data.gemfire.transaction;
 
 import org.apache.geode.cache.Cache;
 import org.apache.geode.cache.CacheTransactionManager;
@@ -52,20 +53,20 @@ import org.springframework.util.Assert;
  * workaround, one could use explicitly deep copy objects before making changes
  * to them to avoid unnecessary copying on every fetch.
  *
- * @see org.apache.geode.cache.CacheTransactionManager
+ * @author Costin Leau
+ * @author John Blum
  * @see org.apache.geode.cache.Cache#setCopyOnRead(boolean)
+ * @see org.apache.geode.cache.CacheTransactionManager
  * @see org.apache.geode.cache.Region#get(Object)
  * @see org.apache.geode.CopyHelper#copy(Object)
- * @see #setCopyOnRead(boolean)
  * @see org.springframework.transaction.support.AbstractPlatformTransactionManager
- *
- * @author Costin Leau
+ * @see #setCopyOnRead(boolean)
  */
 // TODO add lenient behavior if a transaction is already started on the current
 // thread (what should happen then)
 @SuppressWarnings("serial")
-public class GemfireTransactionManager extends AbstractPlatformTransactionManager implements InitializingBean,
-		ResourceTransactionManager {
+public class GemfireTransactionManager extends AbstractPlatformTransactionManager
+		implements InitializingBean, ResourceTransactionManager {
 
 	private Cache cache;
 
@@ -112,7 +113,7 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage
 	protected void doBegin(Object transaction, TransactionDefinition definition) throws TransactionException {
 		CacheTransactionObject txObject = (CacheTransactionObject) transaction;
 
-		Cache cache = null;
+		Cache cache;
 
 		try {
 			cache = getCache();