diff --git a/README.md b/README.md index 0157aa74..ed4a081c 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -Spring Data GemFire -=================== +Spring Data for Pivotal GemFire +=============================== -The primary goal of the [Spring Data GemFire](http://projects.spring.io/spring-data-gemfire) project -is to make it easier to build highly scalable, _Spring_ powered applications using [Pivotal GemFire](https://pivotal.io/pivotal-gemfire) +The primary goal of the [Spring Data for Pivotal GemFire](http://projects.spring.io/spring-data-gemfire) project +is to make it easier to build highly scalable, _Spring_ powered applications using [Pivotal GemFire](https://pivotal.io/pivotal-gemfire) as the underlying distributed, in-memory data management platform. # Examples -For examples on using the _Spring Data GemFire_, see the +For examples on using the _Spring Data for Pivotal GemFire_, see the [spring-gemfire-examples](https://github.com/SpringSource/spring-gemfire-examples) project. # Getting Help -Read the main project [website](http://projects.spring.io/spring-data-gemfire/) along with +Read the main project [website](http://projects.spring.io/spring-data-gemfire/) along with the [User Guide](http://docs.spring.io/spring-data-gemfire/docs/current/reference/html/). Look at the source code and the [JavaDocs](http://docs.spring.io/spring-data-gemfire/docs/current/api/). For more detailed questions, visit [_StackOverflow_](https://stackoverflow.com/questions/tagged/spring-data-gemfire). -If you are new to _Spring_ as well as _Spring Data GemFire_, look for information about +If you are new to _Spring_ as well as _Spring Data for Pivotal GemFire_, look for information about [_Spring_ projects](http://spring.io/projects). Quick Start @@ -66,7 +66,7 @@ dependencies { } ~~~~~ -* Configure a GemFire cache and Region (REPLICATE, PARTITION and so on): +* Configure a Pivotal GemFire cache and Region (REPLICATE, PARTITION and so on): ~~~~~ xml spring-data-gemfire 2.0.8.BUILD-SNAPSHOT - Spring Data GemFire + Spring Data for Pivotal GemFire SGF diff --git a/samples/hello-world/build.gradle b/samples/hello-world/build.gradle index 789093dc..0ed78060 100644 --- a/samples/hello-world/build.gradle +++ b/samples/hello-world/build.gradle @@ -1,4 +1,4 @@ -description = 'Spring Data GemFire Samples - Hello World' +description = 'Spring Data for Pivotal GemFire Samples - Hello World' apply plugin: 'base' apply plugin: 'idea' @@ -21,7 +21,7 @@ dependencies { runtime "log4j:log4j:$log4jVersion" runtime "org.slf4j:slf4j-log4j12:$slf4jVersion" - + testCompile "junit:junit:$junitVersion" testCompile "org.springframework:spring-test:$springVersion" } @@ -34,4 +34,4 @@ run { systemProperties['java.net.preferIPv4Stack'] = 'true' } -defaultTasks 'run' \ No newline at end of file +defaultTasks 'run' diff --git a/samples/hello-world/src/main/java/org/springframework/data/gemfire/samples/helloworld/Main.java b/samples/hello-world/src/main/java/org/springframework/data/gemfire/samples/helloworld/Main.java index d16b92e3..cba3d340 100644 --- a/samples/hello-world/src/main/java/org/springframework/data/gemfire/samples/helloworld/Main.java +++ b/samples/hello-world/src/main/java/org/springframework/data/gemfire/samples/helloworld/Main.java @@ -20,15 +20,17 @@ import org.springframework.context.support.AbstractApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; /** - * Hello World startup class. Bootstraps the Spring container which in turns starts GemFire and the actual application. + * Hello World startup class. + * + * Bootstraps the Spring container which in turns starts Pivotal GemFire and the actual application. * * Accepts as optional parameters location of one (or multiple) application contexts that will * be used for configuring the Spring container. See the reference documentation for more * {@link http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/resources.html information}. - * + * * Note that in most (if not all) managed environments writing such a class is not needed * as Spring already provides the required integration. - * + * * @see org.springframework.web.context.ContextLoaderListener * @author Costin Leau */ diff --git a/samples/hello-world/src/main/resources/cache-context.xml b/samples/hello-world/src/main/resources/cache-context.xml index b5d76810..55847bc4 100644 --- a/samples/hello-world/src/main/resources/cache-context.xml +++ b/samples/hello-world/src/main/resources/cache-context.xml @@ -8,13 +8,13 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd http://www.springframework.org/schema/gemfire http://www.springframework.org/schema/gemfire/spring-gemfire.xsd"> - + - + - + @@ -22,7 +22,7 @@ - + - + diff --git a/src/main/asciidoc/appendix/appendix-schema.adoc b/src/main/asciidoc/appendix/appendix-schema.adoc index 93b60d98..120d4895 100644 --- a/src/main/asciidoc/appendix/appendix-schema.adoc +++ b/src/main/asciidoc/appendix/appendix-schema.adoc @@ -1,7 +1,7 @@ [[appendix-schema]] [appendix] -= Spring Data GemFire Schema += Spring Data for Pivotal GemFire Schema :resourcesDir: {basedocdir}/../resources -- http://www.springframework.org/schema/gemfire/spring-gemfire.xsd[Spring Data GemFire Core Schema (`gfe`-namespace)] -- http://www.springframework.org/schema/gemfire/spring-data-gemfire.xsd[Spring Data GemFire Data Access Schema (`gfe-data`-namespace)] +- http://www.springframework.org/schema/gemfire/spring-gemfire.xsd[Spring Data for Pivotal GemFire Core Schema (`gfe`-namespace)] +- http://www.springframework.org/schema/gemfire/spring-data-gemfire.xsd[Spring Data for Pivotal GemFire Data Access Schema (`gfe-data`-namespace)] diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index 727c8090..3b80c0bc 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -1,4 +1,4 @@ -= Spring Data GemFire Reference Guide += Spring Data for Pivotal GemFire Reference Guide Costin Leau , David Turanski , John Blum , Oliver Gierke :revnumber: {version} :revdate: {localdate} @@ -6,7 +6,7 @@ Costin Leau , David Turanski , John Blum , Oliver Gierke :toc: :!toc-placement: -(C) 2010-2017 The original authors. +(C) 2010-2018 The original authors. NOTE: Copies of this document may be made for your own use and for distribution to others provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice diff --git a/src/main/asciidoc/introduction/introduction.adoc b/src/main/asciidoc/introduction/introduction.adoc index 42aa210e..1a88e0b1 100644 --- a/src/main/asciidoc/introduction/introduction.adoc +++ b/src/main/asciidoc/introduction/introduction.adoc @@ -1,6 +1,6 @@ [[introduction]] = Introduction -This reference guide for _Spring Data GemFire_ explains how to use the _Spring Framework_ to configure and develop -applications with Pivotal GemFire. It presents the basic concepts, semantics and provides numerous examples -to help you get started. +Welcome! The _Spring Data for Pivotal GemFire_ reference guide explains how to use the _Spring Framework_ +to configure and develop applications with Pivotal GemFire. It presents the basic concepts and provides +numerous examples to help you get started. diff --git a/src/main/asciidoc/introduction/new-features.adoc b/src/main/asciidoc/introduction/new-features.adoc index cd2fd35f..e2d681e1 100644 --- a/src/main/asciidoc/introduction/new-features.adoc +++ b/src/main/asciidoc/introduction/new-features.adoc @@ -1,48 +1,49 @@ [[new-features]] = New Features -NOTE: As of the 1.2.0.RELEASE, this project, formerly known as _Spring GemFire_, has been renamed to -_Spring Data GemFire_ to reflect that it is now a module of the -http://projects.spring.io/spring-data/[Spring Data] project. +NOTE: As of the 1.2.0.RELEASE, this project, formerly known as _Spring Pivotal GemFire_, has been renamed to +_Spring Data for Pivotal GemFire_ to reflect that it is now a module of the +http://projects.spring.io/spring-data/[Spring Data] project +and built on https://pivotal.io/pivotal-gemfire[Pivotal GemFire]. [[new-in-1-2-0]] == New in the 1.2 Release -* Full support for GemFire configuration via the SDG *gfe* namespace. Now GemFire components may be configured completely without requiring a native *cache.xml* file. -* WAN Gateway support for GemFire 6.6.x. See <>. +* Full support for Pivotal GemFire configuration via the SDG *gfe* namespace. Now Pivotal GemFire components may be configured completely without requiring a native *cache.xml* file. +* WAN Gateway support for Pivotal GemFire 6.6.x. See <>. * Spring Data Repository support using a dedicated SDG namespace, *gfe-data*. See <> -* Namespace support for registering GemFire Functions. See <> +* Namespace support for registering Pivotal GemFire Functions. See <> * A top-level `` element has been added to the SDG *gfe* namespace to allow sharing of persist stores among Regions, and other components that support persistent backup or overflow. See <> + WARNING: The `<*-region>` elements no longer allow a nested `` element. + -* GemFire Sub-Regions are supported via nested `<*-region>` elements. +* Pivotal GemFire Sub-Regions are supported via nested `<*-region>` elements. * A `` element has been added to configure a Local Region. -* Support for the re-designed WAN Gateway in GemFire 7.0. +* Support for the re-designed WAN Gateway in Pivotal GemFire 7.0. [[new-in-1-3-0]] == New in the 1.3 Release -* Annotation support for GemFire Functions. It is now possible to declare and register Functions written as POJOs using annotations. In addition, Function executions are defined as +* Annotation support for Pivotal GemFire Functions. It is now possible to declare and register Functions written as POJOs using annotations. In addition, Function executions are defined as annotated interfaces, similar to the way Spring Data Repositories work. See <>. -* Added a `` element to the SDG *gfe-data* namespace to simplify establishing a basic <> to a GemFire data grid. +* Added a `` element to the SDG *gfe-data* namespace to simplify establishing a basic <> to a Pivotal GemFire data grid. * Added a `` element to the SDG *gfe-data* namespace to <> features introduced -in GemFire 7.0, enabling Spring AOP to perform the necessary conversions automatically on Region operations. -* Upgraded to GemFire 7.0.1 and added namespace support for new AsyncEventQueue attributes. +in Pivotal GemFire 7.0, enabling Spring AOP to perform the necessary conversions automatically on Region operations. +* Upgraded to Pivotal GemFire 7.0.1 and added namespace support for new AsyncEventQueue attributes. * Added support for setting subscription interest policy on Regions. * Support for void returns on Function executions. See <> for complete details. * Support for persisting Local Regions. See <> and <>. -* Support for entry time-to-live and entry idle-time on a GemFire Client Cache. See <>. -* Support for multiple Spring Data GemFire web-based applications using a single GemFire cluster, operating concurrently inside tc Server. -* Support for concurrency-checks-enabled on all GemFire Cache Region definitions using the SDG *gfe* namespace. See <>. +* Support for entry time-to-live and entry idle-time on a Pivotal GemFire Client Cache. See <>. +* Support for multiple Spring Data for Pivotal GemFire web-based applications using a single Pivotal GemFire cluster, operating concurrently inside tc Server. +* Support for concurrency-checks-enabled on all Pivotal GemFire Cache Region definitions using the SDG *gfe* namespace. See <>. * Support for Cache Loaders and Cache Writers on Client, Local Regions. See <>. -* Support for registering CacheListeners, AsyncEventQueues and Gateway Senders on GemFire Cache Sub-Regions. -* Support for PDX persistent keys in GemFire Regions. +* Support for registering CacheListeners, AsyncEventQueues and Gateway Senders on Pivotal GemFire Cache Sub-Regions. +* Support for PDX persistent keys in Pivotal GemFire Regions. * Support for correct Partition Region bean creation in a Spring context when collocation is specified with the *colocated-with* attribute. -* Full support for GemFire Cache Sub-Regions using proper, nested `<*-region>` element syntax in the SDG *gfe* namespace. -* Upgraded Spring Data GemFire to Spring Framework 3.2.8. -* Upgraded Spring Data GemFire to Spring Data Commons 1.7.1. +* Full support for Pivotal GemFire Cache Sub-Regions using proper, nested `<*-region>` element syntax in the SDG *gfe* namespace. +* Upgraded Spring Data for Pivotal GemFire to Spring Framework 3.2.8. +* Upgraded Spring Data for Pivotal GemFire to Spring Data Commons 1.7.1. [[new-in-1-4-0]] == New in the 1.4 Release @@ -50,27 +51,27 @@ in GemFire 7.0, enabling Spring AOP to perform the necessary conversions automat * Upgrades to Pivotal GemFire 7.0.2. * Upgrades to _Spring Data Commons_ 1.8.x.RELEASE. * Upgrades to _Spring Framework_ 3.2.x.RELEASE. -* Integrates _Spring Data GemFire_ with _Spring Boot_, which includes both a *spring-boot-starter-data-gemfire* POM -along with a _Spring Boot_ sample application demonstrating GemFire Cache Transactions configured with SDG +* Integrates _Spring Data for Pivotal GemFire_ with _Spring Boot_, which includes both a *spring-boot-starter-data-gemfire* POM +along with a _Spring Boot_ sample application demonstrating Pivotal GemFire Cache Transactions configured with SDG and bootstrapped with _Spring Boot_. -* Support for bootstrapping a Spring `ApplicationContext` in a GemFire Server when started from _Gfsh_. +* Support for bootstrapping a Spring `ApplicationContext` in a Pivotal GemFire Server when started from _Gfsh_. See <> for more details. -* Support for persisting application domain object/entities to multiple GemFire Cache Regions. +* Support for persisting application domain object/entities to multiple Pivotal GemFire Cache Regions. See <> for more details. -* Support for persisting application domain object/entities to GemFire Cache Sub-Regions, avoiding collisions +* Support for persisting application domain object/entities to Pivotal GemFire Cache Sub-Regions, avoiding collisions when Sub-Regions are uniquely identifiable, but identically named. See <> for more details. * Adds strict XSD type rules to, and full support for, Data Policies and Region Shortcuts -on all GemFire Cache Region types. +on all Pivotal GemFire Cache Region types. * Changed the default behavior of SDG `<*-region>` elements from lookup to always create a new Region along with an option to restore old behavior using the *ignore-if-exists* attribute. See <> and <> for more details. -* _Spring Data GemFire_ can now be fully built and ran on JDK 7 and JDK 8. +* _Spring Data for Pivotal GemFire_ can now be fully built and ran on JDK 7 and JDK 8. CAUTION: Pivotal GemFire has not yet been fully tested and certified to run JDK 8; See -http://gemfire.docs.pivotal.io/docs-gemfire/supported_configs/supported_configs_and_system_reqs.html[GemFire User Guide] +http://gemfire.docs.pivotal.io/docs-gemfire/supported_configs/supported_configs_and_system_reqs.html[Pivotal GemFire User Guide] for additional details. [[new-in-1-5-0]] @@ -80,12 +81,12 @@ for additional details. * Upgrades to _Spring Data Commons_ 1.9.x.RELEASE. * Upgrades to _Spring Framework_ 4.0.x.RELEASE. * Reference Guide migrated to Asciidoc. -* Renewed support for deploying _Spring Data GemFire_ in an OSGi container. -* Removed all default values in the _Spring Data GemFire_ XML namespace Region-type elements to -rely on GemFire defaults instead. +* Renewed support for deploying _Spring Data for Pivotal GemFire_ in an OSGi container. +* Removed all default values in the _Spring Data for Pivotal GemFire_ XML namespace Region-type elements to +rely on Pivotal GemFire defaults instead. * Added convenience to automatically create Disk Store directory locations. * SDG annotated Function implementations can now be executed from _Gfsh_. -* Enable GemFire `GatewayReceivers` to be started manually. +* Enable Pivotal GemFire `GatewayReceivers` to be started manually. * Support for Auto Region Lookups. See <> for further details. * Support for Region Templates. See <> for further details. @@ -95,10 +96,10 @@ rely on GemFire defaults instead. * Upgrades to Pivotal GemFire 8.0.0. * Upgrades to _Spring Data Commons_ 1.10.x.RELEASE. * Maintains support on _Spring Framework_ 4.0.x.RELEASE. -* Adds support for GemFire 8's new Cluster-based Configuration. -* Enables 'auto-reconnect' functionality to be employed in Spring-configured GemFire Servers. +* Adds support for Pivotal GemFire 8's new Cluster-based Configuration. +* Enables 'auto-reconnect' functionality to be employed in Spring-configured Pivotal GemFire Servers. * Allows the creation of concurrent and parallel Async Event Queues and Gateway Senders. -* Adds support for GemFire 8's Region data compression. +* Adds support for Pivotal GemFire 8's Region data compression. * Adds attributes to set both critical and warning percentages on Disk Store usage. * Supports the capability to add the new EventSubstitutionFilters to GatewaySenders. @@ -109,7 +110,7 @@ rely on GemFire defaults instead. * Upgrades to _Spring Data Commons_ 1.11.x.RELEASE. * Upgrades to _Spring Framework_ 4.1.x.RELEASE. * Early access support for Pivotal GemFire. -* Support for adding _Spring_-defined Cache Listeners, Loaders and Writers on "existing" GemFire Regions +* Support for adding _Spring_-defined Cache Listeners, Loaders and Writers on "existing" Pivotal GemFire Regions configured in _Spring_ XML, `cache.xml` or even with Pivotal GemFire's _Cluster Config_. * _Spring_ JavaConfig support added to `SpringContextBootstrappingInitializer`. * Support for custom `ClassLoaders` in `SpringContextBootstrappingInitializer` to load _Spring_-defined bean classes. @@ -135,10 +136,10 @@ endpoint lists configured with _Spring's_ property placeholders. * Adds `durable-client-id` and `durable-client-timeout` attributes to ``. * GemfirePersistentProperty now properly handles other non-entity, scalar-like types (e.g. `BigDecimal`, `BigInteger`). * Prevents SDG-defined `Pools` from being destroyed before `Regions` that use those `Pools`. -* Handles case-insensitive GemFire OQL queries defined as _Repository_ query methods. -* Changes `GemFireCache.evict(key)` to call `Region.remove(key)` in SDG's _Spring Cache Abstraction_ support. +* Handles case-insensitive Pivotal GemFire OQL queries defined as _Repository_ query methods. +* Changes `Pivotal GemFireCache.evict(key)` to call `Region.remove(key)` in SDG's _Spring Cache Abstraction_ support. * Fixes `RegionNotFoundException` with _Repository_ queries on a client `Region` associated with a specific `Pool` -configured for GemFire server groups. +configured for Pivotal GemFire server groups. * Changes `Gateway Senders/Receivers` to no longer be tied to the _Spring_ container. [[new-in-1-9-0]] @@ -151,9 +152,9 @@ configured for GemFire server groups. * Adds support for suspend and resume in the `GemfireTransactionManager`. * Adds support in _Repositories_ to use the bean `id` property as the Region key when the `@Id` annotation is not present. -* Uses `MappingPdxSerializer` as the default GemFire serialization strategy when `@EnablePdx` is used. +* Uses `MappingPdxSerializer` as the default Pivotal GemFire serialization strategy when `@EnablePdx` is used. * Enables `GemfireCacheManager` to explicitly list Region names to be used in the _Spring's Caching Abstraction_. -* Configure GemFire Caches, CacheServers, Locators, Pools, Regions, Indexes, DiskStores, Expiration, Eviction, +* Configure Pivotal GemFire Caches, CacheServers, Locators, Pools, Regions, Indexes, DiskStores, Expiration, Eviction, Statistics, Mcast, HttpService, Auth, SSL, Logging, System Properties. * Repository support with multiple _Spring Data_ modules on the classpath. @@ -171,4 +172,4 @@ Statistics, Mcast, HttpService, Auth, SSL, Logging, System Properties. * Renames `@EnableIndexes` to `@EnableIndexing`. * Introduces a `InterestsBuilder` class to easily and conveniently express Interests in keys/values between client and server when using JavaConfig. -* Adds support for Off-Heap, Redis Adapter and GemFire's new Security framework to the Annotation configuration model. +* Adds support for Off-Heap, Redis Adapter and Pivotal GemFire's new Security framework to the Annotation configuration model. diff --git a/src/main/asciidoc/introduction/requirements.adoc b/src/main/asciidoc/introduction/requirements.adoc index f93ea4a9..75feae41 100644 --- a/src/main/asciidoc/introduction/requirements.adoc +++ b/src/main/asciidoc/introduction/requirements.adoc @@ -1,5 +1,5 @@ [[requirements]] = Requirements -_Spring Data GemFire_ requires JDK 8.0, http://projects.spring.io/spring-framework[Spring Framework] 5 +_Spring Data for Pivotal GemFire_ requires JDK 8.0, http://projects.spring.io/spring-framework[Spring Framework] 5 and http://geode.apache.org/[Pivotal GemFire] 9.0.x. diff --git a/src/main/asciidoc/links.adoc b/src/main/asciidoc/links.adoc index 5573b747..05663b2a 100644 --- a/src/main/asciidoc/links.adoc +++ b/src/main/asciidoc/links.adoc @@ -1,14 +1,14 @@ [[sgf-links]] = Useful Links -* http://projects.spring.io/spring-data-gemfire[Spring Data GemFire Project Page] -* https://github.com/spring-projects/spring-data-gemfire[Spring Data GemFire source code] -* https://jira.spring.io/browse/SGF[Spring Data GemFire JIRA] -* http://stackoverflow.com/questions/tagged/spring-data-gemfire[Spring Data GemFire on StackOverflow] -* http://forum.spring.io/forum/spring-projects/data/gemfire[Archive of the Spring Data GemFire Forum on Spring IO] +* http://projects.spring.io/spring-data-gemfire[Spring Data for Pivotal GemFire Project Page] +* https://github.com/spring-projects/spring-data-gemfire[Spring Data for Pivotal GemFire source code] +* https://jira.spring.io/browse/SGF[Spring Data for Pivotal GemFire JIRA] +* http://stackoverflow.com/questions/tagged/spring-data-gemfire[Spring Data for Pivotal GemFire on StackOverflow] +* http://forum.spring.io/forum/spring-projects/data/gemfire[Archive of the Spring Data for Pivotal GemFire Forum on Spring IO] * https://pivotal.io/pivotal-gemfire[Pivotal GemFire Home Page] -* http://gemfire.docs.pivotal.io/gemfire/about_gemfire.html[Pivotal GemFire Documentation] +* http://gemfire.docs.pivotal.io/latest/gemfire/about_gemfire.html[Pivotal GemFire Documentation] * http://geode.apache.org/community/[Apache Geode Community] * https://github.com/apache/geode[Apache Geode source code] -* https://issues.apache.org/jira/browse/GEODE/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel[Apache Geode JIRA] +* https://issues.apache.org/jira/projects/GEODE/issues/GEODE-4748?filter=allopenissues[Apache Geode JIRA] * http://stackoverflow.com/questions/tagged/gemfire[Pivotal GemFire on StackOverflow] diff --git a/src/main/asciidoc/preface.adoc b/src/main/asciidoc/preface.adoc index 491a0e31..278eb211 100644 --- a/src/main/asciidoc/preface.adoc +++ b/src/main/asciidoc/preface.adoc @@ -1,16 +1,16 @@ = Preface -_Spring Data GemFire_ focuses on integrating the _Spring Framework's_ powerful, non-invasive programming model -and concepts with Pivotal GemFire to simplify configuration and development of Java applications using GemFire. +_Spring Data for Pivotal GemFire_ focuses on integrating the _Spring Framework's_ powerful, non-invasive programming model +and concepts with Pivotal GemFire to simplify configuration and development of Java applications using Pivotal GemFire. -This document assumes the reader already has a basic familiarity with the _Spring Framework_ and Pivotal GemFire -concepts and APIs. +This document assumes the reader already has a basic understanding and some familiarity with the core _Spring Framework_ +and Pivotal GemFire concepts and APIs. -While every effort has been made to ensure this documentation is comprehensive and complete, with no errors, +While every effort has been made to ensure this documentation is comprehensive and complete without errors, some topics are beyond the scope of this document and may require more explanation (e.g. data distribution management -with partitioning for HA while still preserving consistency). Additionally, some typos might have crept in. +using partitioning with HA while still preserving consistency). Additionally, some typos might have crept in. If you do spot mistakes or even more serious errors and you can spare a few cycles, please do bring these issues -to the attention of the _Spring Data GemFire_ team by raising an appropriate -https://jira.spring.io/browse/DATAGEODE[issue]. +to the attention of the _Spring Data_ team by raising an appropriate +https://jira.spring.io/browse/SGF[issue in JIRA]. Thank you. diff --git a/src/main/asciidoc/reference/bootstrap-annotations.adoc b/src/main/asciidoc/reference/bootstrap-annotations.adoc index 6ff4b03f..676df1db 100644 --- a/src/main/asciidoc/reference/bootstrap-annotations.adoc +++ b/src/main/asciidoc/reference/bootstrap-annotations.adoc @@ -2,7 +2,7 @@ = Bootstrapping Pivotal GemFire using Spring Annotations _Spring Data for Pivotal GemFire_ (SDG) 2.0 introduces a **new** Annotation-based configuration model -to bootstrap and configure Pivotal GemFire using the Spring container. +to configure and bootstrap Pivotal GemFire using the Spring container. The primary motivation for introducing an Annotation-based approach to the configuration of Pivotal GemFire in a Spring context is to enable application developers to _**get up and running** as **quickly** @@ -26,7 +26,7 @@ http://gemfire.docs.pivotal.io/geode/topologies_and_comm/multi_site_configuratio and https://cwiki.apache.org/confluence/display/GEODE/Geode+Internal+Architecture?src=contextnavpagetreemode[_Distributed System Design Patterns_] (e.g. shared-nothing architecture). The Annotation-based configuration model aims to simplify all this plus more. -The Annotation-based configuration model is an alternative to XML-based configuration using _Spring Data GemFire's_ +The Annotation-based configuration model is an alternative to XML-based configuration using _Spring Data for Pivotal GemFire's_ XML Namespace. With XML, an application developer would use the `spring-gemfire` (`gfe`) schema for configuration and the `spring-data-gemfire` (`gfe-data`) schema for data access related concerns. See <> for more details. @@ -34,7 +34,7 @@ Pivotal GemFire with the Spring Container>> for more details. NOTE: As of SDG 2.0, the new Annotation-based configuration model does not yet have configuration support for Pivotal GemFire's WAN components and topology. -Like _Spring Boot_, _Spring Data GemFire's_ Annotation-based configuration model was designed as an opinionated, +Like _Spring Boot_, _Spring Data for Pivotal GemFire's_ Annotation-based configuration model was designed as an opinionated, _convention over configuration_ approach for using Pivotal GemFire. Indeed, this Annotation-based configuration model was inspired by _Spring Boot_ as well as several other Spring and _Spring Data_ projects. @@ -49,7 +49,7 @@ unnecessarily configure a large number of attributes or properties just to use t Again, _getting up and running as quickly and as easily as possible_ is the primary objective. However, the option to customize the configuration meta-data and behavior of Pivotal GemFire is there should an application -developer need it and _Spring Data GemFire's_ Annotation-based configuration will quietly back away. The application +developer need it and _Spring Data for Pivotal GemFire's_ Annotation-based configuration will quietly back away. The application developer simply just needs to specify the configuration attributes s/he wishes to adjust. And, as we will see below, there are several ways to configure an Pivotal GemFire feature or embedded service using Annotations. @@ -151,7 +151,7 @@ _Spring Boot_ application with `@ClientCacheApplication` and you are ready to go You can even start your servers using _Gfsh's_ `start server` command if you prefer. Your _Spring Boot_ `@ClientCacheApplication` will still connect to the server regardless of how it is started. Although, we think you -will prefer to configure and start your servers using the _Spring Data GemFire_ approach, with Annotations. +will prefer to configure and start your servers using the _Spring Data for Pivotal GemFire_ approach, with Annotations. As an application developer, you will no doubt want to customize the "DEFAULT" `Pool` setup by Pivotal GemFire to possibly connect to 1 or more Locators, for instance... @@ -245,7 +245,7 @@ One of the finer features of Spring is the ability to use _property placeholders in properties or attributes of the configuration meta-data when configuring beans in a Spring context. Although, this would require all Annotation attributes to be `Strings` thereby giving up _Type-Safety_; not acceptable! -So, _Spring Data GemFire_ borrows from another commonly used pattern in Spring, `Configurers`. Many different +So, _Spring Data for Pivotal GemFire_ borrows from another commonly used pattern in Spring, `Configurers`. Many different `Configurer` interfaces are provided out-of-the-box in Spring Web MVC, such as the https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/config/annotation/ContentNegotiationConfigurer.html[`org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer`]. @@ -254,7 +254,7 @@ the configuration of a component, or bean on startup. The framework calls back the configuration at runtime. One of the more common uses of this pattern is to supply conditional configuration based on the application's runtime environment. -_Spring Data GemFire_ provides several `Configurer` callback interfaces to customize different aspects of Annotation-based +_Spring Data for Pivotal GemFire_ provides several `Configurer` callback interfaces to customize different aspects of Annotation-based configuration meta-data at runtime, before the _Spring_ managed beans that the Annotations create are initialized: * `ClientCacheConfigurer` @@ -320,9 +320,9 @@ In addition, when the `Configurer` is declared as a bean in the Spring context, of other Spring container features, such as _property placeholders_, or _SpEL expressions_ using the `@Value` annotation on factory method parameters, and so on. -All _Spring Data GemFire_-provided `Configurers` take 2 bits of information in the callback: the name of the bean created +All _Spring Data for Pivotal GemFire_-provided `Configurers` take 2 bits of information in the callback: the name of the bean created in the Spring context by the Annotation along with a reference to the `FactoryBean` used by the Annotation to -create and configure the GemFire component (e.g. a `ClientCache` instance is created and configured with +create and configure the Pivotal GemFire component (e.g. a `ClientCache` instance is created and configured with SDG's `ClientCacheFactoryBean`). NOTE: SDG `FactoryBeans` are part of the SDG public API and are what an application developer would use in Spring's @@ -486,7 +486,7 @@ the use case. As mentioned previously, Pivotal GemFire Locators are used by clients to connect with and find servers in a cluster as well as by new members joining an existing cluster to find other peers. -It is often convenient for application developers as they are developing their _Spring Boot_, _Spring Data GemFire_ +It is often convenient for application developers as they are developing their _Spring Boot_, _Spring Data for Pivotal GemFire_ applications to startup up a small cluster of 2 or 3 Pivotal GemFire servers. Rather than starting a separate Locator process, a user can simply annotate her _Spring Boot_ `@CacheServerApplication` class with `@EnableLocator`. @@ -828,7 +828,7 @@ domain object type-specific `PdxSerializer` instances, but acts as a single `Pdx You can declare this _Composite_ `PdxSerializer` as a managed bean in the Spring context and refer to this _Composite_ `PdxSerializer` by bean name in the `@EnablePdx` annotation using the `serializerBeanName` attribute. -_Spring Data GemFire_ will take care of registering it with Pivotal GemFire on the user's behalf. +_Spring Data for Pivotal GemFire_ will take care of registering it with Pivotal GemFire on the user's behalf. .Spring `ClientCache` application with PDX enabled, using a custom, composite `PdxSerializer` [source, java] @@ -847,7 +847,7 @@ public class ClientApplication { It is also possible to declare Pivotal GemFire's http://gemfire-91-javadocs.docs.pivotal.io/org/apache/geode/pdx/ReflectionBasedAutoSerializer.html[`org.apache.geode.pdx.ReflectionBasedAutoSerializer`] -as a bean definition in a Spring context. Alternatively, you should use _Spring Data GemFire's_ more robust, +as a bean definition in a Spring context. Alternatively, you should use _Spring Data for Pivotal GemFire's_ more robust, https://docs.spring.io/spring-data-gemfire/docs/current/api/org/springframework/data/gemfire/mapping/MappingPdxSerializer.html[`org.springframework.data.gemfire.mapping.MappingPdxSerializer`], which uses _Spring Data_ mapping meta-data and infrastructure applied to the serialization process for more efficient handling than reflection alone. @@ -882,7 +882,7 @@ with SSL, or they can all be collectively configured at once to use SSL using th It is easy to specify which Pivotal GemFire components that the SSL configuration settings should applied to using the nested `@EnableSsl` annotation `Component` enum... -.Spring `ClientCache` application with SSL enabled by Aache GemFire component +.Spring `ClientCache` application with SSL enabled by Aache Pivotal GemFire component [source, java] ---- @SpringBootApplication @@ -900,36 +900,36 @@ More details on Pivotal GemFire SSL support can be found http://gemfire.docs.pivotal.io/geode/managing/security/ssl_overview.html[here]. [[bootstrap-annotation-config-gemfire-properties]] -== Configuring GemFire Properties +== Configuring Pivotal GemFire Properties While many of the http://gemfire.docs.pivotal.io/geode/reference/topics/gemfire_properties.html[gemfire.properties] are conveniently encapsulated in and abstracted with an Annotation in the SDG Annotation-based configuration model, -the less commonly used _GemFire Properties_ are still accessible from the `@EnableGemFireProperties` annotation. +the less commonly used _Pivotal GemFire Properties_ are still accessible from the `@EnablePivotal GemFireProperties` annotation. -Using the `@EnableGemFireProperties` annotation on your application class is convenient and a nice alternative to -creating a `gemfire.properties` file or setting _GemFire Properties_ as Java System properties on the command-line +Using the `@EnablePivotal GemFireProperties` annotation on your application class is convenient and a nice alternative to +creating a `gemfire.properties` file or setting _Pivotal GemFire Properties_ as Java System properties on the command-line when launching your application. -TIP: It is recommended that these _GemFire Properties_ be set in a `gemfire.properties` file when deploying +TIP: It is recommended that these _Pivotal GemFire Properties_ be set in a `gemfire.properties` file when deploying your application to production. But, at development-time, it can be convenient to set these properties individually, as needed, for prototyping and testing purposes. -A few examples of some of the less common _GemFire Properties_ that a user usually need not worry about include, +A few examples of some of the less common _Pivotal GemFire Properties_ that a user usually need not worry about include, but are not limited to: `ack-wait-threshold`, `disable-tcp`, `socket-buffer-size`, etc. -To individually set any _GemFire Property_, simply annotate your application class with `@EnableGemFireProperties` -and set the _GemFire Properties_ you want to change from the default, out-of-the-box value set by Pivotal GemFire... +To individually set any _Pivotal GemFire Property_, simply annotate your application class with `@EnablePivotal GemFireProperties` +and set the _Pivotal GemFire Properties_ you want to change from the default, out-of-the-box value set by Pivotal GemFire... -.Spring `ClientCache` application with specific _GemFire Properties_ set +.Spring `ClientCache` application with specific _Pivotal GemFire Properties_ set [source, java] ---- @SpringBootApplication @ClientCacheApplication -@EnableGemFireProperties(conflateEvents = true, socketBufferSize = 16384) +@EnablePivotal GemFireProperties(conflateEvents = true, socketBufferSize = 16384) public class ClientApplication { .. } ---- -Keep in mind, some of the _GemFire Properties_ are client specific (e.g. `conflateEvents`) while others are +Keep in mind, some of the _Pivotal GemFire Properties_ are client specific (e.g. `conflateEvents`) while others are server specific (e.g. `distributedSystemId`, `enableNetworkPartitionDetection`, `enforceUniqueHost`, `memberTimeout`, `redundancyZone`, etc). @@ -951,7 +951,7 @@ Region as a table in a relational database. Generally, a Region should only sto more conducive for building effective `Indexes` and writing queries. We will talk about Indexing <>. -Previously, _Spring Data GemFire_ users needed to explicitly define and declare the Regions used in their applications +Previously, _Spring Data for Pivotal GemFire_ users needed to explicitly define and declare the Regions used in their applications to store data by writing very verbose Spring configuration meta-data, whether a user was using SDG's `FactoryBeans` from the API in Spring's https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#beans-java[Java-based container configuration]... @@ -960,10 +960,10 @@ https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html# [source, java] ---- @Configuration -class GemFireConfiguration { +class Pivotal GemFireConfiguration { @Bean("Example") - PartitionedRegionFactoryBean exampleRegion(GemFireCache gemfireCache) { + PartitionedRegionFactoryBean exampleRegion(Pivotal GemFireCache gemfireCache) { PartitionedRegionFactoryBean exampleRegion = new PartitionedRegionFactoryBean<>(); @@ -999,12 +999,12 @@ Now users can define and configure Regions based on their application domain obj a user need to explicitly define `Region` bean definitions in Spring configuration meta-data, unless finer-grained control is required. -To simplify Region creation, _Spring Data GemFire_ combines the use of _Spring Data_ _Repositories_ with the expressive +To simplify Region creation, _Spring Data for Pivotal GemFire_ combines the use of _Spring Data_ _Repositories_ with the expressive power of Annotation-based configuration using the **new** `@EnableEntityDefinedRegions` annotation. NOTE: Most _Spring Data_ application developers should already be familiar with the https://docs.spring.io/spring-data/commons/docs/current/reference/html/#repositories[_Spring Data Repository_ abstraction] -and _Spring Data GemFire's_ <> of _Spring Data's_ _Repository abstraction_, +and _Spring Data for Pivotal GemFire's_ <> of _Spring Data's_ _Repository abstraction_, which has been specifically customized to optimize data access operations for Pivotal GemFire. First, an application developer starts by defining the application domain objects... @@ -1045,16 +1045,16 @@ operations (CRUD) along with support for simple queries (e.g. `findById(..)`). more sophisticated queries simply by declaring query methods on the _Repository_ interface (e.g. `List findByAuthor(Author author);`). -Under-the-hood, _Spring Data GemFire_ provides an implementation of the applications _Repository_ interface when +Under-the-hood, _Spring Data for Pivotal GemFire_ provides an implementation of the applications _Repository_ interface when the Spring container is bootstrapped. SDG will even implement the query methods defined by the user so long as the user follows simple <>. Now, when a user defined the `Book` class, she also specified the Region in which instances of `Book` will be mapped -and stored by declaring the _Spring Data GemFire_ mapping annotation, `@Region` on the entity's type. Of course, if +and stored by declaring the _Spring Data for Pivotal GemFire_ mapping annotation, `@Region` on the entity's type. Of course, if the entity type (i.e. `Book`) referenced in the type parameter of the _Repository_ interface (i.e. `BookRepository`) is not annotated with `@Region`, the name is derived from the simple class name of the entity type (i.e. "Book"). -_Spring Data GemFire_ uses the mapping context containing mapping meta-data for all the entities defined in your +_Spring Data for Pivotal GemFire_ uses the mapping context containing mapping meta-data for all the entities defined in your application to determine all the Regions that will be needed at runtime. To enable and use this feature, simply annotate the application class with `@EnableEntityDefinedRegions`... @@ -1070,7 +1070,7 @@ class ClientApplication { .. } ---- TIP: Creating Regions from entity classes is the most useful when using _Spring Data Repositories_ in your application. -_Spring Data GemFire's_ _Repository_ support is enabled with the `@EnableGemfireRepositories` annotation, as shown +_Spring Data for Pivotal GemFire's_ _Repository_ support is enabled with the `@EnableGemfireRepositories` annotation, as shown in the example above. By default, the `@EnableEntityDefinedRegions` annotation will scan for entity classes recursively starting from @@ -1116,7 +1116,7 @@ See http://gemfire.docs.pivotal.io/geode/developing/region_options/storage_distr in the Pivotal GemFire User Guide for more details. When the user annotates her application domain object types with the generic `@Region` mapping annotation, -_Spring Data GemFire_ will decide which type of `Region` to create. SDG's default strategy takes the cache type +_Spring Data for Pivotal GemFire_ will decide which type of `Region` to create. SDG's default strategy takes the cache type into consideration when determining the type of `Region` to create. For example, if the application was declared as a `ClientCache` using the `@ClientCacheApplication` annotation, @@ -1124,7 +1124,7 @@ then SDG would create a client `PROXY` `Region`. Or, if the application was dec `@PeerCacheApplication` or `@CacheServerApplication` annotations, then SDG would create a server `PARTITION` `Region`. Of course, an application developer is always able to override the default when necessary. To override the default -applied by _Spring Data GemFire_, 4 new Region mapping annotations have been introduced: +applied by _Spring Data for Pivotal GemFire_, 4 new Region mapping annotations have been introduced: * `ClientRegion` * `LocalRegion` @@ -1223,16 +1223,16 @@ Along with <>, _Expirat by allowing entries stored in a Region to expire. Both _Time-to-Live_ (TTL) and _Idle-Timeout_ (TTI) based entry expiration policies are supported in Pivotal GemFire. -_Spring Data GemFire's_ Annotation-based Expiration configuration is based on +_Spring Data for Pivotal GemFire's_ Annotation-based Expiration configuration is based on <> added in -_Spring Data GemFire version 1.5. +_Spring Data for Pivotal GemFire_ version 1.5. -Essentially, _Spring Data GemFire's_ Expiration annotation support is based on a provided, custom implementation of +Essentially, _Spring Data for Pivotal GemFire's_ Expiration annotation support is based on a provided, custom implementation of Pivotal GemFire's http://gemfire-91-javadocs.docs.pivotal.io/org/apache/geode/cache/CustomExpiry.html[`org.apache.geode.cache.CustomExpiry`] interface. This `o.a.g.cache.CustomExpiry` implementation inspects the user's application domain objects stored in a Region for the presence of type-level Expiration annotations. -_Spring Data GemFire_ provides the following Expiration annotations used on application domain object types, +_Spring Data for Pivotal GemFire_ provides the following Expiration annotations used on application domain object types, out-of-the-box... * `Expiration` @@ -1384,14 +1384,14 @@ expressed by the query's projection. Different types of Indexes can be created, http://gemfire.docs.pivotal.io/geode/developing/query_index/creating_key_indexes.html[Key] and http://gemfire.docs.pivotal.io/geode/developing/query_index/creating_hash_indexes.html[Hash] Indexes. -_Spring Data GemFire_ makes it very easy to create Indexes on Regions where the data is stored and accessed. +_Spring Data for Pivotal GemFire_ makes it very easy to create Indexes on Regions where the data is stored and accessed. Rather than explicitly declaring `Index` bean definitions using Spring config as before... .Index bean definition using Java config [source, java] ---- @Bean("BooksIsbnIndex") -IndexFactoryBean bookIsbnIndex(GemFireCache gemfireCache) { +IndexFactoryBean bookIsbnIndex(Pivotal GemFireCache gemfireCache) { IndexFactoryBean bookIsbnIndex = new IndexFactoryBean(); @@ -1446,7 +1446,7 @@ class Book { In our new `Book` class definition, we annotated the `author` field with `@Indexed` and the `title` field with `@LuceneIndexed`. Also, the `isbn` field had previously been annotated with _Spring Data's_ `@Id` annotation, -which identifies the field containing the unique identifier for `Book` instances, and in _Spring Data GemFire_, +which identifies the field containing the unique identifier for `Book` instances, and in _Spring Data for Pivotal GemFire_, the `@Id` annotated field or property is used as the key in the Region when storing the entry. * `@Id` annotated fields/properties result in the creation of an Pivotal GemFire KEY Index. @@ -1460,7 +1460,7 @@ is exactly the name of the field or property. The `fromClause` is derived from the domain object's class (or the simple name of the domain object class if the `@Region` annotation was not specified). Of course, any of the `@Indexed` annotation attributes may be explicitly set to override the default values -provided by _Spring Data GemFire_. +provided by _Spring Data for Pivotal GemFire_. .Application domain object type modeling a Book using cutomized Indexes [source, java] @@ -1510,7 +1510,7 @@ Essentially, Indexes are defined from fields/properties on the entity class type in order to inspect the entity's fields and properties for the presence of Index annotations. Without this scan, Index annotations would not be found. It is also strongly recommended that you limit the scope of the scan. -While Lucene queries are not supported on _Spring Data GemFire_ _Repositories_ (yet), SDG does provide comprehensive +While Lucene queries are not supported on _Spring Data for Pivotal GemFire_ _Repositories_ (yet), SDG does provide comprehensive https://docs.spring.io/spring-data-gemfire/docs/current/reference/html/#bootstrap:lucene[support] for Pivotal GemFire Lucene queries using the familiar Spring _Template_ design pattern. @@ -1526,7 +1526,7 @@ http://gemfire-91-javadocs.docs.pivotal.io/org/apache/geode/cache/RegionFactory. as an asynchronous task. Another optimization that may be utilized when re-starting your Spring application where Indexes have to be rebuilt -is to first define all the Indexes upfront and then create them all at once, which, in _Spring Data GemFire_, happens +is to first define all the Indexes upfront and then create them all at once, which, in _Spring Data for Pivotal GemFire_, happens when the Spring context is refreshed. Indexes can be defined upfront then created all at once by setting the `define` attribute on the `@EnableIndexing` @@ -1560,7 +1560,7 @@ will use the "DEFAULT" `DiskStore`. However, it is possible and recommended to define Region-specific `DiskStores` when persisting or overflowing data to disk. -_Spring Data GemFire_ provides Annotation support for defining and creating application Region `DiskStores` +_Spring Data for Pivotal GemFire_ provides Annotation support for defining and creating application Region `DiskStores` by annotating the application class with the `@EnableDiskStore` and `@EnableDiskStores` annotations. TIP: `@EnableDiskStores` is a composite annotation for aggregating 1 or more `@EnableDiskStore` annotations. @@ -1584,7 +1584,7 @@ class ServerApplication { .. } Again, more than 1 `DiskStore` can be defined using the composite, `@EnableDiskStores` annotation. -Like other Annotations in _Spring Data GemFire's_ Annotation-based configuration model, both `@EnableDiskStore` +Like other Annotations in _Spring Data for Pivotal GemFire's_ Annotation-based configuration model, both `@EnableDiskStore` and `@EnableDiskStores` have many attributes along with associated configuration properties to customize the `DiskStores` created at runtime. @@ -1594,7 +1594,7 @@ Individual `DiskStore` configuration will override a particular global setting, annotation conveniently defines common configuration attributes applied across all `DiskStores` aggregated by the annotation. -_Spring Data GemFire_ also provides the `DiskStoreConfigurer` callback interface, which can be declared in Java config +_Spring Data for Pivotal GemFire_ also provides the `DiskStoreConfigurer` callback interface, which can be declared in Java config and used instead of configuration properties to customize a `DiskStore` at runtime... .Spring application with custom DiskStore configuration @@ -1644,7 +1644,7 @@ occur. The data that a client application may be interested in is expressed as is used to filter, or identify the data of interests. When data is changed or added, and it matches the criteria defined in the query predicate of the registered CQ, the client application is notified. -_Spring Data GemFire_ makes defining and registering CQs along with an associated listener to handle and process CQ +_Spring Data for Pivotal GemFire_ makes defining and registering CQs along with an associated listener to handle and process CQ events without all the cruft of Pivotal GemFire's plumbing, a non-event (no pun intended). SDG's new Annotation-based configuration for CQs builds on the existing _Continuous Query_ support in the <>. @@ -1691,7 +1691,7 @@ Additionally, the POJO method signature should adhere to the requirements outlin See the `@EnableContinuousQueries` and `@ContinuousQuery` annotation _Javadoc_ for more details on available attributes and configuration settings. -More details on _Spring Data GemFire's_ Continuous Query support can be found +More details on _Spring Data for Pivotal GemFire's_ Continuous Query support can be found <>. More details on Pivotal GemFire's Continuous Queries can be found @@ -1700,14 +1700,14 @@ http://gemfire.docs.pivotal.io/geode/developing/continuous_querying/chapter_over [[bootstrap-annotation-config-caching]] == Configuring Spring's Cache Abstraction -With _Spring Data GemFire_, Pivotal GemFire can be used as a caching provider in Spring's +With _Spring Data for Pivotal GemFire_, Pivotal GemFire can be used as a caching provider in Spring's https://docs.spring.io/spring/docs/current/spring-framework-reference/integration.html#cache[Cache Abstraction]. In _Spring's Cache Abstraction_, the caching annotations (e.g. `@Cacheable`) identify the cache on which a cache lookup is performed before invoking a potentially expensive operation, or where the results of an application service method are cached after the operation is invoked. -In _Spring Data GemFire_, a Spring `Cache` corresponds directly to a Region. The Region must exist before any +In _Spring Data for Pivotal GemFire_, a Spring `Cache` corresponds directly to a Region. The Region must exist before any `@Cacheable` application service methods are called. This is true for any of Spring's caching annotations (i.e. `@Cacheable`, `@CachePut` and `@CacheEvict`) that identify the cache to use in the operation. @@ -1733,19 +1733,19 @@ class PointOfSaleService } ---- -To make the application developer's life easier when using _Spring Data GemFire_ and Pivotal GemFire with +To make the application developer's life easier when using _Spring Data for Pivotal GemFire_ and Pivotal GemFire with _Spring's Cache Abstraction_, 2 new features have been added to the **new** Annotation-based configuration model. Given the following Spring caching configuration... -.Enabling Caching using Pivotal GemFire with Spring Data GemFire +.Enabling Caching using Pivotal GemFire with Spring Data for Pivotal GemFire [source, java] ---- @EnableCaching class CachingConfiguration { @Bean - GemfireCacheManager cacheManager(GemFireCache gemfireCache) { + GemfireCacheManager cacheManager(Pivotal GemFireCache gemfireCache) { GemfireCacheManager cacheManager = new GemfireCacheManager(); @@ -1755,7 +1755,7 @@ class CachingConfiguration { } @Bean("BookPricesCache") - ReplicatedRegionFactoryBean bookPricesRegion(GemFireCache gemfireCache) { + ReplicatedRegionFactoryBean bookPricesRegion(Pivotal GemFireCache gemfireCache) { ReplicatedRegionFactoryBean bookPricesRegion = new ReplicatedRegionFactoryBean<>(); @@ -1774,9 +1774,9 @@ class CachingConfiguration { } ---- -Using _Spring Data GemFire's_ new features, the same caching configuration can be simplified to... +Using _Spring Data for Pivotal GemFire's_ new features, the same caching configuration can be simplified to... -.Enabling GemFire Caching +.Enabling Pivotal GemFire Caching [source, java] ---- @EnableGemfireCaching @@ -1818,7 +1818,7 @@ https://docs.spring.io/spring/docs/current/spring-framework-reference/integratio [[bootstrap-annotation-config-cluster]] == Configuring Cluster Configuration Push -This may be the most exciting **new** feature in _Spring Data GemFire_. +This may be the most exciting **new** feature in _Spring Data for Pivotal GemFire_. When a client application class is annotated with `@EnableClusterConfiguration`, any Regions or Indexes defined and declared as beans in the Spring context by the client application are "pushed" to the cluster of servers to @@ -1827,9 +1827,9 @@ remember the configuration pushed by the client, when using HTTP. If all the no will come back up with the same configuration as before. In a sense, this feature is not much different than if a user were to use _Gfsh_ to create the Regions and Indexes -on all the servers in the cluster, manually. Except now, with _Spring Data GemFire_, users does **not** need to use +on all the servers in the cluster, manually. Except now, with _Spring Data for Pivotal GemFire_, users does **not** need to use _Gfsh_ to create Regions and Indexes. The user's _Spring Boot_ application, enabled with the power of -_Spring Data GemFire_, already contains all the configuration meta-data needed to create Regions and Indexes +_Spring Data for Pivotal GemFire_, already contains all the configuration meta-data needed to create Regions and Indexes for the user. When users are using the _Spring Data Repository_ abstraction, we know all the Regions (e.g. `@Region` annotated @@ -1842,7 +1842,7 @@ or otherwise, and whether for configuration, for mapping, or whatever purpose. The point is, users can focus on their application business logic along with using the framework provided services and supporting infrastructure (e.g. _Spring Data Repositories_, _Spring's Transaction Management_, _Spring Caching_, -and so on) and _Spring Data GemFire_ will take care of all the Pivotal GemFire plumbing required by those framework +and so on) and _Spring Data for Pivotal GemFire_ will take care of all the Pivotal GemFire plumbing required by those framework services on the user's behalf. Pushing configuration from the client to the servers in the cluster and having the cluster remember it is made possible @@ -1852,7 +1852,7 @@ schema-related changes (e.g. `gfsh> create region --name=Example --type=PARTITIO from the shell. Of course, since the cluster "remembers" the prior configuration pushed by a client from a previous run, perhaps, -_Spring Data GemFire_ is careful not to stomp on any existing Regions and Indexes already defined in the servers. +_Spring Data for Pivotal GemFire_ is careful not to stomp on any existing Regions and Indexes already defined in the servers. This is especially important when Regions already contain data, for instance. NOTE: Currently there is no option to overwrite any existing Region or Index definitions. To recreate a Region @@ -1860,7 +1860,7 @@ or Index, the user must use _Gfsh_ to destroy the Region or Index first and then so that configuration will be pushed up to the server again. Alternatively a user can just use _Gfsh_ to (re-)define the Regions and Indexes manually. -NOTE: Unlike _Gfsh_, _Spring Data GemFire_ only supports the creation of Regions and Indexes on the servers from a client. +NOTE: Unlike _Gfsh_, _Spring Data for Pivotal GemFire_ only supports the creation of Regions and Indexes on the servers from a client. For advanced configuration and use cases, _Gfsh_ should be used to manage the cluster. For a moment, just imagine the power expressed in the following configuration... @@ -1891,7 +1891,7 @@ behavior, etc, and the developer is in business. Nothing the user did in this c and plumbing required in the application's back-end services (e.g. Pivotal GemFire). Database users have similar features. Now Spring, Pivotal GemFire developers can too! -When combined with a couple more _Spring Data GemFire_ Annotations... +When combined with a couple more _Spring Data for Pivotal GemFire_ Annotations... * `@EnableContinuousQueries` * `@EnableGemfireFunctionExecutions` @@ -1904,7 +1904,7 @@ See the `@EnableClusterConfiguration` annotation _Javadoc_ for more details. [[bootstrap-annotation-config-security]] == Configuring Security -Without a doubt, application _Security_ is extremely important and _Spring Data GemFire_ provides comprehensive support +Without a doubt, application _Security_ is extremely important and _Spring Data for Pivotal GemFire_ provides comprehensive support for securing both Pivotal GemFire clients and servers. Recently, Pivotal GemFire introduced a new http://gemfire.docs.pivotal.io/geode/managing/security/implementing_security.html[Integrated Security] framework, @@ -1913,7 +1913,7 @@ One of the main features and benefits of this new Security framework is that it https://shiro.apache.org/[Apache Shiro] and can therefore delegate both authentication and authorization requests to Apache Shiro when enforcing security. -The following demonstrates how _Spring Data GemFire_ can simplify Pivotal GemFire's Security story even further. +The following demonstrates how _Spring Data for Pivotal GemFire_ can simplify Pivotal GemFire's Security story even further. [[bootstrap-annotation-config-security-server]] === Configuring Server Security @@ -1930,7 +1930,7 @@ method when creating an instance of an Pivotal GemFire peer `Cache`. and _permissions_ defined for your application, then set the Pivotal GemFire `security-shiro-init` property to refer to this `shiro.ini` file, which must be available in the `CLASSPATH`. -3. Using just Apache Shiro, annotate your _Spring Boot_ application class with _Spring Data GemFire's_ **new** +3. Using just Apache Shiro, annotate your _Spring Boot_ application class with _Spring Data for Pivotal GemFire's_ **new** `@EnableSecurity` annotation and define 1 or more Apache Shiro https://shiro.apache.org/realm.html[`Realms`] (as needed) as beans in the Spring context for accessing your application's Security meta-data (i.e. _authorized users_, _roles_ and _permissions_), and your done! @@ -1965,7 +1965,7 @@ class ServerApplication { PropertiesRealm propertiesRealm = new PropertiesRealm(); propertiesRealm.setResourcePath("classpath:shiro.properties"); - propertiesRealm.setPermissionResolver(new GemFirePermissionResolver()); + propertiesRealm.setPermissionResolver(new Pivotal GemFirePermissionResolver()); return propertiesRealm; } @@ -1982,10 +1982,10 @@ or perhaps a custom implementation of an Apache Shiro `Realm` implemented by the https://shiro.apache.org/realm.html[documentation on Realms] for more details. When Apache Shiro is on the `CLASSPATH` of the servers in the cluster and 1 or more Apache Shiro `Realms` have been -defined as beans in the Spring context, _Spring Data GemFire_ will detect this configuration and use Apache Shiro +defined as beans in the Spring context, _Spring Data for Pivotal GemFire_ will detect this configuration and use Apache Shiro as the Security provider to secure your Pivotal GemFire servers when the `@EnableSecurity` annotation is used. -TIP: Earlier, information was posted on _Spring Data GemFire's_ support for Pivotal GemFire's **new** Integrated Security +TIP: Earlier, information was posted on _Spring Data for Pivotal GemFire's_ support for Pivotal GemFire's **new** Integrated Security framework using Apache Shiro in this https://spring.io/blog/2016/11/10/spring-data-geode-1-0-0-incubating-release-released[spring.io blob post]. @@ -2011,7 +2011,7 @@ http://gemfire-91-javadocs.docs.pivotal.io/org/apache/geode/security/AuthInitial 3. And finally, a user would typically specify the user credentials in a proprietary, Pivotal GemFire `gfsecurity.properties` file. -_Spring Data GemFire_ simplifies all of that using the same `@EnableSecurity` annotation as applied to +_Spring Data for Pivotal GemFire_ simplifies all of that using the same `@EnableSecurity` annotation as applied to server applications. In other words, the same `@EnableSecurity` annotation handles Security for both client and server applications. This makes it easier for users when they decide to switch their applications from an embedded peer `Cache` application to a `ClientCache` application, for instance. Simply change the SDG annotation @@ -2059,7 +2059,7 @@ The following tips will help users get the most out of using the **new** Annotat == Configuration Organization As we saw in the section on <>, when -many Pivotal GemFire and/or _Spring Data GemFire_ features are enabled using Annotations, we start to stack a lot of +many Pivotal GemFire and/or _Spring Data for Pivotal GemFire_ features are enabled using Annotations, we start to stack a lot of Annotations on the Spring `@Configuration` or `@SpringBootApplication` class. In this situation, it makes sense to start compartmentalizing the configuration a bit. @@ -2088,7 +2088,7 @@ We could break this configuration down by concern. For example... [source, java] ---- @SpringBootApplication -@Import({ GemFireConfiguration.class, CachingConfiguration.class, +@Import({ Pivotal GemFireConfiguration.class, CachingConfiguration.class, FunctionsConfiguration.class, QueriesConfiguration.class, RepositoriesConfiguration.class }) class ClientApplication { .. } @@ -2096,7 +2096,7 @@ class ClientApplication { .. } @ClientCacheApplication @EnableClusterConfiguration @EnableGemfireCacheTransactions -class GemFireConfiguration { .. } +class Pivotal GemFireConfiguration { .. } @EnableGemfireCaching @EnableCachingDefinedRegions @@ -2138,14 +2138,14 @@ Again, Pivotal GemFire's new _Integrated Security_ framework can be enabled on b * `@EnableAutoRegionLookup` - Not recommended. Essentially, this Annotation supports finding Regions defined in external configuration meta-data (e.g. `cache.xml`, or _Cluster Configuration_ when applied to a server) and registers those Regions as beans in the Spring context automatically. Users should generally prefer Spring config when -using Spring and _Spring Data GemFire_. See <> +using Spring and _Spring Data for Pivotal GemFire_. See <> and <> instead. * `@EnableBeanFactoryLocator` - enables the SDG `GemfireBeanFactoryLocator` feature, which is only useful, again, when using external configuration meta-data (e.g. `cache.xml`). For example, if a user defines a `CacheLoader` on a Region defined in `cache.xml`, the user can still auto-wire this `CacheLoader` with say, a relational database `DataSource` bean defined in Spring config. This Annotation takes advantage of this SDG <> and might be useful for users who have a large amount of legacy configuration meta-data, like `cache.xml` files. -* `@EnableGemFireAsLastResource` - is actually discussed in +* `@EnablePivotal GemFireAsLastResource` - is actually discussed in <> with Pivotal GemFire. * `@EnableMcast` - enables Pivotal GemFire's old peer discovery mechanism using UDP-based Multi-cast Networking. (_Deprecated_; users should be using Pivotal GemFire Locators instead; see @@ -2157,7 +2157,7 @@ as beans in the Spring context, intercepting the Region op and logging the event [[bootstrap-annotation-config-conclusion]] == Conclusion -As we learned in the previous sections, there is a tremendous amount of power provided by _Spring Data GemFire_'s +As we learned in the previous sections, there is a tremendous amount of power provided by _Spring Data for Pivotal GemFire_'s **new** Annotation-based configuration model. Hopefully, it lives up to its goal of making it easier for users to get started quickly when using Pivotal GemFire with Spring. @@ -2166,7 +2166,7 @@ Java config, or even XML, if you prefer. You can even combine all 3 approaches https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/context/annotation/Import.html[`@Import`] and https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/context/annotation/ImportResource.html[`@ImportResource`] annotations on a Spring `@Configuration` or `@SpringBootApplication` class, if you like. The moment you explicitly -provide a bean definition that would otherwise be provided by _Spring Data GemFire_ using an Annotation, +provide a bean definition that would otherwise be provided by _Spring Data for Pivotal GemFire_ using an Annotation, the Annotation-based configuration backs away. In certain cases you may even need to fallback to Java config, as in the `Configurers` case, to handle more complex diff --git a/src/main/asciidoc/reference/bootstrap.adoc b/src/main/asciidoc/reference/bootstrap.adoc index 2d990537..c0454d16 100644 --- a/src/main/asciidoc/reference/bootstrap.adoc +++ b/src/main/asciidoc/reference/bootstrap.adoc @@ -1,7 +1,7 @@ [[bootstrap]] = Bootstrapping Pivotal GemFire with the Spring container -_Spring Data GemFire_ provides full configuration and initialization of the Pivotal GemFire In-Memory Data Grid (IMDG) +_Spring Data for Pivotal GemFire_ provides full configuration and initialization of the Pivotal GemFire In-Memory Data Grid (IMDG) using the _Spring_ IoC container. The framework includes several classes to help simplify the configuration of Pivotal GemFire components including: Caches, Regions, Indexes, DiskStores, Functions, WAN Gateways, persistence backup along with several other Distributed System components in order to support a variety of use cases with minimal effort. @@ -12,18 +12,18 @@ see the Pivotal GemFire http://geode.apache.org/docs/[product documentation]. [[bootstrap:namespace:xml]] == Advantages of using Spring over Pivotal GemFire `cache.xml` -_Spring Data GemFire's_ XML namespace supports full configuration of the Pivotal GemFire In-Memory Data Grid (IMDG). +_Spring Data for Pivotal GemFire's_ XML namespace supports full configuration of the Pivotal GemFire In-Memory Data Grid (IMDG). The XML namespace is the preferred way to configure Pivotal GemFire in a _Spring_ context in order to properly -manage GemFire's lifecycle inside the _Spring_ container. While support for GemFire's native `cache.xml` persists -for legacy reasons, GemFire application developers are encouraged to do everything in _Spring_ XML to take advantage of +manage Pivotal GemFire's lifecycle inside the _Spring_ container. While support for Pivotal GemFire's native `cache.xml` persists +for legacy reasons, Pivotal GemFire application developers are encouraged to do everything in _Spring_ XML to take advantage of the many wonderful things _Spring_ has to offer such as modular XML configuration, property placeholders and overrides, -SpEL, and environment profiles. Behind the XML namespace, _Spring Data GemFire_ makes extensive use of _Spring's_ -`FactoryBean` pattern to simplify the creation, configuration and initialization of GemFire components. +SpEL, and environment profiles. Behind the XML namespace, _Spring Data for Pivotal GemFire_ makes extensive use of _Spring's_ +`FactoryBean` pattern to simplify the creation, configuration and initialization of Pivotal GemFire components. Pivotal GemFire provides several callback interfaces, such as `CacheListener`, `CacheLoader` and `CacheWriter`, that allow developers to add custom event handlers. Using _Spring's_ IoC container, these callbacks may be configured -as normal _Spring_ beans and injected into GemFire components. This is a significant improvement over native `cache.xml`, -which provides relatively limited configuration options and requires callbacks to implement GemFire's `Declarable` +as normal _Spring_ beans and injected into Pivotal GemFire components. This is a significant improvement over native `cache.xml`, +which provides relatively limited configuration options and requires callbacks to implement Pivotal GemFire's `Declarable` interface (see <> to see how you can still use `Declarables` within _Spring's_ IoC/DI container). In addition, IDEs, such as the _Spring Tool Suite_ (STS), provide excellent support for _Spring_ XML namespaces @@ -32,7 +32,7 @@ including code completion, pop-up annotations, and real time validation, making [[bootstrap:namespace]] == Using the Core Namespace -To simplify configuration, _Spring Data GemFire_ provides a dedicated XML namespace for configuring core Pivotal GemFire +To simplify configuration, _Spring Data for Pivotal GemFire_ provides a dedicated XML namespace for configuring core Pivotal GemFire components. It is possible to configure beans directly using _Spring's_ standard `` definition. However, all bean properties are exposed via the XML namespace so there is little benefit to using raw bean definitions. For more information about XML Schema-based configuration in _Spring_, see the @@ -40,9 +40,9 @@ http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/ in the _Spring Framework_ reference documentation. NOTE: _Spring Data Repository_ support uses a separate XML namespace. See <> for more information -on how to configure _Spring Data GemFire_ Repositories. +on how to configure _Spring Data for Pivotal GemFire_ Repositories. -To use the _Spring Data GemFire_ XML namespace, simply declare it in your _Spring_ XML configuration meta-data: +To use the _Spring Data for Pivotal GemFire_ XML namespace, simply declare it in your _Spring_ XML configuration meta-data: [source,xml] ---- @@ -60,17 +60,17 @@ To use the _Spring Data GemFire_ XML namespace, simply declare it in your _Sprin ---- -<1> _Spring Data GemFire_ XML namespace prefix. Any name will do but through out this reference documentation, +<1> _Spring Data for Pivotal GemFire_ XML namespace prefix. Any name will do but through out this reference documentation, `gfe` will be used. <2> The XML namespace prefix is mapped to the URI. <3> The XML namespace URI location. Note that even though the location points to an external address (which does exist -and is valid), _Spring_ will resolve the schema locally as it is included in the _Spring Data GemFire_ library. +and is valid), _Spring_ will resolve the schema locally as it is included in the _Spring Data for Pivotal GemFire_ library. <4> Example declaration using the XML namespace with the `gfe` prefix. [NOTE] ==== It is possible to change the default namespace from `beans` to `gfe`. This is useful for XML configuration -composed mainly of GemFire components as it avoids declaring the prefix. To achieve this, simply swap the namespace +composed mainly of Pivotal GemFire components as it avoids declaring the prefix. To achieve this, simply swap the namespace prefix declaration above: [source,xml] @@ -89,7 +89,7 @@ prefix declaration above: ---- -<1> The default namespace declaration for this XML document points to the _Spring Data GemFire_ XML namespace. +<1> The default namespace declaration for this XML document points to the _Spring Data for Pivotal GemFire_ XML namespace. <2> The `beans` namespace prefix declaration for _Spring's_ raw bean definitions. <3> Bean declaration using the `beans` namespace. Notice the prefix. <4> Bean declaration using the `gfe` namespace. Notice the lack of prefix since `gfe` is the default namespace. diff --git a/src/main/asciidoc/reference/cache.adoc b/src/main/asciidoc/reference/cache.adoc index beed371c..8c9aca6b 100644 --- a/src/main/asciidoc/reference/cache.adoc +++ b/src/main/asciidoc/reference/cache.adoc @@ -2,7 +2,7 @@ = Configuring a Cache To use Pivotal GemFire, a developer needs to either create a new `Cache` or connect to an existing one. -With the current version of GemFire, there can be only one open Cache per VM (technically, per `ClassLoader`). +With the current version of Pivotal GemFire, there can be only one open Cache per VM (technically, per `ClassLoader`). In most cases, the `Cache` should only be created once. NOTE: This section describes the creation and configuration of a peer cache member, appropriate in @@ -19,11 +19,11 @@ A peer cache with default configuration can be created with a very simple declar ---- During Spring container initialization, any application context containing this cache definition will register -a `CacheFactoryBean` that creates a Spring bean named `gemfireCache` referencing a GemFire `Cache` instance. +a `CacheFactoryBean` that creates a Spring bean named `gemfireCache` referencing a Pivotal GemFire `Cache` instance. This bean will refer to either an existing cache, or if one does not already exist, a newly created one. Since no additional properties were specified, a newly created cache will apply the default cache configuration. -All _Spring Data GemFire_ components that depend on the cache respect this naming convention, so there is no need +All _Spring Data for Pivotal GemFire_ components that depend on the cache respect this naming convention, so there is no need to explicitly declare the cache dependency. If you prefer, you can make the dependency explicit via the `cache-ref` attribute provided by various SDG XML namespace elements. Also, you can easily override the cache's bean name using the `id` attribute: @@ -33,9 +33,9 @@ the `id` attribute: ---- -A GemFire `Cache` can be fully configured using Spring, however, GemFire's native XML configuration file, `cache.xml`, -is also supported. For situations where the GemFire cache needs to be configured natively, simply provide a reference -to the GemFire XML configuration file using the `cache-xml-location` attribute: +A Pivotal GemFire `Cache` can be fully configured using Spring, however, Pivotal GemFire's native XML configuration file, `cache.xml`, +is also supported. For situations where the Pivotal GemFire cache needs to be configured natively, simply provide a reference +to the Pivotal GemFire XML configuration file using the `cache-xml-location` attribute: [source,xml] ---- @@ -49,7 +49,7 @@ NOTE: The configuration makes use of Spring's http://docs.spring.io/spring/docs/ abstraction to locate the file. This allows various search patterns to be used, depending on the runtime environment or the prefix specified (if any) in the resource location. -In addition to referencing an external XML configuration file, a developer may also specify GemFire System +In addition to referencing an external XML configuration file, a developer may also specify Pivotal GemFire System http://geode.apache.org/docs/guide/11/reference/topics/gemfire_properties.html[properties] using any of Spring's `Properties` support features. @@ -127,22 +127,22 @@ or child elements: ---- <1> Various cache options are supported by attributes. For further information regarding anything shown in this example, -please consult the GemFire http://docs.pivotal.io/gemfire[product documentation]. +please consult the Pivotal GemFire http://docs.pivotal.io/gemfire[product documentation]. The `close` attribute determines whether the cache should be closed when the Spring application context is closed. The default is `true`, however, for use cases in which multiple application contexts use the cache (common in web applications), set this value to `false`. -<2> Setting the `enable-auto-reconnect` attribute to true (default is false), allows a disconnected GemFire member to -automatically reconnect and rejoin the GemFire cluster. -See the GemFire http://geode.apache.org/docs/guide/11/managing/autoreconnect/member-reconnect.html[product documentation] +<2> Setting the `enable-auto-reconnect` attribute to true (default is false), allows a disconnected Pivotal GemFire member to +automatically reconnect and rejoin the Pivotal GemFire cluster. +See the Pivotal GemFire http://geode.apache.org/docs/guide/11/managing/autoreconnect/member-reconnect.html[product documentation] for more details. <3> Setting the `use-bean-factory-locator` attribute to `true` (defaults to `false`) is only applicable when both -Spring (XML) configuration meta-data and GemFire `cache.xml` is used to configure the GemFire cache node -(whether client or peer). This option allows GemFire components (e.g. `CacheLoader`) expressed in `cache.xml` +Spring (XML) configuration meta-data and Pivotal GemFire `cache.xml` is used to configure the Pivotal GemFire cache node +(whether client or peer). This option allows Pivotal GemFire components (e.g. `CacheLoader`) expressed in `cache.xml` to be auto-wired with beans (e.g. `DataSource`) defined in the Spring application context. This option is typically used in conjunction with `cache-xml-location`. -<4> Setting the `use-cluster-configuration` attribute to `true` (default is `false`) enables a GemFire member to +<4> Setting the `use-cluster-configuration` attribute to `true` (default is `false`) enables a Pivotal GemFire member to retrieve the common, shared Cluster-based configuration from a Locator. -See the GemFire http://geode.apache.org/docs/guide/11/configuring/cluster_config/gfsh_persist.html[product documentation] +See the Pivotal GemFire http://geode.apache.org/docs/guide/11/configuring/cluster_config/gfsh_persist.html[product documentation] for more details. <5> Example of a `TransactionListener` callback declaration using a bean reference. The referenced bean must implement http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/TransactionListener.html[TransactionListener]. @@ -155,16 +155,16 @@ must implement http://geode.apache.org/releases/latest/javadoc/org/apache/geode/ [GatewayConflictResolver]. A `GatewayConflictResolver` is a Cache-level plugin that is called upon to decide what to do with events that originate in other systems and arrive through the WAN Gateway. -<8> Enable GemFire's http://geode.apache.org/docs/guide/11/developing/region_options/dynamic_region_creation.html[DynamicRegionFactory], +<8> Enable Pivotal GemFire's http://geode.apache.org/docs/guide/11/developing/region_options/dynamic_region_creation.html[DynamicRegionFactory], which provides a distributed Region creation service. -<9> Declares a JNDI binding to enlist an external DataSource in a GemFire transaction. +<9> Declares a JNDI binding to enlist an external DataSource in a Pivotal GemFire transaction. [[bootstrap:cache:pdx-serialization]] === Enabling PDX Serialization -The example above includes a number of attributes related to GemFire's enhanced serialization framework, PDX. +The example above includes a number of attributes related to Pivotal GemFire's enhanced serialization framework, PDX. While a complete discussion of PDX is beyond the scope of this reference guide, it is important to note that PDX -is enabled by registering a `PdxSerializer` which is specified via the `pdx-serializer` attribute. GemFire provides +is enabled by registering a `PdxSerializer` which is specified via the `pdx-serializer` attribute. Pivotal GemFire provides an implementing class `org.apache.geode.pdx.ReflectionBasedAutoSerializer` that uses Java Reflection, however, it is common for developers to provide their own implementation. The value of the attribute is simply a reference to a Spring bean that implements the `PdxSerializer` interface. @@ -176,17 +176,17 @@ More information on serialization support can be found in <> Setting the ` ---- -NOTE: While certain GemFire tools, like _Gfsh_, have their actions "recorded" when schema-like changes are made -(e.g. `gfsh>create region --name=Example --type=PARTITION`), _Spring Data GemFire's_ configuration meta-data -is not recorded. The same is true when using GemFire's public Java API directly; it too is not recorded. +NOTE: While certain Pivotal GemFire tools, like _Gfsh_, have their actions "recorded" when schema-like changes are made +(e.g. `gfsh>create region --name=Example --type=PARTITION`), _Spring Data for Pivotal GemFire's_ configuration meta-data +is not recorded. The same is true when using Pivotal GemFire's public Java API directly; it too is not recorded. -For more information on GemFire's Cluster Configuration Service, see the +For more information on Pivotal GemFire's Cluster Configuration Service, see the http://geode.apache.org/docs/guide/11/configuring/cluster_config/gfsh_persist.html[product documentation]. [[bootstrap:cache:server]] -== Configuring a GemFire CacheServer +== Configuring a Pivotal GemFire CacheServer -_Spring Data GemFire_ includes dedicated support for configuring a +_Spring Data for Pivotal GemFire_ includes dedicated support for configuring a http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/server/CacheServer.html[CacheServer], allowing complete configuration through the Spring container: @@ -262,7 +262,7 @@ allowing complete configuration through the Spring container: - + > and is supported by the `org.springframework.data.gemfire.client.ClientCacheFactoryBean`. +the Pivotal GemFire peer <> and is supported by the `org.springframework.data.gemfire.client.ClientCacheFactoryBean`. -The simplest definition of a GemFire cache client using default configuration can be accomplished with the following +The simplest definition of a Pivotal GemFire cache client using default configuration can be accomplished with the following declaration: [source,xml] @@ -342,9 +342,9 @@ initialization will include a call to http://geode.apache.org/releases/latest/ja Client-side configuration is covered in more detail in <>. [[bootstrap:cache:client:pool]] -=== GemFire's DEFAULT Pool and Spring Data GemFire Pool Definitions +=== Pivotal GemFire's DEFAULT Pool and Spring Data for Pivotal GemFire Pool Definitions -If a GemFire `ClientCache` is local-only, then no Pool definition is required. For instance, a developer may define: +If a Pivotal GemFire `ClientCache` is local-only, then no Pool definition is required. For instance, a developer may define: [source,xml] ---- @@ -354,14 +354,14 @@ If a GemFire `ClientCache` is local-only, then no Pool definition is required. ---- In this case, the "Example" Region is `LOCAL` and no data is distributed between the client and a server, therefore, -no Pool is necessary. This is true for any client-side, local-only Region, as defined by the GemFire's +no Pool is necessary. This is true for any client-side, local-only Region, as defined by the Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/client/ClientRegionShortcut.html[ClientRegionShortcut] (all `LOCAL_*` shortcuts). However, if a client Region is a (caching) proxy to a server-side Region, then a Pool is required. There are several ways to define and use a Pool in this case. -When a client cache, Pool and proxy-based Region are all defined, but not explicitly identified, _Spring Data GemFire_ +When a client cache, Pool and proxy-based Region are all defined, but not explicitly identified, _Spring Data for Pivotal GemFire_ will resolve the references automatically for you. For example: @@ -378,10 +378,10 @@ For example: ---- In the example above, the client cache is identified as `gemfireCache`, the Pool as `gemfirePool` and the client Region -as "Example". However, the client cache will initialize GemFire's DEFAULT Pool from `gemfirePool` and the client Region +as "Example". However, the client cache will initialize Pivotal GemFire's DEFAULT Pool from `gemfirePool` and the client Region will use the `gemfirePool` when distributing data between the client and the server. -Basically, _Spring Data GemFire_ resolves the above configuration to the following: +Basically, _Spring Data for Pivotal GemFire_ resolves the above configuration to the following: [source,xml] ---- @@ -394,7 +394,7 @@ Basically, _Spring Data GemFire_ resolves the above configuration to the followi ---- -GemFire still creates a Pool called "DEFAULT". _Spring Data GemFire_ will just cause the "DEFAULT" Pool to be +Pivotal GemFire still creates a Pool called "DEFAULT". _Spring Data for Pivotal GemFire_ will just cause the "DEFAULT" Pool to be initialized from the `gemfirePool`. This is useful in situations where multiple Pools are defined and client Regions are using separate Pools. @@ -419,12 +419,12 @@ Consider the following: ---- -In this setup, the GemFire client cache's "DEFAULT" Pool is initialized from "locatorPool" as specified with the -`pool-name` attribute. There is no _Spring Data GemFire_-defined `gemfirePool` since both Pools were explicitly +In this setup, the Pivotal GemFire client cache's "DEFAULT" Pool is initialized from "locatorPool" as specified with the +`pool-name` attribute. There is no _Spring Data for Pivotal GemFire_-defined `gemfirePool` since both Pools were explicitly identified (named) "locatorPool" and "serverPool", respectively. The "Example" Region explicitly refers to and uses the "serverPool" exclusively. The "AnotherExample" Region uses -GemFire's "DEFAULT" Pool, which was configured from the "locatorPool" based on the client cache bean definition's +Pivotal GemFire's "DEFAULT" Pool, which was configured from the "locatorPool" based on the client cache bean definition's `pool-name` attribute. Finally, the "YetAnotherExample" Region will not use a Pool since it is `LOCAL`. diff --git a/src/main/asciidoc/reference/cq-container.adoc b/src/main/asciidoc/reference/cq-container.adoc index 1bdb36e8..94436796 100644 --- a/src/main/asciidoc/reference/cq-container.adoc +++ b/src/main/asciidoc/reference/cq-container.adoc @@ -4,25 +4,25 @@ A powerful functionality offered by Pivotal GemFire is http://geode.apache.org/docs/guide/11/developing/continuous_querying/chapter_overview.html[Continuous Query] (or CQ). In short, CQ allows one to create and register an OQL query, and then automatically be notified when new data -that gets added to GemFire matches the query predicate. _Spring Data GemFire_ provides dedicated support for CQs through +that gets added to Pivotal GemFire matches the query predicate. _Spring Data for Pivotal GemFire_ provides dedicated support for CQs through the `org.springframework.data.gemfire.listener` package and its *listener container*; very similar in functionality and naming to the JMS integration in the _Spring Framework_; in fact, users familiar with the JMS support in _Spring_, should feel right at home. -Basically _Spring Data GemFire_ allows methods on POJOs to become end-points for CQ. Simply define the query -and indicate the method that should be called to be notified when there is a match. _Spring Data GemFire_ takes care +Basically _Spring Data for Pivotal GemFire_ allows methods on POJOs to become end-points for CQ. Simply define the query +and indicate the method that should be called to be notified when there is a match. _Spring Data for Pivotal GemFire_ takes care of the rest. This is very similar to Java EE's message-driven bean style, but without any requirement for base class or interface implementations, based on Pivotal GemFire. -NOTE: Currently, Continuous Query is only supported in GemFire's client/server topology. Additionally, the client Pool -used is required to have the subscription enabled. Please refer to the GemFire +NOTE: Currently, Continuous Query is only supported in Pivotal GemFire's client/server topology. Additionally, the client Pool +used is required to have the subscription enabled. Please refer to the Pivotal GemFire http://geode.apache.org/docs/guide/11/developing/continuous_querying/implementing_continuous_querying.html[documentation] for more information. [[apis:continuous-query:container]] == Continuous Query Listener Container -_Spring Data GemFire_ simplifies creation, registration, life-cycle and dispatch of CQ events by taking care of +_Spring Data for Pivotal GemFire_ simplifies creation, registration, life-cycle and dispatch of CQ events by taking care of the infrastructure around CQ with the use of SDG's `ContinuousQueryListenerContainer`, which does all the heavy lifting on behalf of the user. Users familiar with EJB and JMS should find the concepts familiar as it is designed as close as possible to the support provided in the _Spring Framework_ with its Message-driven POJOs (MDPs). @@ -33,7 +33,7 @@ is responsible for all threading of message reception and dispatches into the li the intermediary between an EDP (Event-driven POJO) and the event provider and takes care of creation and registration of CQs (to receive events), resource acquisition and release, exception conversion and the like. This allows you, as an application developer, to write the (possibly complex) business logic associated with receiving an event -(and reacting to it), and delegate the boilerplate GemFire infrastructure concerns to the framework. +(and reacting to it), and delegate the boilerplate Pivotal GemFire infrastructure concerns to the framework. The listener container is fully customizable. A developer can chose either to use the CQ thread to perform the dispatch (synchronous delivery) or a new thread (from an existing pool) for an asynchronous approach by defining the suitable @@ -45,10 +45,10 @@ to take advantage of its runtime. [[apis:continuous-query:adapter]] == The `ContinuousQueryListener` and `ContinuousQueryListenerAdapter` -The `ContinuousQueryListenerAdapter` class is the final component in _Spring Data GemFire_ CQ support. In a nutshell, +The `ContinuousQueryListenerAdapter` class is the final component in _Spring Data for Pivotal GemFire_ CQ support. In a nutshell, class allows you to expose almost *any* implementing class as an EDP with minimal constraints. `ContinuousQueryListenerAdapter` implements the `ContinuousQueryListener` interface, a simple listener interface -similar to GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/query/CqListener.html[CqListener]. +similar to Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/query/CqListener.html[CqListener]. Consider the following interface definition. Notice the various event handling methods and their parameters: @@ -75,7 +75,7 @@ class DefaultEventDelegate implements EventDelegate { } ---- -In particular, note how the above implementation of the `EventDelegate` interface has *no* GemFire dependencies at all. +In particular, note how the above implementation of the `EventDelegate` interface has *no* Pivotal GemFire dependencies at all. It truly is a POJO that we can and will make into an EDP via the following configuration. NOTE: the class does not have to implement an interface; an interface is only used to better showcase the decoupling @@ -115,7 +115,7 @@ reference and the actual query definition are required. It's possible, however, the resulting Continuous Query (useful for monitoring) but also the name of the method (the default is `handleEvent`). The specified method can have various argument types, the `EventDelegate` interface lists the allowed types. -The example above uses the _Spring Data GemFire_ namespace to declare the event listener container +The example above uses the _Spring Data for Pivotal GemFire_ namespace to declare the event listener container and automatically register the listeners. The full blown, *beans* definition is displayed below: [source,xml] @@ -142,6 +142,6 @@ and automatically register the listeners. The full blown, *beans* definition is ---- -Each time an event is received, the adapter automatically performs type translation between the GemFire event +Each time an event is received, the adapter automatically performs type translation between the Pivotal GemFire event and the required method argument(s) transparently. Any exception caused by the method invocation is caught and handled by the container (by default, being logged). diff --git a/src/main/asciidoc/reference/data-access.adoc b/src/main/asciidoc/reference/data-access.adoc index b9268527..f9f54490 100644 --- a/src/main/asciidoc/reference/data-access.adoc +++ b/src/main/asciidoc/reference/data-access.adoc @@ -1,16 +1,16 @@ [[data-access]] = Using the Data Access Namespace -In addition to the core XML namespace (`gfe`), _Spring Data GemFire_ provides a `gfe-data` XML namespace -primarily intended to simplify the development of Pivotal GemFire client applications. This namespace currently contains -support for GemFire <> and function <> as well as -includes a `` tag that offers a convenient way to connect to the Pivotal GemFire data grid. +In addition to the core XML namespace (`gfe`), _Spring Data for Pivotal GemFire_ provides a data access XML namespace (`gfe-data`), +which is primarily intended to simplify the development of Pivotal GemFire client applications. This namespace currently contains +support for Pivotal GemFire <> and function <> +as well as includes a `` tag offering a convenient way to connect to a Pivotal GemFire cluster. [[data-access:datasource]] -== An Easy Way to Connect to GemFire +== An Easy Way to Connect to Pivotal GemFire -For many applications, a basic connection to a GemFire data grid using default values is sufficient. -_Spring Data GemFire's_ `` tag provides a simple way to access data. The data source creates +For many applications, a basic connection to a Pivotal GemFire data grid using default values is sufficient. +_Spring Data for Pivotal GemFire's_ `` tag provides a simple way to access data. The data source creates a `ClientCache` and connection `Pool`. In addition, it will query the cluster servers for all existing root Regions and create an (empty) client Region proxy for each one. diff --git a/src/main/asciidoc/reference/data.adoc b/src/main/asciidoc/reference/data.adoc index 7fcc93dc..7aa32c7f 100644 --- a/src/main/asciidoc/reference/data.adoc +++ b/src/main/asciidoc/reference/data.adoc @@ -3,17 +3,17 @@ Once the Pivotal GemFire Cache and Regions have been configured, they can be injected and used inside application objects. This chapter describes the integration with _Spring's_ Transaction Management functionality and DAO exception hierarchy. -This chapter also covers support for dependency injection of GemFire managed objects. +This chapter also covers support for dependency injection of Pivotal GemFire managed objects. [[apis:template]] == GemfireTemplate -As with many other high-level abstractions provided by _Spring_ projects, _Spring Data GemFire_ provides a *template* -to simplify GemFire data access. The class provides several *one-liner* methods containing common Region operations, -but also has the ability to *execute* code against the native GemFire API without having to deal with GemFire checked -exceptions by using a `GemfireCallback`. +As with many other high-level abstractions provided by _Spring_, _Spring Data for Pivotal GemFire_ provides a *template* +to simplify Pivotal GemFire data access operations. The class provides several methods containing common Region operations, +but also provides the capability to *execute* code against native Pivotal GemFire APIs without having to deal with +Pivotal GemFire checked exceptions by using a `GemfireCallback`. -The template class requires a GemFire `Region` instance, and once configured, is thread-safe and can be reused +The template class requires a Pivotal GemFire `Region`, and once configured, is thread-safe and is reusable across multiple application classes: [source,xml] @@ -22,12 +22,15 @@ across multiple application classes: ---- Once the template is configured, a developer can use it alongside `GemfireCallback` to work directly with -the GemFire `Region` without having to deal with checked exceptions, threading or resource management concerns: +the Pivotal GemFire `Region` without having to deal with checked exceptions, threading or resource management concerns: [source,java] ---- template.execute(new GemfireCallback>() { - public Iterable doInGemfire(Region region) throws GemFireCheckedException, GemFireException { + + public Iterable doInGemfire(Region region) + throws Pivotal GemFireCheckedException, Pivotal GemFireException { + Region localRegion = (Region) region; localRegion.put("1", "one"); @@ -39,10 +42,10 @@ template.execute(new GemfireCallback>() { ---- For accessing the full power of the Pivotal GemFire query language, a developer can use the `find` and `findUnique` -methods, which, as opposed to the `query` method, can execute queries across multiple Regions, execute projections, +methods, which, compared to the `query` method, can execute queries across multiple Regions, execute projections, and the like. -The `find` method should be used when the query selects multiple items (through`SelectResults`) and the latter, +The `find` method should be used when the query selects multiple items (through `SelectResults`) and the latter, `findUnique`, as the name suggests, when only one object is returned. [[apis:exception-translation]] @@ -60,7 +63,7 @@ As mentioned in _Spring Framework's_ documentation, http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#orm-exception-translation[Exception translation] can be applied transparently to your Data Access Objects (DAO) through the use of the `@Repository` annotation and AOP by defining a `PersistenceExceptionTranslationPostProcessor` bean. The same exception translation functionality -is enabled when using GemFire as long as the `CacheFactoryBean` is declared, e.g. using either a `` +is enabled when using Pivotal GemFire as long as the `CacheFactoryBean` is declared, e.g. using either a `` or `` declaration, which acts as an exception translator and is automatically detected by the _Spring_ infrastructure and used accordingly. @@ -76,7 +79,7 @@ about _Spring's Transaction Management_ infrastructure as it offers a consistent transparently across multiple APIs and can be configured either programmatically or declaratively (the most popular choice). -For Pivotal GemFire, _Spring Data GemFire_ provides a dedicated, per-cache, `PlatformTransactionManager` that, +For Pivotal GemFire, _Spring Data for Pivotal GemFire_ provides a dedicated, per-cache, `PlatformTransactionManager` that, once declared, allows Region operations to be executed atomically through _Spring_: [source,xml] @@ -84,8 +87,8 @@ once declared, allows Region operations to be executed atomically through _Sprin ---- -NOTE: The example above can be simplified even further by eliminating the `cache-ref` attribute if the GemFire cache -is defined under the default name, `gemfireCache`. As with the other _Spring Data GemFire_ namespace elements, +NOTE: The example above can be simplified even further by eliminating the `cache-ref` attribute if the Pivotal GemFire cache +is defined under the default name, `gemfireCache`. As with the other _Spring Data for Pivotal GemFire_ namespace elements, if the cache bean name is not configured, the aforementioned naming convention will be used. Additionally, the transaction manager name is "`gemfireTransactionManager`" if not explicitly specified. @@ -126,15 +129,15 @@ There are a series of steps you must complete to properly use Pivotal GemFire as involving more than 1 transactional resource. Additionally, there can only be 1 non-XA compliant resource (e.g. Pivotal GemFire) in such an arrangement. -1) First, you must complete Steps 1-4 in GemFire's documentation +1) First, you must complete Steps 1-4 in Pivotal GemFire's documentation http://gemfire90.docs.pivotal.io/geode/developing/transactions/JTA_transactions.html#concept_csy_vfb_wk[here]. -NOTE: #1 above is independent of your _Spring [Boot] and/or [Data GemFire]_ application +NOTE: #1 above is independent of your _Spring [Boot] and/or [Data Pivotal GemFire]_ application and must be completed successfully. -2) Referring to Step 5 in GemFire's http://gemfire90.docs.pivotal.io/geode/developing/transactions/JTA_transactions.html#concept_csy_vfb_wk[documentation], -_Spring Data GemFire's_ Annotation support will attempt to set the `GemFireCache`, http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/GemFireCache.html#setCopyOnRead-boolean-[`copyOnRead`] -property for you when using the `@EnableGemFireAsLastResource` annotation. +2) Referring to Step 5 in Pivotal GemFire's http://gemfire90.docs.pivotal.io/geode/developing/transactions/JTA_transactions.html#concept_csy_vfb_wk[documentation], +_Spring Data for Pivotal GemFire's_ Annotation support will attempt to set the `Pivotal GemFireCache`, http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/Pivotal GemFireCache.html#setCopyOnRead-boolean-[`copyOnRead`] +property for you when using the `@EnablePivotal GemFireAsLastResource` annotation. However, if SDG's auto-configuration is unsuccessful then you must explicitly set the `copy-on-read` attribute on the `` or `` element in XML or the `copyOnRead` property of the SDG `CacheFactoryBean` class @@ -189,18 +192,18 @@ Client Cache JavaConfig: NOTE: explicitly setting the `copy-on-read` attribute or optionally the `copyOnRead` property really should not be necessary. -3) At this point, you *skip* Steps 6-8 in GemFire's http://gemfire90.docs.pivotal.io/geode/developing/transactions/JTA_transactions.html#concept_csy_vfb_wk[documentation] +3) At this point, you *skip* Steps 6-8 in Pivotal GemFire's http://gemfire90.docs.pivotal.io/geode/developing/transactions/JTA_transactions.html#concept_csy_vfb_wk[documentation] and let _Spring Data Geode_ work its magic. All you need do is annotate your _Spring_ `@Configuration` class -with _Spring Data GemFire's_ *new* `@EnableGemFireAsLastResource` annotation and a combination of _Spring's_ +with _Spring Data for Pivotal GemFire's_ *new* `@EnablePivotal GemFireAsLastResource` annotation and a combination of _Spring's_ http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#transaction[Transaction Management] -infrastructure and _Spring Data GemFire's_ `@EnableGemFireAsLastResource` configuration does the trick. +infrastructure and _Spring Data for Pivotal GemFire's_ `@EnablePivotal GemFireAsLastResource` configuration does the trick. The configuration looks like this... [source,java] ---- @Configuration -@EnableGemFireAsLastResource +@EnablePivotal GemFireAsLastResource @EnableTransactionManagement(order = 1) class GeodeConfiguration { @@ -210,7 +213,7 @@ class GeodeConfiguration { The only requirements are... -3.1) The `@EnableGemFireAsLastResource` annotation must be declared on the same _Spring_ `@Configuration` class +3.1) The `@EnablePivotal GemFireAsLastResource` annotation must be declared on the same _Spring_ `@Configuration` class where _Spring's_ `@EnableTransactionManagement` annotation is also specified. 3.2) The `order` attribute of the `@EnableTransactionManagement` annotation must be explicitly set to an integer value @@ -233,15 +236,15 @@ public JtaTransactionManager transactionManager(UserTransaction userTransaction) ---- NOTE: The configuration in section <> does *not* apply here. -The use of _Spring Data GemFire's_ `GemfireTransactionManager` is applicable only in "Local", Cache Transactions, +The use of _Spring Data for Pivotal GemFire's_ `GemfireTransactionManager` is applicable only in "Local", Cache Transactions, *not* "Global", JTA Transactions. Therefore, you do *not* configure the SDG `GemfireTransactionManager` in this case. You configure _Spring's_ `JtaTransactionManager` as shown above. For more details on using _Spring's Transaction Management_ with JTA, see http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#transaction-application-server-integration[here]. -Effectively, _Spring Data GemFire's_ `@EnableGemFireAsLastResource` annotation imports configuration containing 2 Aspect -bean definitions that handles the GemFire `o.a.g.ra.GFConnectionFactory.getConnection()` +Effectively, _Spring Data for Pivotal GemFire's_ `@EnablePivotal GemFireAsLastResource` annotation imports configuration containing 2 Aspect +bean definitions that handles the Pivotal GemFire `o.a.g.ra.GFConnectionFactory.getConnection()` and `o.a.g.ra.GFConnection.close()` operations at the appropriate points during the transactional operation. Specifically, the correct sequence of events are... @@ -257,8 +260,8 @@ Specifically, the correct sequence of events are... 5. Finally, `GFConnection.close()` This is consistent with how you, as the application developer, would code this manually if you had to use the JTA API -+ GemFire API yourself, as shown in the -GemFire http://gemfire90.docs.pivotal.io/geode/developing/transactions/jca_adapter_example.html#concept_swv_z2p_wk[example]. ++ Pivotal GemFire API yourself, as shown in the +Pivotal GemFire http://gemfire90.docs.pivotal.io/geode/developing/transactions/jca_adapter_example.html#concept_swv_z2p_wk[example]. Thankfully, _Spring_ does the heavy lifting for you and all you need do after applying the appropriate configuration (shown above) is... @@ -281,7 +284,7 @@ class MyTransactionalService ... { `@Transactional` boundary is entered by your application (i.e. when the `MyTransactionSerivce.someTransactionalMethod()` is called). -#2 & #3 are handled by _Spring Data GemFire's_ new Aspects enabled with the `@EnableGemFireAsLastResource` annotation. +#2 & #3 are handled by _Spring Data for Pivotal GemFire's_ new Aspects enabled with the `@EnablePivotal GemFireAsLastResource` annotation. #3 of course is the responsibility of your application. @@ -291,8 +294,8 @@ Indeed, with the appropriate logging configured, you will see the correct sequen ---- 2017-Jun-22 11:11:37 TRACE TransactionInterceptor - Getting transaction for [example.app.service.MessageService.send] -2017-Jun-22 11:11:37 TRACE GemFireAsLastResourceConnectionAcquiringAspect - Acquiring GemFire Connection -from GemFire JCA ResourceAdapter registered at [gfe/jca] +2017-Jun-22 11:11:37 TRACE Pivotal GemFireAsLastResourceConnectionAcquiringAspect - Acquiring Pivotal GemFire Connection +from Pivotal GemFire JCA ResourceAdapter registered at [gfe/jca] 2017-Jun-22 11:11:37 TRACE MessageService - PRODUCER [ Message : [{ @type = example.app.domain.Message, id= MSG0000000000, message = SENT }], @@ -300,7 +303,7 @@ JSON : [{"id":"MSG0000000000","message":"SENT"}] ] 2017-Jun-22 11:11:37 TRACE TransactionInterceptor - Completing transaction for [example.app.service.MessageService.send] -2017-Jun-22 11:11:37 TRACE GemFireAsLastResourceConnectionClosingAspect - Closed GemFire Connection @ [Reference [...]] +2017-Jun-22 11:11:37 TRACE Pivotal GemFireAsLastResourceConnectionClosingAspect - Closed Pivotal GemFire Connection @ [Reference [...]] ---- For more details on using Pivotal GemFire in JTA transactions, @@ -320,7 +323,7 @@ include::{basedocdir}/reference/cq-container.adoc[] Pivotal GemFire XML configuration (usually referred to as `cache.xml`) allows *user* objects to be declared as part of the configuration. Usually these objects are `CacheLoaders` or other pluggable callback components -supported by GemFire. Using native GemFire configuration, each user type declared through XML must implement +supported by Pivotal GemFire. Using native Pivotal GemFire configuration, each user type declared through XML must implement the `Declarable` interface, which allows arbitrary parameters to be passed to the declared class through a `Properties` instance. @@ -330,7 +333,7 @@ pluggable components to focus on the application logic and not the location or c or other collaborators. However, if you are starting a green field project, it is recommended that you configure Cache, Region, -and other pluggable GemFire components directly in _Spring_. This avoids inheriting from the `Declarable` interface +and other pluggable Pivotal GemFire components directly in _Spring_. This avoids inheriting from the `Declarable` interface or the base class presented in this section. See the following sidebar for more information on this approach. @@ -356,15 +359,15 @@ As an example of configuring a `Declarable` component using _Spring_, consider t ---- -To simplify the task of parsing, converting the parameters and initializing the object, _Spring Data GemFire_ offers -a base class (`WiringDeclarableSupport`) that allows GemFire user objects to be wired through a *template* bean definition +To simplify the task of parsing, converting the parameters and initializing the object, _Spring Data for Pivotal GemFire_ offers +a base class (`WiringDeclarableSupport`) that allows Pivotal GemFire user objects to be wired through a *template* bean definition or, in case that is missing, perform auto-wiring through the _Spring_ IoC container. To take advantage of this feature, the user objects need to extend `WiringDeclarableSupport`, which automatically locates the declaring `BeanFactory` and performs wiring as part of the initialization process. .Why is a base class needed? **** -In the current GemFire release there is no concept of an *object factory* and the types declared are instantiated +In the current Pivotal GemFire release there is no concept of an *object factory* and the types declared are instantiated and used as is. In other words, there is no easy way to manage object creation outside Pivotal GemFire. **** @@ -416,8 +419,8 @@ class DBLoader extends WiringDeclarableSupport implements CacheLoader { ---- In the scenario above, as no parameter was specified, a bean with the id/name `com.company.app.DBLoader` was used -as a template for wiring the instance created by GemFire. For cases where the bean name uses a different convention, -one can pass in the `bean-name` parameter in the GemFire configuration: +as a template for wiring the instance created by Pivotal GemFire. For cases where the bean name uses a different convention, +one can pass in the `bean-name` parameter in the Pivotal GemFire configuration: [source,xml] ---- @@ -513,7 +516,7 @@ the `DBLoader` code. [[apis:spring-cache-abstraction]] == Support for the Spring Cache Abstraction -_Spring Data GemFire_ provides an implementation of the _Spring_ +_Spring Data for Pivotal GemFire_ provides an implementation of the _Spring_ http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#cache[Cache Abstraction] to position Pivotal GemFire as a _caching provider_ in Spring's caching infrastructure. @@ -549,7 +552,7 @@ is used (i.e. "gemfireCache"), i.e. `` without an explicit ID. When the `GemfireCacheManager` (Singleton) bean instance is declared and declarative caching is enabled (either in XML with `` or in JavaConfig with _Spring's_ `@EnableCaching` annotation), the _Spring_ caching annotations (e.g. `@Cacheable`) identify the "caches" that will cache data in-memory -using GemFire Regions. +using Pivotal GemFire Regions. These caches (i.e. Regions) must exist before the caching annotations that use them otherwise an error will occur. diff --git a/src/main/asciidoc/reference/diskstore.adoc b/src/main/asciidoc/reference/diskstore.adoc index 151812f5..d7d4ae7e 100644 --- a/src/main/asciidoc/reference/diskstore.adoc +++ b/src/main/asciidoc/reference/diskstore.adoc @@ -1,22 +1,23 @@ [[bootstrap:diskstore]] = Configuring a DiskStore -_Spring Data GemFire_ supports `DiskStore` configuration via the `disk-store` element. +_Spring Data for Pivotal GemFire_ supports `DiskStore` configuration and creation via the `disk-store` element. For example: [source,xml] ---- - - - + + + ---- `DiskStores` are used by Regions for file system persistent backup and overflow of evicted entries -as well as persistent backup of WAN Gateways. Multiple GemFire components may share the same `DiskStore`. -Additionally, multiple file system directories may be defined for a single `DiskStore`. +as well as persistent backup for WAN Gateways. Multiple Pivotal GemFire components may share the same `DiskStore`. +Additionally, multiple file system directories may be defined for a single `DiskStore` as shown in the example above. -Please refer to Pivotal GemFire's documentation for a complete explanation of the -http://geode.apache.org/docs/guide/11/developing/storing_data_on_disk/chapter_overview.html[configuration options]. +Please refer to Pivotal GemFire's documentation for a complete explanation of +http://gemfire.docs.pivotal.io/95/geode/developing/storing_data_on_disk/chapter_overview.html[Persistence and Overflow] +along with configuration options on `DiskStores`. diff --git a/src/main/asciidoc/reference/function-annotations.adoc b/src/main/asciidoc/reference/function-annotations.adoc index d9f40541..02beb9ab 100644 --- a/src/main/asciidoc/reference/function-annotations.adoc +++ b/src/main/asciidoc/reference/function-annotations.adoc @@ -3,22 +3,22 @@ == Introduction -_Spring Data GemFire_ includes annotation support to simplify working with GemFire +_Spring Data for Pivotal GemFire_ includes annotation support to simplify working with Pivotal GemFire http://geode.apache.org/docs/guide/11/developing/function_exec/chapter_overview.html[Function Execution]. -Under-the-hood, the Pivotal GemFire API provides classes to implement and register GemFire +Under-the-hood, the Pivotal GemFire API provides classes to implement and register Pivotal GemFire http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/execute/Function.html[Functions] -that are deployed on GemFire servers, which may then be invoked by other peer member applications +that are deployed on Pivotal GemFire servers, which may then be invoked by other peer member applications or remotely from cache clients. -Functions can execute in parallel, distributed among multiple GemFire servers in the cluster, aggregating results +Functions can execute in parallel, distributed among multiple Pivotal GemFire servers in the cluster, aggregating results with the map-reduce pattern that are sent back to the caller. Functions can also be targeted to run on a single server or Region. The Pivotal GemFire API supports remote execution of Functions targeted using various predefined scopes: on Region, on members [in groups], on servers, etc. The implementation and execution of remote Functions, as with any RPC protocol, requires some boilerplate code. -_Spring Data GemFire_, true to _Spring's_ core value proposition, aims to hide the mechanics of remote Function execution -and allow developers to focus on core POJO programming and business logic. To this end, _Spring Data GemFire_ introduces -annotations to declaratively register public methods of a POJO class as GemFire Functions along with the ability to +_Spring Data for Pivotal GemFire_, true to _Spring's_ core value proposition, aims to hide the mechanics of remote Function execution +and allow developers to focus on core POJO programming and business logic. To this end, _Spring Data for Pivotal GemFire_ introduces +annotations to declaratively register public methods of a POJO class as Pivotal GemFire Functions along with the ability to invoke registered Functions [remotely] via annotated interfaces. == Implementation vs Execution @@ -44,8 +44,8 @@ to aggregate and acquire the execution results. In certain cases, a custom `Res is required and may be registered with the `Execution`. NOTE: 'Client' and 'Server' are used here in the context of Function execution, which may have a different meaning -than client and server in GemFire's client-server topology. While it is common for an application using a `ClientCache` -to invoke a Function on one or more GemFire servers in a cluster, it is also possible to execute Functions +than client and server in Pivotal GemFire's client-server topology. While it is common for an application using a `ClientCache` +to invoke a Function on one or more Pivotal GemFire servers in a cluster, it is also possible to execute Functions in a peer-to-peer (P2P) configuration, where the application is a member of the cluster hosting a peer `Cache`. Keep in mind that a peer member cache application is subject to all the same constraints of being a peer member of the cluster. @@ -53,7 +53,7 @@ of the cluster. [[function-implementation]] == Implementing a Function -Using GemFire APIs, the `FunctionContext` provides a runtime invocation context that includes the client's +Using Pivotal GemFire APIs, the `FunctionContext` provides a runtime invocation context that includes the client's calling arguments and a `ResultSender` implementation to send results back to the client. Additionally, if the Function is executed on a Region, the `FunctionContext` is actually an instance of `RegionFunctionContext`, which provides additional information such as the target Region on which the Function was invoked @@ -101,7 +101,7 @@ or the `ResultSender`, if you need to control how the results are returned to th === Annotations for Function Implementation The following example illustrates how SDG's Function annotations are used to expose POJO methods -as GemFire Functions: +as Pivotal GemFire Functions: [source,java] ---- @@ -120,7 +120,7 @@ public class ApplicationFunctions { } ---- -Note, the class itself must be registered as a _Spring_ bean and each GemFire Function is annotated +Note, the class itself must be registered as a _Spring_ bean and each Pivotal GemFire Function is annotated with `@GemfireFunction`. In this example, _Spring's_ `@Component` annotation was used, but you may register the bean by any method supported by _Spring_ (e.g. XML configuration or with a Java configuration class using _Spring Boot_). This allows the _Spring_ container to create an instance of this class and wrap it in a @@ -129,14 +129,14 @@ _Spring_ creates a wrapper instance for each method annotated with `@GemfireFunc the same target object instance to invoke the corresponding method. TIP: The fact that the POJO Function class is a _Spring_ bean may offer other benefits since it shares -the `ApplicationContext` with GemFire components such as the Cache and Regions. These may be injected into the class +the `ApplicationContext` with Pivotal GemFire components such as the Cache and Regions. These may be injected into the class if necessary. -_Spring_ creates the wrapper class and registers the Function(s) with GemFire's Function Service. The Function id used +_Spring_ creates the wrapper class and registers the Function(s) with Pivotal GemFire's Function Service. The Function id used to register the Functions must be unique. Using convention it defaults to the simple (unqualified) method name. The name can be explicitly defined using the `id` attribute of the `@GemfireFunction` annotation. The `@GemfireFunction` annotation also provides other configuration attributes, `HA` and `optimizedForWrite`, -which correspond to properties defined by GemFire's +which correspond to properties defined by Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/execute/Function.html[Function] interface. If the method's return type is void, then the `hasResult` property is automatically set to `false`; otherwise, if the method returns a value the `hasResult` attributes is set to `true`. @@ -145,7 +145,7 @@ Even for `void` return types, the annotation's `hasResult` attribute can be set as shown in the `functionWithContext` method above. Presumably, the intention is to use the `ResultSender` directly to send results to the caller. -The `PojoFunctionWrapper` implements GemFire's `Function` interface, binds method parameters and invokes the target method +The `PojoFunctionWrapper` implements Pivotal GemFire's `Function` interface, binds method parameters and invokes the target method in its `execute()` method. It also sends the method's return value using the `ResultSender`. === Batching Results @@ -184,11 +184,11 @@ class ApplicationConfiguration { .. } == Executing a Function A process invoking a remote Function needs to provide the Function's ID, calling arguments, the execution target -(onRegion, onServers, onServer, onMember, onMembers) and optionally, a Filter set. Using _Spring Data GemFire_, +(onRegion, onServers, onServer, onMember, onMembers) and optionally, a Filter set. Using _Spring Data for Pivotal GemFire_, all a developer need do is define an interface supported by annotations. _Spring_ will create a dynamic proxy for the interface, which will use the `FunctionService` to create an `Execution`, invoke the `Execution` and coerce the results to the defined return type, if necessary. This technique is very similar to the way -_Spring Data GemFire's Repository extension_ works, thus some of the configuration and concepts should be familiar. +_Spring Data for Pivotal GemFire's Repository extension_ works, thus some of the configuration and concepts should be familiar. Generally, a single interface definition maps to multiple Function executions, one corresponding to each method defined in the interface. @@ -196,7 +196,7 @@ defined in the interface. To support client-side Function execution, the following SDG Function annotations are provided: `@OnRegion`, `@OnServer`, `@OnServers`, `@OnMember`, `@OnMembers`. These annotations correspond to the `Execution` implementations -prodided by GemFire's +prodided by Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/execute/FunctionService.html[FunctionService]. Each annotation exposes the appropriate attributes. These annotations also provide an optional `resultCollector` attribute whose value is the name of a _Spring_ bean implementing the @@ -288,12 +288,12 @@ The Filter argument is optional. The following arguments are a variable argumen [[function-execution-pdx]] == Function Execution with PDX -When using _Spring Data GemFire's_ Function annotation support combined with Pivotal GemFire's +When using _Spring Data for Pivotal GemFire's_ Function annotation support combined with Pivotal GemFire's http://geode.apache.org/docs/guide/11/developing/data_serialization/gemfire_pdx_serialization.html[PDX Serialization], there are a few logistical things to keep in mind. -As explained above, and by way of example, typically developers will define GemFire Functions using POJO classes -annotated with Spring Data GemFire +As explained above, and by way of example, typically developers will define Pivotal GemFire Functions using POJO classes +annotated with Spring Data for Pivotal GemFire http://docs.spring.io/spring-data-gemfire/docs/current/api/org/springframework/data/gemfire/function/annotation/package-summary.html[Function annotations] like so... @@ -334,7 +334,7 @@ public enum OrderSource { } ---- -Of course, a developer may define a Function `Execution` interface to call the 'process' GemFire Server Function... +Of course, a developer may define a Function `Execution` interface to call the 'process' Pivotal GemFire Server Function... [source,java] ---- @@ -349,16 +349,16 @@ Clearly, this `process(..)` `Order` Function is being called from a client-side The same is true when invoking peer-to-peer member Functions (e.g. `@OnMember(s)) between peers in the cluster. Any form of `distribution` requires the data transmitted between client and server, or peers, to be serialized. -Now, if the developer has configured GemFire to use PDX for serialization (instead of Java serialization, for instance) +Now, if the developer has configured Pivotal GemFire to use PDX for serialization (instead of Java serialization, for instance) it is common for developers to also set the `pdx-read-serialized` attribute to *true* in their configuration -of the GemFire server(s)... +of the Pivotal GemFire server(s)... [source,xml] ---- ---- -Or from a GemFire cache client application... +Or from a Pivotal GemFire cache client application... [source,xml] ---- @@ -368,24 +368,24 @@ Or from a GemFire cache client application... This causes all values read from the cache (i.e. Regions) as well as information passed between client and servers, or peers, to remain in serialized form, including, but not limited to, Function arguments. -GemFire will only serialize application domain object types that you have specifically configured (registered), -with either GemFire's +Pivotal GemFire will only serialize application domain object types that you have specifically configured (registered), +with either Pivotal GemFire's http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/pdx/ReflectionBasedAutoSerializer.html[ReflectionBasedAutoSerializer], -or specifically (and recommended) using a "custom" GemFire +or specifically (and recommended) using a "custom" Pivotal GemFire http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/pdx/PdxSerializer.html[PdxSerializer]. If you are using -_Spring Data GemFire's_ Repository extension to _Spring Data Common's_ Repository abstraction and infrastructure, -you might even want to consider using _Spring Data GemFire's_ +_Spring Data for Pivotal GemFire's_ Repository extension to _Spring Data Common's_ Repository abstraction and infrastructure, +you might even want to consider using _Spring Data for Pivotal GemFire's_ http://docs.spring.io/spring-data-gemfire/docs/current/api/org/springframework/data/gemfire/mapping/MappingPdxSerializer.html[MappingPdxSerializer], which uses a entity's mapping meta-data to determine data from the application domain object that will be serialized to the PDX instance. -What is less than apparent, though, is that GemFire automatically handles Java Enum types regardless of whether they are +What is less than apparent, though, is that Pivotal GemFire automatically handles Java Enum types regardless of whether they are explicitly configured or not (i.e. registered with a `ReflectionBasedAutoSerializer` using a regex pattern -and the `classes` parameter, or are handled by a "custom" GemFire `PdxSerializer`), despite the fact that Java Enums +and the `classes` parameter, or are handled by a "custom" Pivotal GemFire `PdxSerializer`), despite the fact that Java Enums implement `java.io.Serializable`. -So, when a developer sets `pdx-read-serialized` to *true* on GemFire Servers where the GemFire Functions -(including Spring Data GemFire Function annotated POJO classes) are registered, then the developer +So, when a developer sets `pdx-read-serialized` to *true* on Pivotal GemFire Servers where the Pivotal GemFire Functions +(including Spring Data for Pivotal GemFire Function annotated POJO classes) are registered, then the developer may encounter surprising behavior when invoking the Function `Execution`. What the developer may pass as arguments when invoking the Function is... @@ -395,7 +395,7 @@ What the developer may pass as arguments when invoking the Function is... orderProcessingFunctions.process(new Order(123, customer, Calendar.getInstance(), items), OrderSource.ONLINE, 400); ---- -But, what the GemFire Function on the Server gets is... +But, what the Pivotal GemFire Function on the Server gets is... [source,java] ---- @@ -405,17 +405,17 @@ process(regionData, order:PdxInstance, :PdxInstanceEnum, 400); The `Order` and `OrderSource` have been passed to the Function as http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/pdx/PdxInstance.html[PDX instances]. Again, this is all because `pdx-read-serialized` is set to *true*, which may be necessary in cases where -the GemFire Servers are interacting with multiple different clients (e.g. Java, native clients, such as C++/C#, etc). +the Pivotal GemFire Servers are interacting with multiple different clients (e.g. Java, native clients, such as C++/C#, etc). -This flies in the face of _Spring Data GemFire's_ "strongly-typed", Function annotated POJO class method signatures, +This flies in the face of _Spring Data for Pivotal GemFire's_ "strongly-typed", Function annotated POJO class method signatures, as the developer is expecting application domain object types, not PDX serialized instances. -So, _Spring Data GemFire_ includes enhanced Function support to automatically convert method arguments passed to +So, _Spring Data for Pivotal GemFire_ includes enhanced Function support to automatically convert method arguments passed to the Function that are of type PDX to the desired application domain object types defined by the Function method's parameter types. -However, this also requires the developer to explicitly register a GemFire `PdxSerializer` on the GemFire Servers -where _Spring Data GemFire_ Function annotated POJOs are registered and used, e.g. ... +However, this also requires the developer to explicitly register a Pivotal GemFire `PdxSerializer` on the Pivotal GemFire Servers +where _Spring Data for Pivotal GemFire_ Function annotated POJOs are registered and used, e.g. ... [source,java] ---- @@ -424,13 +424,13 @@ where _Spring Data GemFire_ Function annotated POJOs are registered and used, e. ---- -Alternatively, a developer my use GemFire's +Alternatively, a developer my use Pivotal GemFire's http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/pdx/ReflectionBasedAutoSerializer.html[ReflectionBasedAutoSerializer] for convenience. Of course, it is recommended that you use a "custom" `PdxSerializer` where possible to maintain finer grained control over your serialization strategy. -Finally, _Spring Data GemFire_ is careful not to convert your Function arguments if you treat your Function arguments -generically, or as one of GemFire's PDX types... +Finally, _Spring Data for Pivotal GemFire_ is careful not to convert your Function arguments if you treat your Function arguments +generically, or as one of Pivotal GemFire's PDX types... [source,java] ---- @@ -440,9 +440,9 @@ public Object genericFunction(String value, Object domainObject, PdxInstanceEnum } ---- -_Spring Data GemFire_ only converts PDX type data to the corresponding application domain types if and only if +_Spring Data for Pivotal GemFire_ only converts PDX type data to the corresponding application domain types if and only if the corresponding application domain types are on the classpath the the Function annotated POJO method expects it. -For a good example of "custom", "composed" application-specific GemFire `PdxSerializers` as well as appropriate -POJO Function parameter type handling based on the method signatures, see Spring Data GemFire's +For a good example of "custom", "composed" application-specific Pivotal GemFire `PdxSerializers` as well as appropriate +POJO Function parameter type handling based on the method signatures, see Spring Data for Pivotal GemFire's https://github.com/spring-projects/spring-data-gemfire/blob/2.0.0.M2/src/test/java/org/springframework/data/gemfire/function/ClientCacheFunctionExecutionWithPdxIntegrationTest.java[ClientCacheFunctionExecutionWithPdxIntegrationTest] class. diff --git a/src/main/asciidoc/reference/function.adoc b/src/main/asciidoc/reference/function.adoc index 144c9037..7f963db5 100644 --- a/src/main/asciidoc/reference/function.adoc +++ b/src/main/asciidoc/reference/function.adoc @@ -1,17 +1,17 @@ [[bootstrap:function]] = Configuring the Function Service -_Spring Data GemFire_ provides <> support for implementing and registering +_Spring Data for Pivotal GemFire_ provides <> support for implementing and registering Pivotal GemFire Functions. -_Spring Data GemFire_ also provides namespace support for registering Pivotal GemFire +_Spring Data for Pivotal GemFire_ also provides namespace support for registering Pivotal GemFire http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/execute/Function.html[Functions] for remote Function execution. Please refer to Pivotal GemFire' http://geode.apache.org/docs/guide/11/developing/function_exec/chapter_overview.html[documentation] for more information on the Function execution framework. -GemFire Functions are declared as _Spring_ beans and must implement the `org.apache.geode.cache.execute.Function` +Pivotal GemFire Functions are declared as _Spring_ beans and must implement the `org.apache.geode.cache.execute.Function` interface or extend `org.apache.geode.cache.execute.FunctionAdapter`. The namespace uses a familiar pattern to declare functions: diff --git a/src/main/asciidoc/reference/gateway.adoc b/src/main/asciidoc/reference/gateway.adoc index 8809dda6..0e0af21f 100644 --- a/src/main/asciidoc/reference/gateway.adoc +++ b/src/main/asciidoc/reference/gateway.adoc @@ -2,9 +2,9 @@ = Configuring WAN Gateways WAN Gateways provide a way to synchronize Pivotal GemFire Distributed Systems across geographic areas. -_Spring Data GemFire_ provides namespace support for configuring WAN Gateways as illustrated in the following examples. +_Spring Data for Pivotal GemFire_ provides namespace support for configuring WAN Gateways as illustrated in the following examples. -== WAN Configuration in GemFire 7.0 +== WAN Configuration in Pivotal GemFire 7.0 In the example below, `GatewaySenders` are configured for a PARTITION Region by adding child elements to the Region (`gateway-sender` and `gateway-sender-ref`). diff --git a/src/main/asciidoc/reference/gemfire-bootstrap.adoc b/src/main/asciidoc/reference/gemfire-bootstrap.adoc index ff2940e2..75eabc0f 100644 --- a/src/main/asciidoc/reference/gemfire-bootstrap.adoc +++ b/src/main/asciidoc/reference/gemfire-bootstrap.adoc @@ -3,37 +3,37 @@ == Introduction -Normally, a _Spring_-based application will <> using _Spring Data GemFire's. -Just by specifying a `` element using the _Spring Data GemFire_ XML namespace, a single, embedded GemFire +Normally, a _Spring_-based application will <> using _Spring Data for Pivotal GemFire's. +Just by specifying a `` element using the _Spring Data for Pivotal GemFire_ XML namespace, a single, embedded Pivotal GemFire peer `Cache` instance is created and initialized with default settings in the same JVM process as your application. -However, it is sometimes necessary, perhaps a requirement imposed by your IT organization, that GemFire be fully managed +However, it is sometimes necessary, perhaps a requirement imposed by your IT organization, that Pivotal GemFire be fully managed and operated using the provided Pivotal GemFire tool suite, such as with http://geode.apache.org/docs/guide/11/tools_modules/gfsh/chapter_overview.html[Gfsh]. By using _Gfsh_, -GemFire will bootstrap your _Spring_ application context rather than the other way around. Instead of -an application server, or a Java main class using _Spring Boot_, whatever, GemFire does the bootstrapping and will +Pivotal GemFire will bootstrap your _Spring_ application context rather than the other way around. Instead of +an application server, or a Java main class using _Spring Boot_, whatever, Pivotal GemFire does the bootstrapping and will host your application. -Keep in mind, however, that GemFire is not an application server. In addition, there are limitations to using -this approach where GemFire cache configuration is concerned. +Keep in mind, however, that Pivotal GemFire is not an application server. In addition, there are limitations to using +this approach where Pivotal GemFire cache configuration is concerned. [[gemfire-bootstrap-gfsh]] == Using Pivotal GemFire to Bootstrap a Spring Context Started with Gfsh -In order to bootstrap a _Spring_ application context in GemFire when starting a GemFire Server process using _Gfsh_, -a user must make use of GemFire's +In order to bootstrap a _Spring_ application context in Pivotal GemFire when starting a Pivotal GemFire Server process using _Gfsh_, +a user must make use of Pivotal GemFire's http://geode.apache.org/docs/guide/11/basic_config/the_cache/setting_cache_initializer.html[Initalizer] functionality. -An Initializer block can declare a callback application that is launched after the cache is initialized by GemFire. +An Initializer block can declare a callback application that is launched after the cache is initialized by Pivotal GemFire. An Initializer is declared within an http://geode.apache.org/docs/guide/11/reference/topics/cache_xml.html#initializer[initializer] element -using a minimal snippet of GemFire's native `cache.xml`. The `cache.xml` file is required in order to bootstrap +using a minimal snippet of Pivotal GemFire's native `cache.xml`. The `cache.xml` file is required in order to bootstrap the _Spring_ application context, much like a minimal snippet of _Spring_ XML config is needed to bootstrap a _Spring_ application context configured with component scanning (e.g. ``) Fortunately, such an Initializer is already conveniently provided by the framework, the http://docs.spring.io/spring-data-gemfire/docs/current/api/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializer.html[SpringContextBootstrappingInitializer]. -A typical, yet very minimal configuration for this class inside GemFires's `cache.xml` file will look like this: +A typical, yet very minimal configuration for this class inside Pivotal GemFires's `cache.xml` file will look like this: [source,xml] ---- @@ -81,7 +81,7 @@ on the classpath: ---- Then, with a properly configured and constructed `CLASSPATH` along with `cache.xml` file shown above, specified as -a command-line option when starting a GemFire Server in _Gfsh_, the command-line would be: +a command-line option when starting a Pivotal GemFire Server in _Gfsh_, the command-line would be: [source] ---- @@ -91,35 +91,35 @@ gfsh>start server --name=Server1 --log-level=config ... ---- The `application-context.xml` can be any valid _Spring_ context configuration meta-data including all the SDG namespace -elements. The only limitation with this approach is that a GemFire cache cannot be configured using -the _Spring Data GemFire_ namespace. In other words, none of the `` element attributes, +elements. The only limitation with this approach is that a Pivotal GemFire cache cannot be configured using +the _Spring Data for Pivotal GemFire_ namespace. In other words, none of the `` element attributes, such as `cache-xml-location`, `properties-ref`, `critical-heap-percentage`, `pdx-serializer-ref`, `lock-lease`, etc, can be specified. If used, these attributes will be ignored. -The reason for this is that GemFire itself has already created an initialized the cache before the Initializer +The reason for this is that Pivotal GemFire itself has already created an initialized the cache before the Initializer gets invoked. As such, the cache will already exist and since it is a "Singleton", it cannot be re-initialized or have any of it's configuration augmented. [[gemfire-bootstrap-lazywiring]] -== Lazy-Wiring GemFire Components +== Lazy-Wiring Pivotal GemFire Components -_Spring Data GemFire_ already provides existing support for wiring GemFire components, such as `CacheListeners`, -`CacheLoaders`, `CacheWriters` and so on, that are declared and created by GemFire in `cache.xml` using +_Spring Data for Pivotal GemFire_ already provides existing support for wiring Pivotal GemFire components, such as `CacheListeners`, +`CacheLoaders`, `CacheWriters` and so on, that are declared and created by Pivotal GemFire in `cache.xml` using SDG's `WiringDeclarableSupport` class as described in <>. However, this only works -when _Spring_ is the one doing the bootstrapping (i.e. bootstrapping GemFire). +when _Spring_ is the one doing the bootstrapping (i.e. bootstrapping Pivotal GemFire). -When your _Spring_ application context is bootstrapped by GemFire, then these GemFire application components go unnoticed +When your _Spring_ application context is bootstrapped by Pivotal GemFire, then these Pivotal GemFire application components go unnoticed since the _Spring_ application context does not even exist yet! The _Spring_ application context will not get created -until GemFire calls the Initializer block, which only occurs after all the other GemFire components and configuration +until Pivotal GemFire calls the Initializer block, which only occurs after all the other Pivotal GemFire components and configuration have already been created and initialized. So, in order to solve this problem, a new `LazyWiringDeclarableSupport` class was introduced that is, in a sense, _Spring_ application context aware. The intention of this abstract base class is that any implementing class -will register itself to be configured by the _Spring_ container that will eventually be created by GemFire -once the Initializer is called. In essence, this give your GemFire defined application components a chance +will register itself to be configured by the _Spring_ container that will eventually be created by Pivotal GemFire +once the Initializer is called. In essence, this give your Pivotal GemFire defined application components a chance to be configured and auto-wired with _Spring_ beans defined in the _Spring_ application context. -In order for your GemFire application components to be auto-wired by the _Spring_ container, create an application class +In order for your Pivotal GemFire application components to be auto-wired by the _Spring_ container, create an application class that extends the `LazyWiringDeclarableSupport` and annotate any class member that needs to be provided as a _Spring_ bean dependency, similar to: @@ -136,12 +136,12 @@ public class UserDataSourceCacheLoader extends LazyWiringDeclarableSupport ---- As implied in the `CacheLoader` example above, you might necessarily (although, rarely) have defined both -a Region and `CacheListener` component in GemFire `cache.xml`. The `CacheLoader` may need access to an application DAO, -or perhaps a _Spring_ application context defined JDBC `DataSource` for loading `Users` into a GemFire `REPLICATE` Region +a Region and `CacheListener` component in Pivotal GemFire `cache.xml`. The `CacheLoader` may need access to an application DAO, +or perhaps a _Spring_ application context defined JDBC `DataSource` for loading `Users` into a Pivotal GemFire `REPLICATE` Region on start. CAUTION: Be careful when mixing the different life-cycles of Pivotal GemFire and the _Spring_ Container together -in this manner as not all use cases and scenarios are supported. The GemFire `cache.xml` configuration would be +in this manner as not all use cases and scenarios are supported. The Pivotal GemFire `cache.xml` configuration would be similar to the following (which comes from SDG's test suite): [source,xml] diff --git a/src/main/asciidoc/reference/indexing.adoc b/src/main/asciidoc/reference/indexing.adoc index 9476782c..8f8a9492 100644 --- a/src/main/asciidoc/reference/indexing.adoc +++ b/src/main/asciidoc/reference/indexing.adoc @@ -3,17 +3,17 @@ Pivotal GemFire allows Indexes (or Indices) to be created on Region data to improve the performance of OQL queries. -In _Spring Data GemFire_ (SDG), Indexes are declared with the `index` element: +In _Spring Data for Pivotal GemFire_ (SDG), Indexes are declared with the `index` element: [source,xml] ---- ---- -In _Spring Data GemFire's_ XML schema (a.k.a. SDG namespace), `Index` bean declarations are not bound to a _Region_, -unlike GemFire's native `cache.xml`. Rather, they are top-level elements just like `<gfe:cache>`. This allows +In _Spring Data for Pivotal GemFire's_ XML schema (a.k.a. SDG namespace), `Index` bean declarations are not bound to a _Region_, +unlike Pivotal GemFire's native `cache.xml`. Rather, they are top-level elements just like `<gfe:cache>`. This allows a developer to declare any number of Indexes on any _Region_ whether they were just created or already exist, -a significant improvement over GemFire's native `cache.xml` format. +a significant improvement over Pivotal GemFire's native `cache.xml` format. An `Index` must have a name. A developer may give the `Index` an explicit name using the `name` attribute, otherwise the _bean name_ (i.e. value of the `id` attribute) of the `Index` bean definition is used as @@ -69,9 +69,9 @@ Therefore, I might want to create an `Index` like so... ---- The `from` clause must refer to a valid, existing _Region_ and is how an `Index` gets applied to a _Region_. -This is *not* _Sprig Data GemFire_ specific; this is a feature of Pivotal GemFire. +This is *not* _Sprig Data Pivotal GemFire_ specific; this is a feature of Pivotal GemFire. -The `Index` `type` maybe 1 of 3 enumerated values defined by _Spring Data GemFire's_ +The `Index` `type` maybe 1 of 3 enumerated values defined by _Spring Data for Pivotal GemFire's_ http://docs.spring.io/spring-data-gemfire/docs/current/api/org/springframework/data/gemfire/IndexType.html[IndexType] enumeration: `FUNCTIONAL`, `HASH` and `PRIMARY_KEY`. @@ -84,14 +84,14 @@ is invoked to create a `KEY` `Index`. The default is `FUNCTIONAL` and results in one of the `QueryService.createIndex(..)` methods being invoked. -See the _Spring Data GemFire_ XML schema for a full set of options. +See the _Spring Data for Pivotal GemFire_ XML schema for a full set of options. For more information on Indexing in Pivotal GemFire, see http://gemfire90.docs.pivotal.io/geode/developing/query_index/query_index.html[Working with Indexes] in Pivotal GemFire's User Guide. == Defining Indexes -In addition to creating Indexes upfront as `Index` bean definitions are processed by _Spring Data GemFire_ +In addition to creating Indexes upfront as `Index` bean definitions are processed by _Spring Data for Pivotal GemFire_ on _Spring_ container initialization, you may also *define* all of your application Indexes prior to creating them by using the `define` attribute, like so... @@ -102,8 +102,8 @@ them by using the `define` attribute, like so... When `define` is set to `true` (defaults to `false`), this will not actually create the `Index` right then and there. All "defined" Indexes are created all at once, when the _Spring_ `ApplicationContext` is "refreshed", or, that is, -when a `ContextRefreshedEvent` is published by the _Spring_ container. _Spring Data GemFire_ registers itself as -an `ApplicationListener` listening for the `ContextRefreshedEvent`. When fired, _Spring Data GemFire_ will call +when a `ContextRefreshedEvent` is published by the _Spring_ container. _Spring Data for Pivotal GemFire_ registers itself as +an `ApplicationListener` listening for the `ContextRefreshedEvent`. When fired, _Spring Data for Pivotal GemFire_ will call http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/QueryService.html#createDefinedIndexes--[QueryService.createDefinedIndexes()]. Defining Indexes and creating them all at once helps promote speed and efficiency when creating Indexes. @@ -113,21 +113,21 @@ for more details. == `IgnoreIfExists` and `Override` -Two _Spring Data GemFire_ `Index` configuration options warrant special mention here: `ignoreIfExists` and `override`. +Two _Spring Data for Pivotal GemFire_ `Index` configuration options warrant special mention here: `ignoreIfExists` and `override`. These options correspond to the `ignore-if-exists` and `override` attributes on the `<gfe:index>` element -in _Spring Data GemFire's_ XML schema, respectively. +in _Spring Data for Pivotal GemFire's_ XML schema, respectively. WARNING: Make sure you absolutely understand what you are doing before using either of these options. These options can affect the performance and/or resources (e.g. memory) consumed by your application at runtime. As such, both of these options are disabled (i.e. set to `false`) in SDG by default. -NOTE: These options are only available in _Spring Data GemFire_ and exist to workaround known limitations -with Pivotal GemFire; there are no equivalent options or functionality available in GemFire itself. +NOTE: These options are only available in _Spring Data for Pivotal GemFire_ and exist to workaround known limitations +with Pivotal GemFire; there are no equivalent options or functionality available in Pivotal GemFire itself. -Each option significantly differs in behavior and entirely depends on the type of GemFire `Index` _Exception_ thrown. -This also means that neither option has any effect if a GemFire Index-type _Exception_ is *not* thrown. These options -are meant to specifically handle GemFire `IndexExistsExceptions` and `IndexNameConflictExceptions`, which can occur +Each option significantly differs in behavior and entirely depends on the type of Pivotal GemFire `Index` _Exception_ thrown. +This also means that neither option has any effect if a Pivotal GemFire Index-type _Exception_ is *not* thrown. These options +are meant to specifically handle Pivotal GemFire `IndexExistsExceptions` and `IndexNameConflictExceptions`, which can occur for various, sometimes obscure reasons. But, in general... * An http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/IndexExistsException.html[IndexExistsException] @@ -138,9 +138,9 @@ create an `Index`. is thrown when there exists another `Index` with the same name but possibly different definition when attempting to create an `Index`. -_Spring Data GemFire's_ default behavior is to *_fail-fast_*, always! So, neither `Index` _Exception_ will be "handled" +_Spring Data for Pivotal GemFire's_ default behavior is to *_fail-fast_*, always! So, neither `Index` _Exception_ will be "handled" by default; these `Index` _Exceptions_ are simply wrapped in a SDG `GemfireIndexException` and rethrown. If you wish -for _Spring Data GemFire_ to handle them for you, then you can set either of these `Index` bean definition options. +for _Spring Data for Pivotal GemFire_ to handle them for you, then you can set either of these `Index` bean definition options. `IgnoreIfExists` always takes *precedence* over `Override`, primarily because it uses less resources given it returns the "existing" `Index` in both exceptional cases. @@ -152,10 +152,10 @@ then the `Index` that would have been created by this `Index` bean definition / and the "existing" `Index` will be returned. There is very little consequence in returning the "existing" `Index` since the `Index` "definition" is the same, -as deemed by GemFire itself, *not* SDG. +as deemed by Pivotal GemFire itself, *not* SDG. However, this also means that *no* `Index` with the "`name`" specified in your `Index` bean definition / declaration -will "actually" exist from GemFire's perspective either (i.e. with +will "actually" exist from Pivotal GemFire's perspective either (i.e. with http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/QueryService.html#getIndexes--[QueryService.getIndexes()]). Therefore, you should be careful when writing OQL query statements that use _Query Hints_, especially _Hints_ that refer to the application `Index` being "*ignored*". Those _Query Hints_ will need to be changed. @@ -173,7 +173,7 @@ this might not be the case. So, make sure you verify. NOTE: SDG makes a best effort to inform the user when the `Index` being ignored is significantly different in its definition from the "existing" `Index`. However, in order for SDG to accomplish this, it must be able to "find" -the existing `Index`, which is looked up using the GemFire API (the only means available). +the existing `Index`, which is looked up using the Pivotal GemFire API (the only means available). === `Override` Behavior @@ -182,7 +182,7 @@ When an `IndexExistsException` is thrown and `override` is set to `true` (or `&l the `Index` is effectively "_renamed_". Remember, `IndexExistsExceptions` are thrown when multiple Indexes exist, all having the same "definition" but different "names". -_Spring Data GemFire_ can only accomplish this using GemFire's API, by first "_removing_" the "existing" `Index` +_Spring Data for Pivotal GemFire_ can only accomplish this using Pivotal GemFire's API, by first "_removing_" the "existing" `Index` and then "_recreating_" the `Index` with the *new* name. It is possible that either the remove or subsequent create invocation could fail. There is no way to execute both actions atomically and rollback this joint operation if either fails. @@ -197,7 +197,7 @@ is thrown. If so, SDG is *smart* and will just return the "existing" Index as is, even on `override`. There is no harm in this since both the "name" and the "definition" are exactly the same. Of course, SDG can only accomplish this when -SDG is able to "find" the "existing" `Index`, which is dependent on GemFire's APIs. If it cannot find it, +SDG is able to "find" the "existing" `Index`, which is dependent on Pivotal GemFire's APIs. If it cannot find it, nothing happens and a SDG `GemfireIndexException` is thrown wrapping the `IndexNameConflictException`. However, when the "definition" of the "existing" `Index` is different, then SDG will attempt to "_recreate_" the `Index` @@ -207,31 +207,31 @@ and make sure the `Index` definition matches your expectations and application r === How does `IndexNameConflictExceptions` actually happen? It is probably not all that uncommon for `IndexExistsExceptions` to be thrown, especially when -multiple configuration sources are used to configure GemFire (e.g. _Spring Data GemFire_, GemFire _Cluster Config_, -maybe GemFire native `cache.xml`, the API, etc, etc). You should definitely prefer 1 configuration method here +multiple configuration sources are used to configure Pivotal GemFire (e.g. _Spring Data for Pivotal GemFire_, Pivotal GemFire _Cluster Config_, +maybe Pivotal GemFire native `cache.xml`, the API, etc, etc). You should definitely prefer 1 configuration method here and stick with it. _However, when does an `IndexNameConflictException` get thrown?_ One particular case is an `Index` defined on a `PARTITION` _Region_ (PR). When an `Index` is defined on -a `PARTITION` _Region_ (e.g. "X"), GemFire distributes the `Index` definition (and name) to other peer members +a `PARTITION` _Region_ (e.g. "X"), Pivotal GemFire distributes the `Index` definition (and name) to other peer members in the cluster that also host the same `PARTITION` _Region_ (i.e. "X"). The distribution of this `Index` definition to and subsequent creation of this `Index` by peer members on a "need-to-know" basis (i.e. those hosting the same PR) is performed asynchronously. -During this window of time, it is possible that these "pending" PR `Indexes` will not be identifiable by GemFire, +During this window of time, it is possible that these "pending" PR `Indexes` will not be identifiable by Pivotal GemFire, such as with a call to http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/QueryService.html#getIndexes--[QueryService.getIndexes()] or with http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/QueryService.html#getIndexes-org.apache.geode.cache.Region-[QueryService.getIndexes(:Region)], or even with http://gemfire-90-javadocs.docs.pivotal.io/org/apache/geode/cache/query/QueryService.html#getIndex-org.apache.geode.cache.Region-java.lang.String-[QueryService.getIndex(:Region, indexName:String)]. -As such, the only way for SDG or other GemFire cache client applications (not involving _Spring_) to know for sure, +As such, the only way for SDG or other Pivotal GemFire cache client applications (not involving _Spring_) to know for sure, is to just attempt to create the `Index`. If it fails with either an `IndexNameConflictException`, or even an `IndexExistsException`, then you will know. This is because the `QueryService` `Index` creation waits on -"pending" `Index` definitions, where as the other GemFire API calls do not. +"pending" `Index` definitions, where as the other Pivotal GemFire API calls do not. In any case, SDG makes a best effort and attempts to inform the user what has or is happening along with -the corrective action. Given all GemFire `QueryService.createIndex(..)` methods are synchronous, "blocking" operations, -then the state of GemFire should be consistent and accessible after either of these Index-type _Exceptions_ are thrown, +the corrective action. Given all Pivotal GemFire `QueryService.createIndex(..)` methods are synchronous, "blocking" operations, +then the state of Pivotal GemFire should be consistent and accessible after either of these Index-type _Exceptions_ are thrown, in which case, SDG can inspect the state of the system and respond/act accordingly, based on the user's desired configuration. diff --git a/src/main/asciidoc/reference/introduction.adoc b/src/main/asciidoc/reference/introduction.adoc index 1d5a6a71..9c68ea85 100644 --- a/src/main/asciidoc/reference/introduction.adoc +++ b/src/main/asciidoc/reference/introduction.adoc @@ -1,24 +1,29 @@ [[ref-introduction]] = Document Structure -The following chapters explain the core functionality offered by _Spring Data GemFire_ for Pivotal GemFire. +The following chapters explain the core functionality offered by _Spring Data for Pivotal GemFire_. -<> describes the configuration support provided for bootstrapping, configuring, initializing -and accessing Pivotal GemFire Caches, Regions, and related Distributed System components. +<> describes the configuration support provided for configuring, initializing and accessing +Pivotal GemFire Caches, Regions, and other related Distributed System components. <> explains the integration between the Pivotal GemFire APIs and the various data access features -available in _Spring_, such as transaction management and exception translation. +available in _Spring_, such as data access, exception translation, transaction management and caching. -<> describes the enhancements for Pivotal GemFire (de)serialization and management of associated objects. +<> describes enhancements to Pivotal GemFire's (de)serialization of managed objects. <> describes persistence mapping for POJOs stored in Pivotal GemFire using _Spring Data_. -<> describes how to create and use _Spring Data Repositories_ to access data in Pivotal GemFire. +<> describes how to create and use _Spring Data Repositories_ to access data +stored in Pivotal GemFire using basic CRUD and simple query operations. -<> describes how to create and use Pivotal GemFire Functions using Annotations. +<> describes how to create and use Pivotal GemFire Functions using Annotations +to perform distributed computations where the data lives. + +<> describes how to use Pivotal GemFire's Continuous Query (CQ) functionality +to process a stream of events based on interest defined and registered using a Pivotal GemFire OQL query. <> describes how to bootstrap a _Spring_ `ApplicationContext` running in an Pivotal GemFire server using _Gfsh_. <> describes the examples provided with the distribution to illustrate the various features -available in _Spring Data GemFire_. +available in _Spring Data for Pivotal GemFire_. diff --git a/src/main/asciidoc/reference/lucene.adoc b/src/main/asciidoc/reference/lucene.adoc index b35ec9c7..a3eace43 100644 --- a/src/main/asciidoc/reference/lucene.adoc +++ b/src/main/asciidoc/reference/lucene.adoc @@ -74,7 +74,7 @@ inside a `@Configuration` class with... ---- @Bean(name = "Books") @DependsOn("bookTitleIndex") -PartitionedRegionFactoryBean booksRegion(GemFireCache gemfireCache) { +PartitionedRegionFactoryBean booksRegion(Pivotal GemFireCache gemfireCache) { PartitionedRegionFactoryBean peopleRegion = new PartitionedRegionFactoryBean<>(); @@ -87,7 +87,7 @@ PartitionedRegionFactoryBean booksRegion(GemFireCache gemfireCache) } @Bean -LuceneIndexFactoryBean bookTitleIndex(GemFireCache gemFireCache, +LuceneIndexFactoryBean bookTitleIndex(Pivotal GemFireCache gemFireCache, LuceneSerializer luceneSerializer) { LuceneIndexFactoryBean luceneIndex = new LuceneIndexFactoryBean(); @@ -243,7 +243,7 @@ If I define the following `LuceneIndex`... [source,java] ---- @Bean -LuceneIndexFactoryBean personLastNameIndex(GemFireCache gemfireCache) { +LuceneIndexFactoryBean personLastNameIndex(Pivotal GemFireCache gemfireCache) { LuceneIndexFactoryBean personLastNameIndex = new LuceneIndexFactoryBean(); diff --git a/src/main/asciidoc/reference/mapping.adoc b/src/main/asciidoc/reference/mapping.adoc index 1c95530d..baf4f124 100644 --- a/src/main/asciidoc/reference/mapping.adoc +++ b/src/main/asciidoc/reference/mapping.adoc @@ -4,10 +4,10 @@ [[mapping.entities]] == Entity Mapping -_Spring Data GemFire_ provides support to map entities that will be stored in a Region in the GemFire In-Memory Data Grid. +_Spring Data for Pivotal GemFire_ provides support to map entities that will be stored in a Region in the Pivotal GemFire In-Memory Data Grid. The mapping metadata is defined using annotations on application domain classes just like this: -.Mapping a domain class to a GemFire Region +.Mapping a domain class to a Pivotal GemFire Region ==== [source,java] ---- @@ -53,17 +53,17 @@ public class Guest extends User { } ---- -Be sure to use the full-path of the GemFire Region, as defined with the _Spring Data GemFire_ XML namespace +Be sure to use the full-path of the Pivotal GemFire Region, as defined with the _Spring Data for Pivotal GemFire_ XML namespace using the `id` or `name` attributes of the `<*-region>` element. [[mapping.entities.region]] === Entity Mapping by Region Type -In addition to the `@Region` annotation, _Spring Data GemFire_ also recognizes the Region type-specific +In addition to the `@Region` annotation, _Spring Data for Pivotal GemFire_ also recognizes the Region type-specific mapping annotations: `@ClientRegion`, `@LocalRegion`, `@PartitionRegion` and `@ReplicateRegion`. Functionally, these annotations are treated exactly the same as the generic `@Region` annotation in the SDG -mapping infrastructure. However, these additional mapping annotations are useful in _Spring Data GemFire's` +mapping infrastructure. However, these additional mapping annotations are useful in _Spring Data for Pivotal GemFire's` Annotation configuration model. When combined with the `@EnableEntityDefinedRegions` configuration annotation on _Spring_ `@Configuration` annotated class, it is possible to generate Regions in the local cache, whether the application is a client or peer. @@ -84,7 +84,7 @@ As an alternative to specifying the Region in which the entity will be stored us on the entity class, you can also specify the `@Region` annotation on the entity's `Repository`. See <> for more details. -However, let's say you want to store a `Person` in multiple GemFire Regions (e.g. `People` and `Customers`), +However, let's say you want to store a `Person` in multiple Pivotal GemFire Regions (e.g. `People` and `Customers`), then you can define your corresponding `Repository` interface extensions like so: [source,java] @@ -100,7 +100,7 @@ public interface CustomerRepository extends GemfireRepository { } ---- -Then, using each Repository individually, you can store the entity in multiple GemFire Regions. +Then, using each Repository individually, you can store the entity in multiple Pivotal GemFire Regions. [source,java] ---- @@ -124,7 +124,7 @@ either as a local cache transaction or a global transaction. [[mapping.pdx-serializer]] == Mapping PDX Serializer -_Spring Data GemFire_ provides a custom +_Spring Data for Pivotal GemFire_ provides a custom http://geode.apache.org/releases/latest/javadoc/org/apache/geode/pdx/PdxSerializer.html[PdxSerializer] implementation that uses the mapping information to customize entity serialization. Beyond that, it allows customizing the entity instantiation by using the Spring Data `EntityInstantiator` abstraction. By default the serializer diff --git a/src/main/asciidoc/reference/region.adoc b/src/main/asciidoc/reference/region.adoc index 6ed7abab..69ef213f 100644 --- a/src/main/asciidoc/reference/region.adoc +++ b/src/main/asciidoc/reference/region.adoc @@ -6,7 +6,7 @@ extending `java.util.Map` and enables basic data access using familiar key-value is wired into application classes that require it so the actual Region type is decoupled from the programming model. Typically, each Region is associated with one domain object, similar to a table in a relational database. -GemFire implements the following types of Regions: +Pivotal GemFire implements the following types of Regions: * *REPLICATE* - Data is replicated across all cache members that define the Region. This provides very high read performance but writes take longer to perform the replication. @@ -25,7 +25,7 @@ http://geode.apache.org/docs/guide/11/developing/region_options/region_types.htm [[bootstrap:region:lookup]] == Using an externally configured Region -To reference Regions already configured in a GemFire native `cache.xml` file, use the `lookup-region` element. +To reference Regions already configured in a Pivotal GemFire native `cache.xml` file, use the `lookup-region` element. Simply declare the target Region name with the `name` attribute. For example, to declare a bean definition identified as `ordersRegion` for an existing Region named `Orders`, you can use the following bean definition: @@ -61,7 +61,7 @@ the Region semantics or setup infrastructure. [[bootstrap:region:lookup:auto]] == Auto Region Lookup -"auto-lookup" allows all Regions defined in a GemFire native `cache.xml` file to be imported into a _Spring_ +"auto-lookup" allows all Regions defined in a Pivotal GemFire native `cache.xml` file to be imported into a _Spring_ application context when using the`cache-xml-location` attribute on the `` element. For instance, given a `cache.xml` file of... @@ -97,12 +97,12 @@ with: ---- -_Spring Data GemFire_ will automatically create beans for all GemFire Regions defined in `cache.xml` that have not been +_Spring Data for Pivotal GemFire_ will automatically create beans for all Pivotal GemFire Regions defined in `cache.xml` that have not been explicitly added to the _Spring_ context with explicit `` bean declarations. -It is important to realize that _Spring Data GemFire_ uses a _Spring_ +It is important to realize that _Spring Data for Pivotal GemFire_ uses a _Spring_ http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/beans/factory/config/BeanPostProcessor.html[BeanPostProcessor] -to post process the cache after it is both created and initialized to determine the Regions defined in GemFire to add +to post process the cache after it is both created and initialized to determine the Regions defined in Pivotal GemFire to add as beans in the _Spring_ application context. You may inject these "auto-looked-up" Regions like any other bean defined in the _Spring_ application context with @@ -137,13 +137,13 @@ If you are declaring your components using _Spring_ XML config, then you would d ---- -This ensures the GemFire cache and all the Regions defined in `cache.xml` get created before any components +This ensures the Pivotal GemFire cache and all the Regions defined in `cache.xml` get created before any components with auto-wire references when using the new `` element. [[bootstrap:region:overview]] == Configuring Regions -_Spring Data GemFire_ provides comprehensive support for configuring any type of Region via the following elements: +_Spring Data for Pivotal GemFire_ provides comprehensive support for configuring any type of Region via the following elements: * LOCAL Region: `` * PARTITION Region: `` @@ -166,8 +166,8 @@ The following table lists attributes available for all Region types: | Description | cache-ref -| GemFire Cache bean reference -| The name of the bean defining the GemFire Cache (by default 'gemfireCache'). +| Pivotal GemFire Cache bean reference +| The name of the bean defining the Pivotal GemFire Cache (by default 'gemfireCache'). | cloning-enabled | boolean, default:false @@ -182,7 +182,7 @@ The following table lists attributes available for all Region types: | Determines whether members perform checks to provide consistent handling for concurrent or out-of-order updates to distributed Regions. | data-policy -| See GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/DataPolicy.html[Data Policy] +| See Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/DataPolicy.html[Data Policy] | The Region's Data Policy. Note, not all Data Policies are supported for every Region type. | destroy @@ -297,7 +297,7 @@ mutually exclusive and using both in the same element will result in an exceptio .Bean Reference Conventions [NOTE] ==== -The `cache-listener` element is an example of a common pattern used in the namespace anywhere GemFire provides +The `cache-listener` element is an example of a common pattern used in the namespace anywhere Pivotal GemFire provides a callback interface to be implemented in order to invoke custom code in response to Cache or Region events. Using _Spring's_ IoC container, the implementation is a standard _Spring_ bean. In order to simplify the configuration, the schema allows a single occurrence of the `cache-listener` element, but it may contain nested bean references @@ -311,11 +311,11 @@ configuration example. === CacheLoaders and CacheWriters Similar to `cache-listener`, the namespace provides `cache-loader` and `cache-writer` elements to register -these GemFire components respectively for a Region. +these Pivotal GemFire components respectively for a Region. A `CacheLoader` is invoked on a cache miss to allow an entry to be loaded from an external data source, such as a database. A `CacheWriter` is invoked before an entry is created or updated, intended for synchronizing to -an external data source. The difference is GemFire only supports at most a single instance `CacheLoader` and `CacheWriter` +an external data source. The difference is Pivotal GemFire only supports at most a single instance `CacheLoader` and `CacheWriter` per Region. However, either declaration style may be used. Example: @@ -345,7 +345,7 @@ in the Pivotal GemFire documentation for more details. [[bootstrap:region:compression]] == Compression -GemFire Regions may also be compressed in order to reduce JVM memory consumption and pressure to possibly avoid +Pivotal GemFire Regions may also be compressed in order to reduce JVM memory consumption and pressure to possibly avoid stop the world GCs. When you enable compression for a Region, all values stored in the Region, in-memory are compressed while keys and indexes remain uncompressed. New values are compressed when put into Region and all values are decompressed automatically when read back from the Region. Values are not compressed when @@ -370,11 +370,11 @@ http://gemfire.docs.pivotal.io/geode/managing/region_compression/region_compress [[bootstrap:region:subregions]] == Subregions -_Spring Data GemFire_ also supports Subregions, allowing Regions to be arranged in a hierarchical relationship. +_Spring Data for Pivotal GemFire_ also supports Subregions, allowing Regions to be arranged in a hierarchical relationship. -For example, GemFire allows for a */Customer/Address* Region and a different */Employee/Address* Region. Additionally, +For example, Pivotal GemFire allows for a */Customer/Address* Region and a different */Employee/Address* Region. Additionally, a Subregion may have it's own Subregions and its own configuration. A Subregion does not inherit attributes from -the parent Region. Regions types may be mixed and matched subject to GemFire constraints. A Subregion is naturally +the parent Region. Regions types may be mixed and matched subject to Pivotal GemFire constraints. A Subregion is naturally declared as a child element of a Region. The Subregion's name attribute is the simple name. The above example might be configured as: @@ -399,11 +399,11 @@ OQL query strings. [[bootstrap:region:templates]] == Region Templates -_Spring Data GemFire_ also supports Region Templates. This feature allows developers to define common Region +_Spring Data for Pivotal GemFire_ also supports Region Templates. This feature allows developers to define common Region configuration settings and attributes once and reuse the configuration among many Region bean definitions declared in the _Spring_ application context. -_Spring Data GemFire_ includes 5 Region template tags in namespace: +_Spring Data for Pivotal GemFire_ includes 5 Region template tags in namespace: [cols="1,2", options="header"] .Region Template Tags @@ -481,7 +481,7 @@ Attributes and sub-elements defined in subsequent, inherited Region bean definit === How Templating Works -_Spring Data GemFire_ applies Region Templates when the _Spring_ application context configuration meta-data is *parsed*, +_Spring Data for Pivotal GemFire_ applies Region Templates when the _Spring_ application context configuration meta-data is *parsed*, and therefore, *must be declared in the order of inheritance*. In other words, parent templates must be defined before children. This ensures the proper configuration is applied, especially when element attributes or sub-elements are "overridden". @@ -495,14 +495,14 @@ NOTE: Region Templates are single-inheritance. === Caution concerning Regions, Subregions and Lookups Previously, one of the underlying properties of the `replicated-region`, `partitioned-region`, `local-region` -and `client-region` elements in the _Spring Data GemFire_ XML namespace was to perform a lookup first before +and `client-region` elements in the _Spring Data for Pivotal GemFire_ XML namespace was to perform a lookup first before attempting to create a Region. This was done in case the Region already existed, which would be the case -if the Region was defined in an imported GemFire native `cache.xml` configuration file. Therefore, the lookup +if the Region was defined in an imported Pivotal GemFire native `cache.xml` configuration file. Therefore, the lookup was performed first to avoid any errors. This was by design and subject to change. This behavior has been altered and the default behavior is now to create the Region first. If the Region already exists, then the creation logic fails-fast and an appropriate exception is thrown. However, much like the -`CREATE TABLE IF NOT EXISTS ...` DDL syntax, the _Spring Data GemFire_ `<*-region>` namespace elements now includes +`CREATE TABLE IF NOT EXISTS ...` DDL syntax, the _Spring Data for Pivotal GemFire_ `<*-region>` namespace elements now includes a `ignore-if-exists` attribute, which re-instates the old behavior by performing a lookup of an existing Region identified by name, first. If an existing Region by name is found and `ignore-if-exists` is set to `true`, then the Region bean definition defined in _Spring_ config is ignored. @@ -518,7 +518,7 @@ by the application. Even worse, the application developer may want to define th IMPORTANT: Recommended Practice - Only use `replicated-region`, `partitioned-region`, `local-region` and `client-region` namespace elements to define new Regions. -Consider the following native GemFire `cache.xml` configuration file... +Consider the following native Pivotal GemFire `cache.xml` configuration file... [source,xml] ---- @@ -608,9 +608,9 @@ Then the Region beans defined in the _Spring_ application context will consist o above (i.e. `@Resource(name = "Customers/Accounts"))` is now broken since no bean with name "Customers/Accounts" is actually defined. -GemFire is flexible in referencing both parent Regions and Subregions with or without the leading forward slash. +Pivotal GemFire is flexible in referencing both parent Regions and Subregions with or without the leading forward slash. For example, the parent can be referenced as "/Customers" or "Customers" and the child as "/Customers/Accounts" -or just "Customers/Accounts". However, _Spring Data _GemFire is very specific when it comes to naming beans after Regions, +or just "Customers/Accounts". However, _Spring Data _Pivotal GemFire is very specific when it comes to naming beans after Regions, typically always using the forward slash (/) to represent Subregions (e.g. "/Customers/Accounts"). Therefore, it is recommended that users either use the nested `lookup-region` syntax as shown above, @@ -624,18 +624,18 @@ or define direct references with a leading forward slash (/) like so... The example above where the nested `replicated-region` elements were used to reference the Subregions serves to illustrate the problem stated earlier. Are the Customers, Accounts and Orders Regions/Subregions persistent or not? -Not, since the Regions were defined in the native GemFire `cache.xml` configuration file as `REPLICATES` and will exist +Not, since the Regions were defined in the native Pivotal GemFire `cache.xml` configuration file as `REPLICATES` and will exist by the time the cache is initialized, or once the `` bean is processed. [[bootstrap:region:eviction]] == Data Eviction (with Overflow) Based on various constraints, each Region can have an eviction policy in place for evicting data from memory. -Currently, in GemFire, eviction applies to the _Least Recently Used_ entry (also known as +Currently, in Pivotal GemFire, eviction applies to the _Least Recently Used_ entry (also known as http://en.wikipedia.org/wiki/Cache_algorithms#Least_Recently_Used[LRU]). Evicted entries are either destroyed or paged to disk (referred to as *overflow* to disk). -_Spring Data GemFire_ supports all eviction policies (entry count, memory and heap usage) for PARTITION Regions, +_Spring Data for Pivotal GemFire_ supports all eviction policies (entry count, memory and heap usage) for PARTITION Regions, REPLICATE Regions and client, local Regions using the nested `eviction` element. For example, to configure a PARTITION Region to overflow to disk if the memory size exceeds more than 512 MB, @@ -649,12 +649,12 @@ a developer would specify the following configuration: ---- IMPORTANT: Replicas cannot use `local destroy` eviction since that would invalidate them. -See the GemFire docs for more information. +See the Pivotal GemFire docs for more information. When configuring Regions for overflow, it is recommended to configure the storage through the `disk-store` element for maximum efficiency. -For a detailed description of eviction policies, please refer to the GemFire documentation on +For a detailed description of eviction policies, please refer to the Pivotal GemFire documentation on http://geode.apache.org/docs/guide/11/developing/eviction/chapter_overview.html[Eviction]. [[bootstrap:region:expiration]] @@ -664,7 +664,7 @@ Pivotal GemFire allows you to control how long entries exist in the cache. Expir as opposed to Eviction, which is driven by the entry count or heap/memory usage. Once an entry expires it may no longer be accessed from the cache. -GemFire supports the following Expiration types: +Pivotal GemFire supports the following Expiration types: * *Time-to-Live (TTL)* - The amount of time in seconds that an object may remain in the cache after the last creation or update. For entries, the counter is set to zero for create and put operations. Region counters are reset when @@ -674,7 +674,7 @@ The Idle Timeout counter for an object is reset any time its TTL counter is rese _Idle Timeout_ counter is reset any time the entry is accessed through a get operation or a netSearch. The _Idle Timeout_ counter for a Region is reset whenever the _Idle Timeout_ is reset for one of its entries. -Each of these may be applied to the Region itself or entries in the Region. _Spring Data GemFire_ provides ``, +Each of these may be applied to the Region itself or entries in the Region. _Spring Data for Pivotal GemFire_ provides ``, ``, `` and `` Region child elements to specify timeout values and expiration actions. For example: @@ -687,13 +687,13 @@ For example: ---- -For a detailed description of expiration policies, please refer to the GemFire documentation on +For a detailed description of expiration policies, please refer to the Pivotal GemFire documentation on http://geode.apache.org/docs/guide/11/developing/expiration/chapter_overview.html[Expiration]. [[bootstrap:region:expiration:annotation]] === Annotation-based Data Expiration -With _Spring Data GemFire_, a developer has the ability to define Expiration policies and settings on individual +With _Spring Data for Pivotal GemFire_, a developer has the ability to define Expiration policies and settings on individual Region Entry values, or rather, application domain objects directly. For instance, a developer might define Expiration settings on a Session-based application domain object like so... @@ -727,7 +727,7 @@ Expiration types, such as TTL and TTI, are configured. [NOTE] ==== All @Expiration-based annotations apply only to Region Entry values. Expiration for a "Region" is not covered -by _Spring Data GemFire's_ Expiration annotation support. However, Pivotal GemFire and _Spring Data GemFire_ do allow you +by _Spring Data for Pivotal GemFire's_ Expiration annotation support. However, Pivotal GemFire and _Spring Data for Pivotal GemFire_ do allow you to set Region Expiration using the SDG XML namespace, like so... [source,xml] @@ -739,16 +739,16 @@ to set Region Expiration using the SDG XML namespace, like so... ---- ==== -_Spring Data GemFire's_ `@Expiration` annotation support is implemented with GemFire's +_Spring Data for Pivotal GemFire's_ `@Expiration` annotation support is implemented with Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/CustomExpiry.html[`CustomExpiry`] interface. -Refer to GemFire's documentation on http://geode.apache.org/docs/guide/11/developing/expiration/configuring_data_expiration.html[Configuring Data Expiration] +Refer to Pivotal GemFire's documentation on http://geode.apache.org/docs/guide/11/developing/expiration/configuring_data_expiration.html[Configuring Data Expiration] for more details -The _Spring Data GemFire_ `AnnotationBasedExpiration` class (and `CustomExpiry` implementation) is responsible +The _Spring Data for Pivotal GemFire_ `AnnotationBasedExpiration` class (and `CustomExpiry` implementation) is responsible for processing the SDG `@Expiration` annotations and applying the Expiration policy and settings appropriately for Region Entry Expiration on request. -To use _Spring Data GemFire_ to configure specific GemFire Regions to appropriately apply the Expiration policy +To use _Spring Data for Pivotal GemFire_ to configure specific Pivotal GemFire Regions to appropriately apply the Expiration policy and settings applied to your application domain objects annotated with `@Expiration`-based annotations, you must... 1. Define a bean in the _Spring_ `ApplicationContext` of type `AnnotationBasedExpiration` using the appropriate @@ -773,11 +773,11 @@ along with the `` element to set TTI. ==== 2. (optional) Annotate your application domain objects that will be stored in the Region with Expiration policies -and custom settings using one of _Spring Data GemFire's_ `@Expiration` annotations: `@Expiration`, +and custom settings using one of _Spring Data for Pivotal GemFire's_ `@Expiration` annotations: `@Expiration`, `@IdleTimeoutExpiration` and/or `@TimeToLiveExpiration` -3. (optional) In cases where particular application domain objects have not been annotated with _Spring Data GemFire's_ -`@Expiration` annotations at all, but the GemFire Region is configured to use SDG's custom `AnnotationBasedExpiration` +3. (optional) In cases where particular application domain objects have not been annotated with _Spring Data for Pivotal GemFire's_ +`@Expiration` annotations at all, but the Pivotal GemFire Region is configured to use SDG's custom `AnnotationBasedExpiration` class to determine the Expiration policy and settings for objects stored in the Region, then it is possible to set "default" Expiration attributes on the `AnnotationBasedExpiration` bean by doing the following... @@ -798,11 +798,11 @@ class to determine the Expiration policy and settings for objects stored in the ---- -You may have noticed that _Spring Data GemFire's_ `@Expiration` annotations use a String as the attributes type rather +You may have noticed that _Spring Data for Pivotal GemFire's_ `@Expiration` annotations use a String as the attributes type rather than, and perhaps more appropriately, being strongly typed, i.e. `int` for 'timeout' and SDG'S `ExpirationActionType` for 'action'. Why is that? -Well, enter one of _Spring Data GemFire's_ other features, leveraging _Spring's_ core infrastructure +Well, enter one of _Spring Data for Pivotal GemFire's_ other features, leveraging _Spring's_ core infrastructure for configuration convenience: _Property Placeholders_ and _Spring Expression Language_ (SpEL). For instance, a developer can specify both the Expiration 'timeout' and 'action' using _Property Placeholders_ @@ -866,18 +866,18 @@ instance of `java.util.Properties`. In this example, even the Properties (`expir the action value on the actual Expiration action enumerated type leading to more quickly identified failures if the types ever change. -All of this has been demonstrated and tested in the _Spring Data GemFire_ test suite, by way of example. See the +All of this has been demonstrated and tested in the _Spring Data for Pivotal GemFire_ test suite, by way of example. See the https://github.com/spring-projects/spring-data-geode[source] for further details. [[bootstrap:region:persistence]] == Data Persistence -Regions can be persistent. GemFire ensures that all the data you put into a Region that is configured for persistence +Regions can be persistent. Pivotal GemFire ensures that all the data you put into a Region that is configured for persistence will be written to disk in a way that is recoverable the next time you recreate the Region. This allows data to be recovered after machine or process failure, or even after an orderly shutdown and subsequent restart of -the GemFire data node. +the Pivotal GemFire data node. -To enable persistence with _Spring Data GemFire_, simply set the `persistent` attribute to `true` on +To enable persistence with _Spring Data for Pivotal GemFire_, simply set the `persistent` attribute to `true` on any of the `<*-region>` elements. For example... [source,xml] @@ -886,7 +886,7 @@ any of the `<*-region>` elements. For example... ---- Persistence may also be configured using the `data-policy` attribute; set the attribute's value to one of -http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/DataPolicy.html[GemFire's DataPolicy settings]. +http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/DataPolicy.html[Pivotal GemFire's DataPolicy settings]. For example... [source,xml] @@ -913,8 +913,8 @@ This is discussed further in <> [[bootstrap:region:subscription]] == Subscription Policy -GemFire allows configuration of http://geode.apache.org/docs/guide/11/developing/events/configure_p2p_event_messaging.html[peer-to-peer (P2P) event messaging] -to control the entry events that the Region will receive. _Spring Data GemFire_ provides the `` +Pivotal GemFire allows configuration of http://geode.apache.org/docs/guide/11/developing/events/configure_p2p_event_messaging.html[peer-to-peer (P2P) event messaging] +to control the entry events that the Region will receive. _Spring Data for Pivotal GemFire_ provides the `` sub-element to set the subscription policy on REPLICATE and PARTITION Regions to either `ALL` or `CACHE_CONTENT`. [source,xml] @@ -927,11 +927,11 @@ sub-element to set the subscription policy on REPLICATE and PARTITION Regions to [[bootstrap:region:local]] == Local Region -_Spring Data GemFire_ offers a dedicated `local-region` element for creating local Regions. Local Regions, as the name +_Spring Data for Pivotal GemFire_ offers a dedicated `local-region` element for creating local Regions. Local Regions, as the name implies, are standalone, meaning they do not share data with any other distributed system member. Other than that, all common Region configuration options apply. -A minimal declaration looks as follows (again, the example relies on the _Spring Data GemFire_ namespace +A minimal declaration looks as follows (again, the example relies on the _Spring Data for Pivotal GemFire_ namespace naming conventions to wire the cache): [source,xml] @@ -940,7 +940,7 @@ naming conventions to wire the cache): ---- Here, a local Region is created (if one doesn't exist already). The name of the Region is the same as the bean id -(`exampleLocalRegion`) and the bean assumes the existence of a GemFire cache named `gemfireCache`. +(`exampleLocalRegion`) and the bean assumes the existence of a Pivotal GemFire cache named `gemfireCache`. [[bootstrap:region:replicate]] == Replicated Region @@ -951,7 +951,7 @@ a REPLICATE Region is distributed to all copies of the Region. When a _replica_ an initialization stage in which it discovers other _replicas_ and automatically copies all the entries. While one _replica_ is initializing you can still continue to use the other _replica_. -_Spring Data GemFire_ offers a `replicated-region` element. A minimal declaration looks as follows. +_Spring Data for Pivotal GemFire_ offers a `replicated-region` element. A minimal declaration looks as follows. All common configuration options are available for REPLICATE Regions. [source,xml] @@ -959,22 +959,22 @@ All common configuration options are available for REPLICATE Regions. ---- -Refer to GemFire's documentation on +Refer to Pivotal GemFire's documentation on http://geode.apache.org/docs/guide/11/developing/distributed_regions/chapter_overview.html[Distributed and Replicated Regions] for more details. [[bootstrap:region:partition]] == Partitioned Region -Another Region type supported out-of-the-box by the _Spring Data GemFire_ namespace is the PARTITION Region. +Another Region type supported out-of-the-box by the _Spring Data for Pivotal GemFire_ namespace is the PARTITION Region. -To quote the GemFire docs: +To quote the Pivotal GemFire docs: "A partitioned region is a region where data is divided between peer servers hosting the region so that each peer stores a subset of the data. When using a partitioned region, applications are presented with a logical view of the region that looks like a single map containing all of the data in the region. Reads or writes to this map are transparently routed to the peer that hosts the entry that is the target of -the operation. GemFire divides the domain of hashcodes into buckets. Each bucket is assigned to a specific peer, +the operation. Pivotal GemFire divides the domain of hashcodes into buckets. Each bucket is assigned to a specific peer, but may be relocated at any time to another peer in order to improve the utilization of resources across the cluster." A partition is created using the `partitioned-region` element. Its configuration options are similar to that of @@ -992,7 +992,7 @@ Below is a quick example on setting up a PARTITION Region with 2 redundant copie ---- -Refer to GemFire's documentation on +Refer to Pivotal GemFire's documentation on http://geode.apache.org/docs/guide/11/developing/partitioned_regions/chapter_overview.html[Partitioned Regions] for more details. @@ -1049,12 +1049,12 @@ immediately when a new member is added. [[bootstrap:region:client]] == Client Region -Pivotal GemFire supports various deployment topologies for managing and distributing data. GemFire topologies is outside -the scope of this documentation. However, to quickly recap, GemFire's supported topologies can be classified in short as: +Pivotal GemFire supports various deployment topologies for managing and distributing data. Pivotal GemFire topologies is outside +the scope of this documentation. However, to quickly recap, Pivotal GemFire's supported topologies can be classified in short as: _peer-to-peer_ (p2p), _client-server_, and _wide area network_ (WAN). In the last two configurations, it is common to declare *client* Regions which connect to a cache server. -_Spring Data GemFire_ offers dedicated support for such configuration through <>, +_Spring Data for Pivotal GemFire_ offers dedicated support for such configuration through <>, `client-region` and `pool` elements. As the names imply, the former defines a client Region while the latter defines a Pool of connections to be used/shared by the various client Regions. @@ -1089,14 +1089,14 @@ cache servers and peer data members in the distributed system and are recommende possible to configure the Pool to connect directly to one or more cache servers using the `server` element. For a full list of options to set on the client and especially on the Pool, please refer to -the _Spring Data GemFire_ schema (<>) and GemFire's documentation on +the _Spring Data for Pivotal GemFire_ schema (<>) and Pivotal GemFire's documentation on http://geode.apache.org/docs/guide/11/topologies_and_comm/cs_configuration/chapter_overview.html[Client/Server Configuration]. [[bootstrap:region:client:interests]] === Client Interests -To minimize network traffic, each client can separately define its own 'interests' policies, indicating to GemFire -the data it actually requires. In _Spring Data GemFire_, 'interests' can be defined for each client Region separately. +To minimize network traffic, each client can separately define its own 'interests' policies, indicating to Pivotal GemFire +the data it actually requires. In _Spring Data for Pivotal GemFire_, 'interests' can be defined for each client Region separately. Both Key-based and Regular Expression-based interest types are supported. For example: @@ -1193,12 +1193,12 @@ for more details. == JSON Support Pivotal GemFire has support for caching JSON documents in Regions along with the ability to query stored JSON documents -using the GemFire OQL. JSON documents are stored internally as +using the Pivotal GemFire OQL. JSON documents are stored internally as http://geode.apache.org/releases/latest/javadoc/org/apache/geode/pdx/PdxInstance.html[PdxInstance] types using the http://geode.apache.org/releases/latest/javadoc/org/apache/geode/pdx/JSONFormatter.html[JSONFormatter] class to perform conversion to and from JSON documents (as a `String`). -_Spring Data GemFire_ provides the `` element to enable a +_Spring Data for Pivotal GemFire_ provides the `` element to enable a http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#aop-introduction[AOP, _Spring_] component to advise appropriate, proxied Region operations, which effectively encapsulates the `JSONFormatter`, thereby allowing your applications to work directly with JSON Strings. @@ -1215,7 +1215,7 @@ configured Regions. This is done by creating a parallel data structure in local significant overhead for large collections, so set the `convert-returned-collections` to *false* if you would like to disable automatic conversion for these Region operations. -NOTE: Certain Region operations, specifically those that use GemFire's proprietary `Region.Entry` such as: +NOTE: Certain Region operations, specifically those that use Pivotal GemFire's proprietary `Region.Entry` such as: `entries(boolean)`, `entrySet(boolean)` and `getEntry()` type are not targeted for AOP advice. In addition, the `entrySet()` method which returns a `Set>` is also not affected. diff --git a/src/main/asciidoc/reference/repositories.adoc b/src/main/asciidoc/reference/repositories.adoc index 27a5f83f..9a3c8ecd 100644 --- a/src/main/asciidoc/reference/repositories.adoc +++ b/src/main/asciidoc/reference/repositories.adoc @@ -1,19 +1,19 @@ [[gemfire-repositories]] -= Spring Data GemFire Repositories += Spring Data for Pivotal GemFire Repositories == Introduction -_Spring Data GemFire_ provides support to use the _Spring Data Repository_ abstraction to easily persist entities -into GemFire along with execute queries. A general introduction to the _Repository programming model_ is provided +_Spring Data for Pivotal GemFire_ provides support to use the _Spring Data Repository_ abstraction to easily persist entities +into Pivotal GemFire along with execute queries. A general introduction to the _Repository programming model_ is provided http://docs.spring.io/spring-data/data-commons/docs/current/reference/html/#repositories[here]. [[gemfire-repositories.spring-configuration-xml]] == Spring XML Configuration -To bootstrap _Spring Data Repositories_, you use the `` element from the _Spring Data GemFire_ +To bootstrap _Spring Data Repositories_, you use the `` element from the _Spring Data for Pivotal GemFire_ Data namespace: -.Bootstrap Spring Data GemFire Repositories in XML +.Bootstrap Spring Data for Pivotal GemFire Repositories in XML ==== [source,xml] ---- @@ -31,7 +31,7 @@ Data namespace: ==== This configuration snippet looks for interfaces below the configured base package and creates _Repository_ instances -for those interfaces backed by a `SimpleGemFireRepository`. +for those interfaces backed by a `SimplePivotal GemFireRepository`. IMPORTANT: You must have your application domain classes correctly mapped to configured Regions or the bootstrap process will fail otherwise. @@ -45,7 +45,7 @@ https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html# Using this approach, it is a simple matter to bootstrap _Spring Data Repositories_ using the SDG `@EnableGemfireRepositories` annotation: -.Bootstrap _Spring Data GemFire Repositories_ with `@EnableGemfireRepositories` +.Bootstrap _Spring Data for Pivotal GemFire Repositories_ with `@EnableGemfireRepositories` ==== [source, java] ---- @@ -85,7 +85,7 @@ not provided out-of-the-box (OOTB) by the data store (e.g. SDG). One example of where custom _Repository_ implementations are needed with Pivotal GemFire is when performing _Joins_. _Joins_ are not supported by SDG _Repositories_ OOTB. With a Pivotal GemFire `PARTITION` Region, the _Join_ must be performed on collocated `PARTITION` Regions even, since Pivotal GemFire does not support "distributed" _Joins_. -In addition, the _Equi-Join_ OQL Query must be performed inside a GemFire Function. +In addition, the _Equi-Join_ OQL Query must be performed inside a Pivotal GemFire Function. See http://gemfire91.docs.pivotal.io/geode/developing/partitioned_regions/join_query_partitioned_regions.html[here] for more details on Pivotal GemFire _Equi-Join Queries_. @@ -96,7 +96,7 @@ for more details on all configuration settings. [[gemfire-repositories.queries.executing]] == Executing OQL Queries -_Spring Data GemFire Repositories_ enable the definition of query methods to easily execute GemFire OQL Queries +_Spring Data for Pivotal GemFire Repositories_ enable the definition of query methods to easily execute Pivotal GemFire OQL Queries against the Region the managed entity is mapped to. .Sample Repository @@ -207,20 +207,20 @@ for application development today. Technically, this means developers can acces supported by _Spring Data Commons_ within their applications by reusing their existing application-specific Repository interfaces, a very convenient and powerful abstraction. -To support GemFire's OQL Query language extensions and preserve portability across different data stores, -_Spring Data GemFire_ adds support for OQL Query extensions using Java Annotations. These Annotations will be ignored +To support Pivotal GemFire's OQL Query language extensions and preserve portability across different data stores, +_Spring Data for Pivotal GemFire_ adds support for OQL Query extensions using Java Annotations. These Annotations will be ignored by other _Spring Data Repository_ implementations (e.g. _Spring Data_ JPA or _Spring Data Redis_) that do not have similar query language extensions. -For instance, many data stores will most likely not implement GemFire's OQL `IMPORT` keyword. By implementing `IMPORT` +For instance, many data stores will most likely not implement Pivotal GemFire's OQL `IMPORT` keyword. By implementing `IMPORT` as an Annotation (i.e. `@Import`) rather than as part of the query method signature (specifically, the method 'name'), then this will not interfere with the parsing infrastructure when evaluating the query method name to construct another data store language appropriate query. -Currently, the set of GemFire OQL Query language extensions that are supported by _Spring Data GemFire_ include: +Currently, the set of Pivotal GemFire OQL Query language extensions that are supported by _Spring Data for Pivotal GemFire_ include: [cols="1,2,2,2", options="header"] -.Supported GemFire OQL extensions for Repository query methods +.Supported Pivotal GemFire OQL extensions for Repository query methods |=== | Keyword | Annotation @@ -248,7 +248,7 @@ Currently, the set of GemFire OQL Query language extensions that are supported b | NA |=== -As an example, suppose you have a `Customers` application domain class and corresponding GemFire Region along with a +As an example, suppose you have a `Customers` application domain class and corresponding Pivotal GemFire Region along with a `CustomerRepository` and a query method to lookup `Customers` by last name, like so... .Sample Customers Repository @@ -295,7 +295,7 @@ This will result in the following OQL Query: ` IMPORT org.example.app.domain.Customer; SELECT * FROM /Customers x WHERE x.lastName = $1 LIMIT 10` -_Spring Data GemFire's Repository_ extension and support is careful not to create conflicting declarations when +_Spring Data for Pivotal GemFire's Repository_ extension and support is careful not to create conflicting declarations when the OQL Annotation extensions are used in combination with the `@Query` annotation. As another example, suppose you have a raw `@Query` annotated query method defined in your `CustomerRepository` @@ -342,7 +342,7 @@ Using the Spring Data _Repository_ abstraction, query method convention for defi (e.g. OQL) is easy and convenient. However, it is sometimes desirable to still want to inspect or even possibly modify the query "generated" from the _Repository_ query method. -Since 2.0.x, _Spring Data GemFire_ introduces the `o.s.d.gemfire.repository.query.QueryPostProcessor` +Since 2.0.x, _Spring Data for Pivotal GemFire_ introduces the `o.s.d.gemfire.repository.query.QueryPostProcessor` functional interface. The interface is loosely defined as follows... .QueryPostProcessor @@ -378,7 +378,7 @@ and used to create a pipeline of processing for a group of generated query metho Finally, the `QueryPostProcessor` accepts type arguments corresponding to the type parameters, `T` and `QUERY`, respectively. Type of `T` extends the _Spring Data Commons_ marker interface, https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/Repository.html[`org.springframework.data.repository.Repository`]. -We will discuss this further below. All `QUERY` type parameter arguments in _Spring Data GemFire's_ case +We will discuss this further below. All `QUERY` type parameter arguments in _Spring Data for Pivotal GemFire's_ case will be of type `java.lang.String`. NOTE: It is useful to define the query as type `QUERY` since this `QueryPostProcessor` interface maybe ported to @@ -478,7 +478,7 @@ class OrderedLimitedCustomerByLastNameQueryPostProcessor implements QueryPostPro ==== While this works, it possible to achieve the same affect just using the Spring Data _Repository_ convention and extensions -provided by _Spring Data GemFire_. For instance, the same query could be defined as... +provided by _Spring Data for Pivotal GemFire_. For instance, the same query could be defined as... .CustomerRepository using the convention ==== diff --git a/src/main/asciidoc/reference/samples.adoc b/src/main/asciidoc/reference/samples.adoc index e4b7e0c6..73b2461a 100644 --- a/src/main/asciidoc/reference/samples.adoc +++ b/src/main/asciidoc/reference/samples.adoc @@ -2,12 +2,12 @@ = Sample Applications NOTE: Sample applications are now maintained in the -https://github.com/spring-projects/spring-gemfire-examples[Spring GemFire Examples] repository. +https://github.com/spring-projects/spring-gemfire-examples[Spring Pivotal GemFire Examples] repository. -The _Spring Data GemFire_ project also includes one sample application. Named "Hello World", the sample application +The _Spring Data for Pivotal GemFire_ project also includes one sample application. Named "Hello World", the sample application demonstrates how to configure and use Pivotal GemFire inside a _Spring_ application. At runtime, the sample offers a *shell* to the user allowing her to run various commands against the data grid. It provides an excellent -starting point for users unfamiliar with the essential components or with _Spring_ and GemFire concepts. +starting point for users unfamiliar with the essential components or with _Spring_ and Pivotal GemFire concepts. The sample is bundled with the distribution and is Maven-based. A developer can easily import them into any Maven-aware IDE (such as https://spring.io/tools/sts[Spring Tool Suite]) or run them from the command-line. @@ -15,13 +15,13 @@ Maven-aware IDE (such as https://spring.io/tools/sts[Spring Tool Suite]) or run [[samples:hello-world]] == Hello World -The Hello World sample application demonstrates the core functionality of the _Spring Data GemFire_ project. -It bootstraps GemFire, configures it, executes arbitrary commands against the cache and shuts it down +The Hello World sample application demonstrates the core functionality of the _Spring Data for Pivotal GemFire_ project. +It bootstraps Pivotal GemFire, configures it, executes arbitrary commands against the cache and shuts it down when the application exits. Multiple instances of the application can be started at the same time and they will work together, sharing data without any user intervention. .Running under Linux -NOTE: If you experience networking problems when starting GemFire or the samples, try adding the following +NOTE: If you experience networking problems when starting Pivotal GemFire or the samples, try adding the following system property `java.net.preferIPv4Stack=true` to the command line (e.g. `-Djava.net.preferIPv4Stack=true`). For an alternative (global) fix especially on Ubuntu see https://jira.spring.io/browse/SGF-28[SGF-28]. @@ -44,7 +44,7 @@ The output will likely look as follows: [source] ---- -INFO: Created GemFire Cache [Spring GemFire World] v. X.Y.Z +INFO: Created Pivotal GemFire Cache [Spring Pivotal GemFire World] v. X.Y.Z INFO: Created new cache region [myWorld] INFO: Member xxxxxx:50694/51611 connecting to region [myWorld] Hello World! @@ -81,7 +81,7 @@ and its information: [source] ---- -INFO: Connected to Distributed System ['Spring GemFire World'=xxxx:56218/49320@yyyyy] +INFO: Connected to Distributed System ['Spring Pivotal GemFire World'=xxxx:56218/49320@yyyyy] Hello World! ... @@ -107,7 +107,7 @@ http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/ for _Spring_ http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#beans-annotation-config[components]. -The cache configuration defines the GemFire cache, Region and for illustrative purposes, a simple `CacheListener` +The cache configuration defines the Pivotal GemFire cache, Region and for illustrative purposes, a simple `CacheListener` that acts as a logger. The main *beans* are `HelloWorld` and `CommandProcessor` which rely on the `GemfireTemplate` to interact with diff --git a/src/main/asciidoc/reference/serialization.adoc b/src/main/asciidoc/reference/serialization.adoc index cacc2ef3..ba8c26b6 100644 --- a/src/main/asciidoc/reference/serialization.adoc +++ b/src/main/asciidoc/reference/serialization.adoc @@ -1,7 +1,7 @@ [[serialization]] = Working with Pivotal GemFire Serialization -To improve overall performance of the Pivotal GemFire In-memory Data Grid, GemFire supports a dedicated +To improve overall performance of the Pivotal GemFire In-memory Data Grid, Pivotal GemFire supports a dedicated serialization protocol, called PDX, that is both faster and offers more compact results over standard Java serialization in addition to works transparently across various language platforms (Java, C++, .NET). Please refer to @@ -10,7 +10,7 @@ and https://cwiki.apache.org/confluence/display/GEODE/PDX+Serialization+Internals[PDX Serialization Internals] for more details. -This chapter discusses the various ways in which _Spring Data GemFire_ simplifies and improves GemFire's +This chapter discusses the various ways in which _Spring Data for Pivotal GemFire_ simplifies and improves Pivotal GemFire's custom serialization in Java. [[serialization:wiring]] @@ -19,9 +19,9 @@ custom serialization in Java. It is fairly common for serialized objects to have transient data. Transient data is often dependent on the system or environment where it lives at a certain point in time. For instance, a `DataSource` is environment specific. Serializing such information is useless, and potentially even dangerous, since it is local to a certain VM/machine. -For such cases, _Spring Data GemFire_ offers a special +For such cases, _Spring Data for Pivotal GemFire_ offers a special http://geode.apache.org/releases/latest/javadoc/org/apache/geode/Instantiator.html[`Instantiator`] -that performs wiring for each new instance created by GemFire during deserialization. +that performs wiring for each new instance created by Pivotal GemFire during deserialization. Through such a mechanism, one can rely on the _Spring_ container to inject and manage certain dependencies making it easy to split transient from persistent data and have *rich domain objects* in a transparent manner. @@ -46,16 +46,16 @@ To use this SDG `Instantiator`, simply declare it as a bean: ---- During the _Spring_ container startup, once it is being initialized, the `Instantiator` will, by default, register -itself with the GemFire serialization system and perform wiring on all instances of `SomeDataSerializableClass` -created by GemFire during deserialization. +itself with the Pivotal GemFire serialization system and perform wiring on all instances of `SomeDataSerializableClass` +created by Pivotal GemFire during deserialization. [[serialization:instance-generator]] == Auto-generating custom `Instantiators` For data intensive applications, a large number of instances might be created on each machine as data flows in. -Out-of-the-box, GemFire uses reflection to create new types, but for some scenarios, this might prove to be expensive. +Out-of-the-box, Pivotal GemFire uses reflection to create new types, but for some scenarios, this might prove to be expensive. As always, it is good to perform profiling to quantify whether this is the case or not. For such cases, -_Spring Data GemFire_ allows the automatic generation of `Instatiator` classes which instantiate a new type +_Spring Data for Pivotal GemFire_ allows the automatic generation of `Instatiator` classes which instantiate a new type (using the default constructor) without the use of reflection: [source,xml] @@ -71,5 +71,5 @@ _Spring Data GemFire_ allows the automatic generation of `Instatiator` classes w ---- The definition above, automatically generates two `Instantiators` for two classes, namely `CustomTypeA` -and `CustomTypeB` and registers them with GemFire, under user id `1025` and `1026`. The two `Instantiators` avoid +and `CustomTypeB` and registers them with Pivotal GemFire, under user id `1025` and `1026`. The two `Instantiators` avoid the use of reflection and create the instances directly through Java code. diff --git a/src/main/asciidoc/reference/snapshot.adoc b/src/main/asciidoc/reference/snapshot.adoc index c4ce8815..303adf72 100644 --- a/src/main/asciidoc/reference/snapshot.adoc +++ b/src/main/asciidoc/reference/snapshot.adoc @@ -1,9 +1,9 @@ [[bootstrap:snapshot]] = Configuring the Snapshot Service -_Spring Data GemFire_ supports `Cache` and `Region` snapshots using +_Spring Data for Pivotal GemFire_ supports `Cache` and `Region` snapshots using http://geode.apache.org/docs/guide/11/managing/cache_snapshots/chapter_overview.html[Pivotal GemFire's Snapshot Service]. -The out-of-the-box Snapshot Service support offers several convenient features to simplify the use of GemFire's +The out-of-the-box Snapshot Service support offers several convenient features to simplify the use of Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/CacheSnapshotService.html[Cache] and http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/RegionSnapshotService.html[Region] Snapshot Service APIs. @@ -11,11 +11,11 @@ Snapshot Service APIs. As the http://geode.apache.org/docs/guide/11/managing/cache_snapshots/chapter_overview.html[Pivotal GemFire documentation] describes, snapshots allow you to save and subsequently reload the cached data later, which can be useful for moving data between environments, such as from production to a staging or test environment in order to reproduce -data-related issues in a controlled context. You can imagine combining _Spring Data GemFire's_ Snapshot Service support +data-related issues in a controlled context. You can imagine combining _Spring Data for Pivotal GemFire's_ Snapshot Service support with http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#beans-definition-profiles[Spring's bean definition profiles] to load snapshot data specific to the environment as necessary. -_Spring Data GemFire's_ support for Pivotal GemFire's Snapshot Service begins with the `` element +_Spring Data for Pivotal GemFire's_ support for Pivotal GemFire's Snapshot Service begins with the `` element from the `` namespace. For example, I might want to define Cache-wide snapshots to be loaded as well as saved using a couple snapshot imports @@ -32,10 +32,10 @@ and a data export definition as follows: ---- You can define as many imports and/or exports as you like. You can define just imports or just exports. -The file locations and directory paths can be absolute, or relative to the _Spring Data GemFire_ application, +The file locations and directory paths can be absolute, or relative to the _Spring Data for Pivotal GemFire_ application, JVM process's working directory. -This is a pretty simple example and the Snapshot Service defined in this case refers to the GemFire `Cache` with +This is a pretty simple example and the Snapshot Service defined in this case refers to the Pivotal GemFire `Cache` with the default name of `gemfireCache` (as described in <>). If you name your cache bean definition something other than the default, than you can use the `cache-ref` attribute to refer to the cache bean by name: @@ -48,7 +48,7 @@ something other than the default, than you can use the `cache-ref` attribute to ---- -It is also straightforward to define a Snapshot Service for a particular GemFire Region by specifying +It is also straightforward to define a Snapshot Service for a particular Pivotal GemFire Region by specifying the `region-ref` attribute: [source,xml] @@ -61,17 +61,17 @@ the `region-ref` attribute: ---- -When the `region-ref` attribute is specified, _Spring Data GemFire's_ `SnapshotServiceFactoryBean` resolves +When the `region-ref` attribute is specified, _Spring Data for Pivotal GemFire's_ `SnapshotServiceFactoryBean` resolves the `region-ref` attribute value to a Region bean defined in the _Spring_ context and proceeds to create a http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/RegionSnapshotService.html[RegionSnapshotService]. The snapshot import and export definitions function the same way, however, the `location` must refer to a file on export. -NOTE: GemFire is strict about imported snapshot files actually existing before they are referenced. For exports, -GemFire will create the snapshot file if it does not already exist. If the snapshot file for export already exists, +NOTE: Pivotal GemFire is strict about imported snapshot files actually existing before they are referenced. For exports, +Pivotal GemFire will create the snapshot file if it does not already exist. If the snapshot file for export already exists, the data will be overwritten. -TIP: _Spring Data GemFire_ includes a `suppress-import-on-init` attribute on the `` element +TIP: _Spring Data for Pivotal GemFire_ includes a `suppress-import-on-init` attribute on the `` element to suppress the configured Snapshot Service from trying to import data into the Cache or Region on initialization. This is useful when data exported from 1 Region is used to feed the import of another Region, for example. @@ -86,13 +86,13 @@ http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/ method in the `CacheSnapshotService` API indicates. NOTE: Of course, a developer may use the other, overloaded `load(:File[], :SnapshotFormat, :SnapshotOptions)` method -variant to get specific about which snapshot files are to be loaded into the GemFire `Cache`. +variant to get specific about which snapshot files are to be loaded into the Pivotal GemFire `Cache`. -However, _Spring Data GemFire_ recognizes that a typical developer workflow might be to extract and export data +However, _Spring Data for Pivotal GemFire_ recognizes that a typical developer workflow might be to extract and export data from one environment into several snapshot files, zip all of them up, and then conveniently move the ZIP file to another environment for import. -Therefore, _Spring Data GemFire_ enables the developer to specify a JAR or ZIP file on import for a `Cache`-based +Therefore, _Spring Data for Pivotal GemFire_ enables the developer to specify a JAR or ZIP file on import for a `Cache`-based Snapshot Service as follows: [source,xml] @@ -102,7 +102,7 @@ Snapshot Service as follows: ---- -_Spring Data GemFire_ will conveniently extract the provided ZIP file and treat it like a directory import (load). +_Spring Data for Pivotal GemFire_ will conveniently extract the provided ZIP file and treat it like a directory import (load). [[bootstrap:snapshot:filters]] == Snapshot Filters @@ -113,7 +113,7 @@ http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/ interface and are used to filter Region entries for inclusion into the Region on import and for inclusion into the snapshot on export. -_Spring Data GemFire_ makes it brain dead simple to utilize snapshot filters on import and export using the `filter-ref` +_Spring Data for Pivotal GemFire_ makes it brain dead simple to utilize snapshot filters on import and export using the `filter-ref` attribute or an anonymous, nested bean definition: [source,xml] @@ -140,8 +140,8 @@ attribute or an anonymous, nested bean definition: ---- -In addition, more complex snapshot filters can be expressed with the `ComposableSnapshotFilter` _Spring Data GemFire_ -provided class. This class implements GemFire's +In addition, more complex snapshot filters can be expressed with the `ComposableSnapshotFilter` _Spring Data for Pivotal GemFire_ +provided class. This class implements Pivotal GemFire's http://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/snapshot/SnapshotFilter.html[SnapshotFilter] interface as well as the https://en.wikipedia.org/wiki/Composite_pattern[Composite] software design pattern. @@ -189,15 +189,15 @@ The developer could then go onto combine the `activesUsersSinceFilter` with anot [[bootstrap::snapshot::events]] == Snapshot Events -By default, _Spring Data GemFire_ uses Pivotal GemFire's Snapshot Services on startup to import data and shutdown +By default, _Spring Data for Pivotal GemFire_ uses Pivotal GemFire's Snapshot Services on startup to import data and shutdown to export data. However, you may want to trigger periodic, event-based snapshots, for either import or export from within your _Spring_ application. -For this purpose, _Spring Data GemFire_ defines two additional _Spring_ application events, extending _Spring's_ +For this purpose, _Spring Data for Pivotal GemFire_ defines two additional _Spring_ application events, extending _Spring's_ http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/context/ApplicationEvent.html[ApplicationEvent] class for imports and exports, respectively: `ImportSnapshotApplicationEvent` and `ExportSnapshotApplicationEvent`. -The two application events can be targeted at the entire GemFire Cache, or individual GemFire Regions. The constructors +The two application events can be targeted at the entire Pivotal GemFire Cache, or individual Pivotal GemFire Regions. The constructors in these classes accept an optional Region pathname (e.g. "/Example") as well as 0 or more `SnapshotMetadata` instances. The array of `SnapshotMetadata` is used to override the snapshot meta-data defined by `` diff --git a/src/main/java/org/springframework/data/gemfire/CacheFactoryBean.java b/src/main/java/org/springframework/data/gemfire/CacheFactoryBean.java index 8512273b..64165f2b 100644 --- a/src/main/java/org/springframework/data/gemfire/CacheFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/CacheFactoryBean.java @@ -907,7 +907,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport } /** - * Sets an instance of the DynamicRegionSupport to support Dynamic Regions in this GemFire Cache. + * Sets an instance of the DynamicRegionSupport to support Dynamic Regions in this Pivotal GemFire Cache. * * @param dynamicRegionSupport the DynamicRegionSupport class to setup Dynamic Regions in this Cache. */ @@ -923,10 +923,10 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport } /** - * Controls whether auto-reconnect functionality introduced in GemFire 8 is enabled or not. + * Controls whether auto-reconnect functionality introduced in Pivotal GemFire 8 is enabled or not. * * @param enableAutoReconnect a boolean value to enable/disable auto-reconnect functionality. - * @since GemFire 8.0 + * @since Pivotal GemFire 8.0 */ public void setEnableAutoReconnect(Boolean enableAutoReconnect) { this.enableAutoReconnect = enableAutoReconnect; @@ -975,7 +975,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport } /** - * Requires GemFire 7.0 or higher + * Requires Pivotal GemFire 7.0 or higher * @param gatewayConflictResolver defined as Object in the signature for backward * compatibility with Gemfire 6 compatibility. This must be an instance of * {@link org.apache.geode.cache.util.GatewayConflictResolver} @@ -1075,7 +1075,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport /** * Controls whether pdx ignores fields that were unread during - * deserialization. Applicable on GemFire 6.6 or higher. + * deserialization. Applicable on Pivotal GemFire 6.6 or higher. * * @param pdxIgnoreUnreadFields the pdxIgnoreUnreadFields to set */ @@ -1091,7 +1091,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport } /** - * Controls whether type metadata for PDX objects is persisted to disk. Applicable on GemFire 6.6 or higher. + * Controls whether type metadata for PDX objects is persisted to disk. Applicable on Pivotal GemFire 6.6 or higher. * * @param pdxPersistent a boolean value indicating that PDX type meta-data should be persisted to disk. */ @@ -1107,7 +1107,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport } /** - * Sets the object preference to PdxInstance. Applicable on GemFire 6.6 or higher. + * Sets the object preference to PdxInstance. Applicable on Pivotal GemFire 6.6 or higher. * * @param pdxReadSerialized a boolean value indicating the PDX instance should be returned from Region.get(key) * when available. @@ -1126,7 +1126,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport /** * Sets the {@link PdxSerializable} for this cache. Applicable on GemFire * 6.6 or higher. The argument is of type object for compatibility with - * GemFire 6.5. + * Pivotal GemFire 6.5. * * @param serializer pdx serializer configured for this cache. */ @@ -1186,7 +1186,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport * Sets the list of TransactionListeners used to configure the Cache to receive transaction events after * the transaction is processed (committed, rolled back). * - * @param transactionListeners the list of GemFire TransactionListeners listening for transaction events. + * @param transactionListeners the list of Pivotal GemFire TransactionListeners listening for transaction events. * @see org.apache.geode.cache.TransactionListener */ public void setTransactionListeners(List transactionListeners) { @@ -1204,7 +1204,7 @@ public class CacheFactoryBean extends AbstractFactoryBeanSupport * Sets the TransactionWriter used to configure the Cache for handling transaction events, such as to veto * the transaction or update an external DB before the commit. * - * @param transactionWriter the GemFire TransactionWriter callback receiving transaction events. + * @param transactionWriter the Pivotal GemFire TransactionWriter callback receiving transaction events. * @see org.apache.geode.cache.TransactionWriter */ public void setTransactionWriter(TransactionWriter transactionWriter) { diff --git a/src/main/java/org/springframework/data/gemfire/DataPolicyConverter.java b/src/main/java/org/springframework/data/gemfire/DataPolicyConverter.java index 6e6cfaae..eba242da 100644 --- a/src/main/java/org/springframework/data/gemfire/DataPolicyConverter.java +++ b/src/main/java/org/springframework/data/gemfire/DataPolicyConverter.java @@ -20,7 +20,7 @@ import org.apache.geode.cache.DataPolicy; import org.springframework.core.convert.converter.Converter; /** - * The DataPolicyConverter class converts String values into GemFire DataPolicy enumerated values. + * The DataPolicyConverter class converts String values into Pivotal GemFire DataPolicy enumerated values. * * @author David Turanski * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/GemfireAccessor.java b/src/main/java/org/springframework/data/gemfire/GemfireAccessor.java index c939e45a..35067d61 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireAccessor.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireAccessor.java @@ -43,11 +43,11 @@ public class GemfireAccessor implements InitializingBean { private Region region; /** - * Returns the template GemFire Cache Region. + * Returns the template Pivotal GemFire Cache Region. * * @param the Region key class type. * @param the Region value class type. - * @return the GemFire Cache Region. + * @return the Pivotal GemFire Cache Region. * @see org.apache.geode.cache.Region */ @SuppressWarnings("unchecked") @@ -56,9 +56,9 @@ public class GemfireAccessor implements InitializingBean { } /** - * Sets the template GemFire Cache Region. + * Sets the template Pivotal GemFire Cache Region. * - * @param region the GemFire Cache Region used by this template. + * @param region the Pivotal GemFire Cache Region used by this template. * @see org.apache.geode.cache.Region */ public void setRegion(Region region) { @@ -92,9 +92,9 @@ public class GemfireAccessor implements InitializingBean { } /** - * Converts the given GemFire exception to an appropriate exception from the + * Converts the given Pivotal GemFire exception to an appropriate exception from the * org.springframework.dao hierarchy. Note that this particular implementation - * is called only for GemFire querying exception that do NOT extend from GemFire exception. + * is called only for Pivotal GemFire querying exception that do NOT extend from Pivotal GemFire exception. * May be overridden in subclasses. * * @param ex GemFireException that occurred diff --git a/src/main/java/org/springframework/data/gemfire/GemfireCacheUtils.java b/src/main/java/org/springframework/data/gemfire/GemfireCacheUtils.java index 22316b30..368225c3 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireCacheUtils.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireCacheUtils.java @@ -76,7 +76,7 @@ import org.springframework.dao.TypeMismatchDataAccessException; import org.springframework.util.ClassUtils; /** - * Helper class featuring methods for GemFire Cache or Region handling. + * Helper class featuring methods for Pivotal GemFire Cache or Region handling. * * @author Costin Leau */ @@ -297,7 +297,7 @@ public abstract class GemfireCacheUtils { /** * Converts the given (unchecked) Gemfire exception to an appropriate one from the * org.springframework.dao hierarchy. This method exists to handle backwards compatibility - * for exceptions that had their parents changed in GemFire 6.5. + * for exceptions that had their parents changed in Pivotal GemFire 6.5. * * @param ex Gemfire unchecked exception * @return new the corresponding DataAccessException instance @@ -309,7 +309,7 @@ public abstract class GemfireCacheUtils { /** * Converts the given (unchecked) Gemfire exception to an appropriate one from the * org.springframework.dao hierarchy. This method exists to handle backwards compatibility - * for exceptions that had their parents changed in GemFire 6.5. + * for exceptions that had their parents changed in Pivotal GemFire 6.5. * * @param ex Gemfire unchecked exception * @return new the corresponding DataAccessException instance @@ -319,7 +319,7 @@ public abstract class GemfireCacheUtils { } /** - * Package protected method for detecting CqInvalidException which has been removed in GemFire 6.5 GA. + * Package protected method for detecting CqInvalidException which has been removed in Pivotal GemFire 6.5 GA. */ static boolean isCqInvalidException(RuntimeException ex) { return (CQ_EXCEPTION_CLASS != null && CQ_EXCEPTION_CLASS.isAssignableFrom(ex.getClass())); diff --git a/src/main/java/org/springframework/data/gemfire/GemfireCallback.java b/src/main/java/org/springframework/data/gemfire/GemfireCallback.java index c80702c3..7c764274 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireCallback.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireCallback.java @@ -21,7 +21,7 @@ import org.apache.geode.GemFireException; import org.apache.geode.cache.Region; /** - * Callback interface for GemFire code. To be used with {@link GemfireTemplate}'s execution methods, often as anonymous + * Callback interface for Pivotal GemFire code. To be used with {@link GemfireTemplate}'s execution methods, often as anonymous * classes within a method implementation. A typical implementation will call Region.get/put/query to perform some * operations on stored objects. * @@ -41,7 +41,7 @@ public interface GemfireCallback { * A thrown custom RuntimeException is treated as an application exception: it gets propagated to * the caller of the template. * - * @param region the GemFire Cache Region upon which the operation of this callback will be performed. + * @param region the Pivotal GemFire Cache Region upon which the operation of this callback will be performed. * @return a result object, or null if no result. * @throws GemFireCheckedException for checked Exceptions occurring in GemFire. * @throws GemFireException for runtime Exceptions occurring in GemFire. diff --git a/src/main/java/org/springframework/data/gemfire/GemfireOperations.java b/src/main/java/org/springframework/data/gemfire/GemfireOperations.java index 21e526f0..1523eace 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireOperations.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireOperations.java @@ -55,7 +55,7 @@ public interface GemfireOperations { boolean replace(K key, V oldValue, V newValue); /** - * Executes a GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return multiple results; for queries that return only one + * Executes a Pivotal GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return multiple results; for queries that return only one * element use {@link #findUnique(String, Object...)}. * * As oppose, to the {@link #query(String)} method, this method allows for more generic queries (against multiple regions even) to be executed. @@ -75,7 +75,7 @@ public interface GemfireOperations { SelectResults find(String query, Object... params) throws InvalidDataAccessApiUsageException; /** - * Executes a GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return a single result; for queries that return multiple + * Executes a Pivotal GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return a single result; for queries that return multiple * elements use {@link #find(String, Object...)}. * * As oppose, to the {@link #query(String)} method, this method allows for more generic queries (against multiple regions even) to be executed. @@ -113,7 +113,7 @@ public interface GemfireOperations { * @param type parameter specifying the returned result type. * @param action callback object that specifies the Gemfire action to execute. * @return a result object returned by the action, or null. - * @throws org.springframework.dao.DataAccessException in case of GemFire errors. + * @throws org.springframework.dao.DataAccessException in case of Pivotal GemFire errors. */ T execute(GemfireCallback action) throws DataAccessException; @@ -122,9 +122,9 @@ public interface GemfireOperations { * * @param type parameter specifying the returned result type. * @param action callback object that specifies the Gemfire action to execute. - * @param exposeNativeRegion whether to expose the native GemFire region to callback code. + * @param exposeNativeRegion whether to expose the native Pivotal GemFire region to callback code. * @return a result object returned by the action, or null. - * @throws org.springframework.dao.DataAccessException in case of GemFire errors. + * @throws org.springframework.dao.DataAccessException in case of Pivotal GemFire errors. */ T execute(GemfireCallback action, boolean exposeNativeRegion) throws DataAccessException; diff --git a/src/main/java/org/springframework/data/gemfire/GemfireSystemException.java b/src/main/java/org/springframework/data/gemfire/GemfireSystemException.java index bbc4ab40..72dd0819 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireSystemException.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireSystemException.java @@ -21,7 +21,7 @@ import org.apache.geode.GemFireException; import org.springframework.dao.UncategorizedDataAccessException; /** - * GemFire-specific subclass of UncategorizedDataAccessException, for GemFire system errors that do not match any concrete org.springframework.dao exceptions. + * GemFire-specific subclass of UncategorizedDataAccessException, for Pivotal GemFire system errors that do not match any concrete org.springframework.dao exceptions. * * @author Costin Leau */ diff --git a/src/main/java/org/springframework/data/gemfire/GemfireTemplate.java b/src/main/java/org/springframework/data/gemfire/GemfireTemplate.java index befa7fe1..c511141d 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireTemplate.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireTemplate.java @@ -42,14 +42,14 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** - * Helper class that simplifies GemFire data access code and converts {@link GemFireCheckedException} and + * Helper class that simplifies Pivotal GemFire data access code and converts {@link GemFireCheckedException} and * {@link GemFireException} into Spring {@link DataAccessException}, following the org.springframework.dao * exception hierarchy. * - * The central method is execute, supporting GemFire access code implementing the GemfireCallback interface. + * The central method is execute, supporting Pivotal GemFire access code implementing the GemfireCallback interface. * It provides dedicated handling such that neither the GemfireCallback implementation nor the calling code needs to * explicitly care about handling {@link Region} life-cycle exceptions. - * Typically used to implement data access or business logic services that use GemFire within their implementation but + * Typically used to implement data access or business logic services that use Pivotal GemFire within their implementation but * are GemFire-agnostic in their interface. The latter or code calling the latter only have to deal with business * objects, query objects, and org.springframework.dao exceptions. * @@ -89,7 +89,7 @@ public class GemfireTemplate extends GemfireAccessor implements GemfireOperation *

As there is often a need to cast to a interface, the exposed proxy implements all interfaces * implemented by the original {@link Region}. If this is not sufficient, turn this flag to "true". * - * @param exposeNativeRegion a boolean value to indicate whether the native GemFire Cache Region should be exposed + * @param exposeNativeRegion a boolean value to indicate whether the native Pivotal GemFire Cache Region should be exposed * to the GemfireCallback. * @see org.springframework.data.gemfire.GemfireCallback */ @@ -98,9 +98,9 @@ public class GemfireTemplate extends GemfireAccessor implements GemfireOperation } /** - * Returns whether to expose the native GemFire Cache Region or a Region proxy to the GemfireCallback code. + * Returns whether to expose the native Pivotal GemFire Cache Region or a Region proxy to the GemfireCallback code. * - * @return a boolean value indicating whether the native GemFire Cache Region or Region proxy is exposed + * @return a boolean value indicating whether the native Pivotal GemFire Cache Region or Region proxy is exposed * to the GemfireCallback code. */ public boolean isExposeNativeRegion() { @@ -473,12 +473,12 @@ public class GemfireTemplate extends GemfireAccessor implements GemfireOperation } /** - * Create a close-suppressing proxy for the given GemFire Cache {@link Region}. + * Create a close-suppressing proxy for the given Pivotal GemFire Cache {@link Region}. * Called by the execute method. * * @param the Region key class type. * @param the Region value class type. - * @param region the GemFire Cache Region to create a proxy for. + * @param region the Pivotal GemFire Cache Region to create a proxy for. * @return the Region proxy implementing all interfaces implemented by the passed-in Region object. * @see org.apache.geode.cache.Region#close() * @see #execute(GemfireCallback, boolean) @@ -493,7 +493,7 @@ public class GemfireTemplate extends GemfireAccessor implements GemfireOperation } /** - * InvocationHandler that suppresses close calls on GemFire Cache Regions. + * InvocationHandler that suppresses close calls on Pivotal GemFire Cache Regions. * * @see org.apache.geode.cache.Region#close() * @see java.lang.reflect.InvocationHandler diff --git a/src/main/java/org/springframework/data/gemfire/GemfireUtils.java b/src/main/java/org/springframework/data/gemfire/GemfireUtils.java index bfe47f5a..5f39c4a4 100644 --- a/src/main/java/org/springframework/data/gemfire/GemfireUtils.java +++ b/src/main/java/org/springframework/data/gemfire/GemfireUtils.java @@ -26,7 +26,7 @@ import org.springframework.util.ClassUtils; /** * {@link GemfireUtils} is an abstract utility class encapsulating common functionality to access features - * and capabilities of GemFire based on version and other configuration meta-data. + * and capabilities of Pivotal GemFire based on version and other configuration meta-data. * * @author John Blum * @see org.apache.geode.cache.CacheFactory @@ -42,7 +42,6 @@ public abstract class GemfireUtils extends RegionUtils { public final static String GEMFIRE_VERSION = apacheGeodeVersion(); public final static String UNKNOWN = "unknown"; - /* (non-Javadoc) */ public static String apacheGeodeProductName() { try { @@ -53,7 +52,6 @@ public abstract class GemfireUtils extends RegionUtils { } } - /* (non-Javadoc) */ public static String apacheGeodeVersion() { try { @@ -64,13 +62,11 @@ public abstract class GemfireUtils extends RegionUtils { } } - /* (non-Javadoc) */ public static boolean isGemfireVersionGreaterThanEqualTo(double expectedVersion) { double actualVersion = Double.parseDouble(GEMFIRE_VERSION.substring(0, 3)); return actualVersion >= expectedVersion; } - /* (non-Javadoc) */ public static boolean isGemfireVersion65OrAbove() { // expected 'major.minor' try { @@ -83,7 +79,6 @@ public abstract class GemfireUtils extends RegionUtils { } } - /* (non-Javadoc) */ public static boolean isGemfireVersion7OrAbove() { try { return isGemfireVersionGreaterThanEqualTo(7.0); @@ -95,7 +90,6 @@ public abstract class GemfireUtils extends RegionUtils { } } - /* (non-Javadoc) */ public static boolean isGemfireVersion8OrAbove() { try { diff --git a/src/main/java/org/springframework/data/gemfire/GenericRegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/GenericRegionFactoryBean.java index c329f532..fe3fa7b1 100644 --- a/src/main/java/org/springframework/data/gemfire/GenericRegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/GenericRegionFactoryBean.java @@ -18,14 +18,14 @@ package org.springframework.data.gemfire; /** * The GenericRegionFactoryBean class is an extension of the abstract, base RegionFactoryBean class enabling developers - * to define a GemFire Cache Region with defaults. + * to define a Pivotal GemFire Cache Region with defaults. * * The defaults for DataPolicy is NORMAL and Scope is DISTRIBUTED_NO_ACK, effectively creating a "non-replicate", * Distributed Region. * * This class enables developers to create various non-strongly-typed Regions (e.g. PARTITION, REPLICATE) based on * various combinations of the DataPolicy, Scope and Subscription settings as defined in the Region Types section - * of the GemFire User Guide (see link below). How GemFire Regions receive and distribute entry updates + * of the Pivotal GemFire User Guide (see link below). How Pivotal GemFire Regions receive and distribute entry updates * is defined in the Storage and Distribution Options section. * * Note, it is generally better to define strong-typed Regions (e.g. PARTITION with PartitionedRegionFactoryBean) diff --git a/src/main/java/org/springframework/data/gemfire/IndexMaintenancePolicyType.java b/src/main/java/org/springframework/data/gemfire/IndexMaintenancePolicyType.java index f2f5746b..6b96af3c 100644 --- a/src/main/java/org/springframework/data/gemfire/IndexMaintenancePolicyType.java +++ b/src/main/java/org/springframework/data/gemfire/IndexMaintenancePolicyType.java @@ -20,7 +20,7 @@ import org.apache.geode.cache.AttributesFactory; import org.apache.geode.cache.RegionFactory; /** - * The IndexMaintenanceType enum is a enumerated type of GemFire Index maintenance update options. + * The IndexMaintenanceType enum is a enumerated type of Pivotal GemFire Index maintenance update options. * * @author John Blum * @see org.apache.geode.cache.AttributesFactory#setIndexMaintenanceSynchronous(boolean) @@ -56,7 +56,7 @@ public enum IndexMaintenancePolicyType { } /** - * Sets the GemFire AttributesFactory's 'indexMaintenanceSynchronous' property appropriately based on + * Sets the Pivotal GemFire AttributesFactory's 'indexMaintenanceSynchronous' property appropriately based on * this IndexMaintenancePolicyType. * * @param attributesFactory the AttributesFactory instance on which to set the indexMaintenanceProperty. @@ -69,7 +69,7 @@ public enum IndexMaintenancePolicyType { } /** - * Sets the GemFire RegionFactory's 'indexMaintenanceSynchronous' property appropriately based on + * Sets the Pivotal GemFire RegionFactory's 'indexMaintenanceSynchronous' property appropriately based on * this IndexMaintenancePolicyType. * * @param regionFactory the RegionFactory instance on which to set the indexMaintenanceProperty. diff --git a/src/main/java/org/springframework/data/gemfire/IndexType.java b/src/main/java/org/springframework/data/gemfire/IndexType.java index ec51d6af..2683909f 100644 --- a/src/main/java/org/springframework/data/gemfire/IndexType.java +++ b/src/main/java/org/springframework/data/gemfire/IndexType.java @@ -17,7 +17,7 @@ package org.springframework.data.gemfire; /** - * The IndexType class is an enumerated type of GemFire Index Types. + * The IndexType class is an enumerated type of Pivotal GemFire Index Types. * * @author John Blum * @see org.apache.geode.cache.query.IndexType @@ -34,9 +34,9 @@ public enum IndexType { private final org.apache.geode.cache.query.IndexType gemfireIndexType; /** - * Constructs an instance of the IndexType enum initialized with the given GemFire IndexType. + * Constructs an instance of the IndexType enum initialized with the given Pivotal GemFire IndexType. * - * @param gemfireIndexType the corresponding GemFire IndexType + * @param gemfireIndexType the corresponding Pivotal GemFire IndexType * @see org.apache.geode.cache.query.IndexType */ IndexType(final org.apache.geode.cache.query.IndexType gemfireIndexType) { @@ -77,11 +77,11 @@ public enum IndexType { } /** - * Returns an IndexType given the corresponding GemFire IndexType or null if no SDG IndexType - * corresponds to the GemFire IndexType. + * Returns an IndexType given the corresponding Pivotal GemFire IndexType or null if no SDG IndexType + * corresponds to the Pivotal GemFire IndexType. * - * @param gemfireIndexType the GemFire IndexType. - * @return a IndexType matching the GemFire IndexType or null if the GemFire IndexType does not match + * @param gemfireIndexType the Pivotal GemFire IndexType. + * @return a IndexType matching the Pivotal GemFire IndexType or null if the Pivotal GemFire IndexType does not match * any IndexType in this enumeration. * @see org.apache.geode.cache.query.IndexType */ @@ -115,9 +115,9 @@ public enum IndexType { } /** - * Gets the matching GemFire IndexType for this IndexType enumerated value. + * Gets the matching Pivotal GemFire IndexType for this IndexType enumerated value. * - * @return the matching GemFire IndexType. + * @return the matching Pivotal GemFire IndexType. * @see org.apache.geode.cache.query.IndexType */ public org.apache.geode.cache.query.IndexType getGemfireIndexType() { diff --git a/src/main/java/org/springframework/data/gemfire/InterestPolicyConverter.java b/src/main/java/org/springframework/data/gemfire/InterestPolicyConverter.java index 4b26cb1d..d450b9de 100644 --- a/src/main/java/org/springframework/data/gemfire/InterestPolicyConverter.java +++ b/src/main/java/org/springframework/data/gemfire/InterestPolicyConverter.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS /** * The InterestPolicyConverter class is a Spring Converter implementation and Java PropertyEditor handling - * the conversion between Strings and GemFire InterestPolicy values. + * the conversion between Strings and Pivotal GemFire InterestPolicy values. * * @author John Blum * @see org.springframework.data.gemfire.support.AbstractPropertyEditorConverterSupport @@ -32,11 +32,11 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS public class InterestPolicyConverter extends AbstractPropertyEditorConverterSupport { /** - * Converts the given String into a GemFire InterestPolicy value. + * Converts the given String into a Pivotal GemFire InterestPolicy value. * - * @param source the String value to convert into a GemFire InterestPolicy value. - * @return a GemFire InterestPolicy value for the given String description of the GemFire InterestPolicy - * @throws java.lang.IllegalArgumentException if the String is not a valid GemFire InterestPolicy. + * @param source the String value to convert into a Pivotal GemFire InterestPolicy value. + * @return a Pivotal GemFire InterestPolicy value for the given String description of the Pivotal GemFire InterestPolicy + * @throws java.lang.IllegalArgumentException if the String is not a valid Pivotal GemFire InterestPolicy. * @see org.springframework.data.gemfire.InterestPolicyType#getInterestPolicy(InterestPolicyType) * @see org.springframework.data.gemfire.InterestPolicyType#valueOfIgnoreCase(String) * @see #assertConverted(String, Object, Class) diff --git a/src/main/java/org/springframework/data/gemfire/InterestPolicyType.java b/src/main/java/org/springframework/data/gemfire/InterestPolicyType.java index 21ce6658..c19c0de4 100644 --- a/src/main/java/org/springframework/data/gemfire/InterestPolicyType.java +++ b/src/main/java/org/springframework/data/gemfire/InterestPolicyType.java @@ -18,7 +18,7 @@ package org.springframework.data.gemfire; import org.apache.geode.cache.InterestPolicy; /** - * The InterestPolicyType enum is an enumeration of all the GemFire Subscription, InterestPolicy values. + * The InterestPolicyType enum is an enumeration of all the Pivotal GemFire Subscription, InterestPolicy values. * * @author Lyndon Adams * @author John Blum @@ -27,6 +27,7 @@ import org.apache.geode.cache.InterestPolicy; */ @SuppressWarnings("unused") public enum InterestPolicyType { + ALL(InterestPolicy.ALL), CACHE_CONTENT(InterestPolicy.CACHE_CONTENT); @@ -35,9 +36,9 @@ public enum InterestPolicyType { private final InterestPolicy interestPolicy; /** - * Constructs an instance of the SubscriptionType enum initialized with the matching GemFire InterestPolicy. + * Constructs an instance of the SubscriptionType enum initialized with the matching Pivotal GemFire InterestPolicy. * - * @param interestPolicy a GemFire InterestPolicy corresponding to this SubscriptionType. + * @param interestPolicy a Pivotal GemFire InterestPolicy corresponding to this SubscriptionType. * @see org.apache.geode.cache.InterestPolicy */ InterestPolicyType(final InterestPolicy interestPolicy) { @@ -45,11 +46,13 @@ public enum InterestPolicyType { } /** - * Null-safe operation to extract the GemFire InterestPolicy from the InterPolicyType enumerated value. + * Null-safe operation to extract the Pivotal GemFire {@link InterestPolicy} + * from the {@link InterestPolicyType} enumerated value. * - * @param interestPolicyType the InterestPolicyType enum from which to extract GemFire's InterestPolicy - * @return a GemFire InterestPolicy for the given InterestPolicyType enumerated value - * or null if InterestPolicyType is null. + * @param interestPolicyType the {@link InterestPolicyType} enum from which to extract + * Pivotal GemFire's {@link InterestPolicy}. + * @return a Pivotal GemFire {@link InterestPolicy} for the given {@link InterestPolicyType} enumerated value + * or {@literal null} if {@link InterestPolicyType} is {@literal null}. * @see org.apache.geode.cache.InterestPolicy */ public static InterestPolicy getInterestPolicy(final InterestPolicyType interestPolicyType) { @@ -57,10 +60,10 @@ public enum InterestPolicyType { } /** - * Returns a SubscriptionType enumerated value for the given GemFire InterestPolicy. + * Returns a SubscriptionType enumerated value for the given Pivotal GemFire InterestPolicy. * - * @param interestPolicy the GemFire InterestPolicy used to lookup and match a SubscriptionType. - * @return a SubscriptionType enumerated value matching the given GemFire InterestPolicy + * @param interestPolicy the Pivotal GemFire InterestPolicy used to lookup and match a SubscriptionType. + * @return a SubscriptionType enumerated value matching the given Pivotal GemFire InterestPolicy * or null if no matching value was found. * @see org.apache.geode.cache.InterestPolicy * @see #getInterestPolicy() @@ -95,13 +98,12 @@ public enum InterestPolicyType { } /** - * Returns the GemFire InterestPolicy corresponding to this SubscriptionType enumerated value. + * Returns the Pivotal GemFire InterestPolicy corresponding to this SubscriptionType enumerated value. * - * @return the GemFire InterestPolicy corresponding to this SubscriptionType. + * @return the Pivotal GemFire InterestPolicy corresponding to this SubscriptionType. * @see org.apache.geode.cache.InterestPolicy */ public InterestPolicy getInterestPolicy() { return interestPolicy; } - } diff --git a/src/main/java/org/springframework/data/gemfire/JndiDataSourceType.java b/src/main/java/org/springframework/data/gemfire/JndiDataSourceType.java index 7113b1d0..e86e4250 100644 --- a/src/main/java/org/springframework/data/gemfire/JndiDataSourceType.java +++ b/src/main/java/org/springframework/data/gemfire/JndiDataSourceType.java @@ -36,10 +36,10 @@ public enum JndiDataSourceType { private final String name; /** - * Constructs an instance of the JndiDataSourceType enum initialized with the specified name used by GemFire to + * Constructs an instance of the JndiDataSourceType enum initialized with the specified name used by Pivotal GemFire to * specify supported JNDI DataSource implementations. * - * @param name the GemFire named JNDI DataSource implementation. + * @param name the Pivotal GemFire named JNDI DataSource implementation. */ JndiDataSourceType(final String name) { Assert.hasText(name, "The JNDI DataSource Type 'name' must be specified!"); @@ -47,11 +47,11 @@ public enum JndiDataSourceType { } /** - * Returns a JndiDataSourceType enumerated value based on the GemFire preferred name for the supported JNDI, + * Returns a JndiDataSourceType enumerated value based on the Pivotal GemFire preferred name for the supported JNDI, * DataSource implementation, ignoring case and all extra leading/trailing whitespace. * - * @param name the GemFire named JNDI DataSource implementation. - * @return the JndiDataSourceType enumerated value matching the given GemFire name used for the supported JNDI, + * @param name the Pivotal GemFire named JNDI DataSource implementation. + * @return the JndiDataSourceType enumerated value matching the given Pivotal GemFire name used for the supported JNDI, * DataSource implementation, or null if not match was found. * @see #values() * @see #isMatch(JndiDataSourceType, String) @@ -67,11 +67,11 @@ public enum JndiDataSourceType { } /** - * Determines whether the specified JndiDataSourceType enum and the given, supported GemFire 'named', + * Determines whether the specified JndiDataSourceType enum and the given, supported Pivotal GemFire 'named', * JNDI DataSource implementation are a match. * * @param jndiDataSourceType the given JndiDataSourceType enum used in the match. - * @param name the specified GemFire "named" JNDI DataSource implementation. + * @param name the specified Pivotal GemFire "named" JNDI DataSource implementation. * @return a boolean value indicating whether the given JndiDataSourceType enumerated value matched the given name. * @see java.lang.String#equalsIgnoreCase(String) * @see org.springframework.util.StringUtils#trimWhitespace(String) @@ -83,16 +83,16 @@ public enum JndiDataSourceType { } /** - * Gets the GemFire name of the support JNDI DataSource implementation type. + * Gets the Pivotal GemFire name of the support JNDI DataSource implementation type. * - * @return the GemFire named JNDI DataSource implementation. + * @return the Pivotal GemFire named JNDI DataSource implementation. */ public String getName() { return name; } /** - * Returns a String describing this JNDI DataSource implementation based on the GemFire supported names. + * Returns a String describing this JNDI DataSource implementation based on the Pivotal GemFire supported names. * * @return a String description for this JNDI DataSource (implementation) type. */ diff --git a/src/main/java/org/springframework/data/gemfire/LocalRegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/LocalRegionFactoryBean.java index bfcd20ef..3f113428 100644 --- a/src/main/java/org/springframework/data/gemfire/LocalRegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/LocalRegionFactoryBean.java @@ -67,13 +67,13 @@ public class LocalRegionFactoryBean extends RegionFactoryBean { } /** - * Resolves the Data Policy used by this "local" GemFire Region (i.e. locally Scoped; Scope.LOCAL) based on the + * Resolves the Data Policy used by this "local" Pivotal GemFire Region (i.e. locally Scoped; Scope.LOCAL) based on the * enumerated value from org.apache.geode.cache.RegionShortcuts (LOCAL, LOCAL_PERSISTENT, LOCAL_HEAP_LRU, * LOCAL_OVERFLOW, and LOCAL_PERSISTENT_OVERFLOW), but without consideration of the Eviction settings. * - * @param regionFactory the GemFire RegionFactory used to created the Local Region. + * @param regionFactory the Pivotal GemFire RegionFactory used to created the Local Region. * @param persistent a boolean value indicating whether the Local Region should persist it's data. - * @param dataPolicy requested Data Policy as set by the user in the Spring GemFire configuration meta-data. + * @param dataPolicy requested Data Policy as set by the user in the Spring Pivotal GemFire configuration meta-data. * @see org.apache.geode.cache.DataPolicy * @see org.apache.geode.cache.RegionFactory * @see org.apache.geode.cache.RegionShortcut diff --git a/src/main/java/org/springframework/data/gemfire/PartitionedRegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/PartitionedRegionFactoryBean.java index 4311c91f..c63e7515 100644 --- a/src/main/java/org/springframework/data/gemfire/PartitionedRegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/PartitionedRegionFactoryBean.java @@ -31,17 +31,17 @@ public class PartitionedRegionFactoryBean extends RegionFactoryBean // First, verify the GemFire version is 6.5 or Higher when Persistence is specified... Assert.isTrue(!DataPolicy.PERSISTENT_PARTITION.equals(dataPolicy) || GemfireUtils.isGemfireVersion65OrAbove(), - String.format("Persistent PARTITION Regions can only be used from GemFire 6.5 onwards; current version is [%s].", + String.format("Persistent PARTITION Regions can only be used from Pivotal GemFire 6.5 onwards; current version is [%s]", CacheFactory.getVersion())); if (dataPolicy == null) { dataPolicy = (isPersistent() ? DataPolicy.PERSISTENT_PARTITION : DataPolicy.PARTITION); } else { - // Validate that the user-defined Data Policy matches the appropriate Spring GemFire XML namespace + // Validate that the user-defined Data Policy matches the appropriate Spring Pivotal GemFire XML namespace // configuration meta-data element for Region (i.e. )! Assert.isTrue(dataPolicy.withPartitioning(), String.format( - "Data Policy '%1$s' is not supported in Partitioned Regions.", dataPolicy)); + "Data Policy [%s] is not supported in Partitioned Regions", dataPolicy)); } // Validate the data-policy and persistent attributes are compatible when specified! diff --git a/src/main/java/org/springframework/data/gemfire/RegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/RegionFactoryBean.java index 11ef4e60..681f6649 100644 --- a/src/main/java/org/springframework/data/gemfire/RegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/RegionFactoryBean.java @@ -401,7 +401,7 @@ public abstract class RegionFactoryBean extends RegionLookupFactoryBean the Class type fo the Region key. * @param the Class type of the Region value. - * @param regionFactory the GemFire RegionFactory used to configure and create the Region that is the product + * @param regionFactory the Pivotal GemFire RegionFactory used to configure and create the Region that is the product * of this RegionFactoryBean. * @param regionAttributes the RegionAttributes containing the Region configuration settings to merge to the * RegionFactory. @@ -512,7 +512,7 @@ public abstract class RegionFactoryBean extends RegionLookupFactoryBean extends RegionLookupFactoryBean extends RegionLookupFactoryBean>>>>>> c22ebe6... DATAGEODE-12 - Introduce Spring Configurers to flexibly alter Spring Data GemFire configuration when using Annotation config. * Validates and sets the Data Policy on the RegionFactory used to create and configure the Region from this * FactoryBean. +======= + * Validates and sets the {@link DataPolicy} on the {@link RegionFactory} used to create and configure + * the {@link Region} from this {@link FactoryBean}. +>>>>>>> 12126a1... SGF-732 - Change branding from Spring Data GemFire to Spring Data for Pivotal GemFire. * * @param regionFactory the RegionFactory used by this FactoryBean to create and configure the Region. * @param persistent a boolean value indicating whether the Region should be persistent and persist it's @@ -625,9 +630,9 @@ public abstract class RegionFactoryBean extends RegionLookupFactoryBean extends RegionLookupFactoryBean extends AbstractFactoryBeanS this.cache = cache; } - /* (non-Javadoc) */ boolean isLookupEnabled() { return Boolean.TRUE.equals(getLookupEnabled()); } - /* (non-Javadoc) */ public void setLookupEnabled(Boolean lookupEnabled) { this.lookupEnabled = lookupEnabled; } - /* (non-Javadoc) */ public Boolean getLookupEnabled() { return this.lookupEnabled; } @@ -236,7 +233,7 @@ public abstract class RegionLookupFactoryBean extends AbstractFactoryBeanS } /** - * Sets a reference to the parent {@link Region} to indicated this {@link FactoryBean} represents a GemFire cache + * Sets a reference to the parent {@link Region} to indicated this {@link FactoryBean} represents a Pivotal GemFire cache * {@link Region Sub-Region}. * * @param parent reference to the parent {@link Region}. @@ -247,7 +244,7 @@ public abstract class RegionLookupFactoryBean extends AbstractFactoryBeanS } /** - * Returns a reference to the parent {@link Region} indicating this {@link FactoryBean} represents a GemFire cache + * Returns a reference to the parent {@link Region} indicating this {@link FactoryBean} represents a Pivotal GemFire cache * {@link Region Sub-Region}. * * @return a reference to the parent {@link Region} or {@literal null} if this {@link Region} diff --git a/src/main/java/org/springframework/data/gemfire/RegionShortcutConverter.java b/src/main/java/org/springframework/data/gemfire/RegionShortcutConverter.java index c19c0cc5..e74152b1 100644 --- a/src/main/java/org/springframework/data/gemfire/RegionShortcutConverter.java +++ b/src/main/java/org/springframework/data/gemfire/RegionShortcutConverter.java @@ -21,7 +21,7 @@ import org.springframework.core.convert.converter.Converter; /** * The RegionShortcutConverter class is a Spring Converter implementation converting String value Region Shortcut - * representations into actual GemFire RegionShortcut enumerated values. + * representations into actual Pivotal GemFire RegionShortcut enumerated values. * * @author John Blum * @see org.springframework.core.convert.converter.Converter diff --git a/src/main/java/org/springframework/data/gemfire/RegionShortcutWrapper.java b/src/main/java/org/springframework/data/gemfire/RegionShortcutWrapper.java index f1c3b0f7..63bf9126 100644 --- a/src/main/java/org/springframework/data/gemfire/RegionShortcutWrapper.java +++ b/src/main/java/org/springframework/data/gemfire/RegionShortcutWrapper.java @@ -21,10 +21,11 @@ import org.apache.geode.cache.RegionShortcut; import org.springframework.util.ObjectUtils; /** - * The {@link RegionShortcutWrapper} enum is a Java enumerated type that wraps GemFire's {@link RegionShortcut RegionShortcuts} - * with Spring Data GemFire {@link RegionShortcutWrapper} enumerated values. + * The {@link RegionShortcutWrapper} enum is a Java enumerated type that wraps Pivotal GemFire's + * {@link RegionShortcut RegionShortcuts} with SDG {@link RegionShortcutWrapper} enumerated values. * * @author John Blum + * @see org.apache.geode.cache.DataPolicy * @see org.apache.geode.cache.RegionShortcut * @since 1.4.0 */ diff --git a/src/main/java/org/springframework/data/gemfire/ReplicatedRegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/ReplicatedRegionFactoryBean.java index f7dd9b73..769c4964 100644 --- a/src/main/java/org/springframework/data/gemfire/ReplicatedRegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/ReplicatedRegionFactoryBean.java @@ -34,7 +34,7 @@ public class ReplicatedRegionFactoryBean extends RegionFactoryBean { dataPolicy = DataPolicy.EMPTY; } else { - // Validate that the user-defined Data Policy matches the appropriate Spring GemFire XML namespace + // Validate that the user-defined Data Policy matches the appropriate Spring Pivotal GemFire XML namespace // configuration meta-data element for the Region (i.e. )! Assert.isTrue(dataPolicy.withReplication(), String.format( "Data Policy '%1$s' is not supported in Replicated Regions.", dataPolicy)); diff --git a/src/main/java/org/springframework/data/gemfire/ScopeConverter.java b/src/main/java/org/springframework/data/gemfire/ScopeConverter.java index 6145350e..232c7e28 100644 --- a/src/main/java/org/springframework/data/gemfire/ScopeConverter.java +++ b/src/main/java/org/springframework/data/gemfire/ScopeConverter.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS /** * The ScopeConverter class is a Spring Converter and JavaBeans PropertyEditor that converts Strings - * into GemFire Scope constant values. + * into Pivotal GemFire Scope constant values. * * @author John Blum * @see org.springframework.data.gemfire.support.AbstractPropertyEditorConverterSupport @@ -32,11 +32,11 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS public class ScopeConverter extends AbstractPropertyEditorConverterSupport { /** - * Converts the given String source into an instance of GemFire Scope. + * Converts the given String source into an instance of Pivotal GemFire Scope. * - * @param source the String to convert into a GemFire Scope. - * @return a GemFire Scope for the given String. - * @throws java.lang.IllegalArgumentException if the String is not a valid GemFire Scope. + * @param source the String to convert into a Pivotal GemFire Scope. + * @return a Pivotal GemFire Scope for the given String. + * @throws java.lang.IllegalArgumentException if the String is not a valid Pivotal GemFire Scope. * @see org.springframework.data.gemfire.ScopeType#getScope(ScopeType) * @see org.springframework.data.gemfire.ScopeType#valueOfIgnoreCase(String) * @see org.apache.geode.cache.Scope#fromString(String) diff --git a/src/main/java/org/springframework/data/gemfire/ScopeType.java b/src/main/java/org/springframework/data/gemfire/ScopeType.java index e23ab611..02f7ad78 100644 --- a/src/main/java/org/springframework/data/gemfire/ScopeType.java +++ b/src/main/java/org/springframework/data/gemfire/ScopeType.java @@ -20,7 +20,7 @@ import org.apache.geode.cache.Scope; import org.springframework.util.StringUtils; /** - * The ScopeType enum is an enumeration of GemFire Scopes. + * The ScopeType enum is an enumeration of Pivotal GemFire Scopes. * * @author John Blum * @see org.apache.geode.cache.Scope @@ -36,9 +36,9 @@ public enum ScopeType { private final Scope gemfireScope; /** - * Constructs an instance of the ScopeType initialized with a matching GemFire Scope. + * Constructs an instance of the ScopeType initialized with a matching Pivotal GemFire Scope. * - * @param gemfireScope the GemFire Scope paired with this enumerated value. + * @param gemfireScope the Pivotal GemFire Scope paired with this enumerated value. * @see org.apache.geode.cache.Scope */ ScopeType(final Scope gemfireScope) { @@ -46,11 +46,11 @@ public enum ScopeType { } /** - * Null-safe operation to extract the GemFire Scope from the given ScopeType enum value, or null if the provided + * Null-safe operation to extract the Pivotal GemFire Scope from the given ScopeType enum value, or null if the provided * scopeType is null. * - * @param scopeType the ScopeType enumerated value from which to extract the GemFire Scope. - * @return the paired GemFire Scope from the given ScopeType or null if scopeType is null. + * @param scopeType the ScopeType enumerated value from which to extract the Pivotal GemFire Scope. + * @return the paired Pivotal GemFire Scope from the given ScopeType or null if scopeType is null. * @see org.apache.geode.cache.Scope * @see #getScope() */ @@ -59,10 +59,10 @@ public enum ScopeType { } /** - * Returns a ScopeType enumerated value for the given a GemFire Scope. + * Returns a ScopeType enumerated value for the given a Pivotal GemFire Scope. * - * @param scope the GemFire Scope used to lookup and match the appropriate ScopeType. - * @return a ScopeType for the given GemFire Scope or null if no match was found. + * @param scope the Pivotal GemFire Scope used to lookup and match the appropriate ScopeType. + * @return a ScopeType for the given Pivotal GemFire Scope or null if no match was found. * @see org.apache.geode.cache.Scope * @see #getScope() * @see #values() @@ -78,10 +78,10 @@ public enum ScopeType { } /** - * Returns a ScopeType enumerated value given the case-insensitive name of the GemFire Scope. + * Returns a ScopeType enumerated value given the case-insensitive name of the Pivotal GemFire Scope. * * @param name a String name describing the ScopeType enum value. - * @return a ScopeType for the given case-insensitive, named GemFire Scope. + * @return a ScopeType for the given case-insensitive, named Pivotal GemFire Scope. * @see java.lang.String#equalsIgnoreCase(String) * @see #values() * @see #name() @@ -112,9 +112,9 @@ public enum ScopeType { } /** - * Gets the matching GemFire Scope for this enumerated value. + * Gets the matching Pivotal GemFire Scope for this enumerated value. * - * @return a GemFire Scope for this enumerated value. + * @return a Pivotal GemFire Scope for this enumerated value. * @see org.apache.geode.cache.Scope */ public Scope getScope() { diff --git a/src/main/java/org/springframework/data/gemfire/SubscriptionAttributesFactoryBean.java b/src/main/java/org/springframework/data/gemfire/SubscriptionAttributesFactoryBean.java index 4c6337f9..b4e0b68d 100644 --- a/src/main/java/org/springframework/data/gemfire/SubscriptionAttributesFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/SubscriptionAttributesFactoryBean.java @@ -22,7 +22,7 @@ import org.springframework.beans.factory.InitializingBean; /** * The SubscriptionAttributesFactoryBean class is a Spring FactoryBean used for defining and constructing - * a GemFire SubscriptionAttributes object, which determines the Subscription policy used by Regions to + * a Pivotal GemFire SubscriptionAttributes object, which determines the Subscription policy used by Regions to * declared their data interests. * * @author Lyndon Adams @@ -76,10 +76,10 @@ public class SubscriptionAttributesFactoryBean implements FactoryBean region) { - Assert.notNull(region, "GemFire Region must not be null"); + Assert.notNull(region, "Region must not be null"); this.region = region; } /** - * Returns the GemFire {@link Region} used as the implementation for this Spring {@link Cache}. + * Returns the Pivotal GemFire {@link Region} used as the implementation for this Spring {@link Cache}. * - * @return the GemFire {@link Region} used as the implementation for this Spring {@link Cache}. + * @return the Pivotal GemFire {@link Region} used as the implementation for this Spring {@link Cache}. * @see org.apache.geode.cache.Region */ public Region getNativeCache() { diff --git a/src/main/java/org/springframework/data/gemfire/cache/GemfireCacheManager.java b/src/main/java/org/springframework/data/gemfire/cache/GemfireCacheManager.java index acf11b38..7c3c0501 100644 --- a/src/main/java/org/springframework/data/gemfire/cache/GemfireCacheManager.java +++ b/src/main/java/org/springframework/data/gemfire/cache/GemfireCacheManager.java @@ -29,10 +29,10 @@ import org.springframework.cache.support.AbstractCacheManager; import org.springframework.util.Assert; /** - * Core Spring Framework {@link CacheManager} implementation backed by a GemFire cache instance + * Core Spring Framework {@link CacheManager} implementation backed by a Pivotal GemFire cache instance * (either a client or peer cache). * - * Automatically discovers available caches (or GemFire {@link Region Regions}) when a cache for a given name + * Automatically discovers available caches (or Pivotal GemFire {@link Region Regions}) when a cache for a given name * is missing and dynamic cache lookup/creation is enabled. * * @author Costin Leau @@ -55,17 +55,16 @@ public class GemfireCacheManager extends AbstractCacheManager { private Set cacheNames; - /* (non-Javadoc) */ @SuppressWarnings("all") T assertGemFireCacheAvailable(T gemfireCache) { - Assert.state(gemfireCache != null, "A GemFire cache instance is required"); - Assert.state(!gemfireCache.isClosed(), String.format("GemFire cache [%s] has been closed", + + Assert.state(gemfireCache != null, "A cache instance is required"); + Assert.state(!gemfireCache.isClosed(), String.format("The cache [%s] has been closed", gemfireCache.getName())); return gemfireCache; } - /* (non-Javadoc) */ @SuppressWarnings("all") Region assertGemFireRegionAvailable(Region region, String cacheName) { Assert.state(region != null, String.format("No Region for cache name [%s] was found", cacheName)); @@ -75,23 +74,23 @@ public class GemfireCacheManager extends AbstractCacheManager { } /** - * Loads all configured GemFire {@link Region Regions} that will be used by this {@link CacheManager}. + * Loads all configured Pivotal GemFire {@link Region Regions} that will be used by this {@link CacheManager}. * - * Any GemFire {@link Region Regions} configured with the {@link #regions} property will take precedence over - * any configured {@link #cacheNames}. If no GemFire {@link Region Regions} were configured, then any - * {@link #cacheNames} that were specified will be used to lookup existing GemFire {@link Region Regions} + * Any Pivotal GemFire {@link Region Regions} configured with the {@link #regions} property will take precedence over + * any configured {@link #cacheNames}. If no Pivotal GemFire {@link Region Regions} were configured, then any + * {@link #cacheNames} that were specified will be used to lookup existing Pivotal GemFire {@link Region Regions} * to function as Spring {@link Cache Caches}in Spring's caching infrastructure. * * However, if neither {@link #regions} nor {@link #cacheNames} were specified, then all defined GemFire * {@link Region Regions} declared in the Spring application context, as determined by * {@link GemFireCache#rootRegions()}, will be used as Spring {@link Cache Caches}, and this {@link CacheManager} - * will allow any dynamically created GemFire {@link Region Regions} at runtime to be found and used as a + * will allow any dynamically created Pivotal GemFire {@link Region Regions} at runtime to be found and used as a * Spring {@link Cache} as well. * - * @return a {@link Collection} of GemFire {@link Region Regions} used by this {@link CacheManager} + * @return a {@link Collection} of Pivotal GemFire {@link Region Regions} used by this {@link CacheManager} * to function as {@link Cache Caches} in Spring's caching infrastructure. - * @throws IllegalStateException if a GemFire cache instance was not provided, the provided GemFire cache instance - * has been closed, no GemFire {@link Region} could be found for a given cache name, or the GemFire {@link Region} + * @throws IllegalStateException if a Pivotal GemFire cache instance was not provided, the provided Pivotal GemFire cache instance + * has been closed, no Pivotal GemFire {@link Region} could be found for a given cache name, or the Pivotal GemFire {@link Region} * for the given cache name has been destroyed. * @see org.springframework.cache.Cache */ @@ -108,8 +107,8 @@ public class GemfireCacheManager extends AbstractCacheManager { return caches; } - /* (non-Javadoc) */ Set> resolveRegions(GemFireCache gemfireCache, Set> regions, Set cacheNames) { + if (isSet(regions)) { dynamic.set(false); return regions; @@ -130,16 +129,15 @@ public class GemfireCacheManager extends AbstractCacheManager { } } - /* (non-Javadoc) */ boolean isSet(Iterable collection) { return (collection != null && collection.iterator().hasNext()); } /** - * Constructs a new instance of {@link GemfireCache} initialized with the given GemFire {@link Region}. + * Constructs a new instance of {@link GemfireCache} initialized with the given Pivotal GemFire {@link Region}. * - * @param region GemFire {@link Region} to wrap (adapt). - * @return an instance of {@link GemfireCache} initialized with the given GemFire {@link Region}. + * @param region Pivotal GemFire {@link Region} to wrap (adapt). + * @return an instance of {@link GemfireCache} initialized with the given Pivotal GemFire {@link Region}. * @see GemfireCache * @see org.apache.geode.cache.Region */ @@ -147,7 +145,6 @@ public class GemfireCacheManager extends AbstractCacheManager { return GemfireCache.wrap(region); } - /* (non-Javadoc) */ Region regionFor(GemFireCache gemfireCache, String cacheName) { return assertGemFireRegionAvailable(assertGemFireCacheAvailable(gemfireCache).getRegion(cacheName), cacheName); } @@ -168,9 +165,10 @@ public class GemfireCacheManager extends AbstractCacheManager { */ @Override protected Cache getMissingCache(String name) { + Cache cache = super.getMissingCache(name); - return (cache != null ? cache : (isDynamic() ? newGemfireCache(regionFor(this.gemfireCache, name)) : null)); + return cache != null ? cache : (isDynamic() ? newGemfireCache(regionFor(this.gemfireCache, name)) : null); } /** @@ -183,14 +181,14 @@ public class GemfireCacheManager extends AbstractCacheManager { } /** - * Sets the GemFire cache instance backing this {@link CacheManager}. + * Sets the Pivotal GemFire cache instance backing this {@link CacheManager}. * * When set, if neither {@link Region Regions} nor {@code cacheNames} were specified, then this {@link CacheManager} - * is capable of creating Spring {@link Cache Caches} backed by existing GemFire {@link Region Regions} used by + * is capable of creating Spring {@link Cache Caches} backed by existing Pivotal GemFire {@link Region Regions} used by * the application at runtime. However, in order to dynamically create Spring {@link Cache Caches} a reference to - * an open GemFire cache instance must be set. + * an open Pivotal GemFire cache instance must be set. * - * @param gemfireCache the GemFire cache instance used by this {@link CacheManager} + * @param gemfireCache the Pivotal GemFire cache instance used by this {@link CacheManager} * to manage Spring {@link Cache Caches}. * @see org.apache.geode.cache.GemFireCache */ @@ -212,7 +210,7 @@ public class GemfireCacheManager extends AbstractCacheManager { * Sets the names of all Spring {@link Cache Caches} that will be used in the application. * * When set, this disables the dynamic capability of this {@link CacheManager} to create Spring {@link Cache Caches} - * at runtime by dynamically looking up existing {@link Region Regions} from the GemFire cache instance. + * at runtime by dynamically looking up existing {@link Region Regions} from the Pivotal GemFire cache instance. * * @param cacheNames {@link Set} of cache names that will be used in the application. * @see java.util.Set @@ -222,13 +220,13 @@ public class GemfireCacheManager extends AbstractCacheManager { } /** - * Explicitly sets the GemFire {@link Region Regions} to be used as Spring {@link Cache Caches} + * Explicitly sets the Pivotal GemFire {@link Region Regions} to be used as Spring {@link Cache Caches} * in the application. * * When set, this disables the dynamic capability of this {@link CacheManager} to create Spring {@link Cache Caches} - * at runtime by dynamically looking up existing {@link Region Regions} from the GemFire cache instance. + * at runtime by dynamically looking up existing {@link Region Regions} from the Pivotal GemFire cache instance. * - * @param regions {@link Set} of GemFire {@link Region Regions} used by this {@link CacheManager} + * @param regions {@link Set} of Pivotal GemFire {@link Region Regions} used by this {@link CacheManager} * as Spring {@link Cache Caches}. * @see org.apache.geode.cache.Region */ @@ -237,10 +235,10 @@ public class GemfireCacheManager extends AbstractCacheManager { } /** - * Returns the set of GemFire {@link Region Regions} used explicitly as Spring {@link Cache Caches} + * Returns the set of Pivotal GemFire {@link Region Regions} used explicitly as Spring {@link Cache Caches} * in Spring's caching infrastructure. * - * @return the set of GemFire {@link Region Regions} functioning as Spring {@link Cache Caches} + * @return the set of Pivotal GemFire {@link Region Regions} functioning as Spring {@link Cache Caches} * in Spring's caching infrastructure * @see org.apache.geode.cache.Region */ diff --git a/src/main/java/org/springframework/data/gemfire/cache/config/GemfireCachingConfiguration.java b/src/main/java/org/springframework/data/gemfire/cache/config/GemfireCachingConfiguration.java index dcf97f0a..a860964b 100644 --- a/src/main/java/org/springframework/data/gemfire/cache/config/GemfireCachingConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/cache/config/GemfireCachingConfiguration.java @@ -27,8 +27,8 @@ import org.springframework.data.gemfire.cache.GemfireCacheManager; * used to configure Pivotal GemFire or Apache Geode as the caching provider in Spring's Cache Abstraction. * * This {@link Configuration @Configuration} class is specifically responsible for declaring and registering - * Spring Data GemFire/Geode's {@link GemfireCacheManager} implementation to properly enable either Pivotal GemFire - * or Apache Geode as the caching provider used with Springs Cache Abstraction. + * SDG {@link GemfireCacheManager} implementation to properly enable either Pivotal GemFire or Apache Geode + * as the caching provider used with Springs Cache Abstraction. * * Additionally, this Spring {@link Configuration @Configuration} class also enables the Spring Cache Abstraction * by declaring Spring's {@link EnableCaching} annotation for the user extending or importing this class using diff --git a/src/main/java/org/springframework/data/gemfire/client/ClientCacheFactoryBean.java b/src/main/java/org/springframework/data/gemfire/client/ClientCacheFactoryBean.java index 031be220..f7a91daa 100644 --- a/src/main/java/org/springframework/data/gemfire/client/ClientCacheFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/client/ClientCacheFactoryBean.java @@ -504,7 +504,7 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Set the GemFire System property 'durable-client-id' to indicate to the server that this client is durable. + * Set the Pivotal GemFire System property 'durable-client-id' to indicate to the server that this client is durable. * * @param durableClientId a String value indicating the durable client id. */ @@ -513,7 +513,7 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Gets the value of the GemFire System property 'durable-client-id' indicating to the server whether + * Gets the value of the Pivotal GemFire System property 'durable-client-id' indicating to the server whether * this client is durable. * * @return a String value indicating the durable client id. @@ -523,7 +523,7 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Set the GemFire System property 'durable-client-timeout' indicating to the server how long to track events + * Set the Pivotal GemFire System property 'durable-client-timeout' indicating to the server how long to track events * for the durable client when disconnected. * * @param durableClientTimeout an Integer value indicating the timeout in seconds for the server to keep @@ -534,7 +534,7 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Get the value of the GemFire System property 'durable-client-timeout' indicating to the server how long + * Get the value of the Pivotal GemFire System property 'durable-client-timeout' indicating to the server how long * to track events for the durable client when disconnected. * * @return an Integer value indicating the timeout in seconds for the server to keep @@ -667,10 +667,10 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Sets the {@link Pool} used by this cache client to obtain connections to the GemFire cluster. + * Sets the {@link Pool} used by this cache client to obtain connections to the Pivotal GemFire cluster. * - * @param pool the GemFire {@link Pool} used by this {@link ClientCache} to obtain connections - * to the GemFire cluster. + * @param pool the Pivotal GemFire {@link Pool} used by this {@link ClientCache} to obtain connections + * to the Pivotal GemFire cluster. * @throws IllegalArgumentException if the {@link Pool} is null. */ public void setPool(Pool pool) { @@ -678,19 +678,19 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Gets the {@link Pool} used by this cache client to obtain connections to the GemFire cluster. + * Gets the {@link Pool} used by this cache client to obtain connections to the Pivotal GemFire cluster. * - * @return the GemFire {@link Pool} used by this {@link ClientCache} to obtain connections - * to the GemFire cluster. + * @return the Pivotal GemFire {@link Pool} used by this {@link ClientCache} to obtain connections + * to the Pivotal GemFire cluster. */ public Pool getPool() { return this.pool; } /** - * Sets the name of the {@link Pool} used by this cache client to obtain connections to the GemFire cluster. + * Sets the name of the {@link Pool} used by this cache client to obtain connections to the Pivotal GemFire cluster. * - * @param poolName set the name of the GemFire {@link Pool} used by this GemFire {@link ClientCache}. + * @param poolName set the name of the Pivotal GemFire {@link Pool} used by this Pivotal GemFire {@link ClientCache}. * @throws IllegalArgumentException if the {@link Pool} name is unspecified. */ public void setPoolName(String poolName) { @@ -698,9 +698,9 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Gets the name of the GemFire {@link Pool} used by this GemFire cache client. + * Gets the name of the Pivotal GemFire {@link Pool} used by this Pivotal GemFire cache client. * - * @return the name of the GemFire {@link Pool} used by this GemFire cache client. + * @return the name of the Pivotal GemFire {@link Pool} used by this Pivotal GemFire cache client. */ public String getPoolName() { return poolName; @@ -758,10 +758,10 @@ public class ClientCacheFactoryBean extends CacheFactoryBean implements Applicat } /** - * Determines whether this GemFire cache client is ready for events. If 'readyForEvents' was explicitly set, + * Determines whether this Pivotal GemFire cache client is ready for events. If 'readyForEvents' was explicitly set, * then it takes precedence over all other considerations (e.g. durability). * - * @return a boolean value indicating whether this GemFire cache client is ready for events. + * @return a boolean value indicating whether this Pivotal GemFire cache client is ready for events. * @see org.springframework.data.gemfire.GemfireUtils#isDurable(ClientCache) * @see #getReadyForEvents() */ diff --git a/src/main/java/org/springframework/data/gemfire/client/ClientRegionFactoryBean.java b/src/main/java/org/springframework/data/gemfire/client/ClientRegionFactoryBean.java index ccc09ec2..5e798d0f 100644 --- a/src/main/java/org/springframework/data/gemfire/client/ClientRegionFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/client/ClientRegionFactoryBean.java @@ -530,7 +530,7 @@ public class ClientRegionFactoryBean extends RegionLookupFactoryBean /** * Sets the CacheLoader used to load data local to the client's Region on cache misses. * - * @param cacheLoader a GemFire CacheLoader used to load data into the client Region. + * @param cacheLoader a Pivotal GemFire CacheLoader used to load data into the client Region. * @see org.apache.geode.cache.CacheLoader */ public void setCacheLoader(CacheLoader cacheLoader) { @@ -540,7 +540,7 @@ public class ClientRegionFactoryBean extends RegionLookupFactoryBean /** * Sets the CacheWriter used to perform a synchronous write-behind when data is put into the client's Region. * - * @param cacheWriter the GemFire CacheWriter used to perform synchronous write-behinds on put ops. + * @param cacheWriter the Pivotal GemFire CacheWriter used to perform synchronous write-behinds on put ops. * @see org.apache.geode.cache.CacheWriter */ public void setCacheWriter(CacheWriter cacheWriter) { diff --git a/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutConverter.java b/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutConverter.java index 79599e0c..2af3b9c4 100644 --- a/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutConverter.java +++ b/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutConverter.java @@ -21,7 +21,7 @@ import org.springframework.core.convert.converter.Converter; /** * The ClientRegionShortcutConverter class is a Spring Converter implementation converting String value Client Region - * Shortcut representations into actual GemFire ClientRegionShortcut enumerated values. + * Shortcut representations into actual Pivotal GemFire ClientRegionShortcut enumerated values. * * @author John Blum * @see org.springframework.core.convert.converter.Converter diff --git a/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutWrapper.java b/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutWrapper.java index e987ea88..2544457e 100644 --- a/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutWrapper.java +++ b/src/main/java/org/springframework/data/gemfire/client/ClientRegionShortcutWrapper.java @@ -21,10 +21,12 @@ import org.apache.geode.cache.client.ClientRegionShortcut; import org.springframework.util.ObjectUtils; /** - * The {@link ClientRegionShortcutWrapper} enum is a Java enumerated type that wraps GemFire's {@link ClientRegionShortcut ClientRegionShortcuts} - * with Spring Data GemFire {@link ClientRegionShortcutWrapper} enumerated values. + * The {@link ClientRegionShortcutWrapper} enum is a Java enumerated type that wraps Pivotal GemFire's + * {@link ClientRegionShortcut ClientRegionShortcuts} with SDG {@link ClientRegionShortcutWrapper} + * enumerated values. * * @author John Blum + * @see org.apache.geode.cache.DataPolicy * @see org.apache.geode.cache.client.ClientRegionShortcut * @since 1.4.0 */ diff --git a/src/main/java/org/springframework/data/gemfire/client/GemfireDataSourcePostProcessor.java b/src/main/java/org/springframework/data/gemfire/client/GemfireDataSourcePostProcessor.java index b2febe91..1628cf0a 100644 --- a/src/main/java/org/springframework/data/gemfire/client/GemfireDataSourcePostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/client/GemfireDataSourcePostProcessor.java @@ -35,7 +35,7 @@ import org.springframework.util.ObjectUtils; /** * A Spring {@link BeanFactoryPostProcessor} used to register a Client Region Proxy bean for each Region - * accessible to a GemFire DataSource. If the Region is already defined, the bean definition will not be overridden. + * accessible to a Pivotal GemFire DataSource. If the Region is already defined, the bean definition will not be overridden. * * @author David Turanski * @author John Blum @@ -58,10 +58,10 @@ public class GemfireDataSourcePostProcessor implements BeanFactoryPostProcessor /** * Constructs an instance of the GemfireDataSourcePostProcessor BeanFactoryPostProcessor class initialized - * with the specified GemFire ClientCache instance for creating client PROXY Regions for all data Regions - * configured in the GemFire cluster. + * with the specified Pivotal GemFire ClientCache instance for creating client PROXY Regions for all data Regions + * configured in the Pivotal GemFire cluster. * - * @param clientCache the GemFire ClientCache instance. + * @param clientCache the Pivotal GemFire ClientCache instance. * @see org.apache.geode.cache.client.ClientCache */ public GemfireDataSourcePostProcessor(final ClientCache clientCache) { diff --git a/src/main/java/org/springframework/data/gemfire/client/InterestResultPolicyConverter.java b/src/main/java/org/springframework/data/gemfire/client/InterestResultPolicyConverter.java index 7110cb98..adf19ec1 100644 --- a/src/main/java/org/springframework/data/gemfire/client/InterestResultPolicyConverter.java +++ b/src/main/java/org/springframework/data/gemfire/client/InterestResultPolicyConverter.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS /** * The InterestResultPolicyConverter class is a Spring Converter and JavaBeans PropertyEditor capable of converting - * a String into a GemFire InterestResultPolicyConverter. + * a String into a Pivotal GemFire InterestResultPolicyConverter. * * @author John Blum * @see org.springframework.data.gemfire.support.AbstractPropertyEditorConverterSupport @@ -31,11 +31,11 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS public class InterestResultPolicyConverter extends AbstractPropertyEditorConverterSupport { /** - * Converts the given String into an instance of GemFire InterestResultPolicy. + * Converts the given String into an instance of Pivotal GemFire InterestResultPolicy. * * @param source the String to convert into an InterestResultPolicy value. - * @return a GemFire InterestResultPolicy value for the given String. - * @throws java.lang.IllegalArgumentException if the String is not a valid GemFire InterestResultPolicy. + * @return a Pivotal GemFire InterestResultPolicy value for the given String. + * @throws java.lang.IllegalArgumentException if the String is not a valid Pivotal GemFire InterestResultPolicy. * @see org.springframework.data.gemfire.client.InterestResultPolicyType#getInterestResultPolicy(InterestResultPolicyType) * @see org.springframework.data.gemfire.client.InterestResultPolicyType#valueOfIgnoreCase(String) * @see #assertConverted(String, Object, Class) diff --git a/src/main/java/org/springframework/data/gemfire/client/PoolAdapter.java b/src/main/java/org/springframework/data/gemfire/client/PoolAdapter.java index 9793e951..a25610ab 100644 --- a/src/main/java/org/springframework/data/gemfire/client/PoolAdapter.java +++ b/src/main/java/org/springframework/data/gemfire/client/PoolAdapter.java @@ -28,9 +28,9 @@ import org.apache.geode.cache.query.QueryService; * that conveniently enables implementing classes to extend this adapter to adapt their interfaces and serve * as a {@link Pool}. * - * For instance, one possible implementation is Spring Data GemFire's {@link PoolFactoryBean}, which can act as - * a {@link Pool} in a context where only the {@link Pool}'s "configuration" and meta-data are required, - * but not actual connections or operating state information (e.g. pendingEventCount). + * For instance, one possible implementation is SDG's {@link PoolFactoryBean}, which can act as a {@link Pool} + * in a context where only the {@link Pool}'s "configuration" and meta-data are required, but no actual connections + * or operating state information (e.g. pendingEventCount) is needed. * * @author John Blum * @see org.springframework.data.gemfire.client.PoolFactoryBean @@ -42,143 +42,114 @@ public abstract class PoolAdapter implements Pool { public static final String NOT_IMPLEMENTED = "Not Implemented"; - /* (non-Javadoc) */ public boolean isDestroyed() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getFreeConnectionTimeout() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public long getIdleTimeout() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getLoadConditioningInterval() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public List getLocators() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getMaxConnections() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getMinConnections() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public boolean getMultiuserAuthentication() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public String getName() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ - @Override public List getOnlineLocators() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getPendingEventCount() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public long getPingInterval() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public boolean getPRSingleHopEnabled() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public QueryService getQueryService() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getReadTimeout() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getRetryAttempts() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public String getServerGroup() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public List getServers() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getSocketBufferSize() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getStatisticInterval() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getSubscriptionAckInterval() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public boolean getSubscriptionEnabled() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getSubscriptionMessageTrackingTimeout() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public int getSubscriptionRedundancy() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public boolean getThreadLocalConnections() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public void destroy() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public void destroy(final boolean keepAlive) { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } - /* (non-Javadoc) */ public void releaseThreadLocalConnection() { throw new UnsupportedOperationException(NOT_IMPLEMENTED); } diff --git a/src/main/java/org/springframework/data/gemfire/client/PoolFactoryBean.java b/src/main/java/org/springframework/data/gemfire/client/PoolFactoryBean.java index ceac7ead..6a662374 100644 --- a/src/main/java/org/springframework/data/gemfire/client/PoolFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/client/PoolFactoryBean.java @@ -78,7 +78,7 @@ public class PoolFactoryBean extends AbstractFactoryBeanSupport implements // indicates whether the Pool has been created internally (by this FactoryBean) or not volatile boolean springBasedPool = true; - // GemFire Pool Configuration Settings + // Pivotal GemFire Pool Configuration Settings private boolean keepAlive = false; private boolean multiUserAuthentication = PoolFactory.DEFAULT_MULTIUSER_AUTHENTICATION; private boolean prSingleHopEnabled = PoolFactory.DEFAULT_PR_SINGLE_HOP_ENABLED; diff --git a/src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java b/src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java index 5a83146b..72607812 100644 --- a/src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java +++ b/src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java @@ -26,8 +26,8 @@ import org.apache.geode.cache.execute.Function; import org.apache.geode.cache.execute.FunctionContext; /** - * ListRegionsOnServerFunction is a GemFire Function class that returns a List of names for all Regions - * defined in the GemFire cluster. + * ListRegionsOnServerFunction is a Pivotal GemFire Function class that returns a List of names for all Regions + * defined in the Pivotal GemFire cluster. * * @author David Turanski * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/client/package-info.java b/src/main/java/org/springframework/data/gemfire/client/package-info.java index d389150b..151fdd75 100644 --- a/src/main/java/org/springframework/data/gemfire/client/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/client/package-info.java @@ -1,6 +1,6 @@ /** * - * Classes providing support for GemFire client configuration. + * Classes providing support for Pivotal GemFire client configuration. * */ -package org.springframework.data.gemfire.client; \ No newline at end of file +package org.springframework.data.gemfire.client; diff --git a/src/main/java/org/springframework/data/gemfire/client/support/DelegatingPoolAdapter.java b/src/main/java/org/springframework/data/gemfire/client/support/DelegatingPoolAdapter.java index 64a67b8c..7b01ef57 100644 --- a/src/main/java/org/springframework/data/gemfire/client/support/DelegatingPoolAdapter.java +++ b/src/main/java/org/springframework/data/gemfire/client/support/DelegatingPoolAdapter.java @@ -25,8 +25,8 @@ import org.apache.geode.cache.client.Pool; import org.apache.geode.cache.query.QueryService; /** - * DelegatingPoolAdapter is an abstract implementation of GemFire's {@link Pool} interface and extension of - * {@link FactoryDefaultsPoolAdapter} that delegates operations to the provided {@link Pool} instance. + * {@link DelegatingPoolAdapter} is an abstract implementation of Pivotal GemFire's {@link Pool} interface + * and extension of {@link FactoryDefaultsPoolAdapter} that delegates operations to the provided {@link Pool} instance. * * However, this implementation guards against a potentially null {@link Pool} reference by returning * default factory settings for the {@link Pool}'s configuration properties along with default behavior for operations @@ -42,7 +42,6 @@ public abstract class DelegatingPoolAdapter extends FactoryDefaultsPoolAdapter { private final Pool delegate; - /* (non-Javadoc) */ public static DelegatingPoolAdapter from(Pool delegate) { return new DelegatingPoolAdapter(delegate) { }; } @@ -57,184 +56,155 @@ public abstract class DelegatingPoolAdapter extends FactoryDefaultsPoolAdapter { this.delegate = delegate; } - /* (non-Javadoc) */ protected Pool getDelegate() { return delegate; } - /* (non-Javadoc) */ @Override public boolean isDestroyed() { return Optional.ofNullable(getDelegate()).map(Pool::isDestroyed).orElseGet(super::isDestroyed); } - /* (non-Javadoc) */ @Override public int getFreeConnectionTimeout() { return Optional.ofNullable(getDelegate()).map(Pool::getFreeConnectionTimeout) .orElseGet(super::getFreeConnectionTimeout); } - /* (non-Javadoc) */ @Override public long getIdleTimeout() { return Optional.ofNullable(getDelegate()).map(Pool::getIdleTimeout).orElseGet(super::getIdleTimeout); } - /* (non-Javadoc) */ @Override public int getLoadConditioningInterval() { return Optional.ofNullable(getDelegate()).map(Pool::getLoadConditioningInterval) .orElseGet(super::getLoadConditioningInterval); } - /* (non-Javadoc) */ @Override public List getLocators() { return Optional.ofNullable(getDelegate()).map(Pool::getLocators).orElseGet(super::getLocators); } - /* (non-Javadoc) */ @Override public int getMaxConnections() { return Optional.ofNullable(getDelegate()).map(Pool::getMaxConnections).orElseGet(super::getMaxConnections); } - /* (non-Javadoc) */ @Override public int getMinConnections() { return Optional.ofNullable(getDelegate()).map(Pool::getMinConnections).orElseGet(super::getMinConnections); } - /* (non-Javadoc) */ @Override public boolean getMultiuserAuthentication() { return Optional.ofNullable(getDelegate()).map(Pool::getMultiuserAuthentication) .orElseGet(super::getMultiuserAuthentication); } - /* (non-Javadoc) */ @Override public String getName() { return Optional.ofNullable(getDelegate()).map(Pool::getName).orElseGet(super::getName); } - /* (non-Javadoc) */ @Override public List getOnlineLocators() { return Optional.ofNullable(getDelegate()).map(Pool::getOnlineLocators).orElseGet(super::getOnlineLocators); } - /* (non-Javadoc) */ @Override public int getPendingEventCount() { return Optional.ofNullable(getDelegate()).map(Pool::getPendingEventCount).orElse(0); } - /* (non-Javadoc) */ @Override public long getPingInterval() { return Optional.ofNullable(getDelegate()).map(Pool::getPingInterval).orElseGet(super::getPingInterval); } - /* (non-Javadoc) */ @Override public boolean getPRSingleHopEnabled() { return Optional.ofNullable(getDelegate()).map(Pool::getPRSingleHopEnabled) .orElseGet(super::getPRSingleHopEnabled); } - /* (non-Javadoc) */ @Override public QueryService getQueryService() { return Optional.ofNullable(getDelegate()).map(Pool::getQueryService).orElseGet(super::getQueryService); } - /* (non-Javadoc) */ @Override public int getReadTimeout() { return Optional.ofNullable(getDelegate()).map(Pool::getReadTimeout).orElseGet(super::getReadTimeout); } - /* (non-Javadoc) */ @Override public int getRetryAttempts() { return Optional.ofNullable(getDelegate()).map(Pool::getRetryAttempts).orElseGet(super::getRetryAttempts); } - /* (non-Javadoc) */ @Override public String getServerGroup() { return Optional.ofNullable(getDelegate()).map(Pool::getServerGroup).orElseGet(super::getServerGroup); } - /* (non-Javadoc) */ @Override public List getServers() { return Optional.ofNullable(getDelegate()).map(Pool::getServers).orElseGet(super::getServers); } - /* (non-Javadoc) */ @Override public int getSocketBufferSize() { return Optional.ofNullable(getDelegate()).map(Pool::getSocketBufferSize).orElseGet(super::getSocketBufferSize); } - /* (non-Javadoc) */ @Override public int getStatisticInterval() { return Optional.ofNullable(getDelegate()).map(Pool::getStatisticInterval) .orElseGet(super::getStatisticInterval); } - /* (non-Javadoc) */ @Override public int getSubscriptionAckInterval() { return Optional.ofNullable(getDelegate()).map(Pool::getSubscriptionAckInterval) .orElseGet(super::getSubscriptionAckInterval); } - /* (non-Javadoc) */ @Override public boolean getSubscriptionEnabled() { return Optional.ofNullable(getDelegate()).map(Pool::getSubscriptionEnabled) .orElseGet(super::getSubscriptionEnabled); } - /* (non-Javadoc) */ @Override public int getSubscriptionMessageTrackingTimeout() { return Optional.ofNullable(getDelegate()).map(Pool::getSubscriptionMessageTrackingTimeout) .orElseGet(super::getSubscriptionMessageTrackingTimeout); } - /* (non-Javadoc) */ @Override public int getSubscriptionRedundancy() { return Optional.ofNullable(getDelegate()).map(Pool::getSubscriptionRedundancy) .orElseGet(super::getSubscriptionRedundancy); } - /* (non-Javadoc) */ @Override public boolean getThreadLocalConnections() { return Optional.ofNullable(getDelegate()).map(Pool::getThreadLocalConnections) .orElseGet(super::getThreadLocalConnections); } - /* (non-Javadoc) */ @Override public void destroy() { Optional.ofNullable(getDelegate()).ifPresent(Pool::destroy); } - /* (non-Javadoc) */ @Override public void destroy(boolean keepAlive) { Optional.ofNullable(getDelegate()).ifPresent(delegate -> delegate.destroy(keepAlive)); } - /* (non-Javadoc) */ @Override public void releaseThreadLocalConnection() { Optional.ofNullable(getDelegate()).ifPresent(Pool::releaseThreadLocalConnection); diff --git a/src/main/java/org/springframework/data/gemfire/config/admin/AbstractGemfireAdminOperations.java b/src/main/java/org/springframework/data/gemfire/config/admin/AbstractGemfireAdminOperations.java index 746f4853..8ff98034 100644 --- a/src/main/java/org/springframework/data/gemfire/config/admin/AbstractGemfireAdminOperations.java +++ b/src/main/java/org/springframework/data/gemfire/config/admin/AbstractGemfireAdminOperations.java @@ -38,9 +38,9 @@ public class AbstractGemfireAdminOperations implements GemfireAdminOperations { protected static final String NOT_IMPLEMENTED = "Not Implemented"; /** - * Returns a {@link Iterable collection} of {@link Region} names defined on the GemFire Servers in the cluster. + * Returns a {@link Iterable collection} of {@link Region} names defined on the Pivotal GemFire Servers in the cluster. * - * @return an {@link Iterable} of {@link Region} names defined on the GemFire Servers in the cluster. + * @return an {@link Iterable} of {@link Region} names defined on the Pivotal GemFire Servers in the cluster. * @see org.apache.geode.cache.Region#getName() * @see java.lang.Iterable */ diff --git a/src/main/java/org/springframework/data/gemfire/config/admin/GemfireAdminOperations.java b/src/main/java/org/springframework/data/gemfire/config/admin/GemfireAdminOperations.java index 93c26a1f..96efbe41 100644 --- a/src/main/java/org/springframework/data/gemfire/config/admin/GemfireAdminOperations.java +++ b/src/main/java/org/springframework/data/gemfire/config/admin/GemfireAdminOperations.java @@ -46,9 +46,9 @@ import org.springframework.data.gemfire.config.schema.definitions.RegionDefiniti public interface GemfireAdminOperations { /** - * Returns a {@link Iterable collection} of {@link Region} names defined on the GemFire Servers in the cluster. + * Returns a {@link Iterable collection} of {@link Region} names defined on the Pivotal GemFire Servers in the cluster. * - * @return an {@link Iterable} of {@link Region} names defined on the GemFire Servers in the cluster. + * @return an {@link Iterable} of {@link Region} names defined on the Pivotal GemFire Servers in the cluster. * @see org.apache.geode.cache.Region#getName() * @see java.lang.Iterable */ diff --git a/src/main/java/org/springframework/data/gemfire/config/admin/remote/FunctionGemfireAdminTemplate.java b/src/main/java/org/springframework/data/gemfire/config/admin/remote/FunctionGemfireAdminTemplate.java index 8bd525fd..c850099a 100644 --- a/src/main/java/org/springframework/data/gemfire/config/admin/remote/FunctionGemfireAdminTemplate.java +++ b/src/main/java/org/springframework/data/gemfire/config/admin/remote/FunctionGemfireAdminTemplate.java @@ -47,7 +47,7 @@ import org.springframework.util.Assert; * in the cluster. * * Note: any schema changing functionality (e.g. {@link #createRegion(RegionDefinition)}) does not get recorded by - * the GemFire/Geode Cluster Configuration Service using this strategy. + * the Pivotal GemFire/Apache Geode Cluster Configuration Service using this strategy. * * @author John Blum * @see org.apache.geode.cache.client.ClientCache @@ -91,7 +91,7 @@ public class FunctionGemfireAdminTemplate extends AbstractGemfireAdminOperations * / Apache Geode cluster. * * @return an {@link Iterable} of servers-side {@link Region} names for all {@link Region Regions} defined - * across all servers in the remote GemFire/Geode cluster. + * across all servers in the remote Pivotal GemFire/Apache Geode cluster. * @see java.lang.Iterable */ @Override diff --git a/src/main/java/org/springframework/data/gemfire/config/admin/remote/RestHttpGemfireAdminTemplate.java b/src/main/java/org/springframework/data/gemfire/config/admin/remote/RestHttpGemfireAdminTemplate.java index 0bad2916..2d19845d 100644 --- a/src/main/java/org/springframework/data/gemfire/config/admin/remote/RestHttpGemfireAdminTemplate.java +++ b/src/main/java/org/springframework/data/gemfire/config/admin/remote/RestHttpGemfireAdminTemplate.java @@ -67,7 +67,7 @@ public class RestHttpGemfireAdminTemplate extends FunctionGemfireAdminTemplate { /** * Constructs an instance of the {@link RestHttpGemfireAdminTemplate} initialized with * the given {@link ClientCache} and configured with the default host and port when accessing - * the GemFire or Geode Management REST API interface. + * the Pivotal GemFire or Geode Management REST API interface. * * @param clientCache reference to the {@link ClientCache} * @throws IllegalArgumentException if the {@link ClientCache} reference is {@literal null}. @@ -80,11 +80,11 @@ public class RestHttpGemfireAdminTemplate extends FunctionGemfireAdminTemplate { /** * Constructs an instance of the {@link RestHttpGemfireAdminTemplate} initialized with * the given {@link ClientCache} and configured with the specified host and port when accessing - * the GemFire or Geode Management REST API interface. + * the Pivotal GemFire or Geode Management REST API interface. * * @param clientCache reference to the {@link ClientCache} - * @param host {@link String} containing the hostname of the GemFire/Geode Manager. - * @param port integer value specifying the port on which the GemFire/Geode Manager HTTP Service is listening + * @param host {@link String} containing the hostname of the Pivotal GemFire/Apache Geode Manager. + * @param port integer value specifying the port on which the Pivotal GemFire/Apache Geode Manager HTTP Service is listening * for HTTP clients. * @throws IllegalArgumentException if the {@link ClientCache} reference is {@literal null}. * @see org.apache.geode.cache.client.ClientCache @@ -111,7 +111,7 @@ public class RestHttpGemfireAdminTemplate extends FunctionGemfireAdminTemplate { /** * Resolves the Pivotal GemFire or Apache Geode Management REST API URL given the host and port - * of the GemFire/Geode Manager's embedded HTTP service. + * of the Pivotal GemFire/Apache Geode Manager's embedded HTTP service. * * @param host {@link String} containing the hostname of the Manager running the embedded HTTP service * and Management REST API. @@ -123,9 +123,9 @@ public class RestHttpGemfireAdminTemplate extends FunctionGemfireAdminTemplate { } /** - * Returns a reference to the resolved GemFire/Geode Management REST API URL. + * Returns a reference to the resolved Pivotal GemFire/Apache Geode Management REST API URL. * - * @return a {@link String} containing the resolved GemFire/Geode Management REST API URL. + * @return a {@link String} containing the resolved Pivotal GemFire/Apache Geode Management REST API URL. */ protected String getManagementRestApiUrl() { return this.managementRestApiUrl; diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AbstractCacheConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AbstractCacheConfiguration.java index f43830da..af49efc3 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AbstractCacheConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AbstractCacheConfiguration.java @@ -167,7 +167,7 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi * * @return a {@link Properties} object containing Pivotal GemFire/Apache Geode properties used to configure * the Pivotal GemFire/Apache Geode cache instance. - * @see GemFire Properties + * @see Pivotal GemFire Properties * @see java.util.Properties * @see #locators() * @see #logLevel() @@ -202,11 +202,11 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi } /** - * Configures Spring container infrastructure components and beans used by Spring Data GemFire - * to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context. + * Configures Spring container infrastructure components and beans used by SDG to enable Pivotal GemFire + * or Apache Geode to function properly inside a Spring context. * * @param importMetadata {@link AnnotationMetadata} containing annotation meta-data - * for the Spring Data GemFire cache application class. + * for the SDG cache application class. * @see org.springframework.core.type.AnnotationMetadata */ protected void configureInfrastructure(AnnotationMetadata importMetadata) { @@ -308,7 +308,7 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi * @param importMetadata {@link AnnotationMetadata} containing PDX meta-data used to configure the cache * with PDX de/serialization capabilities. * @see org.springframework.core.type.AnnotationMetadata - * @see GemFire PDX Serialization + * @see Pivotal GemFire PDX Serialization */ protected void configurePdx(AnnotationMetadata importMetadata) { @@ -491,13 +491,13 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi // REVIEW JAVADOC FROM HERE /** - * Determines whether this is a GemFire {@link org.apache.geode.cache.server.CacheServer} application, + * Determines whether this is a Pivotal GemFire {@link org.apache.geode.cache.server.CacheServer} application, * which is indicated by the presence of the {@link CacheServerApplication} annotation on a Spring application * {@link org.springframework.context.annotation.Configuration @Configuration} class. * * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data * from the annotations used to configure the Spring application. - * @return a boolean value indicating whether this is a GemFire cache server application. + * @return a boolean value indicating whether this is a Pivotal GemFire cache server application. * @see org.springframework.data.gemfire.config.annotation.CacheServerApplication * @see #isTypedCacheApplication(Class, AnnotationMetadata) */ @@ -506,13 +506,13 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi } /** - * Determines whether this is a GemFire {@link org.apache.geode.cache.client.ClientCache} application, + * Determines whether this is a Pivotal GemFire {@link org.apache.geode.cache.client.ClientCache} application, * which is indicated by the presence of the {@link ClientCacheApplication} annotation on a Spring application * {@link org.springframework.context.annotation.Configuration @Configuration} class. * * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data * from the annotations used to configure the Spring application. - * @return a boolean value indicating whether this is a GemFire cache client application. + * @return a boolean value indicating whether this is a Pivotal GemFire cache client application. * @see org.springframework.data.gemfire.config.annotation.ClientCacheApplication * @see #isTypedCacheApplication(Class, AnnotationMetadata) */ @@ -521,13 +521,13 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi } /** - * Determines whether this is a GemFire peer {@link org.apache.geode.cache.Cache} application, + * Determines whether this is a Pivotal GemFire peer {@link org.apache.geode.cache.Cache} application, * which is indicated by the presence of the {@link PeerCacheApplication} annotation on a Spring application * {@link org.springframework.context.annotation.Configuration @Configuration} class. * * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data * from the annotations used to configure the Spring application. - * @return a boolean value indicating whether this is a GemFire peer cache application. + * @return a boolean value indicating whether this is a Pivotal GemFire peer cache application. * @see org.springframework.data.gemfire.config.annotation.PeerCacheApplication * @see #isTypedCacheApplication(Class, AnnotationMetadata) */ @@ -536,7 +536,7 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi } /** - * Determines whether this Spring application is annotated with the given GemFire cache type annotation. + * Determines whether this Spring application is annotated with the given Pivotal GemFire cache type annotation. * * @param annotationType {@link Annotation} cache type. * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data @@ -555,14 +555,14 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi } /** - * Determines whether this is a GemFire {@link org.apache.geode.cache.server.CacheServer} or + * Determines whether this is a Pivotal GemFire {@link org.apache.geode.cache.server.CacheServer} or * {@link org.apache.geode.cache.Cache peer cache} application, which is indicated by the presence * of either the {@link CacheServerApplication} annotation or the {@link PeerCacheApplication} annotation * on a Spring application {@link org.springframework.context.annotation.Configuration @Configuration} class. * * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data * from the annotations used to configure the Spring application. - * @return a boolean value indicating whether this is a GemFire cache server or peer cache application. + * @return a boolean value indicating whether this is a Pivotal GemFire cache server or peer cache application. * @see org.springframework.core.type.AnnotationMetadata * @see org.springframework.data.gemfire.config.annotation.CacheServerApplication * @see org.springframework.data.gemfire.config.annotation.PeerCacheApplication @@ -579,7 +579,7 @@ public abstract class AbstractCacheConfiguration extends AbstractAnnotationConfi * * @param importMetadata {@link AnnotationMetadata} containing application configuration meta-data * from the class type-level annotations used to configure the Spring application. - * @return a boolean value indicating whether this is a GemFire cache server, client cache or peer cache + * @return a boolean value indicating whether this is a Pivotal GemFire cache server, client cache or peer cache * Spring application. * @see #isCacheServerApplication(AnnotationMetadata) * @see #isClientCacheApplication(AnnotationMetadata) diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AddCacheServersConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AddCacheServersConfiguration.java index 7f81437e..92220f69 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AddCacheServersConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AddCacheServersConfiguration.java @@ -26,7 +26,7 @@ import org.springframework.core.type.AnnotationMetadata; /** * The {@link AddCacheServersConfiguration} class registers {@link org.springframework.data.gemfire.server.CacheServerFactoryBean} * bean definitions for all {@link EnableCacheServer} annotation configuration meta-data defined in - * the {@link EnableCacheServers} annotation on a GemFire peer cache application class. + * the {@link EnableCacheServers} annotation on a Pivotal GemFire peer cache application class. * * @author John Blum * @see org.springframework.data.gemfire.config.annotation.AddCacheServerConfiguration diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolConfiguration.java index 4b31ff1c..c1f5360d 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolConfiguration.java @@ -225,9 +225,9 @@ public class AddPoolConfiguration extends AbstractAnnotationConfigSupport } /** - * Uses the list of GemFire Locator and Server connection endpoint definitions and meta-data to configure - * the GemFire client {@link org.apache.geode.cache.client.Pool} used to communicate with the servers - * in the GemFire cluster. + * Uses the list of Pivotal GemFire Locator and Server connection endpoint definitions and meta-data to configure + * the Pivotal GemFire client {@link org.apache.geode.cache.client.Pool} used to communicate with the servers + * in the Pivotal GemFire cluster. * * @param enablePoolAttributes {@link EnablePool} annotation containing * {@link org.apache.geode.cache.client.Pool} Locator/Server connection endpoint meta-data. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolsConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolsConfiguration.java index ef67d0a1..8154f9e4 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolsConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AddPoolsConfiguration.java @@ -26,7 +26,7 @@ import org.springframework.core.type.AnnotationMetadata; /** * The {@link AddPoolsConfiguration} class registers {@link org.springframework.data.gemfire.client.PoolFactoryBean} * bean definitions for all {@link EnablePool} annotation configuration meta-data defined in - * the {@link EnablePools} annotation on a GemFire client cache application class. + * the {@link EnablePools} annotation on a Pivotal GemFire client cache application class. * @author John Blum * @see org.apache.geode.cache.client.Pool diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ApacheShiroSecurityConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ApacheShiroSecurityConfiguration.java index 9c34855a..6d9c69bc 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ApacheShiroSecurityConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ApacheShiroSecurityConfiguration.java @@ -143,9 +143,9 @@ public class ApacheShiroSecurityConfiguration extends AbstractAnnotationConfigSu * declared in the Spring {@link org.springframework.context.ApplicationContext}. * * This {@link Bean} definition declares a dependency on the Apache Geode {@link GemFireCache} instance - * in order to ensure the Geode cache is created and initialized first. This ensures that any internal Geode - * security configuration logic is evaluated and processed before SDG attempts to configure Apache Shiro - * as Apache Geode's security provider. + * in order to ensure the Apache Geode cache is created and initialized first. This ensures that any internal + * Apache Geode security configuration logic is evaluated and processed before SDG attempts to configure + * Apache Shiro as Apache Geode's security provider. * * Additionally, this {@link Bean} definition will register the Apache Shiro * {@link org.apache.geode.security.SecurityManager} with the Apache Shiro security framework diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AutoConfiguredAuthenticationConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AutoConfiguredAuthenticationConfiguration.java index 9d2527ee..e3a0c19e 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AutoConfiguredAuthenticationConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AutoConfiguredAuthenticationConfiguration.java @@ -33,7 +33,7 @@ import org.springframework.util.StringUtils; /** * The {@link AutoConfiguredAuthenticationConfiguration} class is a Spring {@link Configuration @Configuration} class * that auto-configures Pivotal GemFire / Apache Geode Authentication by providing a implementation - * of the {@link org.apache.geode.security.AuthInitialize} interface along with setting the necessary GemFire / Geode + * of the {@link org.apache.geode.security.AuthInitialize} interface along with setting the necessary Pivotal GemFire / Geode * properties. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/AutoRegionLookupConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/AutoRegionLookupConfiguration.java index 6b3a6f77..4674b2ed 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/AutoRegionLookupConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/AutoRegionLookupConfiguration.java @@ -45,12 +45,12 @@ import org.springframework.util.StringUtils; /** * The {@link AutoRegionLookupConfiguration} class is a Spring {@link ImportBeanDefinitionRegistrar} that enables - * the automatic lookup of GemFire Regions, which may have been defined else where, such as in {@literal cache.xml} - * or using GemFire's Cluster Configuration Service. + * the automatic lookup of Pivotal GemFire Regions, which may have been defined else where, such as in {@literal cache.xml} + * or using Pivotal GemFire's Cluster Configuration Service. * * This registrar works by registering the {@link AutoRegionLookupBeanPostProcessor} in the Spring application context, * which is enabled when a Spring {@link org.springframework.context.annotation.Configuration @Configuration} annotated - * GemFire cache application class is annotated with {@link EnableAutoRegionLookup}. + * Pivotal GemFire cache application class is annotated with {@link EnableAutoRegionLookup}. * * @author John Blum * @see org.springframework.beans.factory.BeanFactory @@ -79,7 +79,6 @@ public class AutoRegionLookupConfiguration extends AbstractAnnotationConfigSuppo private StandardEvaluationContext evaluationContext = new StandardEvaluationContext(); - /* (non-Javadoc) */ @Override protected Class getAnnotationType() { return EnableAutoRegionLookup.class; @@ -153,7 +152,6 @@ public class AutoRegionLookupConfiguration extends AbstractAnnotationConfigSuppo return DEFAULT_ENABLED; } - /* (non-Javadoc) */ private void registerAutoRegionLookupBeanPostProcessor(BeanDefinitionRegistry registry) { if (AUTO_REGION_LOOKUP_BEAN_POST_PROCESSOR_REGISTERED.compareAndSet(false, true)) { diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/BeanFactoryLocatorConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/BeanFactoryLocatorConfiguration.java index 27e1018e..71e18cfc 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/BeanFactoryLocatorConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/BeanFactoryLocatorConfiguration.java @@ -25,8 +25,8 @@ import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator; /** * The {@link BeanFactoryLocatorConfiguration} class extends the Spring application configuration by enabling - * Spring Data GemFire/Geode's {@link GemfireBeanFactoryLocator} in order to auto-wire and configure any - * GemFire/Geode Objects declared in GemFire/Geode config (e.g. XML or properties). + * SDG's {@link GemfireBeanFactoryLocator} in order to auto-wire and configure any Pivotal GemFire/Apache Geode objects + * declared in Pivotal GemFire/Apache Geode config (e.g. XML or properties). * * @author John Blum * @see org.springframework.beans.factory.config.BeanPostProcessor @@ -42,8 +42,8 @@ import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator; public class BeanFactoryLocatorConfiguration { /** - * Declares and registers a Spring {@link BeanPostProcessor} and post processes a Spring Data GemFire/Geode - * {@link CacheFactoryBean} by setting the {@literal useBeanFactoryLocator} property to {@literal true}. + * Declares and registers a Spring {@link BeanPostProcessor} and post processes a SDG {@link CacheFactoryBean} + * by setting the {@literal useBeanFactoryLocator} property to {@literal true}. * * @return a Spring {@link BeanPostProcessor} used to post process the SDG {@link CacheFactoryBean}. * @see org.springframework.beans.factory.config.BeanPostProcessor diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/CacheServerApplication.java b/src/main/java/org/springframework/data/gemfire/config/annotation/CacheServerApplication.java index 47ecf33c..dbe1d2f0 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/CacheServerApplication.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/CacheServerApplication.java @@ -33,10 +33,10 @@ import org.springframework.context.annotation.Import; import org.springframework.data.gemfire.server.SubscriptionEvictionPolicy; /** - * The CacheServerApplication annotation enables an embedded GemFire - * {@link org.apache.geode.cache.server.CacheServer} instance in a Spring Data GemFire based application. + * The CacheServerApplication annotation enables an embedded Pivotal GemFire {@link CacheServer} instance + * in a SDG-based application. * - * In addition, this also implies an embedded GemFire peer {@link org.apache.geode.cache.Cache} must exist + * In addition, this also implies an embedded Pivotal GemFire peer {@link org.apache.geode.cache.Cache} must exist * and therefore will be configured, constructed and initialized as a Spring bean in the application context. * * @author John Blum @@ -107,7 +107,7 @@ public @interface CacheServerApplication { float criticalOffHeapPercentage() default 0.0f; /** - * By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache + * By default, a Pivotal GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache * after it has been forced out of the distributed system by a network partition event or has otherwise been * shunned by other members. Use this property to enable the auto-reconnect behavior. * @@ -185,7 +185,7 @@ public @interface CacheServerApplication { int lockTimeout() default 60; /** - * Configures the log level used to output log messages at GemFire cache runtime. + * Configures the log level used to output log messages at Pivotal GemFire cache runtime. * * Defaults to {@literal config}. * @@ -252,7 +252,7 @@ public @interface CacheServerApplication { int messageTimeToLive() default CacheServer.DEFAULT_MESSAGE_TIME_TO_LIVE; /** - * Configures the name of this GemFire member in the cluster (distributed system). + * Configures the name of this Pivotal GemFire member in the cluster (distributed system). * * Defaults to {@literal SpringBasedCacheServerApplication}. * @@ -318,8 +318,8 @@ public @interface CacheServerApplication { /** * Determines whether the Spring {@link BeanFactory} locator should be enabled to lookup - * the Spring {@link BeanFactory} to auto-wire and configure/initialize GemFire components - * created in a non-Spring managed, GemFire context. + * the Spring {@link BeanFactory} to auto-wire and configure/initialize Pivotal GemFire components + * created in a non-Spring managed, Pivotal GemFire context. * * Defaults to {@literal false}. * @@ -328,7 +328,7 @@ public @interface CacheServerApplication { boolean useBeanFactoryLocator() default false; /** - * Configures whether this GemFire cache member node would pull it's configuration meta-data + * Configures whether this Pivotal GemFire cache member node would pull it's configuration meta-data * from the cluster-based Cluster Configuration service. * * Defaults to {@literal false}. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/CachingDefinedRegionsConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/CachingDefinedRegionsConfiguration.java index a92eae20..0cce7191 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/CachingDefinedRegionsConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/CachingDefinedRegionsConfiguration.java @@ -67,7 +67,7 @@ import org.springframework.util.StringUtils; /** * The {@link CachingDefinedRegionsConfiguration} class is a Spring {@link Configuration @Configuration} class - * that applies configuration to a Spring (Data GemFire/Geode) application to create GemFire/Geode cache + * that applies configuration to a Spring (Data Pivotal GemFire/Apache Geode) application to create Pivotal GemFire/Apache Geode cache * {@link Region Regions} based on the use of Spring's Cache Abstraction to enable caching for application * service classes and methods. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheApplication.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheApplication.java index ef3e86b9..2b029ae1 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheApplication.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheApplication.java @@ -33,8 +33,8 @@ import org.springframework.data.gemfire.GemfireUtils; import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator; /** - * The {@link ClientCacheApplication} annotation enables a Spring Data GemFire based application to become - * a GemFire cache client (i.e. {@link org.apache.geode.cache.client.ClientCache}). + * The {@link ClientCacheApplication} annotation enables a SDG based application to become a + * Pivotal GemFire cache client (i.e. {@link org.apache.geode.cache.client.ClientCache}). * * @author John Blum * @see org.apache.geode.cache.client.PoolFactory @@ -163,7 +163,7 @@ public @interface ClientCacheApplication { int loadConditioningInterval() default PoolFactory.DEFAULT_LOAD_CONDITIONING_INTERVAL; /** - * Configures the GemFire {@link org.apache.geode.distributed.Locator Locators} to which + * Configures the Pivotal GemFire {@link org.apache.geode.distributed.Locator Locators} to which * this cache client will connect. * * Use either the {@literal spring.data.gemfire.pool.default.locators} property @@ -172,7 +172,7 @@ public @interface ClientCacheApplication { Locator[] locators() default {}; /** - * Configures the log level used to output log messages at GemFire cache runtime. + * Configures the log level used to output log messages at Pivotal GemFire cache runtime. * * Defaults to {@literal config}. * @@ -212,7 +212,7 @@ public @interface ClientCacheApplication { boolean multiUserAuthentication() default PoolFactory.DEFAULT_MULTIUSER_AUTHENTICATION; /** - * Configures the name of this GemFire member in the cluster (distributed system). + * Configures the name of this Pivotal GemFire member in the cluster (distributed system). * * Defaults to {@literal SpringBasedCacheClientApplication}. * @@ -284,7 +284,7 @@ public @interface ClientCacheApplication { String serverGroup() default PoolFactory.DEFAULT_SERVER_GROUP; /** - * Configures the GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers} to which + * Configures the Pivotal GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers} to which * this cache client will connect. * * Use either the {@literal spring.data.gemfire.pool.default.servers} property @@ -369,8 +369,8 @@ public @interface ClientCacheApplication { /** * Determines whether the {@link GemfireBeanFactoryLocator} should be enabled to lookup - * the Spring {@link BeanFactory} to auto-wire and configure/initialize GemFire components - * created in a non-Spring managed, GemFire context. + * the Spring {@link BeanFactory} to auto-wire and configure/initialize Pivotal GemFire components + * created in a non-Spring managed, Pivotal GemFire context. * * Defaults to {@literal false}. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheConfiguration.java index 1cc1d5ff..d12e5442 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ClientCacheConfiguration.java @@ -190,14 +190,14 @@ public class ClientCacheConfiguration extends AbstractCacheConfiguration { } /** - * Configures Spring container infrastructure components and beans used by Spring Data GemFire - * to enable Pivotal GemFire or Apache Geode to function properly inside a Spring context. + * Configures Spring container infrastructure components and beans used by SDG to enable Pivotal GemFire + * or Apache Geode to function properly inside a Spring context. * * This overridden method configures and registers additional Spring components and bean applicable to * {@link ClientCache ClientCaches}. * * @param importMetadata {@link AnnotationMetadata} containing annotation meta-data - * for the Spring Data GemFire cache application class. + * for the SDG cache application class. * @see org.springframework.core.type.AnnotationMetadata */ @Override diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ClusterConfigurationConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ClusterConfigurationConfiguration.java index ef271731..0fa11bff 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ClusterConfigurationConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ClusterConfigurationConfiguration.java @@ -181,12 +181,12 @@ public class ClusterConfigurationConfiguration extends AbstractAnnotationConfigS /** * Constructs an instance of {@link GemfireAdminOperations} to perform administrative, schema functions - * on a GemFire cache cluster as well as a client cache from a cache client. + * on a Pivotal GemFire cache cluster as well as a client cache from a cache client. * * @param clientCache {@link ClientCache} instance used by the {@link GemfireAdminOperations} interface - * to access the GemFire system. + * to access the Pivotal GemFire system. * @return an implementation of the {@link GemfireAdminOperations} interface to perform administrative functions - * on a GemFire system. + * on a Pivotal GemFire system. * @see org.springframework.data.gemfire.config.admin.GemfireAdminOperations * @see org.apache.geode.cache.client.ClientCache */ @@ -206,10 +206,10 @@ public class ClusterConfigurationConfiguration extends AbstractAnnotationConfigS /** * Constructs an instance of {@link SchemaObjectCollector} to inspect the application's context - * and find all the GemFire schema objects declared of a particular type or types. + * and find all the Pivotal GemFire schema objects declared of a particular type or types. * - * @return a new instance of {@link SchemaObjectCollector} to inspect a GemFire system schema - * in search of specific GemFire schema objects (e.g. {@link Region} or {@link Index}). + * @return a new instance of {@link SchemaObjectCollector} to inspect a Pivotal GemFire system schema + * in search of specific Pivotal GemFire schema objects (e.g. {@link Region} or {@link Index}). * @see org.springframework.data.gemfire.config.schema.SchemaObjectCollector */ private SchemaObjectCollector newSchemaObjectCollector() { @@ -221,7 +221,7 @@ public class ClusterConfigurationConfiguration extends AbstractAnnotationConfigS } /** - * Constructs an instance of {@link SchemaObjectDefiner} used to reverse engineer a GemFire schema object instance + * Constructs an instance of {@link SchemaObjectDefiner} used to reverse engineer a Pivotal GemFire schema object instance * to build a definition. * * @return a new instance of {@link SchemaObjectDefiner}. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ContinuousQueryListenerContainerConfigurer.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ContinuousQueryListenerContainerConfigurer.java index d06f4b21..eb6ed815 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ContinuousQueryListenerContainerConfigurer.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ContinuousQueryListenerContainerConfigurer.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.listener.ContinuousQueryListenerContaine /** * The {@link ContinuousQueryListenerContainerConfigurer} interfaces defines a contract for implementations to customize * the configuration of SDG's {@link ContinuousQueryListenerContainer} when enabling Continuous Query (CQ) functionality - * in Spring Boot, GemFire/Geode cache client applications. + * in Spring Boot, Pivotal GemFire/Apache Geode cache client applications. * * @author John Blum * @see org.springframework.data.gemfire.listener.ContinuousQueryListenerContainer diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoreConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoreConfiguration.java index 1479b77a..64b0e72a 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoreConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoreConfiguration.java @@ -47,7 +47,7 @@ import org.springframework.util.StringUtils; /** * The {@link DiskStoreConfiguration} class is a Spring {@link ImportBeanDefinitionRegistrar} used to register - * a GemFire/Geode {@link org.apache.geode.cache.DiskStore} bean definition. + * a Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.DiskStore} bean definition. * * @author John Blum * @see org.apache.geode.cache.DiskStore diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoresConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoresConfiguration.java index 6e80b215..37d33a92 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoresConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/DiskStoresConfiguration.java @@ -26,7 +26,7 @@ import org.springframework.core.type.AnnotationMetadata; /** * The {@link DiskStoresConfiguration} class is a Spring {@link org.springframework.context.annotation.ImportBeanDefinitionRegistrar} - * used to register multiple GemFire/Geode {@link org.apache.geode.cache.DiskStore} bean definitions. + * used to register multiple Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.DiskStore} bean definitions. * * @author John Blum * @see org.springframework.beans.factory.support.BeanDefinitionRegistry diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableAutoRegionLookup.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableAutoRegionLookup.java index 5153cb03..8a1da9d0 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableAutoRegionLookup.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableAutoRegionLookup.java @@ -24,12 +24,14 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +import org.apache.geode.cache.Region; +import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; /** - * The {@link EnableAutoRegionLookup} annotation configures a Spring {@link org.springframework.context.annotation.Configuration} - * annotated class with the ability to automatically look up and register GemFire {@link org.apache.geode.cache.Region Regions} - * which may have be defined in {@literal cache.xml} or by using GemFire's Cluster Configuration Service. + * The {@link EnableAutoRegionLookup} annotation configures a Spring {@link Configuration} annotated class + * with the ability to automatically look up and register Pivotal GemFire {@link Region Regions} + * which may have be defined in {@literal cache.xml} or by using Pivotal GemFire's Cluster Configuration Service. * * This annotation defines the {@code enabled} attribute to allow users to dynamically change the behavior * of auto {@link org.apache.geode.cache.Region} lookup at application configuration time using either a SpEL diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableBeanFactoryLocator.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableBeanFactoryLocator.java index 365b8fb8..11b468ab 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableBeanFactoryLocator.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableBeanFactoryLocator.java @@ -29,8 +29,8 @@ import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator; /** * The {@link EnableBeanFactoryLocator} annotation annotates a Spring {@link Configuration @Configuration} class - * enabling SDG's {@link GemfireBeanFactoryLocator} in order to auto-wire and configure GemFire/Geode Objects - * declared in GemFire/Geode config. + * enabling SDG's {@link GemfireBeanFactoryLocator} in order to auto-wire and configure Pivotal GemFire/Apache Geode Objects + * declared in Pivotal GemFire/Apache Geode config. * * @author John Blum * @see java.lang.annotation.Documented diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServer.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServer.java index be9cc95a..d6e5915e 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServer.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServer.java @@ -31,10 +31,10 @@ import org.springframework.data.gemfire.server.SubscriptionEvictionPolicy; /** * The {@link EnableCacheServer} annotation configures a Spring {@link org.springframework.context.annotation.Configuration} - * annotated class with a GemFire {@link CacheServer} bean in the Spring application context. + * annotated class with a Pivotal GemFire {@link CacheServer} bean in the Spring application context. * * This annotation is used in conjunction with the {@link CacheServerApplication}, or {@link PeerCacheApplication} - * annotations to add an additional {@link CacheServer CacheServers} to a GemFire peer cache application + * annotations to add an additional {@link CacheServer CacheServers} to a Pivotal GemFire peer cache application * configured with Spring (Data GemFire). * * To add more than 1 {@link CacheServer} to your application, this annotation can be nested in diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServers.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServers.java index 85b7ea4e..a835f298 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServers.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCacheServers.java @@ -29,7 +29,7 @@ import org.springframework.context.annotation.Import; /** * The {@link EnableCacheServers} annotation enables 1 or more {@link CacheServer CacheServers} - * to be defined and used in a peer cache application configured with Spring (Data GemFire/Geode). + * to be defined and used in a peer cache application configured with Spring (Data Pivotal GemFire/Apache Geode). * * @author John Blum * @see org.apache.geode.cache.server.CacheServer @@ -47,7 +47,7 @@ import org.springframework.context.annotation.Import; public @interface EnableCacheServers { /** - * Enables the definition of multiple GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers}. + * Enables the definition of multiple Pivotal GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers}. */ EnableCacheServer[] servers() default {}; diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCachingDefinedRegions.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCachingDefinedRegions.java index b41b863f..d1c13358 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCachingDefinedRegions.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableCachingDefinedRegions.java @@ -35,7 +35,7 @@ import org.springframework.data.gemfire.mapping.annotation.ClientRegion; /** * The {@link EnableCachingDefinedRegions} annotation marks a Spring {@link Configuration @Configuration} application - * annotated class to enable the creation of GemFire/Geode {@link Region Regions} based on Spring's Cache Abstraction + * annotated class to enable the creation of Pivotal GemFire/Apache Geode {@link Region Regions} based on Spring's Cache Abstraction * Annotations applied to application service methods and types. * * Additionally, this annotation enables Spring's Cache Abstraction with SDG's {@link EnableGemfireCaching} annotation, @@ -78,7 +78,7 @@ public @interface EnableCachingDefinedRegions { /** * When this annotation is applied to a cache client application, the {@literal poolName} attribute refers to - * the default name of the GemFire/Geode {@link Pool} assigned to client {@link Region Region(s)}. + * the default name of the Pivotal GemFire/Apache Geode {@link Pool} assigned to client {@link Region Region(s)}. * * This value can be overridden by annotating entities with the {@link ClientRegion} annotation. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.java index 1f1bed84..d32ec5fb 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableClusterConfiguration.java @@ -30,9 +30,9 @@ import org.springframework.context.annotation.Import; /** * The {@link EnableClusterConfiguration} annotation enables Apache Geode / Pivotal GemFire schema-like definitions - * defined in a Spring [Boot], Geode/GemFire cache client application using Spring config to be pushed to - * a Geode/GemFire cluster, similar to how schema commands (e.g. `create region`) in Gfsh are processed by - * an Geode/GemFire Manager. + * defined in a Spring [Boot], Geode/Pivotal GemFire cache client application using Spring config to be pushed to + * a Geode/Pivotal GemFire cluster, similar to how schema commands (e.g. `create region`) in Gfsh are processed by + * an Geode/Pivotal GemFire Manager. * * @author John Blum * @see java.lang.annotation.Documented @@ -52,7 +52,7 @@ import org.springframework.context.annotation.Import; public @interface EnableClusterConfiguration { /** - * Configures the bind address used by the Spring, GemFire/Geode cache client application to locate + * Configures the bind address used by the Spring, Pivotal GemFire/Apache Geode cache client application to locate * the Manager's HTTP Service and access the Management REST API. This configuration setting is only used * when {@link #useHttp()} is set to {@literal true}. * @@ -64,7 +64,7 @@ public @interface EnableClusterConfiguration { String host() default ClusterConfigurationConfiguration.DEFAULT_MANAGEMENT_HTTP_HOST; /** - * Configures the port used by the Spring, GemFire/Geode cache client application to locate + * Configures the port used by the Spring, Pivotal GemFire/Apache Geode cache client application to locate * the Manager's HTTP Service and access the Management REST API. This configuration setting is only used * when {@link #useHttp()} is set to {@literal true}. * @@ -77,7 +77,7 @@ public @interface EnableClusterConfiguration { /** * Configuration setting used to specify the data management policy used when creating {@link Region Regions} - * on the servers in the Geode/GemFire cluster. + * on the servers in the Geode/Pivotal GemFire cluster. * * The data management policy is expressed with a {@link RegionShortcut}, but corresponds to the various * different {@link DataPolicy DataPolicies} available. @@ -90,7 +90,7 @@ public @interface EnableClusterConfiguration { RegionShortcut serverRegionShortcut() default RegionShortcut.PARTITION; /** - * Configures whether connectivity between the Spring, GemFire/Geode application should be established using HTTP. + * Configures whether connectivity between the Spring, Pivotal GemFire/Apache Geode application should be established using HTTP. * * Alternatively, you can configure this setting using the {@literal spring.data.gemfire.management.use-http} * property in {@literal application.properties}. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStore.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStore.java index d63fe853..3d147368 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStore.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStore.java @@ -41,7 +41,7 @@ import org.springframework.core.annotation.AliasFor; /** * The {@link EnableDiskStore} annotation marks a Spring {@link Configuration @Configuration} annotated {@link Class} - * to configure a single GemFire/Geode {@link org.apache.geode.cache.DiskStore} bean in the Spring application context + * to configure a single Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.DiskStore} bean in the Spring application context * in which to persist or overflow data from 1 or more cache {@link org.apache.geode.cache.Region Regions}. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStores.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStores.java index bcaaff13..6934d023 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStores.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableDiskStores.java @@ -28,8 +28,8 @@ import org.springframework.context.annotation.Import; /** * The {@link EnableDiskStores} annotation marks a Spring {@link org.springframework.context.annotation.Configuration @Configuration} - * annotated application class to configure 1 or more GemFire/Geode {@link org.apache.geode.cache.DiskStore} beans - * in the Spring context in which to persist or overflow data from 1 or more GemFire/Geode + * annotated application class to configure 1 or more Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.DiskStore} beans + * in the Spring context in which to persist or overflow data from 1 or more Pivotal GemFire/Apache Geode * {@link org.apache.geode.cache.Region Regions} * * @author John Blum @@ -74,7 +74,7 @@ public @interface EnableDiskStores { long maxOplogSize() default 1024L; /** - * Defines 1 or more GemFire/Geode {@link org.apache.geode.cache.DiskStore DiskStores}. + * Defines 1 or more Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.DiskStore DiskStores}. */ EnableDiskStore[] diskStores(); diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEntityDefinedRegions.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEntityDefinedRegions.java index 7c509d1e..15dfea65 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEntityDefinedRegions.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableEntityDefinedRegions.java @@ -38,7 +38,7 @@ import org.springframework.data.gemfire.mapping.annotation.ClientRegion; /** * The {@link EnableEntityDefinedRegions} annotation marks a Spring {@link Configuration @Configuration} application - * annotated class to enable the creation of GemFire/Geode {@link Region Regions} based on + * annotated class to enable the creation of Pivotal GemFire/Apache Geode {@link Region Regions} based on * the application persistent entities. * * @author John Blum @@ -144,7 +144,7 @@ public @interface EnableEntityDefinedRegions { /** * When this annotation is applied to a cache client application, the {@literal poolName} attribute refers to - * the default name of the GemFire/Geode {@link Pool} assigned to client {@link Region Region(s)}. + * the default name of the Pivotal GemFire/Apache Geode {@link Pool} assigned to client {@link Region Region(s)}. * * This value can be overridden by annotating entities with the {@link ClientRegion} annotation. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableExpiration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableExpiration.java index 5170824f..fd847b64 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableExpiration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableExpiration.java @@ -46,7 +46,7 @@ import org.springframework.data.gemfire.expiration.TimeToLiveExpiration; * @see org.springframework.data.gemfire.expiration.TimeToLiveExpiration * @see org.apache.geode.cache.Region * @see Annotation-based Data Expiration - * @see GemFire Expiration + * @see Pivotal GemFire Expiration * @see Geode Expiration * @since 1.9.0 */ @@ -126,10 +126,10 @@ public @interface EnableExpiration { } /** - * {@link ExpirationType} defines different types of GemFire/Geode Expiration policies such as + * {@link ExpirationType} defines different types of Pivotal GemFire/Apache Geode Expiration policies such as * (Entry) Idle Timeout (TTI) and (Entry) Time to Live (TTL). * - * @see GemFire Expiration + * @see Pivotal GemFire Expiration * @see Geode Expiration */ enum ExpirationType { diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireAsLastResource.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireAsLastResource.java index 4881c301..8cda0545 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireAsLastResource.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireAsLastResource.java @@ -27,7 +27,7 @@ import org.springframework.context.annotation.EnableAspectJAutoProxy; import org.springframework.context.annotation.Import; /** - * The {@link EnableGemFireAsLastResource} annotation is used to enable GemFire as a Last Resource in a Spring, + * The {@link EnableGemFireAsLastResource} annotation is used to enable Pivotal GemFire as a Last Resource in a Spring, * CMT/JTA Transaction. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireProperties.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireProperties.java index 2abefeae..417c2dd9 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireProperties.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableGemFireProperties.java @@ -28,11 +28,11 @@ import org.springframework.context.annotation.Import; /** * The {@link EnableGemFireProperties} annotation marks a Spring {@link org.springframework.context.annotation.Configuration @Configuration} - * annotated class to configure GemFire/Geode System properties at runtime during [Spring Boot] application startup. + * annotated class to configure Pivotal GemFire/Apache Geode System properties at runtime during [Spring Boot] application startup. * * @author John Blum * @see org.springframework.data.gemfire.config.annotation.GemFirePropertiesConfiguration - * @see GemFire System Properties + * @see Pivotal GemFire System Properties * @see Geode System Properties * @since 1.9.0 */ @@ -105,7 +105,7 @@ public @interface EnableGemFireProperties { /** * Relevant only for multi-homed hosts - machines with multiple network interface cards (NICs). * Specifies the adapter card the cache binds to for peer-to-peer (P2P) communication. Also specifies - * the default location for GemFire Servers to listen on, which is used unless overridden by + * the default location for Pivotal GemFire Servers to listen on, which is used unless overridden by * the {@literal server-bind-address}. An empty string causes the member to listen on the default card * for the machine. This is a machine-wide attribute used for system member and client/server communication. * It has no effect on Locator location, unless the Locator is embedded in a member process. @@ -149,9 +149,9 @@ public @interface EnableGemFireProperties { * every application thread has its own sockets for distribution purposes. You can override * this setting for individual threads inside your application. Where possible, it is better to * set {@literal conserve-sockets} to {@literal true} and enable the use of specific extra sockets - * in the application code if needed. WAN deployments increase the messaging demands on a GemFire system. + * in the application code if needed. WAN deployments increase the messaging demands on a Pivotal GemFire system. * To avoid hangs related to WAN messaging, always set {@literal conserve-sockets} to {@literal false} - * for GemFire members that participate in a WAN deployment. + * for Pivotal GemFire members that participate in a WAN deployment. * * Defaults to {@literal true}. */ @@ -169,7 +169,7 @@ public @interface EnableGemFireProperties { * Working directory used when deploying JAR application files to distributed system members. * This directory can be local and unique to the member or a shared resource. * - * Defaults to current working directory of this GemFire JVM process. + * Defaults to current working directory of this Pivotal GemFire JVM process. */ String deployWorkingDirectory() default GemFirePropertiesConfiguration.DEFAULT_DEPLOY_WORKING_DIRECTORY; @@ -208,7 +208,7 @@ public @interface EnableGemFireProperties { /** * Whether partitioned regions will put redundant copies of the same data in different members - * running on the same physical machine. By default, GemFire tries to put redundant copies on different machines, + * running on the same physical machine. By default, Pivotal GemFire tries to put redundant copies on different machines, * but it will put them on the same machine if no other machines are available. Setting this property * to {@literal true} prevents this and requires different machines for redundant copies. * @@ -263,7 +263,7 @@ public @interface EnableGemFireProperties { long maxWaitTimeReconnect() default GemFirePropertiesConfiguration.DEFAULT_MAX_WAIT_TIME_RECONNECT; /** - * GemFire uses the {@literal member-timeout} server configuration, specified in milliseconds, to detect + * Pivotal GemFire uses the {@literal member-timeout} server configuration, specified in milliseconds, to detect * the abnormal termination of members. The configuration setting is used in two ways: * * 1) First, it is used during the UDP heartbeat detection process. When a member detects that @@ -285,7 +285,7 @@ public @interface EnableGemFireProperties { * The range of ports available for unicast UDP messaging and for TCP failure detection. This is specified * as two integers separated by a hyphen. Different members can use different ranges. * - * GemFire randomly chooses at least two unique integers from this range for the member, one for + * Pivotal GemFire randomly chooses at least two unique integers from this range for the member, one for * UDP unicast messaging and the other for TCP failure detection messaging. If {@literal tcp-port} * is configured to {@literal 0}, it will also randomly select a port from this range for TCP sockets * used for peer-to-peer communication only. @@ -295,7 +295,7 @@ public @interface EnableGemFireProperties { * * The system uniquely identifies the member using the combined host IP address and UDP port number. * - * You may want to restrict the range of ports that GemFire uses so the product can run in an environment + * You may want to restrict the range of ports that Pivotal GemFire uses so the product can run in an environment * where routers only allow traffic on certain ports. * * Defaults to {@literal 1024-65535}. @@ -304,7 +304,7 @@ public @interface EnableGemFireProperties { /** * Defines this member’s redundancy zone. Used to separate member’s into different groups for satisfying - * Partitioned Region redundancy. If this property is set, GemFire will not put redundant copies of data + * Partitioned Region redundancy. If this property is set, Pivotal GemFire will not put redundant copies of data * in members with the same redundancy zone setting. * * Defaults to unset. @@ -375,7 +375,7 @@ public @interface EnableGemFireProperties { * The TCP port to listen on for cache communications. If set to zero, the operating system selects * an available port. Each process on a machine must have its own TCP port. Note that some operating systems * restrict the range of ports usable by non-privileged users, and using restricted port numbers can cause - * runtime errors in GemFire startup. + * runtime errors in Pivotal GemFire startup. * * Valid values are in the range 0..65535. * @@ -384,7 +384,7 @@ public @interface EnableGemFireProperties { int tcpPort() default GemFirePropertiesConfiguration.DEFAULT_TCP_PORT; /** - * The number of tombstones that can accumulate before the GemFire member triggers garbage collection + * The number of tombstones that can accumulate before the Pivotal GemFire member triggers garbage collection * for tombstones. * * Defaults to {@literal 100000} tombstones. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableHttpService.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableHttpService.java index d7ae4b5b..d6fc1ea9 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableHttpService.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableHttpService.java @@ -57,9 +57,9 @@ import org.springframework.context.annotation.Import; public @interface EnableHttpService { /** - * If set, then the GemFire member binds the embedded HTTP service to the specified address. + * If set, then the Pivotal GemFire member binds the embedded HTTP service to the specified address. * If this property is not set but the HTTP service is enabled using {@literal http-service-port}, - * then GemFire binds the HTTP service to the member’s local address. Used by the GemFire Pulse Web application + * then Pivotal GemFire binds the HTTP service to the member’s local address. Used by the Pivotal GemFire Pulse Web application * and the Developer REST API service. * * Defaults to unset. @@ -69,8 +69,8 @@ public @interface EnableHttpService { String bindAddress() default ""; /** - * If non-zero, then GemFire starts an embedded HTTP service that listens on this port. The HTTP service - * is used to host the GemFire Pulse Web application and the development REST API service. If you are hosting + * If non-zero, then Pivotal GemFire starts an embedded HTTP service that listens on this port. The HTTP service + * is used to host the Pivotal GemFire Pulse Web application and the development REST API service. If you are hosting * the Pulse web app on your own Web server and are not using the Development REST API service, then disable * this embedded HTTP service by setting this property to zero. Ignored if {@literal jmx-manager} * and {@literal start-dev-rest-api} are both set to {@literal false}. @@ -83,7 +83,7 @@ public @interface EnableHttpService { /** * Boolean indicating whether to require authentication for HTTP service connections. If this property is not set, - * then GemFire uses the value of {@literal cluster-ssl-require-authentication} to determine whether HTTP service + * then Pivotal GemFire uses the value of {@literal cluster-ssl-require-authentication} to determine whether HTTP service * connections require authentication. * * To enable SSL communications for the HTTP service, use the {@link EnableSsl} annotation and set the diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableIndexing.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableIndexing.java index 08e26595..16242edd 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableIndexing.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableIndexing.java @@ -30,7 +30,7 @@ import org.springframework.context.annotation.Configuration; /** * The {@link EnableIndexing} annotation marks a Spring {@link Configuration @Configuration} annotated application class - * to enable the creation of GemFire/Geode {@link Index Indexes} and {@link LuceneIndex LuceneIndexes} based on + * to enable the creation of Pivotal GemFire/Apache Geode {@link Index Indexes} and {@link LuceneIndex LuceneIndexes} based on * application persistent entity field/property annotations, such as the {@link @Id}, {@link @Indexed} * and {@link @LuceneIndex} annotations. * @@ -51,12 +51,12 @@ import org.springframework.context.annotation.Configuration; public @interface EnableIndexing { /** - * Determines whether all GemFire/Geode {@link Index Indexes} will be defined before created. + * Determines whether all Pivotal GemFire/Apache Geode {@link Index Indexes} will be defined before created. * If set to {@literal true}, then all {@link Index Indexes} are defined first and the created * in a single, bulk operation, thereby improving {@link Index} creation process efficiency. * * Only applies to OQL-based {@link Index Indexes}. {@link LuceneIndex LuceneIndexes} are managed differently - * by GemFire/Geode. + * by Pivotal GemFire/Apache Geode. * * Defaults to {@literal false}. */ diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableManager.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableManager.java index c6a06d5f..da1b54fb 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableManager.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableManager.java @@ -131,7 +131,7 @@ public @interface EnableManager { /** * The rate, in milliseconds, at which this member will push updates to any JMX Managers. Currently this value * should be greater than or equal to the {@literal statistic-sample-rate}. Setting this value too high will - * cause stale values to be seen by Gfsh and GemFire Pulse. + * cause stale values to be seen by Gfsh and Pivotal GemFire Pulse. * * Defaults to {@literal 2000} milliseconds. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePool.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePool.java index 9128cfc3..fc51fd1f 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePool.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePool.java @@ -31,10 +31,10 @@ import org.springframework.data.gemfire.GemfireUtils; /** * The {@link EnablePool} annotation configures a Spring {@link org.springframework.context.annotation.Configuration} - * annotated class with a "named" GemFire client {@link Pool} bean in the application context. + * annotated class with a "named" Pivotal GemFire client {@link Pool} bean in the application context. * * This annotation is used in conjunction with the {@link ClientCacheApplication} annotation to add an additional - * {@link Pool} to a GemFire cache client application configured with Spring (Data GemFire). + * {@link Pool} to a Pivotal GemFire cache client application configured with Spring (Data GemFire). * * To add more than 1 {@link Pool} to your application, this annotation can be nested in the {@link EnablePools} * annotation. @@ -90,7 +90,7 @@ public @interface EnablePool { int loadConditioningInterval() default PoolFactory.DEFAULT_LOAD_CONDITIONING_INTERVAL; /** - * Configures the GemFire {@link org.apache.geode.distributed.Locator Locators} to which + * Configures the Pivotal GemFire {@link org.apache.geode.distributed.Locator Locators} to which * this cache client will connect. * * Use either the {@literal spring.data.gemfire.pool..locators} property @@ -101,7 +101,7 @@ public @interface EnablePool { /** * A {@link String} containing a comma-delimited list of hosts and ports defining the connection endpoints - * of GemFire Locators in the cluster. + * of Pivotal GemFire Locators in the cluster. * * The {@link String} must be formatted as: 'host1[port], host2[port], ..., hostN[port]'. * @@ -210,7 +210,7 @@ public @interface EnablePool { String serverGroup() default PoolFactory.DEFAULT_SERVER_GROUP; /** - * Configures the GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers} to which + * Configures the Pivotal GemFire {@link org.apache.geode.cache.server.CacheServer CacheServers} to which * this cache client will connect. * * Use either the {@literal spring.data.gemfire.pool..servers} property @@ -221,7 +221,7 @@ public @interface EnablePool { /** * A {@link String} containing a comma-delimited list of hosts and ports defining the connection endpoints - * of GemFire Servers in the cluster. + * of Pivotal GemFire Servers in the cluster. * * The {@link String} must be formatted as: 'host1[port], host2[port], ..., hostN[port]'. * diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePools.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePools.java index f7fb891a..d93623a4 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePools.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnablePools.java @@ -27,8 +27,8 @@ import java.lang.annotation.Target; import org.springframework.context.annotation.Import; /** - * The {@link EnablePools} annotation enables 1 or more GemFire {@link org.apache.geode.cache.client.Pool Pools} - * to be defined and used in a GemFire client cache application configured with Spring (Data GemFire). + * The {@link EnablePools} annotation enables 1 or more Pivotal GemFire {@link org.apache.geode.cache.client.Pool Pools} + * to be defined and used in a Pivotal GemFire client cache application configured with Spring (Data GemFire). * * @author John Blum * @see org.springframework.data.gemfire.config.annotation.AddPoolsConfiguration @@ -45,7 +45,7 @@ import org.springframework.context.annotation.Import; public @interface EnablePools { /** - * Enables the definition of multiple GemFire {@link org.apache.geode.cache.client.Pool Pools}. + * Enables the definition of multiple Pivotal GemFire {@link org.apache.geode.cache.client.Pool Pools}. */ EnablePool[] pools() default {}; diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableSecurity.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableSecurity.java index 7cefeb20..ae708845 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EnableSecurity.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EnableSecurity.java @@ -119,7 +119,7 @@ public @interface EnableSecurity { String securityPostProcessorClassName() default ""; /** - * The {@literal security-username} used by a GemFire cache client application required to authenticate. + * The {@literal security-username} used by a Pivotal GemFire cache client application required to authenticate. * * Defaults to unset. * @@ -128,7 +128,7 @@ public @interface EnableSecurity { String securityUsername() default ""; /** - * The {@literal security-password} used by a GemFire cache client application required to authenticate. + * The {@literal security-password} used by a Pivotal GemFire cache client application required to authenticate. * * Defaults to unset. * @@ -137,7 +137,7 @@ public @interface EnableSecurity { String securityPassword() default ""; /** - * Sets the Geode System Property referring to the location of an Apache Shiro INI file used to configure + * Sets the Apache Geode System Property referring to the location of an Apache Shiro INI file used to configure * the Apache Shiro Security Framework to secure Apache Geode. * * Default is unset. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EntityDefinedRegionsConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EntityDefinedRegionsConfiguration.java index 4b399873..8a082c7f 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EntityDefinedRegionsConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EntityDefinedRegionsConfiguration.java @@ -79,7 +79,7 @@ import org.springframework.util.StringUtils; /** * The {@link EntityDefinedRegionsConfiguration} class is Spring {@link ImportBeanDefinitionRegistrar} used in - * the {@link EnableEntityDefinedRegions} annotation to dynamically create GemFire/Geode {@link Region Regions} + * the {@link EnableEntityDefinedRegions} annotation to dynamically create Pivotal GemFire/Apache Geode {@link Region Regions} * based on the application persistent entity classes. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/EvictionConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/EvictionConfiguration.java index 93fd3e18..ff4f791d 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/EvictionConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/EvictionConfiguration.java @@ -195,16 +195,16 @@ public class EvictionConfiguration implements ApplicationContextAware, ImportAwa } /** - * {@link EvictionPolicyConfigurer} configures the Eviction policy of a GemFire {@link Region}. + * {@link EvictionPolicyConfigurer} configures the Eviction policy of a Pivotal GemFire {@link Region}. */ protected interface EvictionPolicyConfigurer { /** * Configure the Eviction policy on the given SDG {@link RegionFactoryBean} or {@link ClientRegionFactoryBean} - * used to create a GemFire {@link Region}. + * used to create a Pivotal GemFire {@link Region}. * * @param regionFactoryBean {@link RegionFactoryBean} or {@link ClientRegionFactoryBean} used to create - * a GemFire {@link Region}. + * a Pivotal GemFire {@link Region}. * @return the given {@code regionFactoryBean}. * @see org.springframework.data.gemfire.RegionFactoryBean * @see org.springframework.data.gemfire.client.ClientRegionFactoryBean @@ -352,7 +352,7 @@ public class EvictionConfiguration implements ApplicationContextAware, ImportAwa * Resolves the Eviction policy threshold (a.k.a. maximum) based on the {@link EvictionPolicyType}. * * For instance {@link EvictionPolicyType#HEAP_PERCENTAGE} does not support maximum/threshold since - * the settings are determined by the GemFire/Geode cache critical heap percentage and eviction heap percentage + * the settings are determined by the Pivotal GemFire/Apache Geode cache critical heap percentage and eviction heap percentage * System property settings. * * @param maximum integer value specifying the configured Eviction threshold. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/ExpirationConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/ExpirationConfiguration.java index 8861c2c1..4d8e2c85 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/ExpirationConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/ExpirationConfiguration.java @@ -48,7 +48,7 @@ import org.springframework.util.Assert; /** * {@link ExpirationConfiguration} is a Spring {@link Configuration} class used to configure expiration policies - * for GemFire/Geode {@link Region Regions}. + * for Pivotal GemFire/Apache Geode {@link Region Regions}. * * @author John Blum * @see org.springframework.context.annotation.Configuration diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/GemFireAsLastResourceConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/GemFireAsLastResourceConfiguration.java index 909a2fd8..63931898 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/GemFireAsLastResourceConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/GemFireAsLastResourceConfiguration.java @@ -36,7 +36,7 @@ import org.springframework.transaction.annotation.EnableTransactionManagement; /** * The {@link GemFireAsLastResourceConfiguration} class is a Spring {@link Configuration @Configuration} - * annotated class used to configure the GemFire "Last Resource" Spring Data GemFire {@link Aspect Aspects}. + * annotated class used to configure the Pivotal GemFire "Last Resource" SDG {@link Aspect Aspects}. * * @author John Blum * @see org.apache.geode.cache.GemFireCache @@ -50,7 +50,7 @@ import org.springframework.transaction.annotation.EnableTransactionManagement; * @see org.springframework.data.gemfire.config.annotation.support.GemFireAsLastResourceConnectionAcquiringAspect * @see org.springframework.data.gemfire.config.annotation.support.GemFireAsLastResourceConnectionClosingAspect * @see org.springframework.transaction.annotation.EnableTransactionManagement - * @since 1.0.0 + * @since 2.0.0 */ @Configuration @SuppressWarnings("unused") diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/GemFirePropertiesConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/GemFirePropertiesConfiguration.java index eaf234f6..fa29c9a8 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/GemFirePropertiesConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/GemFirePropertiesConfiguration.java @@ -25,7 +25,7 @@ import org.springframework.data.gemfire.util.PropertiesBuilder; /** * The {@link GemFirePropertiesConfiguration} class is a Spring {@link org.springframework.context.annotation.ImportBeanDefinitionRegistrar} - * capable of configuring additional GemFire Properties on a (Spring Boot) application class at runtime + * capable of configuring additional Pivotal GemFire Properties on a (Spring Boot) application class at runtime * during startup. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/IndexConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/IndexConfiguration.java index 4c11e05e..1b5a0521 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/IndexConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/IndexConfiguration.java @@ -53,7 +53,7 @@ import org.springframework.util.StringUtils; /** * The {@link IndexConfiguration} class is a Spring {@link org.springframework.context.annotation.ImportBeanDefinitionRegistrar} * and extension of {@link EntityDefinedRegionsConfiguration} used in the {@link EnableIndexing} annotation - * to dynamically create GemFire/Geode {@link org.apache.geode.cache.Region} {@link Index Indexes} based on + * to dynamically create Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.Region} {@link Index Indexes} based on * {@link GemfirePersistentEntity} {@link GemfirePersistentProperty} annotations. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/McastConfiguration.java b/src/main/java/org/springframework/data/gemfire/config/annotation/McastConfiguration.java index b4f62c48..eb0a4a92 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/McastConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/McastConfiguration.java @@ -25,8 +25,8 @@ import org.springframework.data.gemfire.util.PropertiesBuilder; /** * The {@link McastConfiguration} class is a Spring {@link org.springframework.context.annotation.ImportBeanDefinitionRegistrar} - * that applies additional GemFire configuration by way of GemFire System properties to configure and use - * multi-cast networking for GemFire communication and distribution rather than the (preferred) + * that applies additional Pivotal GemFire configuration by way of Pivotal GemFire System properties to configure and use + * multi-cast networking for Pivotal GemFire communication and distribution rather than the (preferred) * Locator-based location services. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/PeerCacheApplication.java b/src/main/java/org/springframework/data/gemfire/config/annotation/PeerCacheApplication.java index fab9e55f..d5331491 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/PeerCacheApplication.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/PeerCacheApplication.java @@ -24,6 +24,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +import org.apache.geode.cache.Cache; import org.apache.geode.cache.control.ResourceManager; import org.springframework.beans.factory.BeanFactory; import org.springframework.context.annotation.Configuration; @@ -31,8 +32,8 @@ import org.springframework.context.annotation.Import; import org.springframework.data.gemfire.support.GemfireBeanFactoryLocator; /** - * The {@link PeerCacheApplication} annotation enables an embedded GemFire peer {@link org.apache.geode.cache.Cache} - * instance in a Spring Data GemFire based application. + * The {@link PeerCacheApplication} annotation enables an embedded Pivotal GemFire peer {@link Cache} instance + * in a SDG based application. * * @author John Blum * @see org.apache.geode.cache.control.ResourceManager @@ -81,7 +82,7 @@ public @interface PeerCacheApplication { float criticalOffHeapPercentage() default 0.0f; /** - * By default, a GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache + * By default, a Pivotal GemFire member (both locators and servers) will attempt to reconnect and reinitialize the cache * after it has been forced out of the distributed system by a network partition event or has otherwise been * shunned by other members. Use this property to enable the auto-reconnect behavior. * @@ -139,7 +140,7 @@ public @interface PeerCacheApplication { int lockTimeout() default 60; /** - * Configures the log level used to output log messages at GemFire cache runtime. + * Configures the log level used to output log messages at Pivotal GemFire cache runtime. * * Defaults to {@literal config}. * @@ -159,7 +160,7 @@ public @interface PeerCacheApplication { int messageSyncInterval() default 1; /** - * Configures the name of this GemFire member in the cluster (distributed system). + * Configures the name of this Pivotal GemFire member in the cluster (distributed system). * * Defaults to {@literal SpringBasedPeerCacheApplication}. * @@ -179,8 +180,8 @@ public @interface PeerCacheApplication { /** * Determines whether the {@link GemfireBeanFactoryLocator} should be enabled to lookup - * the Spring {@link BeanFactory} to auto-wire and configure/initialize GemFire components - * created in a non-Spring managed, GemFire context. + * the Spring {@link BeanFactory} to auto-wire and configure/initialize Pivotal GemFire components + * created in a non-Spring managed, Pivotal GemFire context. * * Defaults to {@literal false}. * @@ -189,7 +190,7 @@ public @interface PeerCacheApplication { boolean useBeanFactoryLocator() default false; /** - * Configures whether this GemFire cache member node would pull it's configuration meta-data + * Configures whether this Pivotal GemFire cache member node would pull it's configuration meta-data * from the cluster-based Cluster Configuration service. * * Defaults to {@literal false}. diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/UsesGemFireProperties.java b/src/main/java/org/springframework/data/gemfire/config/annotation/UsesGemFireProperties.java index 1b306d17..4cf1c072 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/UsesGemFireProperties.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/UsesGemFireProperties.java @@ -26,7 +26,7 @@ import java.lang.annotation.Target; /** * {@link UsesGemFireProperties} is a meta-annotation used to mark other SDG {@link Annotation Annotations} - * that uses GemFire properties to configure the Spring-based GemFire cache instance. + * that uses Pivotal GemFire properties to configure the Spring-based Pivotal GemFire cache instance. * * @author John Blum * @see java.lang.annotation.Annotation diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAnnotationConfigSupport.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAnnotationConfigSupport.java index f66ca2a0..ef54a766 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAnnotationConfigSupport.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAnnotationConfigSupport.java @@ -61,9 +61,8 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** - * The {@link AbstractAnnotationConfigSupport} class is an abstract base class encapsulating functionality - * common to all Annotations and configuration classes used to configure Pivotal GemFire/Apache Geode objects - * with Spring Data GemFire or Spring Data Geode. + * The {@link AbstractAnnotationConfigSupport} class is an abstract base class encapsulating functionality common to + * all Annotations and configuration classes used to configure Pivotal GemFire/Apache Geode objects with SDG. * * @author John Blum * @see java.lang.ClassLoader @@ -194,7 +193,7 @@ public abstract class AbstractAnnotationConfigSupport } /** - * Constructs a new instance of {@link Log} to log statements printed by Spring Data GemFire/Geode. + * Constructs a new instance of {@link Log} to log statements printed by SDG. * * @return a new instance of {@link Log}. * @see org.apache.commons.logging.LogFactory#getLog(Class) diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAuthInitialize.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAuthInitialize.java index a15385e3..2d7b5cbc 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAuthInitialize.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractAuthInitialize.java @@ -30,7 +30,7 @@ import org.springframework.data.gemfire.support.WiringDeclarableSupport; /** * The {@link AbstractAuthInitialize} class is an abstract support class and basic implementation * of the {@link AuthInitialize} interface used in the authentication of a client or peer - * with a secure GemFire/Geode cluster. + * with a secure Pivotal GemFire/Apache Geode cluster. * * @author John Blum * @see java.util.Properties diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractGemFireAsLastResourceAspectSupport.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractGemFireAsLastResourceAspectSupport.java index 0bf52e5d..7b4d8e47 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractGemFireAsLastResourceAspectSupport.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/AbstractGemFireAsLastResourceAspectSupport.java @@ -44,7 +44,7 @@ import org.springframework.util.StringUtils; /** * {@link AbstractGemFireAsLastResourceAspectSupport} is an abstract base class encapsulating functionality common - * to all AOP Aspect extensions/implementations involving the GemFire JCA ResourceAdapter object registered in + * to all AOP Aspect extensions/implementations involving the Pivotal GemFire JCA ResourceAdapter object registered in * the JNDI context of a managed environment. * * @author John Blum @@ -111,10 +111,10 @@ public class AbstractGemFireAsLastResourceAspectSupport implements Ordered { } /** - * Returns the configured reference to GemFire's JCA ResourceAdapter registered in the managed environment's + * Returns the configured reference to Pivotal GemFire's JCA ResourceAdapter registered in the managed environment's * JNDI context. * - * @return a {@link String} containing the configured reference to GemFire's JCA ResourceAdapter + * @return a {@link String} containing the configured reference to Pivotal GemFire's JCA ResourceAdapter * registered in the managed environment's JNDI context. */ public String getGemFireJcaResourceAdapterJndiName() { @@ -456,7 +456,7 @@ public class AbstractGemFireAsLastResourceAspectSupport implements Ordered { * Resolves a reference to the {@link GemFireCache} required by this Aspect to perform its function. * * This method either returns the configured {@link GemFireCache} instance or looks up - * the {@link GemFireCache} instance using GemFire's API. + * the {@link GemFireCache} instance using Pivotal GemFire's API. * * @return a reference to the resolved {@link GemFireCache} instance. * @see org.springframework.data.gemfire.GemfireUtils#resolveGemFireCache() @@ -475,10 +475,10 @@ public class AbstractGemFireAsLastResourceAspectSupport implements Ordered { } /** - * Resolves the configured JNDI name used to lookup and resolve the GemFire JCA ResourceAdapter object + * Resolves the configured JNDI name used to lookup and resolve the Pivotal GemFire JCA ResourceAdapter object * from the JNDI context in the managed environment. * - * @return a {@link String} containing the JNDI name used to lookup and resolve the GemFire JCA ResourceAdapter + * @return a {@link String} containing the JNDI name used to lookup and resolve the Pivotal GemFire JCA ResourceAdapter * object from the JNDI context in the managed environment. * @see #getGemFireJcaResourceAdapterJndiName() */ @@ -525,7 +525,7 @@ public class AbstractGemFireAsLastResourceAspectSupport implements Ordered { catch (ResourceException cause) { String message = - String.format("Failed to acquire GemFire Connection from GemFire's JCA ResourceAdapter: %s", + String.format("Failed to acquire Pivotal GemFire Connection from GemFire's JCA ResourceAdapter: %s", cause.getMessage()); if (throwOnError) { @@ -562,7 +562,7 @@ public class AbstractGemFireAsLastResourceAspectSupport implements Ordered { } catch (ResourceException cause) { - String message = String.format("Failed to close GemFire Connection: %s", cause.getMessage()); + String message = String.format("Failed to close Pivotal GemFire Connection: %s", cause.getMessage()); if (throwOnError) { throw newRuntimeException(cause, message); diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/EmbeddedServiceConfigurationSupport.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/EmbeddedServiceConfigurationSupport.java index 6e5120a9..ae6bc68f 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/EmbeddedServiceConfigurationSupport.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/EmbeddedServiceConfigurationSupport.java @@ -70,7 +70,7 @@ public abstract class EmbeddedServiceConfigurationSupport extends AbstractAnnota /** * Returns a reference to an instance of the {@link AbstractCacheConfiguration} class used to configure - * a GemFire (Singleton, client or peer) cache instance along with it's associated, embedded services. + * a Pivotal GemFire (Singleton, client or peer) cache instance along with it's associated, embedded services. * * @param {@link Class} type extension of {@link AbstractCacheConfiguration}. * @return a reference to a single {@link AbstractCacheConfiguration} instance. @@ -233,14 +233,14 @@ public abstract class EmbeddedServiceConfigurationSupport extends AbstractAnnota /** * Constructs a new instance of the {@link GemFirePropertiesBeanPostProcessor} initialized with - * the given GemFire/Geode {@link Properties}. + * the given Pivotal GemFire/Apache Geode {@link Properties}. * * @param gemfireProperties {@link Properties} used to configure Pivotal GemFire or Apache Geode. * @throws IllegalArgumentException if {@link Properties} are {@literal null} or empty. * @see java.util.Properties */ protected GemFirePropertiesBeanPostProcessor(Properties gemfireProperties) { - Assert.notEmpty(gemfireProperties, "GemFire Properties are required"); + Assert.notEmpty(gemfireProperties, "Pivotal GemFire Properties are required"); this.gemfireProperties = gemfireProperties; } diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspect.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspect.java index b505752f..62c5a6e5 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspect.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspect.java @@ -27,7 +27,7 @@ import org.springframework.beans.factory.annotation.Autowired; /** * The {@link GemFireAsLastResourceConnectionAcquiringAspect} class is a {@link AbstractGemFireAsLastResourceAspectSupport} - * implementation responsible for acquiring a GemFire Connection from GemFire's JCA ResourceAdapter, + * implementation responsible for acquiring a Pivotal GemFire Connection from Pivotal GemFire's JCA ResourceAdapter, * {@link GFConnectionFactory} after a CMT/JTA Transaction is began, which is initiated by * Spring's Transaction infrastructure. * @@ -48,18 +48,17 @@ public class GemFireAsLastResourceConnectionAcquiringAspect extends AbstractGemF private GFConnectionFactory gemfireConnectionFactory; /** - * Acquires (opens) a GemFire JCA ResourceAdapter Connection after the Spring CMT/JTA Transaction begins. + * Acquires (opens) a Pivotal GemFire JCA ResourceAdapter Connection after the Spring CMT/JTA Transaction begins. */ @Before("atTransactionalType() || atTransactionalMethod()") public void doGemFireConnectionFactoryGetConnection() { - logTraceInfo("Acquiring GemFire Connection from GemFire JCA ResourceAdapter registered at [%s]...", + logTraceInfo("Acquiring Pivotal GemFire Connection from Pivotal GemFire JCA ResourceAdapter registered at [%s]...", resolveGemFireJcaResourceAdapterJndiName()); GemFireConnectionHolder.acquire(resolveGemFireConnectionFactory(), isThrowOnError(), this::logError); } - /* (non-Javadoc) */ synchronized GFConnectionFactory resolveGemFireConnectionFactory() { GFConnectionFactory connectionFactory = getGemFireConnectionFactory(); diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspect.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspect.java index 8951ceac..d4d1a0fc 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspect.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspect.java @@ -21,8 +21,8 @@ import org.aspectj.lang.annotation.Aspect; /** * The {@link GemFireAsLastResourceConnectionClosingAspect} class is a {@link AbstractGemFireAsLastResourceAspectSupport} - * implementation responsible for closing the GemFire Connection obtained from the GemFire JCA ResourceAdapter - * deployed in a managed environment when using GemFire as the Last Resource in a CMT/JTA Transaction + * implementation responsible for closing the Pivotal GemFire Connection obtained from the Pivotal GemFire JCA ResourceAdapter + * deployed in a managed environment when using Pivotal GemFire as the Last Resource in a CMT/JTA Transaction * initiated from Spring's Transaction infrastructure. * * @author John Blum @@ -38,12 +38,12 @@ public class GemFireAsLastResourceConnectionClosingAspect extends AbstractGemFir private static final int DEFAULT_ORDER = 1024000; /** - * Closes the GemFire JCA ResourceAdapter Connection after the Spring CMT/JTA Transaction completes. + * Closes the Pivotal GemFire JCA ResourceAdapter Connection after the Spring CMT/JTA Transaction completes. */ @After("atTransactionalType() || atTransactionalMethod()") public void doGemFireConnectionClose() { - logTraceInfo("Closing GemFire Connection..."); + logTraceInfo("Closing Pivotal GemFire Connection..."); GemFireConnectionHolder.close(isThrowOnError(), this::logWarning); } diff --git a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireComponentClassTypeScanner.java b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireComponentClassTypeScanner.java index aa027d79..31fcbc62 100644 --- a/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireComponentClassTypeScanner.java +++ b/src/main/java/org/springframework/data/gemfire/config/annotation/support/GemFireComponentClassTypeScanner.java @@ -43,7 +43,7 @@ import org.springframework.util.StringUtils; /** * The {@link GemFireComponentClassTypeScanner} class is a classpath component scanner used to search - * for GemFire components based on {@link Class} type. + * for Pivotal GemFire components based on {@link Class} type. * * @author John Blum * @see java.lang.Iterable @@ -60,7 +60,7 @@ public class GemFireComponentClassTypeScanner implements Iterable { * Factory method to construct an instance of the {@link GemFireComponentClassTypeScanner} initialized with * the given array of base packages to scan. * - * @param basePackages array of base packages to scan for GemFire components. + * @param basePackages array of base packages to scan for Pivotal GemFire components. * @throws IllegalArgumentException if the array of base packages is {@literal null} or empty. * @return an initialized instance of {@link GemFireComponentClassTypeScanner}. * @see #GemFireComponentClassTypeScanner(Set) @@ -73,7 +73,7 @@ public class GemFireComponentClassTypeScanner implements Iterable { * Factory method to construct an instance of the {@link GemFireComponentClassTypeScanner} initialized with * the given {@link Iterable} of base packages to scan. * - * @param basePackages {@link Iterable} of base packages to scan for GemFire components. + * @param basePackages {@link Iterable} of base packages to scan for Pivotal GemFire components. * @throws IllegalArgumentException if the {@link Iterable} of base packages is {@literal null} or empty. * @return an initialized instance of {@link GemFireComponentClassTypeScanner}. * @see #GemFireComponentClassTypeScanner(Set) @@ -98,7 +98,7 @@ public class GemFireComponentClassTypeScanner implements Iterable { * Constructs an instance of the {@link GemFireComponentClassTypeScanner} initialized with * the given {@link Set} of base packages to scan. * - * @param basePackages {@link Set} of base packages to scan for GemFire component clases. + * @param basePackages {@link Set} of base packages to scan for Pivotal GemFire component clases. * @throws IllegalArgumentException if the {@link Set} is {@literal null} or empty. * @see java.util.Set */ @@ -118,9 +118,9 @@ public class GemFireComponentClassTypeScanner implements Iterable { } /** - * Returns an unmodifiable {@link Set} of base packages to scan for GemFire components. + * Returns an unmodifiable {@link Set} of base packages to scan for Pivotal GemFire components. * - * @return an unmodifiable {@link Set} of base packages to scan for GemFire components. + * @return an unmodifiable {@link Set} of base packages to scan for Pivotal GemFire components. * @see java.util.Set */ protected Set getBasePackages() { @@ -128,10 +128,10 @@ public class GemFireComponentClassTypeScanner implements Iterable { } /** - * Returns a reference to the {@link ClassLoader} used to find and load GemFire application + * Returns a reference to the {@link ClassLoader} used to find and load Pivotal GemFire application * persistent entity classes. * - * @return the {@link ClassLoader} used to find and load GemFire application persistent entity classes. + * @return the {@link ClassLoader} used to find and load Pivotal GemFire application persistent entity classes. * @see org.springframework.beans.factory.config.ConfigurableBeanFactory#getBeanClassLoader() * @see java.lang.Thread#getContextClassLoader() * @see java.lang.ClassLoader @@ -147,7 +147,7 @@ public class GemFireComponentClassTypeScanner implements Iterable { } /** - * Returns a reference to the Spring {@link Environment} in which the Spring GemFire application is running. + * Returns a reference to the Spring {@link Environment} in which the Spring Pivotal GemFire application is running. * * @return a reference to the Spring {@link Environment}. * @see org.springframework.context.ApplicationContext#getEnvironment() @@ -192,10 +192,10 @@ public class GemFireComponentClassTypeScanner implements Iterable { } /** - * Scans the {@link Set} of base packages searching for GemFire application components + * Scans the {@link Set} of base packages searching for Pivotal GemFire application components * accepted by the filters of this scanner. * - * @return a {@link Set} of GemFire application component {@link Class} types found on the classpath. + * @return a {@link Set} of Pivotal GemFire application component {@link Class} types found on the classpath. * @see #newClassPathScanningCandidateComponentProvider(boolean) * @see java.util.Set */ diff --git a/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectDefinition.java b/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectDefinition.java index 5942f904..fb646004 100644 --- a/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectDefinition.java +++ b/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectDefinition.java @@ -45,7 +45,7 @@ public abstract class SchemaObjectDefinition implements Serializable, Ordered { /** * Constructs a new instance of {@link SchemaObjectDefinition} initialized with the specified {@link String name}. * - * @param name {@link String name} given to the GemFire/Geode schema object; must not be {@literal null}. + * @param name {@link String name} given to the Pivotal GemFire/Apache Geode schema object; must not be {@literal null}. * @throws IllegalArgumentException if name is not specified. */ public SchemaObjectDefinition(String name) { diff --git a/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectType.java b/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectType.java index e45b0082..34549206 100644 --- a/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectType.java +++ b/src/main/java/org/springframework/data/gemfire/config/schema/SchemaObjectType.java @@ -32,8 +32,8 @@ import org.apache.geode.cache.wan.GatewaySender; /** * {@link SchemaObjectType} defines an enumeration of all the types of Apache Geode or Pivotal GemFire schema objects - * (e.g. {@link Region}) that may possibly be handled by Spring Data Geode / Spring Data GemFire - * and that can be created remotely, from a client application. + * (e.g. {@link Region}) that may possibly be handled by SDG and that can be created remotely, + * from a client application. * * @author John Blum * @see org.apache.geode.cache.asyncqueue.AsyncEventQueue @@ -69,9 +69,9 @@ public enum SchemaObjectType { /** * Constructs an instance of an {@link SchemaObjectType} enumerated value initialized with - * the actual GemFire {@link Class schema object instance type}. + * the actual Pivotal GemFire {@link Class schema object instance type}. * - * @param objectType actual {@link Class interface type} of the GemFire schema object instance. + * @param objectType actual {@link Class interface type} of the Pivotal GemFire schema object instance. * @see java.lang.Class */ SchemaObjectType(Class objectType) { @@ -80,13 +80,13 @@ public enum SchemaObjectType { /** * Null-safe factory method used to look up and resolve the corresponding {@link SchemaObjectType} - * given an instance of a GemFire schema object. + * given an instance of a Pivotal GemFire schema object. * * For example, given an instance of {@link Region}, this factory method will return * {@link SchemaObjectType#REGION}. * - * @param obj actual instance of a GemFire schema object, e.g. reference to a {@link Region}. - * @return a corresponding {@link SchemaObjectType} for a given instance of a GemFire schema object. + * @param obj actual instance of a Pivotal GemFire schema object, e.g. reference to a {@link Region}. + * @return a corresponding {@link SchemaObjectType} for a given instance of a Pivotal GemFire schema object. * If the type cannot be determined, then {@link SchemaObjectType#UNKNOWN} is returned. * @see #from(Class) */ @@ -98,13 +98,13 @@ public enum SchemaObjectType { /** * Null-safe factory method used to look up and resolve the corresponding {@link SchemaObjectType} - * given the type of GemFire schema object. + * given the type of Pivotal GemFire schema object. * * For example, given the {@link Region} {@link Class interface} or any {@link Class sub-type} of {@link Region}, * this factory method will return {@link SchemaObjectType#REGION}. * - * @param type {@link Class type} of the GemFire schema object, e.g. the {@link Region} {@link Class interface}. - * @return a corresponding {@link SchemaObjectType} for a given {@link Class type }of a GemFire schema object. + * @param type {@link Class type} of the Pivotal GemFire schema object, e.g. the {@link Region} {@link Class interface}. + * @return a corresponding {@link SchemaObjectType} for a given {@link Class type }of a Pivotal GemFire schema object. * If the type cannot be determined, then {@link SchemaObjectType#UNKNOWN} is returned. * @see #from(Object) */ @@ -115,9 +115,9 @@ public enum SchemaObjectType { } /** - * Returns the {@link Class class type} of the GemFire schema object represented by this enumerated value. + * Returns the {@link Class class type} of the Pivotal GemFire schema object represented by this enumerated value. * - * @return the {@link Class class type} of the GemFire schema object represented by this enumerated value. + * @return the {@link Class class type} of the Pivotal GemFire schema object represented by this enumerated value. * @see java.lang.Class */ public Class getObjectType() { diff --git a/src/main/java/org/springframework/data/gemfire/config/support/AutoRegionLookupBeanPostProcessor.java b/src/main/java/org/springframework/data/gemfire/config/support/AutoRegionLookupBeanPostProcessor.java index 554cd324..de8d259e 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/AutoRegionLookupBeanPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/AutoRegionLookupBeanPostProcessor.java @@ -38,8 +38,8 @@ import org.springframework.util.StringUtils; * a {@link GemFireCache} by registering all cache {@link Region Regions} that have not been explicitly defined * in the Spring application context. * - * This is usually the case for {@link Region Regions} that have been defined in GemFire's native {@literal cache.xml} - * or defined using GemFire Cluster-based Configuration Service. + * This is usually the case for {@link Region Regions} that have been defined in Pivotal GemFire's + * native {@literal cache.xml} or defined using Pivotal GemFire's Cluster Configuration Service. * * @author John Blum * @see org.apache.geode.cache.GemFireCache @@ -67,7 +67,6 @@ public class AutoRegionLookupBeanPostProcessor implements BeanPostProcessor, Bea this.beanFactory = (ConfigurableListableBeanFactory) beanFactory; } - /* (non-Javadoc) */ protected ConfigurableListableBeanFactory getBeanFactory() { return Optional.ofNullable(this.beanFactory).orElseThrow(() -> newIllegalStateException("BeanFactory was not properly configured")); @@ -86,12 +85,10 @@ public class AutoRegionLookupBeanPostProcessor implements BeanPostProcessor, Bea return bean; } - /* (non-Javadoc) */ void registerCacheRegionsAsBeans(GemFireCache cache) { cache.rootRegions().forEach(this::registerCacheRegionAsBean); } - /* (non-Javadoc) */ void registerCacheRegionAsBean(Region region) { if (region != null) { @@ -108,7 +105,6 @@ public class AutoRegionLookupBeanPostProcessor implements BeanPostProcessor, Bea } } - /* (non-Javadoc) */ String getBeanName(Region region) { return Optional.ofNullable(region.getFullPath()) @@ -117,7 +113,6 @@ public class AutoRegionLookupBeanPostProcessor implements BeanPostProcessor, Bea .orElseGet(region::getName); } - /* (non-Javadoc) */ Set> nullSafeSubregions(Region parentRegion) { return Optional.ofNullable(parentRegion.subregions(false)).orElse(Collections.emptySet()); } diff --git a/src/main/java/org/springframework/data/gemfire/config/support/ClientRegionPoolBeanFactoryPostProcessor.java b/src/main/java/org/springframework/data/gemfire/config/support/ClientRegionPoolBeanFactoryPostProcessor.java index d4c9af9d..b2c00e84 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/ClientRegionPoolBeanFactoryPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/ClientRegionPoolBeanFactoryPostProcessor.java @@ -35,9 +35,9 @@ import org.springframework.util.StringUtils; /** * {@link ClientRegionPoolBeanFactoryPostProcessor} is a Spring {@link BeanFactoryPostProcessor} implementation - * ensuring a proper dependency is declared between a GemFire client {@link org.apache.geode.cache.Region} - * and the GemFire client {@link org.apache.geode.cache.client.Pool} it references and uses, providing - * the GemFire client {@link org.apache.geode.cache.client.Pool} has been defined and configured with + * ensuring a proper dependency is declared between a Pivotal GemFire client {@link org.apache.geode.cache.Region} + * and the Pivotal GemFire client {@link org.apache.geode.cache.client.Pool} it references and uses, providing + * the Pivotal GemFire client {@link org.apache.geode.cache.client.Pool} has been defined and configured with * Spring (Data GemFire) configuration meta-data (e.g. XML). * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/support/CustomEditorBeanFactoryPostProcessor.java b/src/main/java/org/springframework/data/gemfire/config/support/CustomEditorBeanFactoryPostProcessor.java index fb0ecae9..c0e3e164 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/CustomEditorBeanFactoryPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/CustomEditorBeanFactoryPostProcessor.java @@ -16,6 +16,7 @@ package org.springframework.data.gemfire.config.support; +import java.beans.PropertyEditor; import java.beans.PropertyEditorSupport; import org.apache.geode.cache.EvictionAction; @@ -48,9 +49,9 @@ import org.springframework.data.gemfire.wan.OrderPolicyConverter; /** * {@link CustomEditorBeanFactoryPostProcessor} is a Spring {@link BeanFactoryPostProcessor} implementation - * used to register custom {@link java.beans.PropertyEditor PropertyEditors} / Spring {@link Converter Converters} - * that are used to perform type conversions between String-based configuration meta-data and actual GemFire - * or Spring Data GemFire defined (enumerated) types. + * used to register custom {@link PropertyEditor PropertyEditors} / Spring {@link Converter Converters} + * that are used to perform type conversions between String-based configuration meta-data + * and actual Pivotal GemFire or SDG defined types. * * @author John Blum * @see org.springframework.beans.factory.config.BeanFactoryPostProcessor diff --git a/src/main/java/org/springframework/data/gemfire/config/support/DefinedIndexesApplicationListener.java b/src/main/java/org/springframework/data/gemfire/config/support/DefinedIndexesApplicationListener.java index df3d6b28..70474ddc 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/DefinedIndexesApplicationListener.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/DefinedIndexesApplicationListener.java @@ -29,7 +29,7 @@ import org.springframework.data.gemfire.config.xml.GemfireConstants; /** * {@link DefinedIndexesApplicationListener} is a Spring {@link ApplicationListener} used to create all - * "defined" GemFire {@link org.apache.geode.cache.query.Index Indexes} by using the {@link QueryService}, + * "defined" Pivotal GemFire {@link org.apache.geode.cache.query.Index Indexes} by using the {@link QueryService}, * {@literal defineXxxIndex(..)} methods. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/support/DiskStoreDirectoryBeanPostProcessor.java b/src/main/java/org/springframework/data/gemfire/config/support/DiskStoreDirectoryBeanPostProcessor.java index 95b6951a..c2c47f47 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/DiskStoreDirectoryBeanPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/DiskStoreDirectoryBeanPostProcessor.java @@ -28,7 +28,7 @@ import org.springframework.util.Assert; import org.springframework.util.ObjectUtils; /** - * The {@link DiskStoreDirectoryBeanPostProcessor} processes any GemFire {@link org.apache.geode.cache.DiskStore}, + * The {@link DiskStoreDirectoryBeanPostProcessor} processes any Pivotal GemFire {@link org.apache.geode.cache.DiskStore}, * {@link DiskDir} Spring beans defined in the application context to ensure that the directory actually exists * before creating the {@link org.apache.geode.cache.DiskStore}. * diff --git a/src/main/java/org/springframework/data/gemfire/config/support/PdxDiskStoreAwareBeanFactoryPostProcessor.java b/src/main/java/org/springframework/data/gemfire/config/support/PdxDiskStoreAwareBeanFactoryPostProcessor.java index 40aa8829..1f0cf1bd 100644 --- a/src/main/java/org/springframework/data/gemfire/config/support/PdxDiskStoreAwareBeanFactoryPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/config/support/PdxDiskStoreAwareBeanFactoryPostProcessor.java @@ -33,7 +33,7 @@ import org.springframework.util.Assert; /** * {@link PdxDiskStoreAwareBeanFactoryPostProcessor} is a Spring {@link BeanFactoryPostProcessor} that modifies - * all GemFire Async Event Queue, Region and Disk Store beans in the Spring container to form a dependency on + * all Pivotal GemFire Async Event Queue, Region and Disk Store beans in the Spring container to form a dependency on * the Cache's PDX {@link DiskStore} bean. * * A persistent Region may contain PDX typed data, in which case, the PDX type meta-data stored to disk needs to be @@ -57,8 +57,8 @@ public class PdxDiskStoreAwareBeanFactoryPostProcessor implements BeanFactoryPos * Constructs an instance of the {@link PdxDiskStoreAwareBeanFactoryPostProcessor} class initialized with * the given PDX {@link DiskStore} name. * - * @param pdxDiskStoreName name of the GemFire PDX {@link DiskStore}. - * @throws IllegalArgumentException if the GemFire PDX {@link DiskStore} name is unspecified. + * @param pdxDiskStoreName name of the Pivotal GemFire PDX {@link DiskStore}. + * @throws IllegalArgumentException if the Pivotal GemFire PDX {@link DiskStore} name is unspecified. */ public PdxDiskStoreAwareBeanFactoryPostProcessor(String pdxDiskStoreName) { Assert.hasText(pdxDiskStoreName, "PDX DiskStore name is required"); @@ -66,9 +66,9 @@ public class PdxDiskStoreAwareBeanFactoryPostProcessor implements BeanFactoryPos } /** - * Returns the name of the GemFire PDX {@link DiskStore}. + * Returns the name of the Pivotal GemFire PDX {@link DiskStore}. * - * @return the name of the GemFire PDX {@link DiskStore}. + * @return the name of the Pivotal GemFire PDX {@link DiskStore}. */ public String getPdxDiskStoreName() { return this.pdxDiskStoreName; diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/AnnotationDrivenParser.java b/src/main/java/org/springframework/data/gemfire/config/xml/AnnotationDrivenParser.java index b8703f81..db5648bd 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/AnnotationDrivenParser.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/AnnotationDrivenParser.java @@ -23,7 +23,7 @@ import org.springframework.data.gemfire.function.config.GemfireFunctionBeanPostP import org.w3c.dom.Element; /** - * A Spring {@link BeanDefinitionParser} to enable Spring Data GemFire Function annotation support. + * A Spring {@link BeanDefinitionParser} Pivotal GemFire Function annotation support. * * Bean definition parser for the <gfe:annotation-driven> SDG XML namespace (XSD) element. * diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/AutoRegionLookupParser.java b/src/main/java/org/springframework/data/gemfire/config/xml/AutoRegionLookupParser.java index ea58154a..6eeb4ae4 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/AutoRegionLookupParser.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/AutoRegionLookupParser.java @@ -29,8 +29,8 @@ import org.w3c.dom.Element; * Bean definition parser for the <gfe:auto-region-lookup> SDG XML namespace (XSD) element. * * This parser will register a Spring {@link org.springframework.beans.factory.config.BeanPostProcessor) - * that discovers all Regions defined in GemFire's native {@literal cache.xml} file, or when using - * GemFire 8's cluster-based configuration service to define Regions, to create corresponding beans + * that discovers all Regions defined in Pivotal GemFire's native {@literal cache.xml} file, or when using + * Pivotal GemFire 8's cluster-based configuration service to define Regions, to create corresponding beans * in the Spring application context. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireConstants.java b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireConstants.java index 1ae29113..fba8ef39 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireConstants.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireConstants.java @@ -16,7 +16,7 @@ package org.springframework.data.gemfire.config.xml; /** - * The GemfireConstants class define constants for Spring GemFire component bean names. + * The GemfireConstants class define constants for Spring Pivotal GemFire component bean names. * * @author David Turanski * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataNamespaceHandler.java b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataNamespaceHandler.java index 03a20a40..340e7f34 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataNamespaceHandler.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataNamespaceHandler.java @@ -23,8 +23,7 @@ import org.springframework.data.repository.config.RepositoryBeanDefinitionParser import org.springframework.data.repository.config.RepositoryConfigurationExtension; /** - * Spring {@link org.springframework.beans.factory.xml.NamespaceHandler} for Spring Data GemFire - * XML namespace (XSD) bean definitions. + * Spring {@link org.springframework.beans.factory.xml.NamespaceHandler} for SDG XML namespace (XSD) bean definitions. * * @author Costin Leau * @author David Turanski diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataSourceParser.java b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataSourceParser.java index 0d482923..53f4f1af 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataSourceParser.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireDataSourceParser.java @@ -13,8 +13,8 @@ package org.springframework.data.gemfire.config.xml; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.beans.MutablePropertyValues; import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.beans.factory.support.AbstractBeanDefinition; @@ -40,17 +40,32 @@ class GemfireDataSourceParser extends AbstractBeanDefinitionParser { static final String SUBSCRIPTION_ENABLED_ATTRIBUTE_NAME = "subscription-enabled"; static final String SUBSCRIPTION_ENABLED_PROPERTY_NAME = "subscriptionEnabled"; - protected final Log log = LogFactory.getLog(getClass()); + protected final Logger logger = LoggerFactory.getLogger(getClass()); - /** - * {@inheritDoc} - */ @Override protected AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) { + + parseAndRegisterClientCache(element, parserContext); + parseAndRegisterPool(element, parserContext); + registerGemFireDataSourcePostProcessor(parserContext); + + return null; + } + + private void parseAndRegisterClientCache(Element element, ParserContext parserContext) { + BeanDefinition clientCacheDefinition = new ClientCacheParser().parse(element, parserContext); - parserContext.getRegistry().registerBeanDefinition(GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME, - clientCacheDefinition); + parserContext.getRegistry() + .registerBeanDefinition(GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME, clientCacheDefinition); + + if (logger.isDebugEnabled()) { + logger.debug(String.format("Registered Pivotal GemFire ClientCache bean [%1$s] of type [%2$s]%n", + GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME, clientCacheDefinition.getBeanClassName())); + } + } + + private void parseAndRegisterPool(Element element, ParserContext parserContext) { BeanDefinition poolDefinition = new PoolParser().parse(element, parserContext); @@ -61,19 +76,15 @@ class GemfireDataSourceParser extends AbstractBeanDefinitionParser { } parserContext.getRegistry().registerBeanDefinition(GemfireConstants.DEFAULT_GEMFIRE_POOL_NAME, poolDefinition); + } - if (log.isDebugEnabled()) { - log.debug(String.format("Registered GemFire ClientCache bean [%1$s] of type [%2$s]%n", - GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME, clientCacheDefinition.getBeanClassName())); - } + private void registerGemFireDataSourcePostProcessor(ParserContext parserContext) { - BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition( - GemfireDataSourcePostProcessor.class); + BeanDefinitionBuilder builder = + BeanDefinitionBuilder.genericBeanDefinition(GemfireDataSourcePostProcessor.class); builder.addConstructorArgReference(GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME); BeanDefinitionReaderUtils.registerWithGeneratedName(builder.getBeanDefinition(), parserContext.getRegistry()); - - return null; } } diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireListenerContainerParser.java b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireListenerContainerParser.java index 80f13bc5..160a9fc0 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/GemfireListenerContainerParser.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/GemfireListenerContainerParser.java @@ -79,7 +79,7 @@ class GemfireListenerContainerParser extends AbstractSingleBeanDefinitionParser * (of type {@link ContinuousQueryDefinition)). * * @param element XML DOM {@link Element} to parse. - * @return a Spring {@link BeanDefinition} for the GemFire Continuous Query (CQ) listener configuration. + * @return a Spring {@link BeanDefinition} for the Pivotal GemFire Continuous Query (CQ) listener configuration. * @see org.springframework.beans.factory.xml.BeanDefinition * @see org.w3c.dom.Element */ diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/ParsingUtils.java b/src/main/java/org/springframework/data/gemfire/config/xml/ParsingUtils.java index 93e8152f..272475d0 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/ParsingUtils.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/ParsingUtils.java @@ -40,7 +40,7 @@ import org.springframework.util.xml.DomUtils; import org.w3c.dom.Element; /** - * Utilities used by the Spring Data GemFire XML Namespace Parsers. + * Utilities used by SDG XML Namespace Parsers. * * @author Costin Leau * @author David Turanski @@ -394,12 +394,15 @@ abstract class ParsingUtils { } static void throwExceptionIfNotGemfireV7(String elementName, String attributeName, ParserContext parserContext) { + if (!GemfireUtils.isGemfireVersion7OrAbove()) { + String messagePrefix = (attributeName != null) ? String.format("Attribute '%1$s' of element '%2$s'", attributeName, elementName) : String.format("Element '%1$s'", elementName); + parserContext.getReaderContext().error( - String.format("%1$s requires GemFire version 7 or later. The current version is %2$s.", + String.format("%1$s requires Pivotal GemFire version 7 or later. The current version is %2$s.", messagePrefix, GemfireUtils.GEMFIRE_VERSION), null); } } diff --git a/src/main/java/org/springframework/data/gemfire/config/xml/package-info.java b/src/main/java/org/springframework/data/gemfire/config/xml/package-info.java index 76a85f8e..33152d27 100644 --- a/src/main/java/org/springframework/data/gemfire/config/xml/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/config/xml/package-info.java @@ -1,7 +1,7 @@ /** - * This package provides classes and components for configuring GemFire using Spring Data GemFire's + * This package provides classes and components for configuring Pivotal GemFire using Spring Data's * XML namespace support. See more details here... * - * Spring Data GemFire Core Schema (gfe) + * SDG Core Schema (gfe) */ package org.springframework.data.gemfire.config.xml; diff --git a/src/main/java/org/springframework/data/gemfire/dao/GemfireDaoSupport.java b/src/main/java/org/springframework/data/gemfire/dao/GemfireDaoSupport.java index 9306190e..ac2c5fd2 100644 --- a/src/main/java/org/springframework/data/gemfire/dao/GemfireDaoSupport.java +++ b/src/main/java/org/springframework/data/gemfire/dao/GemfireDaoSupport.java @@ -24,13 +24,13 @@ import org.springframework.data.gemfire.GemfireTemplate; import org.springframework.util.Assert; /** - * Convenient super class for GemFire Data Access Objects (DAO) implementing the Spring + * Convenient super class for Pivotal GemFire Data Access Objects (DAO) implementing the Spring * {@link DaoSupport} abstract class. Intended for use with {@link GemfireTemplate}. * - * Requires a GemFire {@link Region} to be set, providing a {@link GemfireTemplate} based on it to subclasses. + * Requires a Pivotal 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. * - * This class will create its own {@link GemfireTemplate} if a GemFire {@link Region} reference is passed in. + * This class will create its own {@link GemfireTemplate} if a Pivotal GemFire {@link Region} reference is passed in. * A custom {@link GemfireTemplate} instance can be used through overriding createGemfireTemplate. * * @author Costin Leau @@ -44,7 +44,7 @@ public abstract class GemfireDaoSupport extends DaoSupport { private GemfireOperations gemfireTemplate; /** - * Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a GemFire Cache {@link Region}. + * Set the GemfireTemplate for this DAO explicitly as an alternative to specifying a Pivotal GemFire Cache {@link Region}. * * @param gemfireTemplate the GemfireTemplate to be use by this DAO. * @see org.springframework.data.gemfire.GemfireOperations @@ -58,7 +58,7 @@ public abstract class GemfireDaoSupport extends DaoSupport { /** * Returns the GemfireTemplate for this DAO, pre-initialized with the Region or set explicitly. * - * @return an instance of the GemfireTemplate to perform data access operations on the GemFire Cache Region. + * @return an instance of the GemfireTemplate to perform data access operations on the Pivotal GemFire Cache Region. * @see org.springframework.data.gemfire.GemfireOperations * @see org.springframework.data.gemfire.GemfireTemplate */ @@ -67,10 +67,10 @@ public abstract class GemfireDaoSupport extends DaoSupport { } /** - * Sets the GemFire Cache Region to be used by this DAO. Will automatically create + * Sets the Pivotal 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. + * @param region the Pivotal GemFire Cache Region upon which this DAO operates. * @see org.apache.geode.cache.Region * @see #createGemfireTemplate(org.apache.geode.cache.Region) */ @@ -79,12 +79,12 @@ public abstract class GemfireDaoSupport extends DaoSupport { } /** - * Creates an instance of the GemfireTemplate for the given GemFire Cache Region. + * Creates an instance of the GemfireTemplate for the given Pivotal GemFire Cache Region. *

Can be overridden in subclasses to provide a GemfireTemplate instance with different configuration, * or even a custom GemfireTemplate subclass. * - * @param region the GemFire Cache Region for which the GemfireTemplate is created. - * @return a new GemfireTemplate instance configured with the given GemFire Cache Region. + * @param region the Pivotal GemFire Cache Region for which the GemfireTemplate is created. + * @return a new GemfireTemplate instance configured with the given Pivotal GemFire Cache Region. * @see org.apache.geode.cache.Region * @see #setRegion */ @@ -97,6 +97,6 @@ public abstract class GemfireDaoSupport extends DaoSupport { */ @Override protected final void checkDaoConfig() { - Assert.state(gemfireTemplate != null, "A GemFire Cache Region or instance of GemfireTemplate is required"); + Assert.state(gemfireTemplate != null, "A Cache Region or instance of GemfireTemplate is required"); } } diff --git a/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionConverter.java b/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionConverter.java index 3bc51a9c..692236d0 100644 --- a/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionConverter.java +++ b/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionConverter.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS /** * The EvictionActionConverter class is a Spring Converter and JavaBeans PropertyEditor that converts - * an Object value into an instance of GemFire EvictionAction. + * an Object value into an instance of Pivotal GemFire EvictionAction. * * @author John Blum * @see EvictionActionType @@ -33,12 +33,12 @@ import org.springframework.data.gemfire.support.AbstractPropertyEditorConverterS public class EvictionActionConverter extends AbstractPropertyEditorConverterSupport { /** - * Converts the given String into a GemFire EvictionAction value. + * Converts the given String into a Pivotal GemFire EvictionAction value. * * @param source the String to convert. - * @return the GemFire EvictionAction value matching the given String. + * @return the Pivotal GemFire EvictionAction value matching the given String. * @throws java.lang.IllegalArgumentException if the String could not be converted into - * an instance of GemFire EvictionAction. + * an instance of Pivotal GemFire EvictionAction. * @see org.apache.geode.cache.EvictionAction */ @Override diff --git a/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionType.java b/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionType.java index 7b24d875..60d4a03c 100644 --- a/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionType.java +++ b/src/main/java/org/springframework/data/gemfire/eviction/EvictionActionType.java @@ -19,7 +19,7 @@ package org.springframework.data.gemfire.eviction; import org.apache.geode.cache.EvictionAction; /** - * The EvictionActionType enum is an enumeration of all the GemFire EvictionAction values. + * The EvictionActionType enum is an enumeration of all the Pivotal GemFire EvictionAction values. * * @author John Blum * @see org.apache.geode.cache.EvictionAction @@ -36,9 +36,9 @@ public enum EvictionActionType { private final EvictionAction evictionAction; /** - * Constructs an instance of the EvictionActionType enum initialized with the matching GemFire EvictionAction. + * Constructs an instance of the EvictionActionType enum initialized with the matching Pivotal GemFire EvictionAction. * - * @param evictionAction the matching GemFire EvictionAction value for this enumerated value. + * @param evictionAction the matching Pivotal GemFire EvictionAction value for this enumerated value. * @see org.apache.geode.cache.EvictionAction */ EvictionActionType(final EvictionAction evictionAction) { @@ -46,11 +46,11 @@ public enum EvictionActionType { } /** - * A null-safe operation to extract the GemFire EvictionAction from the EvictionActionType enumerated value. + * A null-safe operation to extract the Pivotal GemFire EvictionAction from the EvictionActionType enumerated value. * * @param evictionActionType the EvictionActionType enumerated value from which to extract - * the matching GemFire EvictionAction value. - * @return a GemFire EvictionAction given a EvictionActionType enumerated value. + * the matching Pivotal GemFire EvictionAction value. + * @return a Pivotal GemFire EvictionAction given a EvictionActionType enumerated value. * @see #getEvictionAction() */ public static EvictionAction getEvictionAction(final EvictionActionType evictionActionType) { @@ -58,10 +58,10 @@ public enum EvictionActionType { } /** - * Returns an EvictionActionType enumerated value matching the given GemFire EvictionAction. + * Returns an EvictionActionType enumerated value matching the given Pivotal GemFire EvictionAction. * - * @param evictionAction the GemFire EvictionAction used to lookup and match the appropriate EvictionActionType. - * @return an EvictionActionType enumerated value matching the given GemFire EvictionAction + * @param evictionAction the Pivotal GemFire EvictionAction used to lookup and match the appropriate EvictionActionType. + * @return an EvictionActionType enumerated value matching the given Pivotal GemFire EvictionAction * or null if no match was found. * @see org.apache.geode.cache.EvictionAction * @see #getEvictionAction() @@ -96,9 +96,9 @@ public enum EvictionActionType { } /** - * Gets the matching GemFire EvictionAction represented by this enumerated value. + * Gets the matching Pivotal GemFire EvictionAction represented by this enumerated value. * - * @return the GemFire EvictionAction represented by this enum. + * @return the Pivotal GemFire EvictionAction represented by this enum. * @see org.apache.geode.cache.EvictionAction */ public EvictionAction getEvictionAction() { diff --git a/src/main/java/org/springframework/data/gemfire/eviction/EvictionAttributesFactoryBean.java b/src/main/java/org/springframework/data/gemfire/eviction/EvictionAttributesFactoryBean.java index a0e3fb4f..a9a8d333 100644 --- a/src/main/java/org/springframework/data/gemfire/eviction/EvictionAttributesFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/eviction/EvictionAttributesFactoryBean.java @@ -119,7 +119,7 @@ public class EvictionAttributesFactoryBean implements FactoryBean { /** - * Converts the given String into an appropriate GemFire ExpirationAction. + * Converts the given String into an appropriate Pivotal GemFire ExpirationAction. * - * @param source the String to convert into an GemFire ExpirationAction. - * @return an GemFire ExpirationAction value for the given String. - * @throws java.lang.IllegalArgumentException if the String is not a valid GemFire ExpirationAction. + * @param source the String to convert into an Pivotal GemFire ExpirationAction. + * @return an Pivotal GemFire ExpirationAction value for the given String. + * @throws java.lang.IllegalArgumentException if the String is not a valid Pivotal GemFire ExpirationAction. * @see ExpirationActionType#valueOfIgnoreCase(String) * @see org.apache.geode.cache.ExpirationAction */ diff --git a/src/main/java/org/springframework/data/gemfire/expiration/ExpirationActionType.java b/src/main/java/org/springframework/data/gemfire/expiration/ExpirationActionType.java index 6a2f0aae..a1db60e1 100644 --- a/src/main/java/org/springframework/data/gemfire/expiration/ExpirationActionType.java +++ b/src/main/java/org/springframework/data/gemfire/expiration/ExpirationActionType.java @@ -19,7 +19,7 @@ package org.springframework.data.gemfire.expiration; import org.apache.geode.cache.ExpirationAction; /** - * The ExpirationActionType enum is a enumeration of GemFire ExpirationActions on expired Cache Region entries. + * The ExpirationActionType enum is a enumeration of Pivotal GemFire ExpirationActions on expired Cache Region entries. * * @author John Blum * @see org.apache.geode.cache.ExpirationAction @@ -37,9 +37,9 @@ public enum ExpirationActionType { private final ExpirationAction expirationAction; /** - * Constructs an instance of the ExpirationActionType enum initialized with the matching GemFire ExpirationAction. + * Constructs an instance of the ExpirationActionType enum initialized with the matching Pivotal GemFire ExpirationAction. * - * @param expirationAction the matching GemFire ExpirationAction for this enumerated value. + * @param expirationAction the matching Pivotal GemFire ExpirationAction for this enumerated value. * @see org.apache.geode.cache.ExpirationAction */ ExpirationActionType(final ExpirationAction expirationAction) { @@ -47,11 +47,11 @@ public enum ExpirationActionType { } /** - * A null-safe operation to extract the corresponding GemFire ExpirationAction for the ExpirationActionType. + * A null-safe operation to extract the corresponding Pivotal GemFire ExpirationAction for the ExpirationActionType. * * @param expirationActionType the ExpirationActionType enumerated value from which to extract - * the corresponding GemFire ExpirationAction. - * @return a GemFire ExpirationAction given the ExpirationActionType enumerated value. + * the corresponding Pivotal GemFire ExpirationAction. + * @return a Pivotal GemFire ExpirationAction given the ExpirationActionType enumerated value. * @see org.apache.geode.cache.ExpirationAction */ public static ExpirationAction getExpirationAction(final ExpirationActionType expirationActionType) { @@ -59,10 +59,10 @@ public enum ExpirationActionType { } /** - * Returns the ExpirationActionType enumerated value matching the given GemFire ExpirationAction. + * Returns the ExpirationActionType enumerated value matching the given Pivotal GemFire ExpirationAction. * - * @param expirationAction the GemFire ExpirationAction used to match the ExpirationActionType. - * @return a matching ExpirationActionType enumerated value given a GemFire ExpirationAction + * @param expirationAction the Pivotal GemFire ExpirationAction used to match the ExpirationActionType. + * @return a matching ExpirationActionType enumerated value given a Pivotal GemFire ExpirationAction * or null if no match was found. * @see org.apache.geode.cache.ExpirationAction * @see #getExpirationAction() @@ -97,9 +97,9 @@ public enum ExpirationActionType { } /** - * Gets the matching GemFire ExpirationAction for this enumerated value. + * Gets the matching Pivotal GemFire ExpirationAction for this enumerated value. * - * @return the GemFire ExpirationAction instance corresponding to this enumerated value. + * @return the Pivotal GemFire ExpirationAction instance corresponding to this enumerated value. * @see org.apache.geode.cache.ExpirationAction */ public ExpirationAction getExpirationAction() { diff --git a/src/main/java/org/springframework/data/gemfire/expiration/ExpirationAttributesFactoryBean.java b/src/main/java/org/springframework/data/gemfire/expiration/ExpirationAttributesFactoryBean.java index 46e2a94b..1c03574f 100644 --- a/src/main/java/org/springframework/data/gemfire/expiration/ExpirationAttributesFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/expiration/ExpirationAttributesFactoryBean.java @@ -22,7 +22,7 @@ import org.springframework.beans.factory.FactoryBean; import org.springframework.beans.factory.InitializingBean; /** - * The ExpirationAttributesFactoryBean class is a Spring FactoryBean used to create GemFire ExpirationAttributes + * The ExpirationAttributesFactoryBean class is a Spring FactoryBean used to create Pivotal GemFire ExpirationAttributes * to specify Expiration policies for Region Time-to-Live (TTL) and Idle-Timeouts (TTI) as well as * Entry Time-to-Live (TTL) and Idle-Timeouts (TTI). * @@ -105,7 +105,7 @@ public class ExpirationAttributesFactoryBean implements FactoryBean parameterType : getFunctionAnnotatedMethod().getParameterTypes()) { if (parameterType.getName().equals(className)) { return true; @@ -125,5 +129,4 @@ class PdxFunctionArgumentResolver extends DefaultFunctionArgumentResolver { return false; } - } diff --git a/src/main/java/org/springframework/data/gemfire/function/PojoFunctionWrapper.java b/src/main/java/org/springframework/data/gemfire/function/PojoFunctionWrapper.java index a527cd71..f9bcc4a4 100644 --- a/src/main/java/org/springframework/data/gemfire/function/PojoFunctionWrapper.java +++ b/src/main/java/org/springframework/data/gemfire/function/PojoFunctionWrapper.java @@ -25,7 +25,7 @@ import org.springframework.util.ReflectionUtils; import org.springframework.util.StringUtils; /** - * Invokes a given {@link Object POJO} {@link Method} as a (remote) GemFire/Geode {@link Function}. + * Invokes a given {@link Object POJO} {@link Method} as a (remote) Pivotal GemFire/Apache Geode {@link Function}. * * If the {@link Object POJO} has a constructor that takes a {@link java.util.Map}, and the {@link Function} context * is a {@link Region}, the {@link Region} will be injected. diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/FunctionId.java b/src/main/java/org/springframework/data/gemfire/function/annotation/FunctionId.java index 19d19b84..4d4f9c51 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/FunctionId.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/FunctionId.java @@ -18,7 +18,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to bind an interface method to a GemFire function id + * Annotation to bind an interface method to a Pivotal GemFire function id * @author David Turanski * */ diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/GemfireFunction.java b/src/main/java/org/springframework/data/gemfire/function/annotation/GemfireFunction.java index 3b5b515e..a678678f 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/GemfireFunction.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/GemfireFunction.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,11 +18,9 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * - * Used to declare a concrete method as a GemFire function implementation - * - * @author David Turanski + * Used to declare a concrete method as a Pivotal GemFire function implementation * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) @@ -35,16 +33,16 @@ public @interface GemfireFunction { String id() default ""; /** - * Attribute to determine whether the GemFire Function is HA (Highly Available). + * Attribute to determine whether the Pivotal GemFire Function is HA (Highly Available). * - * @return a boolean value indicating whether the defined GemFire Function is HA. + * @return a boolean value indicating whether the defined Pivotal GemFire Function is HA. */ boolean HA() default false; /** - * Attribute to determine whether the GemFire Function is optimized for write operations. + * Attribute to determine whether the Pivotal GemFire Function is optimized for write operations. * - * @return a boolean value indicating if the GemFire Function is configured for optimized write operations. + * @return a boolean value indicating if the Pivotal GemFire Function is configured for optimized write operations. */ boolean optimizeForWrite() default false; @@ -59,7 +57,7 @@ public @interface GemfireFunction { * Normally follows the method return type, i.e., false if void, true otherwise. This allows overriding * a void method which uses the resultSender directly. * - * @return a boolean value indicating if the GemFire Function is expected to return a result. + * @return a boolean value indicating if the Pivotal GemFire Function is expected to return a result. */ boolean hasResult() default false; diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/OnMember.java b/src/main/java/org/springframework/data/gemfire/function/annotation/OnMember.java index 8deab09f..b4b04532 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/OnMember.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/OnMember.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,32 +18,31 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to declare an interface as a GemFire OnMember Function Execution - * - * @author David Turanski + * Annotation to declare an interface as a Pivotal GemFire OnMember Function Execution * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface OnMember { /** - * The bean name of the POJO interface defining the GemFire Function executions. - * - * @return the bean name (id) of the POJO interface defining the GemFire Function executions. + * The bean name of the POJO interface defining the Pivotal GemFire Function executions. + * + * @return the bean name (id) of the POJO interface defining the Pivotal GemFire Function executions. */ String id() default ""; /** - * The GemFire Group to which the members must belong to target the Function execution. - * - * @return the name of the GemFire Group to which the members must belong for the targeted the Function execution. + * The Pivotal GemFire Group to which the members must belong to target the Function execution. + * + * @return the name of the Pivotal GemFire Group to which the members must belong for the targeted the Function execution. */ String groups() default ""; /** * Optional ResultCollector bean reference. - * + * * @return an optional bean name of the ResultCollector to process the Function results. */ String resultCollector() default ""; diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/OnMembers.java b/src/main/java/org/springframework/data/gemfire/function/annotation/OnMembers.java index 7ab8e0d2..b3bfe22c 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/OnMembers.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/OnMembers.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,33 +18,33 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to declare an interface as a GemFire OnMembers Function Execution - * @author David Turanski + * Annotation to declare an interface as a Pivotal GemFire OnMembers Function Execution * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface OnMembers { /** - * The bean name of the POJO interface defining the GemFire Function executions. - * - * @return the bean name (id) of the POJO interface defining the GemFire Function executions. + * The bean name of the POJO interface defining the Pivotal GemFire Function executions. + * + * @return the bean name (id) of the POJO interface defining the Pivotal GemFire Function executions. */ String id() default ""; /** - * The GemFire Group to which the members must belong to target the Function execution. - * - * @return the name of the GemFire Group to which the members must belong for the targeted the Function execution. + * The Pivotal GemFire Group to which the members must belong to target the Function execution. + * + * @return the name of the Pivotal GemFire Group to which the members must belong for the targeted the Function execution. */ String groups() default ""; /** * Optional ResultCollector bean reference. - * + * * @return an optional bean name of the ResultCollector to process the Function results. */ String resultCollector() default ""; - + } diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/OnRegion.java b/src/main/java/org/springframework/data/gemfire/function/annotation/OnRegion.java index 93420998..898c2888 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/OnRegion.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/OnRegion.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,31 +18,31 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to declare an interface as a GemFire OnRegion Function Execution - * @author David Turanski + * Annotation to declare an interface as a Pivotal GemFire OnRegion Function Execution. * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface OnRegion { /** - * The bean name of the POJO interface defining the GemFire Function executions. - * - * @return the bean name (id) of the POJO interface defining the GemFire Function executions. + * The bean name of the POJO interface defining the Pivotal GemFire Function executions. + * + * @return the bean name (id) of the POJO interface defining the Pivotal GemFire Function executions. */ String id() default ""; /** - * A reference to the bean id of the GemFire Region. - * - * @return the bean name (id) of the GemFire Region. + * A reference to the bean id of the Pivotal GemFire Region. + * + * @return the bean name (id) of the Pivotal GemFire Region. */ String region(); /** * Optional ResultCollector bean reference. - * + * * @return an optional bean name of the ResultCollector to process the Function results. */ String resultCollector() default ""; diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/OnServer.java b/src/main/java/org/springframework/data/gemfire/function/annotation/OnServer.java index 1bbf0ab3..1a6530e5 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/OnServer.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/OnServer.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,40 +18,40 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to declare an interface as a GemFire OnServer Function Execution - * @author David Turanski + * Annotation to declare an interface as a Pivotal GemFire OnServer Function Execution. * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface OnServer { /** - * The bean name of the POJO interface defining the GemFire Function executions. - * - * @return the bean name (id) of the POJO interface defining the GemFire Function executions. + * The bean name of the POJO interface defining the Pivotal GemFire Function executions. + * + * @return the bean name (id) of the POJO interface defining the Pivotal GemFire Function executions. */ String id() default ""; /** * A reference to the cache. - * - * @return a bean name reference to the GemFire Cache. + * + * @return a bean name reference to the Pivotal GemFire Cache. */ String cache() default ""; /** * The pool bean name (optional). - * - * @return an optional bean name of the GemFire Pool. + * + * @return an optional bean name of the Pivotal GemFire Pool. */ String pool() default ""; /** * Optional ResultCollector bean reference. - * + * * @return an optional bean name of the ResultCollector to process the Function results. */ String resultCollector() default ""; - + } diff --git a/src/main/java/org/springframework/data/gemfire/function/annotation/OnServers.java b/src/main/java/org/springframework/data/gemfire/function/annotation/OnServers.java index d3104ba0..b61a314f 100644 --- a/src/main/java/org/springframework/data/gemfire/function/annotation/OnServers.java +++ b/src/main/java/org/springframework/data/gemfire/function/annotation/OnServers.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -18,38 +18,38 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to declare an interface as a GemFire OnServers Function Execution - * @author David Turanski + * Annotation to declare an interface as a Pivotal GemFire OnServers Function Execution. * + * @author David Turanski */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) public @interface OnServers { - + /** - * The bean name of the POJO interface defining the GemFire Function executions. - * - * @return the bean name (id) of the POJO interface defining the GemFire Function executions. + * The bean name of the POJO interface defining the Pivotal GemFire Function executions. + * + * @return the bean name (id) of the POJO interface defining the Pivotal GemFire Function executions. */ String id() default ""; /** * A reference to the cache. - * - * @return a bean name reference to the GemFire Cache. + * + * @return a bean name reference to the Pivotal GemFire Cache. */ String cache() default ""; /** * The pool bean name (optional). - * - * @return an optional bean name of the GemFire Pool. + * + * @return an optional bean name of the Pivotal GemFire Pool. */ String pool() default ""; /** * Optional ResultCollector bean reference. - * + * * @return an optional bean name of the ResultCollector to process the Function results. */ String resultCollector() default ""; diff --git a/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctionExecutions.java b/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctionExecutions.java index e071f25a..351c1a5d 100644 --- a/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctionExecutions.java +++ b/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctionExecutions.java @@ -1,11 +1,11 @@ /* * Copyright 2002-2013 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 - * + * * 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. @@ -23,9 +23,9 @@ import org.springframework.context.annotation.ComponentScan.Filter; import org.springframework.context.annotation.Import; /** - * Enables classpath scanning for interfaces annotated as GemFire function executions (function invocations). - * These include interfaces annotated with one of {code} @OnRegion, @OnServer, @OnServers, @OnMember, @OnMembers{code} - * + * Enables classpath scanning for interfaces annotated as Pivotal GemFire function executions (function invocations). + * These include interfaces annotated with one of {code} @OnRegion, @OnServer, @OnServers, @OnMember, @OnMembers{code} + * * @author David Turanski */ @Target(ElementType.TYPE) @@ -34,7 +34,7 @@ import org.springframework.context.annotation.Import; @Inherited @Import(FunctionExecutionBeanDefinitionRegistrar.class) public @interface EnableGemfireFunctionExecutions { - + /** * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation declarations e.g.: * {@code @EnableGemfireRepositories("org.my.pkg")} instead of diff --git a/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctions.java b/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctions.java index dd28d954..f0d1b8ac 100644 --- a/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctions.java +++ b/src/main/java/org/springframework/data/gemfire/function/config/EnableGemfireFunctions.java @@ -22,7 +22,7 @@ import java.lang.annotation.Target; import org.springframework.context.annotation.Import; /** - * Enables GemFire annotated Function implementations. + * Enables Pivotal GemFire annotated Function implementations. * * Causes the container to discover any beans that are annotated with {code}@GemfireFunction{code}, * wrap them in a {@link org.springframework.data.gemfire.function.PojoFunctionWrapper}, diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionExecution.java index 6601e550..9202fdef 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionExecution.java @@ -28,7 +28,7 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * Base class for * Creating a GemFire {@link Execution} using {@link FunctionService}. Protected setters support + * Base class for * Creating a Pivotal GemFire {@link Execution} using {@link FunctionService}. Protected setters support * method chaining. * * @author David Turanski diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionTemplate.java b/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionTemplate.java index b4d7c42e..f6a60f34 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionTemplate.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/AbstractFunctionTemplate.java @@ -18,7 +18,7 @@ import org.apache.geode.cache.execute.Function; import org.apache.geode.cache.execute.ResultCollector; /** - * The base class for GemFire FunctionTemplates used to invoke GemFire Functions. + * The base class for Pivotal GemFire FunctionTemplates used to invoke Pivotal GemFire Functions. * * @author David Turanski * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionOperations.java b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionOperations.java index 60c3f150..d069648d 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionOperations.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionOperations.java @@ -24,30 +24,30 @@ import org.apache.geode.cache.execute.Function; public interface GemfireFunctionOperations { /** - * Execute an unregistered GemFire Function with the given arguments. + * Execute an unregistered Pivotal GemFire Function with the given arguments. * * @param type parameter specifying the result type of the Function execution. - * @param function the GemFire Function object to execute. + * @param function the Pivotal GemFire Function object to execute. * @param args an array of Object arguments to the Function call. * @return the contents of the ResultsCollector. */ Iterable execute(Function function, Object... args); /** - * Execute a GemFire Function registered with the given ID. + * Execute a Pivotal GemFire Function registered with the given ID. * * @param type parameter specifying the result type of the Function execution. - * @param functionId the ID under which the GemFire function is registered. + * @param functionId the ID under which the Pivotal GemFire function is registered. * @param args an array of Object arguments to the Function call. * @return the results */ Iterable execute(String functionId, Object... args); /** - * Execute an unregistered GemFire Function with the expected singleton result. + * Execute an unregistered Pivotal GemFire Function with the expected singleton result. * @param type parameter specifying the result type of the Function execution. - * @param function the GemFire Function object. + * @param function the Pivotal GemFire Function object. * @param args an array of Object arguments to the Function call. * @return the first item in the ResultsCollector. * @see org.apache.geode.cache.execute.Function @@ -55,25 +55,25 @@ public interface GemfireFunctionOperations { T executeAndExtract(Function function, Object... args); /** - * Execute a GemFire Function registered with an ID and with an expected singleton result + * Execute a Pivotal GemFire Function registered with an ID and with an expected singleton result * @param type parameter specifying the result type of the Function execution. - * @param functionId the ID under which the GemFire function is registered. + * @param functionId the ID under which the Pivotal GemFire function is registered. * @param args an array of Object arguments to the Function call. * @return the first item in the results collector */ T executeAndExtract(String functionId, Object... args); /** - * Execute a GemFire Function registered with the given ID having no return value. + * Execute a Pivotal GemFire Function registered with the given ID having no return value. - * @param functionId the ID under which the GemFire function is registered. + * @param functionId the ID under which the Pivotal GemFire function is registered. * @param args an array of Object arguments to the Function call. */ void executeWithNoResult(String functionId, Object... args); /** - * Execute a GemFire Function using a native GemFire {@link org.apache.geode.cache.execute.Execution} instance. + * Execute a Pivotal GemFire Function using a native Pivotal GemFire {@link org.apache.geode.cache.execute.Execution} instance. * * @param type parameter specifying the result type of the Function execution. * @param callback a callback providing the execution instance. diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionProxyFactoryBean.java b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionProxyFactoryBean.java index d8d2fed0..e535ccdc 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionProxyFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireFunctionProxyFactoryBean.java @@ -53,7 +53,7 @@ public class GemfireFunctionProxyFactoryBean implements FactoryBean, Met /** * @param functionExecutionInterface the proxied interface - * @param gemfireFunctionOperations an interface used to delegate the function invocation (typically a GemFire function template) + * @param gemfireFunctionOperations an interface used to delegate the function invocation (typically a Pivotal GemFire function template) */ public GemfireFunctionProxyFactoryBean(Class functionExecutionInterface, GemfireFunctionOperations gemfireFunctionOperations) { Assert.notNull(functionExecutionInterface, "'functionExecutionInterface' must not be null"); @@ -76,7 +76,7 @@ public class GemfireFunctionProxyFactoryBean implements FactoryBean, Met @Override public Object invoke(MethodInvocation invocation) throws Throwable { if (AopUtils.isToStringMethod(invocation.getMethod())) { - return "GemFire Function Proxy for service interface [" + this.functionExecutionInterface + "]"; + return "Pivotal GemFire Function Proxy for service interface [" + this.functionExecutionInterface + "]"; } if (logger.isDebugEnabled()) { diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireOnRegionFunctionTemplate.java b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireOnRegionFunctionTemplate.java index e3263fb6..3a5f105f 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/GemfireOnRegionFunctionTemplate.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/GemfireOnRegionFunctionTemplate.java @@ -27,9 +27,9 @@ public class GemfireOnRegionFunctionTemplate extends AbstractFunctionTemplate im private Region region; /** - * Constructs an instance of the GemFireOnRegionFunctionTemplate with the given GemFire Cache Region. + * Constructs an instance of the GemFireOnRegionFunctionTemplate with the given Pivotal GemFire Cache Region. * - * @param region the GemFire Cache Region upon which the Function will be executed. + * @param region the Pivotal GemFire Cache Region upon which the Function will be executed. * @see org.apache.geode.cache.Region */ public GemfireOnRegionFunctionTemplate(Region region) { diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/GroupMemberFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/GroupMemberFunctionExecution.java index 7fef164b..cb4e58cd 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/GroupMemberFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/GroupMemberFunctionExecution.java @@ -31,7 +31,7 @@ class GroupMemberFunctionExecution extends AbstractFunctionExecution { * Constructs an instance of the GroupMemberFunctionExecution class to execute a data independent Function * on a single member from each of the specified groups. * - * @param groups the list of GemFire Groups from which to pick a member from each group on which to execute + * @param groups the list of Pivotal GemFire Groups from which to pick a member from each group on which to execute * the data independent Function. */ public GroupMemberFunctionExecution(final String... groups) { diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/GroupMembersFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/GroupMembersFunctionExecution.java index efc63e09..efdb705b 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/GroupMembersFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/GroupMembersFunctionExecution.java @@ -31,7 +31,7 @@ class GroupMembersFunctionExecution extends AbstractFunctionExecution { * Constructs an instance of the GroupMembersFunctionExecution class to execute a data independent Function * on all members from each of the specified groups. * - * @param groups the list of GemFire Groups indicating the members on which to execute the data independent Function. + * @param groups the list of Pivotal GemFire Groups indicating the members on which to execute the data independent Function. */ public GroupMembersFunctionExecution(final String... groups) { Assert.notEmpty(groups, "'groups' cannot be null or empty."); diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/PoolServersFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/PoolServersFunctionExecution.java index ac5b5415..e25133ae 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/PoolServersFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/PoolServersFunctionExecution.java @@ -18,7 +18,7 @@ import org.apache.geode.cache.execute.FunctionService; import org.springframework.util.Assert; /** - * Creates a GemFire {@link Execution} using {code}FunctionService.onServers(Pool pool){code} + * Creates a Pivotal GemFire {@link Execution} using {code}FunctionService.onServers(Pool pool){code} * @author David Turanski * */ diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/RegionFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/RegionFunctionExecution.java index 8aadc39e..125fda6c 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/RegionFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/RegionFunctionExecution.java @@ -20,7 +20,7 @@ import org.apache.geode.cache.execute.FunctionService; import org.springframework.util.CollectionUtils; /** - * Creates a GemFire {@link Execution} using {code}FunctionService.onRegion(Region region){code} + * Creates a Pivotal GemFire {@link Execution} using {code}FunctionService.onRegion(Region region){code} * @author David Turanski * */ diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/ServerFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/ServerFunctionExecution.java index e529c6f6..7d277477 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/ServerFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/ServerFunctionExecution.java @@ -18,7 +18,7 @@ import org.apache.geode.cache.execute.FunctionService; import org.springframework.util.Assert; /** - * Creates a GemFire {@link Execution} using {code}FunctionService.onServer(RegionService regionService){code} + * Creates a Pivotal GemFire {@link Execution} using {code}FunctionService.onServer(RegionService regionService){code} * @author David Turanski * */ diff --git a/src/main/java/org/springframework/data/gemfire/function/execution/ServersFunctionExecution.java b/src/main/java/org/springframework/data/gemfire/function/execution/ServersFunctionExecution.java index cf6104d3..a2d95ccc 100644 --- a/src/main/java/org/springframework/data/gemfire/function/execution/ServersFunctionExecution.java +++ b/src/main/java/org/springframework/data/gemfire/function/execution/ServersFunctionExecution.java @@ -18,7 +18,7 @@ import org.apache.geode.cache.execute.FunctionService; import org.springframework.util.Assert; /** - * Creates a GemFire {@link Execution} using {code}FunctionService.onServers(RegionService regionService){code} + * Creates a Pivotal GemFire {@link Execution} using {code}FunctionService.onServers(RegionService regionService){code} * @author David Turanski * */ diff --git a/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListener.java b/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListener.java index ce6b7845..1f7e3ad2 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListener.java +++ b/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListener.java @@ -19,7 +19,7 @@ package org.springframework.data.gemfire.listener; import org.apache.geode.cache.query.CqEvent; /** - * Continuous Query (CQ) listener listening for events and notifications by a GemFire Continuous Query (CQ). + * Continuous Query (CQ) listener listening for events and notifications by a Pivotal GemFire Continuous Query (CQ). * * @author Costin Leau * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListenerContainer.java b/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListenerContainer.java index 303f2be4..e930f41b 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListenerContainer.java +++ b/src/main/java/org/springframework/data/gemfire/listener/ContinuousQueryListenerContainer.java @@ -204,7 +204,7 @@ public class ContinuousQueryListenerContainer implements BeanFactoryAware, BeanN * * However, if the {@link BeanFactory} was not configured, or no bean exists in the Spring container * with the given {@link String name} or of the {@link Pool} type, then the named {@link Pool} is looked up - * in GemFire/Geode's {@link PoolManager}. + * in Pivotal GemFire/Apache Geode's {@link PoolManager}. * * @param poolName {@link String} containing the name of the {@link Pool} to initialize. * @return the given {@link Pool} name. @@ -405,9 +405,9 @@ public class ContinuousQueryListenerContainer implements BeanFactoryAware, BeanN } /** - * Set the underlying RegionService (GemFire Cache) used for registering Queries. + * Set the underlying RegionService (Pivotal GemFire Cache) used for registering Queries. * - * @param cache the RegionService (GemFire Cache) used for registering Queries. + * @param cache the RegionService (Pivotal GemFire Cache) used for registering Queries. * @see org.apache.geode.cache.RegionService */ public void setCache(RegionService cache) { @@ -549,9 +549,9 @@ public class ContinuousQueryListenerContainer implements BeanFactoryAware, BeanN } /** - * Set the GemFire QueryService used by this container to create ContinuousQueries (CQ). + * Set the Pivotal GemFire QueryService used by this container to create ContinuousQueries (CQ). * - * @param queryService the GemFire QueryService object used by the container to create ContinuousQueries (CQ). + * @param queryService the Pivotal GemFire QueryService object used by the container to create ContinuousQueries (CQ). * @see org.apache.geode.cache.query.QueryService */ public void setQueryService(QueryService queryService) { diff --git a/src/main/java/org/springframework/data/gemfire/listener/adapter/ContinuousQueryListenerAdapter.java b/src/main/java/org/springframework/data/gemfire/listener/adapter/ContinuousQueryListenerAdapter.java index 732c3471..03a1d1af 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/adapter/ContinuousQueryListenerAdapter.java +++ b/src/main/java/org/springframework/data/gemfire/listener/adapter/ContinuousQueryListenerAdapter.java @@ -40,11 +40,11 @@ import org.springframework.util.StringUtils; * Event listener adapter that delegates the handling of messages to target listener methods via reflection, * with flexible event type conversion. * - * Allows listener methods to operate on event content types, completely independent from the GemFire/Geode API. + * Allows listener methods to operate on event content types, completely independent from the Pivotal GemFire/Apache Geode API. * *

Modeled as much as possible after the JMS MessageListenerAdapter in the core Spring Framework. * - *

By default, the content of incoming GemFire/Geode CQ events gets extracted before being passed into + *

By default, the content of incoming Pivotal GemFire/Apache Geode CQ events gets extracted before being passed into * the target listener method, to let the target method operate on event content types such as Object or Operation * instead of the raw {@link CqEvent}.

* @@ -158,7 +158,7 @@ public class ContinuousQueryListenerAdapter implements ContinuousQueryListener { * handle the given event. *

The default implementation simply returns the configured * default listener method, if any. - * @param event the GemFire event + * @param event the Pivotal GemFire event * @return the name of the listener method (never null) * @see #setDefaultListenerMethod */ diff --git a/src/main/java/org/springframework/data/gemfire/listener/adapter/package-info.java b/src/main/java/org/springframework/data/gemfire/listener/adapter/package-info.java index 9fa292f2..e9225ee4 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/adapter/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/listener/adapter/package-info.java @@ -1,7 +1,7 @@ /** * Continuous query listener adapter package. - * The adapter delegates to target listener methods, converting GemFire events to the requested argument types - * that get passed into listener methods. + * The adapter delegates to target listener methods, converting Pivotal GemFire events to the requested argument types + * that get passed into listener methods. */ package org.springframework.data.gemfire.listener.adapter; diff --git a/src/main/java/org/springframework/data/gemfire/listener/annotation/ContinuousQuery.java b/src/main/java/org/springframework/data/gemfire/listener/annotation/ContinuousQuery.java index fb84ce08..7380e934 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/annotation/ContinuousQuery.java +++ b/src/main/java/org/springframework/data/gemfire/listener/annotation/ContinuousQuery.java @@ -24,7 +24,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * The {@link ContinuousQuery} annotation to define a GemFire/Geode Continuous Query (CQ) on a POJO method + * The {@link ContinuousQuery} annotation to define a Pivotal GemFire/Apache Geode Continuous Query (CQ) on a POJO method * which handles all CQ events and errors. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/listener/package-info.java b/src/main/java/org/springframework/data/gemfire/listener/package-info.java index 4806cdab..d4b1ab8b 100644 --- a/src/main/java/org/springframework/data/gemfire/listener/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/listener/package-info.java @@ -1,5 +1,5 @@ /** - * Base package for GemFire continuous query listener / container facility + * Base package for Pivotal GemFire continuous query listener / container facility */ package org.springframework.data.gemfire.listener; diff --git a/src/main/java/org/springframework/data/gemfire/mapping/GemfireMappingContext.java b/src/main/java/org/springframework/data/gemfire/mapping/GemfireMappingContext.java index 63e43ebf..3b567c3a 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/GemfireMappingContext.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/GemfireMappingContext.java @@ -25,7 +25,7 @@ import org.springframework.data.util.TypeInformation; /** * Spring Data {@link AbstractMappingContext} implementation defining entity mapping meta-data - * for GemFire persistent entities. + * for Pivotal GemFire persistent entities. * * @author Oliver Gierke * @author John Blum @@ -40,7 +40,7 @@ public class GemfireMappingContext extends AbstractMappingContext entity, GemfirePersistentProperty persistentProperty) { return !entity.isConstructorArgument(persistentProperty) @@ -532,7 +531,6 @@ public class MappingPdxSerializer implements PdxSerializer, ApplicationContextAw return false; } - /* (non-Javadoc) */ boolean isReadable(GemfirePersistentProperty persistentProperty) { return !persistentProperty.isTransient(); } diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/ClientRegion.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/ClientRegion.java index ea8f0fff..e96f3ec0 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/ClientRegion.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/ClientRegion.java @@ -98,9 +98,9 @@ public @interface ClientRegion { boolean ignoreIfExists() default true; /** - * Name of the GemFire/Geode {@link Pool} used by this persistent entity's {@link org.apache.geode.cache.Region} + * Name of the Pivotal GemFire/Apache Geode {@link Pool} used by this persistent entity's {@link org.apache.geode.cache.Region} * data access operations sent to the corresponding {@link org.apache.geode.cache.Region} - * on the GemFire/Geode Server. + * on the Pivotal GemFire/Apache Geode Server. * * Defaults to {@literal DEFAULT}. */ diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/Indexed.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/Indexed.java index 043c7b21..84d300ce 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/Indexed.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/Indexed.java @@ -32,7 +32,7 @@ import org.springframework.data.gemfire.mapping.GemfirePersistentProperty; /** * The {@link Indexed} annotation is used to index a {@link GemfirePersistentEntity} {@link GemfirePersistentProperty}, - * which creates a GemFire/Geode {@link Index} on a GemFire/Geode {@link org.apache.geode.cache.Region}. + * which creates a Pivotal GemFire/Apache Geode {@link Index} on a Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.Region}. * * @author John Blum * @see org.springframework.core.annotation.AliasFor @@ -66,7 +66,7 @@ public @interface Indexed { String expression() default ""; /** - * The GemFire/Geode {@link org.apache.geode.cache.Region} on which the Index is created. + * The Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.Region} on which the Index is created. */ String from() default ""; diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/LocalRegion.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/LocalRegion.java index 6fcd183e..59531754 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/LocalRegion.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/LocalRegion.java @@ -109,7 +109,7 @@ public @interface LocalRegion { * with this persistent entity overflows data to disk during eviction due to entry/heap/memory constraints. * * A {@link org.apache.geode.cache.Region} can also be persistent without an explicit - * {@link org.apache.geode.cache.DiskStore} defined; in that case, GemFire/Geode writes to the "DEFAULT" + * {@link org.apache.geode.cache.DiskStore} defined; in that case, Pivotal GemFire/Apache Geode writes to the "DEFAULT" * {@link org.apache.geode.cache.DiskStore}. * * Defaults to {@literal false}. diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/LuceneIndexed.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/LuceneIndexed.java index 15320ab5..a8a7ef7a 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/LuceneIndexed.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/LuceneIndexed.java @@ -31,8 +31,8 @@ import org.springframework.data.gemfire.mapping.GemfirePersistentProperty; /** * The {@link LuceneIndexed} annotation is used to index a {@link GemfirePersistentEntity} - * {@link GemfirePersistentProperty}, creating a GemFire/Geode {@link LuceneIndex} - * on a GemFire/Geode {@link org.apache.geode.cache.Region}. + * {@link GemfirePersistentProperty}, creating a Pivotal GemFire/Apache Geode {@link LuceneIndex} + * on a Pivotal GemFire/Apache Geode {@link org.apache.geode.cache.Region}. * * @author John Blum * @see org.springframework.core.annotation.AliasFor diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/PartitionRegion.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/PartitionRegion.java index b5647666..d745c335 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/PartitionRegion.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/PartitionRegion.java @@ -130,7 +130,7 @@ public @interface PartitionRegion { * * This setting may also be the name of a Spring bean defined in the Spring context. * - * Defaults to unset, thus using the default GemFire/Geode partitioning strategy. + * Defaults to unset, thus using the default Pivotal GemFire/Apache Geode partitioning strategy. */ String partitionResolverName() default ""; @@ -142,7 +142,7 @@ public @interface PartitionRegion { * with this persistent entity overflows data to disk during eviction due to entry/heap/memory constraints. * * A {@link org.apache.geode.cache.Region} can also be persistent without an explicit - * {@link org.apache.geode.cache.DiskStore} defined; in that case, GemFire/Geode writes to the "DEFAULT" + * {@link org.apache.geode.cache.DiskStore} defined; in that case, Pivotal GemFire/Apache Geode writes to the "DEFAULT" * {@link org.apache.geode.cache.DiskStore}. * * Defaults to {@literal false}. diff --git a/src/main/java/org/springframework/data/gemfire/mapping/annotation/ReplicateRegion.java b/src/main/java/org/springframework/data/gemfire/mapping/annotation/ReplicateRegion.java index 9ab4108e..ef9b399a 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/annotation/ReplicateRegion.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/annotation/ReplicateRegion.java @@ -110,7 +110,7 @@ public @interface ReplicateRegion { * with this persistent entity overflows data to disk during eviction due to entry/heap/memory constraints. * * A {@link org.apache.geode.cache.Region} can also be persistent without an explicit - * {@link org.apache.geode.cache.DiskStore} defined; in that case, GemFire/Geode writes to the "DEFAULT" + * {@link org.apache.geode.cache.DiskStore} defined; in that case, Pivotal GemFire/Apache Geode writes to the "DEFAULT" * {@link org.apache.geode.cache.DiskStore}. * * Defaults to {@literal false}. diff --git a/src/main/java/org/springframework/data/gemfire/mapping/model/GemfireSimpleTypeHolder.java b/src/main/java/org/springframework/data/gemfire/mapping/model/GemfireSimpleTypeHolder.java index 2f149f93..34593c8f 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/model/GemfireSimpleTypeHolder.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/model/GemfireSimpleTypeHolder.java @@ -83,7 +83,7 @@ public class GemfireSimpleTypeHolder extends SimpleTypeHolder { /** * Constructs an instance of GemfireSimpleTypeHolder initialized with additional, custom simple types - * handled by GemFire along with register the default simple types. + * handled by Pivotal GemFire along with register the default simple types. * * @see org.springframework.data.mapping.model.SimpleTypeHolder#SimpleTypeHolder(Set, boolean) */ @@ -94,7 +94,7 @@ public class GemfireSimpleTypeHolder extends SimpleTypeHolder { /** * Constructs an instance of the GemfireSimpleTypeHolder initialized with a source {@link SimpleTypeHolder}. * - * @param source the SimpleTypeHolder used as the source for GemFire's {@link SimpleTypeHolder} implementation. + * @param source the SimpleTypeHolder used as the source for Pivotal GemFire's {@link SimpleTypeHolder} implementation. * source must not be {@literal null}. * @throws NullPointerException if source is null. */ diff --git a/src/main/java/org/springframework/data/gemfire/package-info.java b/src/main/java/org/springframework/data/gemfire/package-info.java index c101cb37..565cd754 100644 --- a/src/main/java/org/springframework/data/gemfire/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/package-info.java @@ -1,12 +1,11 @@ - /** * Package providing integration of - * GemFire + * Pivotal GemFire * with Spring concepts. - * + * * Contains helper classes, a template plus callback for GemFire * access and an implementation of Spring's transaction SPI for local - * GemFire transactions. + * Pivotal GemFire transactions. */ package org.springframework.data.gemfire; diff --git a/src/main/java/org/springframework/data/gemfire/repository/GemfireRepository.java b/src/main/java/org/springframework/data/gemfire/repository/GemfireRepository.java index f72c9e7c..6fab2378 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/GemfireRepository.java +++ b/src/main/java/org/springframework/data/gemfire/repository/GemfireRepository.java @@ -20,7 +20,7 @@ import org.springframework.data.domain.Sort; import org.springframework.data.repository.CrudRepository; /** - * GemFire specific extension of the Spring Data {@link CrudRepository} interface. + * Pivotal GemFire specific extension of the Spring Data {@link CrudRepository} interface. * * @author Oliver Gierke * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryBean.java b/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryBean.java index bd0d5a51..2e6e5a39 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryBean.java @@ -35,7 +35,7 @@ import org.springframework.data.repository.cdi.CdiRepositoryBean; import org.springframework.data.repository.config.CustomRepositoryImplementationDetector; /** - * A CDI-based bean that represents a GemFire Repository. + * A CDI-based bean that represents a Pivotal GemFire Repository. * * @author John Blum * @param class type of the Repository. diff --git a/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryExtension.java b/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryExtension.java index 1ce13308..6dc09911 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryExtension.java +++ b/src/main/java/org/springframework/data/gemfire/repository/cdi/GemfireRepositoryExtension.java @@ -55,13 +55,12 @@ public class GemfireRepositoryExtension extends CdiRepositoryExtensionSupport { final Set> regionBeans = new HashSet>(); - /* (non-Javadoc) */ public GemfireRepositoryExtension() { - logger.info("Activating CDI extension for Spring Data GemFire Repositories"); + logger.info("Activating CDI extension for SDG Repositories"); } /** - * Implementation of an observer that captures GemFire Region beans defined in the CDI container, storing them + * Implementation of an observer that captures Pivotal GemFire Region beans defined in the CDI container, storing them * along with any defined GemfireMappingContexts for later construction of the Repository beans. * * @param class type of the bean instance. @@ -119,14 +118,13 @@ public class GemfireRepositoryExtension extends CdiRepositoryExtensionSupport { } } - /* (non-Javadoc) */ CdiRepositoryBean createRepositoryBean(BeanManager beanManager, Class repositoryType, Set qualifiers) { // Determine the GemfireMappingContext bean that matches the qualifiers of the Repository. Bean gemfireMappingContextBean = mappingContexts.get(qualifiers); - // Construct and return a GemFire Repository bean. + // Construct and return a Pivotal GemFire Repository bean. return new GemfireRepositoryBean(beanManager, repositoryType, qualifiers, getCustomImplementationDetector(), gemfireMappingContextBean, regionBeans); } diff --git a/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java b/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java index da259906..53a6e7bd 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java +++ b/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java @@ -49,7 +49,7 @@ public @interface EnableGemfireRepositories { * {@code @EnableGemfireRepositories("org.my.pkg")} instead of * {@code @EnableGemfireRepositories(basePackages="org.my.pkg")}. * - * @return a String array specifying the packages to search for GemFire Repositories. + * @return a String array specifying the packages to search for Pivotal GemFire Repositories. * @see #basePackages() */ String[] value() default {}; @@ -58,7 +58,7 @@ public @interface EnableGemfireRepositories { * Base packages to scan for annotated components. {@link #value()} is an alias for (and mutually exclusive with) this * attribute. Use {@link #basePackageClasses()} for a type-safe alternative to String-based package names. * - * @return a String array specifying the packages to search for GemFire Repositories. + * @return a String array specifying the packages to search for Pivotal GemFire Repositories. * @see #value() */ String[] basePackages() default {}; @@ -68,7 +68,7 @@ public @interface EnableGemfireRepositories { * package of each class specified will be scanned. Consider creating a special no-op marker class or interface in * each package that serves no purpose other than being referenced by this attribute. * - * @return an array of classes used to determine the packages to scan for GemFire Repositories. + * @return an array of classes used to determine the packages to scan for Pivotal GemFire Repositories. */ Class[] basePackageClasses() default {}; diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java index a069c1e5..18b8d6da 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java @@ -20,7 +20,7 @@ import org.apache.geode.cache.Region; import org.springframework.data.repository.core.EntityInformation; /** - * {@link EntityInformation} capturing GemFire specific information. + * {@link EntityInformation} capturing Pivotal GemFire specific information. * * @author Oliver Gierke * @see org.springframework.data.repository.core.EntityInformation diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryCreator.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryCreator.java index c692483b..ebfa6820 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryCreator.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryCreator.java @@ -115,7 +115,7 @@ class GemfireQueryCreator extends AbstractQueryCreator /** * {@link IndexProvider} is an {@link Iterator} providing sequentially numbered placeholders (starting at 1), - * in a generated GemFire OQL statement corresponding to all possible arguments passed to + * in a generated Pivotal GemFire OQL statement corresponding to all possible arguments passed to * the query's indexed parameters. * * @see java.util.Iterator diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java index 62ace7f4..e6b329ca 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java @@ -35,7 +35,7 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * GemFire specific {@link QueryMethod}. + * Pivotal GemFire specific {@link QueryMethod}. * * @author Oliver Gierke * @author John Blum @@ -71,7 +71,7 @@ public class GemfireQueryMethod extends QueryMethod { } /** - * Asserts that the query method is a non-Paging query method since GemFire does not support pagination + * Asserts that the query method is a non-Paging query method since Pivotal GemFire does not support pagination * as it has no concept of a Cursor. * * @param method the query method to be evaluated @@ -83,7 +83,7 @@ public class GemfireQueryMethod extends QueryMethod { for (Class type : method.getParameterTypes()) { if (Pageable.class.isAssignableFrom(type)) { - throw new IllegalStateException(String.format("Pagination is not supported by GemFire Repositories;" + throw new IllegalStateException(String.format("Pagination is not supported by Pivotal GemFire Repositories;" + " Offending method: %1$s", method.getName())); } } @@ -126,7 +126,7 @@ public class GemfireQueryMethod extends QueryMethod { } /** - * Determines whether this query method uses a query HINT to tell the GemFire OQL query engine which indexes + * Determines whether this query method uses a query HINT to tell the Pivotal GemFire OQL query engine which indexes * to apply to the query execution. * * @return a boolean value to indicate whether this query method uses a query HINT. diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireRepositoryQuery.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireRepositoryQuery.java index 7ed6db25..8d9cb1d0 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireRepositoryQuery.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireRepositoryQuery.java @@ -21,7 +21,7 @@ import org.springframework.data.repository.query.RepositoryQuery; import org.springframework.util.Assert; /** - * Base class for GemFire specific {@link RepositoryQuery} implementations. + * Base class for Pivotal GemFire specific {@link RepositoryQuery} implementations. *

* @author Oliver Gierke * @author David Turanski diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/Predicates.java b/src/main/java/org/springframework/data/gemfire/repository/query/Predicates.java index 349bd7ec..dadaadf5 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/Predicates.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/Predicates.java @@ -114,7 +114,7 @@ class Predicates implements Predicate { } /** - * Builds a conditional expression for the entity property in the WHERE clause of the GemFire OQL + * Builds a conditional expression for the entity property in the WHERE clause of the Pivotal GemFire OQL * query statement. * * @see org.springframework.data.gemfire.repository.query.Predicate#toString(java.lang.String) @@ -162,10 +162,10 @@ class Predicates implements Predicate { } /** - * Resolves the given {@link Type} as an GemFire OQL operator. + * Resolves the given {@link Type} as an Pivotal GemFire OQL operator. * * @param partType the conditional expression (e.g. 'IN') in the query method name. - * @return a GemFire OQL operator. + * @return a Pivotal GemFire OQL operator. */ String resolveOperator(Type partType) { switch (partType) { diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/QueryString.java b/src/main/java/org/springframework/data/gemfire/repository/query/QueryString.java index 08c88737..a28bba9b 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/QueryString.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/QueryString.java @@ -32,7 +32,7 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** - * {@link QueryString} is a utility class used to construct GemFire OQL query statements. + * {@link QueryString} is a utility class used to construct Pivotal GemFire OQL query statements. * * @author Oliver Gierke * @author David Turanski @@ -246,7 +246,7 @@ public class QueryString { } /** - * Appends the {@link Sort} order to this GemFire OQL Query string. + * Appends the {@link Sort} order to this Pivotal GemFire OQL Query string. * * @param sort {@link Sort} indicating the order of the query results. * @return a new {@link QueryString} with an ORDER BY clause if {@link Sort} is not {@literal null}, diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/StringBasedGemfireRepositoryQuery.java b/src/main/java/org/springframework/data/gemfire/repository/query/StringBasedGemfireRepositoryQuery.java index f417198a..724b944d 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/StringBasedGemfireRepositoryQuery.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/StringBasedGemfireRepositoryQuery.java @@ -215,7 +215,7 @@ public class StringBasedGemfireRepositoryQuery extends GemfireRepositoryQuery { * Returns the given object as a Collection. Collections will be returned as is, Arrays will be converted into a * Collection and all other objects will be wrapped into a single-element Collection. * - * @param source the resulting object from the GemFire Query. + * @param source the resulting object from the Pivotal GemFire Query. * @return the querying resulting object as a Collection. * @see java.util.Arrays#asList(Object[]) * @see java.util.Collection diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Hint.java b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Hint.java index 6ff1faff..1970ef86 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Hint.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Hint.java @@ -24,7 +24,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * The Hint class is a annotation type indicating a GemFire OQL Query Hint. + * The Hint class is a annotation type indicating a Pivotal GemFire OQL Query Hint. * * @author John Blum * @see java.lang.annotation.Documented diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Import.java b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Import.java index 53c7069d..cc96f8f3 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Import.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Import.java @@ -24,7 +24,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * The Import class is a annotation type indicating a GemFire OQL Query Import to refer to the class of an object + * The Import class is a annotation type indicating a Pivotal GemFire OQL Query Import to refer to the class of an object * in cases where the same class name resides in two different name scopes (packages), then you must be able to * differentiate the classes having the same name. * diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Limit.java b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Limit.java index abcd4ac3..5acc51ce 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Limit.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Limit.java @@ -24,7 +24,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * The Limit class is an annotation type indicating a GemFire OQL Query Limit on the number of results + * The Limit class is an annotation type indicating a Pivotal GemFire OQL Query Limit on the number of results * that are returned. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Trace.java b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Trace.java index c304791f..6d7c423e 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Trace.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/annotation/Trace.java @@ -24,7 +24,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * The Trace class is an annotation type to enable GemFire OQL Query debugging. + * The Trace class is an annotation type to enable Pivotal GemFire OQL Query debugging. * * @author John Blum * @see java.lang.annotation.Documented diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/support/OqlKeyword.java b/src/main/java/org/springframework/data/gemfire/repository/query/support/OqlKeyword.java index 1661bb90..ae67fa74 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/support/OqlKeyword.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/support/OqlKeyword.java @@ -21,7 +21,7 @@ import org.springframework.util.StringUtils; /** * The OqlKeyword enum represents the range of keywords (Reserved Words) - * in GemFire's Object Query Language (OQL). + * in Pivotal GemFire's Object Query Language (OQL). * * @author John Blum * @see Supported Keywords @@ -56,7 +56,7 @@ public enum OqlKeyword { private final String keyword; /** - * Constructs an instance of the GemFire {@link OqlKeyword} enumerate value with an unspecified keyword. + * Constructs an instance of the Pivotal GemFire {@link OqlKeyword} enumerate value with an unspecified keyword. * When the keyword is unspecified, it defaults to the {@link #name()} of the {@link OqlKeyword}. * * @see #OqlKeyword(String) @@ -66,9 +66,9 @@ public enum OqlKeyword { } /** - * Constructs an {@link OqlKeyword} enumerated value with the given GemFire OQL Keyword. + * Constructs an {@link OqlKeyword} enumerated value with the given Pivotal GemFire OQL Keyword. * - * @param keyword {@link String} specifying the GemFire OQL Keyword; + * @param keyword {@link String} specifying the Pivotal GemFire OQL Keyword; * can be {@literal null}. */ OqlKeyword(String keyword) { @@ -78,9 +78,9 @@ public enum OqlKeyword { /** * Looks up an {@link OqlKeyword} for the given {@code keyword} {@link String}. * - * @param keyword name of the GemFire OQL Keyword to lookup. + * @param keyword name of the Pivotal GemFire OQL Keyword to lookup. * @return an {@link OqlKeyword} enumerated value for the given {@code keyword} {@link String}. - * @throws IllegalArgumentException if {@code keyword} is not a valid GemFire OQL Keyword. + * @throws IllegalArgumentException if {@code keyword} is not a valid Pivotal GemFire OQL Keyword. */ public static OqlKeyword valueOfIgnoreCase(String keyword) { for (OqlKeyword oqlKeyword : values()) { @@ -89,15 +89,15 @@ public enum OqlKeyword { } } - throw new IllegalArgumentException(String.format("[%s] is not a valid GemFire OQL Keyword", keyword)); + throw new IllegalArgumentException(String.format("[%s] is not a valid OQL Keyword", keyword)); } /** - * Returns name of this GemFire OQL Keyword enumerated value. The keyword may have been + * Returns name of this Pivotal GemFire OQL Keyword enumerated value. The keyword may have been * explicitly defined when the {@link OqlKeyword} enumerated value was constructed, in which case * this value is returned, otherwise this method returns {@link OqlKeyword#name()}. * - * @return a {@link String} name for this GemFire OQL Keyword enumerated value. + * @return a {@link String} name for this Pivotal GemFire OQL Keyword enumerated value. * @see #name() */ public String getKeyword() { diff --git a/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactory.java b/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactory.java index 6acce206..c25912d7 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactory.java +++ b/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactory.java @@ -98,10 +98,10 @@ public class GemfireRepositoryFactory extends RepositoryFactorySupport { } /** - * Returns a reference to the GemFire {@link MappingContext} used to provide mapping meta-data + * Returns a reference to the Pivotal GemFire {@link MappingContext} used to provide mapping meta-data * between {@link Class entity types} and the data store. * - * @return a reference to the GemFire {@link MappingContext}. + * @return a reference to the Pivotal GemFire {@link MappingContext}. * @see org.springframework.data.gemfire.mapping.GemfireMappingContext * @see org.springframework.data.mapping.context.MappingContext */ diff --git a/src/main/java/org/springframework/data/gemfire/search/lucene/LuceneServiceFactoryBean.java b/src/main/java/org/springframework/data/gemfire/search/lucene/LuceneServiceFactoryBean.java index 9c433b52..2c6c110f 100644 --- a/src/main/java/org/springframework/data/gemfire/search/lucene/LuceneServiceFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/search/lucene/LuceneServiceFactoryBean.java @@ -64,7 +64,7 @@ public class LuceneServiceFactoryBean extends AbstractFactoryBeanSupport implements FactoryBean snapshotServiceAdapter; - /* (non-Javadoc) */ @SuppressWarnings("unchecked") static SnapshotMetadata[] nullSafeArray(SnapshotMetadata[] configurations) { return (configurations != null ? configurations : EMPTY_ARRAY); } - /* (non-Javadoc) */ static boolean nullSafeIsDirectory(File file) { return (file != null && file.isDirectory()); } - /* (non-Javadoc) */ static boolean nullSafeIsFile(File file) { return (file != null && file.isFile()); } /** - * Sets a reference to the GemFire Cache for which the snapshot will be taken. + * Constructs and initializes the Pivotal GemFire Snapshot Service used to take a snapshot of the configured Cache + * or Region if initialized. In addition, this initialization method will perform the actual import. * - * @param cache the GemFire Cache used to create an instance of CacheSnapshotService. + * @throws Exception if the construction and initialization of the Pivotal GemFire Snapshot Service fails. + * @see org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean.SnapshotServiceAdapter + * @see #getSuppressImportOnInit() + * @see #getImports() + * @see #create() + */ + @Override + @SuppressWarnings("unchecked") + public void afterPropertiesSet() throws Exception { + + this.snapshotServiceAdapter = create(); + + if (!getSuppressImportOnInit()) { + this.snapshotServiceAdapter.doImport(getImports()); + } + } + + /** + * Constructs an appropriate instance of the SnapshotServiceAdapter based on the FactoryBean configuration. If + * a Region has not been specified, then a Pivotal GemFire Snapshot Service for the Cache is constructed, otherwise + * the Pivotal GemFire Snapshot Service for the configured Region is used. + * + * @return a SnapshotServiceAdapter wrapping the appropriate Pivotal GemFire Snapshot Service (either Cache or Region) + * depending on the FactoryBean configuration. + * @see #wrap(CacheSnapshotService) + * @see #wrap(RegionSnapshotService) + * @see #getRegion() + */ + protected SnapshotServiceAdapter create() { + + return Optional.ofNullable(getRegion()) + .map(region -> wrap(region.getSnapshotService())) + .orElseGet(() -> wrap(getCache().getSnapshotService())); + } + + /** + * Wraps the Pivotal GemFire CacheSnapshotService into an appropriate Adapter to uniformly access snapshot operations + * on the Cache and Regions alike. + * + * @param cacheSnapshotService the Pivotal GemFire CacheSnapshotService to wrap. + * @return a SnapshotServiceAdapter wrapping the Pivotal GemFire CacheSnapshotService. + * @see SnapshotServiceFactoryBean.SnapshotServiceAdapter + * @see SnapshotServiceFactoryBean.CacheSnapshotServiceAdapter + * @see org.apache.geode.cache.snapshot.CacheSnapshotService + */ + protected SnapshotServiceAdapter wrap(CacheSnapshotService cacheSnapshotService) { + return new CacheSnapshotServiceAdapter(cacheSnapshotService); + } + + /** + * Wraps Pivotal GemFire's RegionSnapshotService into an appropriate Adapter to uniformly access snapshot operations + * on the Cache and Regions alike. + * + * @param regionSnapshotService the Pivotal GemFire RegionSnapshotService to wrap. + * @return a SnapshotServiceAdapter wrapping the Pivotal GemFire RegionSnapshotService. + * @see SnapshotServiceFactoryBean.SnapshotServiceAdapter + * @see SnapshotServiceFactoryBean.RegionSnapshotServiceAdapter + * @see org.apache.geode.cache.snapshot.RegionSnapshotService + */ + protected SnapshotServiceAdapter wrap(RegionSnapshotService regionSnapshotService) { + return new RegionSnapshotServiceAdapter<>(regionSnapshotService); + } + + /** + * Performs an export of the GemFire Cache or Region if configured. + ======= + * Performs an export of the Pivotal GemFire Cache or Region if configured. + >>>>>>> 12126a1... SGF-732 - Change branding from Spring Data GemFire to Spring Data for Pivotal GemFire. + * + * @throws Exception if the Cache/Region data export operation fails. + * @see org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean.SnapshotServiceAdapter + * @see #getExports() + * @see #getObject() + */ + @Override + public void destroy() throws Exception { + getObject().doExport(getExports()); + } + + /** + * Sets a reference to the Pivotal GemFire Cache for which the snapshot will be taken. + * + * @param cache the Pivotal GemFire Cache used to create an instance of CacheSnapshotService. * @throws IllegalArgumentException if the Cache reference is null. * @see org.apache.geode.cache.Cache * @see #getCache() */ public void setCache(Cache cache) { - Assert.notNull(cache, "The GemFire Cache must not be null"); - this.cache = cache; + this.cache = Optional.ofNullable(cache) + .orElseThrow(() -> newIllegalArgumentException("Cache must not be null")); } /** - * Gets a reference to the GemFire Cache for which the snapshot will be taken. + * Gets a reference to the Pivotal GemFire Cache for which the snapshot will be taken. * - * @return the GemFire Cache used to create an instance of CacheSnapshotService. + * @return the Pivotal GemFire Cache used to create an instance of CacheSnapshotService. * @throws IllegalStateException if the Cache argument is null. * @see org.apache.geode.cache.Cache * @see #setCache(Cache) */ protected Cache getCache() { - Assert.state(cache != null, "The GemFire Cache was not properly initialized"); - return cache; + return Optional.ofNullable(this.cache) + .orElseThrow(() -> newIllegalStateException("The cache was not properly initialized")); } /** @@ -169,9 +252,9 @@ public class SnapshotServiceFactoryBean implements FactoryBean implements FactoryBean implements FactoryBean implements FactoryBean implements FactoryBean region = getRegion(); - return (region != null ? wrap(region.getSnapshotService()) : wrap(getCache().getSnapshotService())); - } - - /** - * Wraps the GemFire CacheSnapshotService into an appropriate Adapter to uniformly access snapshot operations - * on the Cache and Regions alike. - * - * @param cacheSnapshotService the GemFire CacheSnapshotService to wrap. - * @return a SnapshotServiceAdapter wrapping the GemFire CacheSnapshotService. - * @see SnapshotServiceFactoryBean.SnapshotServiceAdapter - * @see SnapshotServiceFactoryBean.CacheSnapshotServiceAdapter - * @see org.apache.geode.cache.snapshot.CacheSnapshotService - */ - protected SnapshotServiceAdapter wrap(CacheSnapshotService cacheSnapshotService) { - return new CacheSnapshotServiceAdapter(cacheSnapshotService); - } - - /** - * Wraps GemFire's RegionSnapshotService into an appropriate Adapter to uniformly access snapshot operations - * on the Cache and Regions alike. - * - * @param regionSnapshotService the GemFire RegionSnapshotService to wrap. - * @return a SnapshotServiceAdapter wrapping the GemFire RegionSnapshotService. - * @see SnapshotServiceFactoryBean.SnapshotServiceAdapter - * @see SnapshotServiceFactoryBean.RegionSnapshotServiceAdapter - * @see org.apache.geode.cache.snapshot.RegionSnapshotService - */ - protected SnapshotServiceAdapter wrap(RegionSnapshotService regionSnapshotService) { - return new RegionSnapshotServiceAdapter(regionSnapshotService); - } - - /** - * Performs an export of the GemFire Cache or Region if configured. - * - * @throws Exception if the Cache/Region data export operation fails. - * @see org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean.SnapshotServiceAdapter - * @see #getExports() - * @see #getObject() - */ - @Override - public void destroy() throws Exception { - getObject().doExport(getExports()); - } - - /** - * Listens for SnapshotApplicationEvents triggering a GemFire Cache-wide or Region data snapshot import/export - * when details of the event match the criteria of this factory's constructed GemFire SnapshotService. - * - * @param event the SnapshotApplicationEvent triggering a GemFire Cache or Region data import/export. + * @param event the SnapshotApplicationEvent triggering a Pivotal GemFire Cache or Region data import/export. * @see org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean.SnapshotServiceAdapter * @see org.springframework.data.gemfire.snapshot.event.ExportSnapshotApplicationEvent * @see org.springframework.data.gemfire.snapshot.event.ImportSnapshotApplicationEvent @@ -354,11 +360,11 @@ public class SnapshotServiceFactoryBean implements FactoryBean implements FactoryBean implements FactoryBean the class type of the Region key. @@ -545,7 +551,7 @@ public class SnapshotServiceFactoryBean implements FactoryBean implements FactoryBean implements FactoryBean the class type of the Region key. @@ -795,5 +801,4 @@ public class SnapshotServiceFactoryBean implements FactoryBean extends ApplicationEvent { } /** - * Gets the absolute pathname of the Region in GemFire for which the snapshot will be taken. + * Gets the absolute pathname of the Region in Pivotal GemFire for which the snapshot will be taken. * * @return a String indicating the absolute pathname of the Region. * @see org.apache.geode.cache.Region#getFullPath() @@ -76,7 +76,7 @@ public abstract class SnapshotApplicationEvent extends ApplicationEvent { } /** - * Gets the meta-data used to perform the GemFire Cache Region data snapshots. + * Gets the meta-data used to perform the Pivotal GemFire Cache Region data snapshots. * * @return an array of SnapshotMetadata containing information necessary to perform the data export. * @see org.springframework.data.gemfire.snapshot.SnapshotServiceFactoryBean.SnapshotMetadata diff --git a/src/main/java/org/springframework/data/gemfire/snapshot/filter/ComposableSnapshotFilter.java b/src/main/java/org/springframework/data/gemfire/snapshot/filter/ComposableSnapshotFilter.java index 0819beab..8906e2ba 100644 --- a/src/main/java/org/springframework/data/gemfire/snapshot/filter/ComposableSnapshotFilter.java +++ b/src/main/java/org/springframework/data/gemfire/snapshot/filter/ComposableSnapshotFilter.java @@ -21,7 +21,7 @@ import java.util.Map; import org.apache.geode.cache.snapshot.SnapshotFilter; /** - * The ComposableSnapshotFilter class is a GemFire SnapshotFilter implementation of the Composition design pattern + * The ComposableSnapshotFilter class is a Pivotal GemFire SnapshotFilter implementation of the Composition design pattern * allowing 2 or more SnapshotFilters to be combined by logical AND and OR operators acting as a single SnapshotFilter. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/support/AbstractFactoryBeanSupport.java b/src/main/java/org/springframework/data/gemfire/support/AbstractFactoryBeanSupport.java index e780481b..fecda0fa 100644 --- a/src/main/java/org/springframework/data/gemfire/support/AbstractFactoryBeanSupport.java +++ b/src/main/java/org/springframework/data/gemfire/support/AbstractFactoryBeanSupport.java @@ -66,7 +66,7 @@ public abstract class AbstractFactoryBeanSupport } /** - * Constructs a new instance of {@link Log} to log statements printed by Spring Data GemFire/Geode. + * Constructs a new instance of {@link Log} to log statements printed by SDG. * * @return a new instance of {@link Log}. * @see org.apache.commons.logging.LogFactory#getLog(Class) diff --git a/src/main/java/org/springframework/data/gemfire/support/ConnectionEndpoint.java b/src/main/java/org/springframework/data/gemfire/support/ConnectionEndpoint.java index a9ddf202..1b83450a 100644 --- a/src/main/java/org/springframework/data/gemfire/support/ConnectionEndpoint.java +++ b/src/main/java/org/springframework/data/gemfire/support/ConnectionEndpoint.java @@ -24,7 +24,7 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** - * The ConnectionEndpoint class models a GemFire connection endpoint in the format of hostname[portnumber], + * The ConnectionEndpoint class models a Pivotal GemFire connection endpoint in the format of hostname[portnumber], * where hostname is the network name or IP address of the host. * * @author John Blum diff --git a/src/main/java/org/springframework/data/gemfire/support/DeclarableSupport.java b/src/main/java/org/springframework/data/gemfire/support/DeclarableSupport.java index 2829c1a8..73aaf6ac 100644 --- a/src/main/java/org/springframework/data/gemfire/support/DeclarableSupport.java +++ b/src/main/java/org/springframework/data/gemfire/support/DeclarableSupport.java @@ -25,7 +25,7 @@ import org.springframework.beans.factory.BeanFactory; import org.springframework.data.gemfire.RegionFactoryBean; /** - * Convenience class for Spring-aware GemFire {@link Declarable} components. Provides subclasses with a reference + * Convenience class for Spring-aware Pivotal GemFire {@link Declarable} components. Provides subclasses with a reference * to the current Spring {@link BeanFactory} in orde to perform Spring bean lookups or resource loading. * * Note, in most cases, the developer should just declare the same components as Spring beans in the Spring container, diff --git a/src/main/java/org/springframework/data/gemfire/support/GemfireBeanFactoryLocator.java b/src/main/java/org/springframework/data/gemfire/support/GemfireBeanFactoryLocator.java index 4836041b..a2eef9b9 100644 --- a/src/main/java/org/springframework/data/gemfire/support/GemfireBeanFactoryLocator.java +++ b/src/main/java/org/springframework/data/gemfire/support/GemfireBeanFactoryLocator.java @@ -41,8 +41,8 @@ import org.springframework.util.StringUtils; /** * The {@link GemfireBeanFactoryLocator} class stores a reference to the Spring * {@link org.springframework.context.ApplicationContext} / {@link BeanFactory} needed to auto-wire - * user application GemFire objects implementing the {@link org.apache.geode.cache.Declarable} interface - * and defined in GemFire's native configuration format (e.g. {@literal cache.xml}. + * user application Pivotal GemFire objects implementing the {@link org.apache.geode.cache.Declarable} interface + * and defined in Pivotal GemFire's native configuration format (e.g. {@literal cache.xml}. * * In most cases, a developer does not need to use this class directly as it is registered by the * {@link org.springframework.data.gemfire.CacheFactoryBean} when the {@literal useBeanFactoryLocator} property diff --git a/src/main/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupport.java b/src/main/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupport.java index 0d91c831..ba72d13f 100644 --- a/src/main/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupport.java +++ b/src/main/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupport.java @@ -34,8 +34,8 @@ import org.springframework.context.event.ContextRefreshedEvent; import org.springframework.util.Assert; /** - * The {@link LazyWiringDeclarableSupport} class is an implementation of GemFire's {@link Declarable} interface - * that enables support for wiring GemFire components with Spring bean dependencies defined in + * The {@link LazyWiringDeclarableSupport} class is an implementation of Pivotal GemFire's {@link Declarable} interface + * that enables support for wiring Pivotal GemFire components with Spring bean dependencies defined in * a Spring {@link ApplicationContext}. * * @author John Blum @@ -53,7 +53,7 @@ import org.springframework.util.Assert; public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSupport implements ApplicationListener, DisposableBean { - // atomic reference to the parameters passed by GemFire when this Declarable object + // atomic reference to the parameters passed by Pivotal GemFire when this Declarable object // was constructed, configured and its init method called private final AtomicReference parametersReference = new AtomicReference<>(); @@ -78,7 +78,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor /** * Asserts that this {@link Declarable} object has been properly configured and initialized by the Spring container - * after has GemFire constructed this {@link Declarable} object during startup. + * after has Pivotal GemFire constructed this {@link Declarable} object during startup. * * This method is recommended to be called before any of this {@link Declarable} object's {@link CacheCallback} * methods (e.g. {@link CacheLoader#load(LoaderHelper)} are invoked in order to ensure that this {@link Declarable} @@ -138,11 +138,11 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor } /** - * Initialization method called by GemFire with the configured parameters once this {@link Declarable} object - * has been constructed by GemFire and the <initalizer> element is parsed - * in GemFire's configuration meta-data during startup. + * Initialization method called by Pivotal GemFire with the configured parameters once this {@link Declarable} object + * has been constructed by Pivotal GemFire and the <initalizer> element is parsed + * in Pivotal GemFire's configuration meta-data during startup. * - * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's + * @param parameters {@link Properties} containing the configured parameters parsed from Pivotal GemFire's * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object. * @see #doInit(BeanFactory, Properties) * @see java.util.Properties @@ -165,9 +165,9 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor * This method is triggered by the Spring {@link org.springframework.context.ApplicationContext}, Spring application * {@link ContextRefreshedEvent}) indicating that the Spring container (context) has been created and refreshed. * - * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's + * @param parameters {@link Properties} containing the configured parameters parsed from Pivotal GemFire's * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object. - * @throws IllegalArgumentException if the {@literal bean-name} parameter was specified in GemFire's + * @throws IllegalArgumentException if the {@literal bean-name} parameter was specified in Pivotal GemFire's * configuration meta-data but no bean with the specified name could be found in the Spring context. * @see #init(java.util.Properties) * @see #configureThis(BeanFactory, String) @@ -186,7 +186,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor * * By default, this method does nothing. * - * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's + * @param parameters {@link Properties} containing the configured parameters parsed from Pivotal GemFire's * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object. * @see #doInit(BeanFactory, Properties) * @see java.util.Properties @@ -198,7 +198,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor * Null-safe operation to return the parameters passed to this {@link Declarable} object when created by GemFire * from it's own configuration meta-data (e.g. {@literal cache.xml}). * - * @return a {@link Properties} containing the configured parameters parsed from GemFire's configuration meta-data + * @return a {@link Properties} containing the configured parameters parsed from Pivotal GemFire's configuration meta-data * (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object. * @see java.util.Properties */ @@ -210,7 +210,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor /** * Stores a reference to the {@link Properties parameters} passed to the {@link Declarable#init(Properties)} method. * - * @param parameters {@link Properties} containing the configured parameters parsed from GemFire's + * @param parameters {@link Properties} containing the configured parameters parsed from Pivotal GemFire's * configuration meta-data (e.g. {@literal cache.xml}) and passed to this {@link Declarable} object. * @see java.util.Properties */ @@ -219,7 +219,7 @@ public abstract class LazyWiringDeclarableSupport extends WiringDeclarableSuppor } /** - * Event handler method called when GemFire has created and initialized (refreshed) + * Event handler method called when Pivotal GemFire has created and initialized (refreshed) * the Spring {@link ApplicationContext} using the {@link SpringContextBootstrappingInitializer}. * * @param event {@link ContextRefreshedEvent} published by the Spring {@link ApplicationContext} after it is diff --git a/src/main/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializer.java b/src/main/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializer.java index 0f75e4d9..cf42d880 100644 --- a/src/main/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializer.java +++ b/src/main/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializer.java @@ -45,11 +45,11 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** - * The {@link SpringContextBootstrappingInitializer} class is a GemFire configuration initializer used to bootstrap - * a Spring {@link ApplicationContext} inside a GemFire Server JVM-based process. This enables a GemFire Server - * resource to be mostly configured with Spring Data GemFire's configuration meta-data. The GemFire {@link Cache} + * The {@link SpringContextBootstrappingInitializer} class is a Pivotal GemFire configuration initializer used to bootstrap + * a Spring {@link ApplicationContext} inside a Pivotal GemFire Server JVM-based process. This enables a Pivotal GemFire Server + * resource to be mostly configured with SDG's configuration meta-data. The Pivotal GemFire {@link Cache} * itself is the only resource that cannot be configured and initialized in a Spring context since the initializer - * is not invoked until after GemFire creates and initializes the GemFire {@link Cache} for use. + * is not invoked until after Pivotal GemFire creates and initializes the Pivotal GemFire {@link Cache} for use. * * @author John Blum * @see org.springframework.context.ApplicationContext @@ -102,7 +102,7 @@ public class SpringContextBootstrappingInitializer implements Declarable, Applic } /** - * Sets the ClassLoader used by the Spring ApplicationContext, created by this GemFire Initializer, when creating + * Sets the ClassLoader used by the Spring ApplicationContext, created by this Pivotal GemFire Initializer, when creating * bean definition classes. * * @param beanClassLoader the ClassLoader used by the Spring ApplicationContext to load bean definition classes. @@ -123,7 +123,7 @@ public class SpringContextBootstrappingInitializer implements Declarable, Applic * Notifies any Spring ApplicationListeners of a current and existing ContextRefreshedEvent if the * ApplicationContext had been previously created, initialized and refreshed before any ApplicationListeners * interested in ContextRefreshedEvents were registered so that application components (such as the - * GemFire CacheLoaders extending LazyWiringDeclarableSupport objects) registered late, requiring configuration + * Pivotal GemFire CacheLoaders extending LazyWiringDeclarableSupport objects) registered late, requiring configuration * (auto-wiring), also get notified and wired accordingly. * * @param listener a Spring ApplicationListener requiring notification of any ContextRefreshedEvents after the @@ -141,7 +141,7 @@ public class SpringContextBootstrappingInitializer implements Declarable, Applic /** * Registers a Spring ApplicationListener to be notified when the Spring ApplicationContext is created by GemFire - * when instantiating and initializing Declarables declared inside the <initializer> block inside GemFire's + * when instantiating and initializing Declarables declared inside the <initializer> block inside Pivotal GemFire's * cache.xml file. * * @param the Class type of the Spring ApplicationListener. @@ -373,12 +373,12 @@ public class SpringContextBootstrappingInitializer implements Declarable, Applic } /** - * Initializes a Spring ApplicationContext with the given parameters specified with a GemFire <initializer> + * Initializes a Spring ApplicationContext with the given parameters specified with a Pivotal GemFire <initializer> * block in cache.xml. * * @param parameters a Properties object containing the configuration parameters and settings defined in the - * GemFire cache.xml <initializer> block for the declared SpringContextBootstrappingInitializer - * GemFire Declarable object. + * Pivotal GemFire cache.xml <initializer> block for the declared SpringContextBootstrappingInitializer + * Pivotal GemFire Declarable object. * @throws org.springframework.context.ApplicationContextException if the Spring ApplicationContext could not be * successfully created, configured and initialized. * @see #createApplicationContext(String[], String[]) @@ -433,8 +433,8 @@ public class SpringContextBootstrappingInitializer implements Declarable, Applic /** * Gets notified when the Spring ApplicationContext gets created and refreshed by GemFire, once the * <initializer> block is processed and the SpringContextBootstrappingInitializer Declarable component - * is initialized. This handler method proceeds in notifying any other GemFire components that need to be aware - * that the Spring ApplicationContext now exists and is ready for use, such as other Declarable GemFire objects + * is initialized. This handler method proceeds in notifying any other Pivotal GemFire components that need to be aware + * that the Spring ApplicationContext now exists and is ready for use, such as other Declarable Pivotal GemFire objects * requiring auto-wiring support, etc. * * In addition, this method handles the ContextClosedEvent by removing the ApplicationContext reference. diff --git a/src/main/java/org/springframework/data/gemfire/support/SpringServerLauncherCacheProvider.java b/src/main/java/org/springframework/data/gemfire/support/SpringServerLauncherCacheProvider.java index b05a72ea..59b7ec3a 100644 --- a/src/main/java/org/springframework/data/gemfire/support/SpringServerLauncherCacheProvider.java +++ b/src/main/java/org/springframework/data/gemfire/support/SpringServerLauncherCacheProvider.java @@ -21,20 +21,21 @@ import org.apache.geode.cache.Cache; import org.apache.geode.distributed.ServerLauncher; import org.apache.geode.distributed.ServerLauncher.Builder; import org.apache.geode.distributed.ServerLauncherCacheProvider; +import org.springframework.context.ApplicationContext; import org.springframework.data.gemfire.GemfireUtils; /** - * The SpringServerLauncherCacheProvider class overrides the default behavior of GemFire's {@link ServerLauncher} - * to bootstrap the GemFire cache using a Spring {@link org.springframework.context.ApplicationContext} instead - * of GemFire cache.xml inside a GemFire Server JVM-based process. This enables a GemFire Cache Server's resources - * to be configured with Spring Data GemFire's XML namespace. + * The {@link SpringServerLauncherCacheProvider} class overrides the default behavior of Pivotal GemFire's + * {@link ServerLauncher} to bootstrap the Pivotal GemFire cache using a Spring {@link ApplicationContext} + * instead of Pivotal GemFire {@literal cache.xml} inside a Pivotal GemFire Server JVM-based process. + * This enables a Pivotal GemFire Cache Server's resources to be configured with SDG's XML namespace. * * Unlike {@link SpringContextBootstrappingInitializer}, this allows the configuration of the cache to specified * in the Spring context. * - * To use this cache provider, ensure that the Spring Data GemFire JAR file is on the classpath of the GemFire server + * To use this cache provider, ensure that the SDG JAR file is on the classpath of the Pivotal GemFire server * and specify the --spring-xml-location option from the Gfsh command line or call - * {@link Builder#setSpringXmlLocation(String)} when launching the GemFire server. + * {@link Builder#setSpringXmlLocation(String)} when launching the Pivotal GemFire server. * * @author Dan Smith * @author John Blum @@ -46,7 +47,6 @@ import org.springframework.data.gemfire.GemfireUtils; */ public class SpringServerLauncherCacheProvider implements ServerLauncherCacheProvider { - /* (non-Javadoc) */ @Override public Cache createCache(Properties gemfireProperties, ServerLauncher serverLauncher) { Cache cache = null; @@ -60,7 +60,6 @@ public class SpringServerLauncherCacheProvider implements ServerLauncherCachePro return cache; } - /* (non-Javadoc) */ Properties createParameters(ServerLauncher serverLauncher) { Properties parameters = new Properties(); parameters.setProperty(SpringContextBootstrappingInitializer.CONTEXT_CONFIG_LOCATIONS_PARAMETER, @@ -68,12 +67,10 @@ public class SpringServerLauncherCacheProvider implements ServerLauncherCachePro return parameters; } - /* (non-Javadoc) */ String gemfireName() { return (GemfireUtils.GEMFIRE_PREFIX + GemfireUtils.NAME_PROPERTY_NAME); } - /* (non-Javadoc) */ SpringContextBootstrappingInitializer newSpringContextBootstrappingInitializer() { return new SpringContextBootstrappingInitializer(); } diff --git a/src/main/java/org/springframework/data/gemfire/support/package-info.java b/src/main/java/org/springframework/data/gemfire/support/package-info.java index 092e5f7e..0df23c7e 100644 --- a/src/main/java/org/springframework/data/gemfire/support/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/support/package-info.java @@ -1,8 +1,7 @@ - /** - * Support package for Spring Gemfire integration. - * - * Provides Spring 3.1 caching support (Cache and CacheManager implementations on top of Gemfire APIs). + * Support package for Spring Pivotal GemFire integration. + * + * Provides Spring caching support (Cache and CacheManager implementations on top of Pivotal GemFire APIs). */ package org.springframework.data.gemfire.support; diff --git a/src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionManager.java b/src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionManager.java index b998fc3c..686906b0 100644 --- a/src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionManager.java +++ b/src/main/java/org/springframework/data/gemfire/transaction/GemfireTransactionManager.java @@ -43,7 +43,7 @@ import org.springframework.util.Assert; * Local Transaction Management for Pivotal GemFire. Provides a Spring {@link PlatformTransactionManager} implementation * for the Pivotal GemFire {@link CacheTransactionManager}. * - * Binds one or multiple GemFire {@link Region Regions} for the specified {@link GemFireCache} to the thread, + * Binds one or multiple Pivotal GemFire {@link Region Regions} for the specified {@link GemFireCache} to the thread, * potentially allowing for one {@link Region} per {@link GemFireCache} model. * *

@@ -141,12 +141,12 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage GemFireCache cache = getCache(); if (logger.isDebugEnabled()) { - logger.debug(String.format("Acquired GemFire Cache [%s] for local cache transaction", cache)); + logger.debug(String.format("Acquired Pivotal GemFire Cache [%s] for local cache transaction", cache)); } CacheTransactionManager cacheTransactionManager = getCacheTransactionManager(); - // begin GemFire local cache transaction + // begin Pivotal GemFire local cache transaction cacheTransactionManager.begin(); TransactionId transactionId = cacheTransactionManager.getTransactionId(); @@ -315,11 +315,11 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * Sets the GemFire cache {@link Region} as an alternative in setting in the {@link GemFireCache} directly. + * Sets the Pivotal GemFire cache {@link Region} as an alternative in setting in the {@link GemFireCache} directly. * * @param {@link Class} type of the {@link Region} key. * @param {@link Class} type of the {@link Region} value. - * @param region GemFire cache {@link Region} directly involved in the local cache transaction. + * @param region Pivotal GemFire cache {@link Region} directly involved in the local cache transaction. * @throws IllegalArgumentException if {@link Region} is {@literal null}. * @see org.apache.geode.cache.Region */ @@ -337,9 +337,9 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /*** - * Sets the timeout used to wait for the GemFire cache transaction to resume. + * Sets the timeout used to wait for the Pivotal GemFire cache transaction to resume. * - * @param resumeWaitTime long value with the timeout used to wait for the GemFire cache transaction to resume. + * @param resumeWaitTime long value with the timeout used to wait for the Pivotal GemFire cache transaction to resume. * @see org.apache.geode.cache.CacheTransactionManager#tryResume(TransactionId, long, TimeUnit) */ public void setResumeWaitTime(Long resumeWaitTime) { @@ -347,9 +347,9 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /*** - * Returns the timeout used to wait for the GemFire cache transaction to resume. + * Returns the timeout used to wait for the Pivotal GemFire cache transaction to resume. * - * @return the long value with the timeout used to wait for the GemFire cache transaction to resume. + * @return the long value with the timeout used to wait for the Pivotal GemFire cache transaction to resume. * @see org.apache.geode.cache.CacheTransactionManager#tryResume(TransactionId, long, TimeUnit) */ protected Long getResumeWaitTime() { @@ -357,10 +357,10 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * Determines whether the user specified a wait time for resuming a GemFire cache transaction. + * Determines whether the user specified a wait time for resuming a Pivotal GemFire cache transaction. * * @return a boolean value to indicate whether the user specified a wait time - * for resuming a GemFire cache transaction. + * for resuming a Pivotal GemFire cache transaction. * @see org.apache.geode.cache.CacheTransactionManager#tryResume(TransactionId, long, TimeUnit) * @see #getResumeWaitTime() */ @@ -370,9 +370,9 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * Sets the {@link TimeUnit} used in the wait timeout when resuming a GemFire cache transaction. + * Sets the {@link TimeUnit} used in the wait timeout when resuming a Pivotal GemFire cache transaction. * - * @param resumeWaitTimeUnit {@link TimeUnit} used in the wait timeout when resuming a GemFire cache transaction. + * @param resumeWaitTimeUnit {@link TimeUnit} used in the wait timeout when resuming a Pivotal GemFire cache transaction. * @see org.apache.geode.cache.CacheTransactionManager#tryResume(TransactionId, long, TimeUnit) */ public void setResumeWaitTimeUnit(TimeUnit resumeWaitTimeUnit) { @@ -380,11 +380,11 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * Returns the {@link TimeUnit} used in the wait timeout when resuming a GemFire cache transaction. + * Returns the {@link TimeUnit} used in the wait timeout when resuming a Pivotal GemFire cache transaction. * * Defaults to {@link TimeUnit#SECONDS}. * - * @return the {@link TimeUnit} used in the wait timeout when resuming a GemFire cache transaction. + * @return the {@link TimeUnit} used in the wait timeout when resuming a Pivotal GemFire cache transaction. * @see org.apache.geode.cache.CacheTransactionManager#tryResume(TransactionId, long, TimeUnit) */ protected TimeUnit getResumeWaitTimeUnit() { @@ -392,7 +392,7 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * GemFire local transaction object. + * Pivotal GemFire local transaction object. * * @author Costin Leau * @author John Blum @@ -438,7 +438,7 @@ public class GemfireTransactionManager extends AbstractPlatformTransactionManage } /** - * Holder of GemFire cache transaction state. + * Holder of Pivotal GemFire cache transaction state. */ protected static class CacheHolder { diff --git a/src/main/java/org/springframework/data/gemfire/transaction/config/EnableGemfireCacheTransactions.java b/src/main/java/org/springframework/data/gemfire/transaction/config/EnableGemfireCacheTransactions.java index c0342d80..ae247e41 100644 --- a/src/main/java/org/springframework/data/gemfire/transaction/config/EnableGemfireCacheTransactions.java +++ b/src/main/java/org/springframework/data/gemfire/transaction/config/EnableGemfireCacheTransactions.java @@ -36,9 +36,9 @@ import org.springframework.context.annotation.Import; * @see java.lang.annotation.Target * @see org.springframework.context.annotation.Import * @see Spring Transaction Management - * @see Spring Data GemFire Transaction Management - * @see GemFire Cache Transactions - * @see Geode Cache Transactions + * @see SDG Transaction Management + * @see Pivotal GemFire Cache Transactions + * @see Apache Geode Cache Transactions * @since 2.0.0 */ @Target(ElementType.TYPE) diff --git a/src/main/java/org/springframework/data/gemfire/transaction/config/GemfireCacheTransactionsConfiguration.java b/src/main/java/org/springframework/data/gemfire/transaction/config/GemfireCacheTransactionsConfiguration.java index f808771a..9659c532 100644 --- a/src/main/java/org/springframework/data/gemfire/transaction/config/GemfireCacheTransactionsConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/transaction/config/GemfireCacheTransactionsConfiguration.java @@ -42,7 +42,7 @@ public class GemfireCacheTransactionsConfiguration { /** * Declares and registers SDG's {@link GemfireTransactionManager} as the {@literal transactionManager} - * in Spring's Transaction Management infrastructure to manage local, GemFire/Geode cache transactions. + * in Spring's Transaction Management infrastructure to manage local, Pivotal GemFire/Apache Geode cache transactions. * * @param gemfireCache reference to the {@link GemFireCache}. * @return a new instance of {@link GemfireTransactionManager} initialized with the given {@link GemFireCache}. diff --git a/src/main/java/org/springframework/data/gemfire/util/DistributedSystemUtils.java b/src/main/java/org/springframework/data/gemfire/util/DistributedSystemUtils.java index 7b06df36..40a1c74d 100644 --- a/src/main/java/org/springframework/data/gemfire/util/DistributedSystemUtils.java +++ b/src/main/java/org/springframework/data/gemfire/util/DistributedSystemUtils.java @@ -31,7 +31,7 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * DistributedSystemUtils is an abstract utility class for working with the GemFire DistributedSystem. + * DistributedSystemUtils is an abstract utility class for working with the Pivotal GemFire DistributedSystem. * * @author John Blum * @see org.apache.geode.cache.GemFireCache diff --git a/src/main/java/org/springframework/data/gemfire/wan/AsyncEventQueueFactoryBean.java b/src/main/java/org/springframework/data/gemfire/wan/AsyncEventQueueFactoryBean.java index 4b8ce27c..bfb9e8a6 100644 --- a/src/main/java/org/springframework/data/gemfire/wan/AsyncEventQueueFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/wan/AsyncEventQueueFactoryBean.java @@ -71,9 +71,9 @@ public class AsyncEventQueueFactoryBean extends AbstractWANComponentFactoryBean< private String diskStoreReference; /** - * Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue. + * Constructs an instance of the AsyncEventQueueFactoryBean for creating an Pivotal GemFire AsyncEventQueue. * - * @param cache the GemFire Cache reference. + * @param cache the Pivotal GemFire Cache reference. * @see #AsyncEventQueueFactoryBean(org.apache.geode.cache.Cache, org.apache.geode.cache.asyncqueue.AsyncEventListener) */ public AsyncEventQueueFactoryBean(final Cache cache) { @@ -81,9 +81,9 @@ public class AsyncEventQueueFactoryBean extends AbstractWANComponentFactoryBean< } /** - * Constructs an instance of the AsyncEventQueueFactoryBean for creating an GemFire AsyncEventQueue. + * Constructs an instance of the AsyncEventQueueFactoryBean for creating an Pivotal GemFire AsyncEventQueue. * - * @param cache the GemFire Cache reference. + * @param cache the Pivotal GemFire Cache reference. * @param asyncEventListener required {@link AsyncEventListener} */ public AsyncEventQueueFactoryBean(Cache cache, AsyncEventListener asyncEventListener) { diff --git a/src/main/java/org/springframework/data/gemfire/wan/GatewayReceiverFactoryBean.java b/src/main/java/org/springframework/data/gemfire/wan/GatewayReceiverFactoryBean.java index 9575d213..075f623f 100644 --- a/src/main/java/org/springframework/data/gemfire/wan/GatewayReceiverFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/wan/GatewayReceiverFactoryBean.java @@ -27,7 +27,7 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * Spring {@link FactoryBean} for creating a GemFire {@link GatewayReceiver}. + * Spring {@link FactoryBean} for creating a Pivotal GemFire {@link GatewayReceiver}. * * @author David Turanski * @author John Blum @@ -57,9 +57,9 @@ public class GatewayReceiverFactoryBean extends AbstractWANComponentFactoryBean< /** * 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}. + * the Pivotal GemFire {@link Cache} used to configure and initialize a Pivotal GemFire {@link GatewayReceiver}. * - * @param cache reference to the GemFire {@link Cache} used to create the {@link GatewayReceiver}. + * @param cache reference to the Pivotal GemFire {@link Cache} used to create the {@link GatewayReceiver}. * @see org.apache.geode.cache.Cache */ public GatewayReceiverFactoryBean(Cache cache) { diff --git a/src/main/java/org/springframework/data/gemfire/wan/GatewaySenderFactoryBean.java b/src/main/java/org/springframework/data/gemfire/wan/GatewaySenderFactoryBean.java index d05e1c4b..225261bd 100644 --- a/src/main/java/org/springframework/data/gemfire/wan/GatewaySenderFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/wan/GatewaySenderFactoryBean.java @@ -28,7 +28,7 @@ import org.springframework.data.gemfire.util.CollectionUtils; import org.springframework.util.Assert; /** - * Spring {@link FactoryBean} for creating a parallel or serial GemFire {@link GatewaySender}. + * Spring {@link FactoryBean} for creating a parallel or serial Pivotal GemFire {@link GatewaySender}. * * @author David Turanski * @author John Blum @@ -73,9 +73,9 @@ public class GatewaySenderFactoryBean extends AbstractWANComponentFactoryBean { /** - * Converts the given String into a GemFire Gateway.OrderPolicy enum. + * Converts the given String into a Pivotal GemFire Gateway.OrderPolicy enum. * * @param source the String to convert. - * @return a GemFire Gateway.OrderPolicy enum for the given String. - * @throws java.lang.IllegalArgumentException if the String is not a valid GemFire Gateway.OrderPolicy. + * @return a Pivotal GemFire Gateway.OrderPolicy enum for the given String. + * @throws java.lang.IllegalArgumentException if the String is not a valid Pivotal GemFire Gateway.OrderPolicy. * @see org.springframework.data.gemfire.wan.OrderPolicyType#getOrderPolicy() * @see org.springframework.data.gemfire.wan.OrderPolicyType#valueOfIgnoreCase(String) * @see org.apache.geode.cache.util.Gateway.OrderPolicy diff --git a/src/main/java/org/springframework/data/gemfire/wan/OrderPolicyType.java b/src/main/java/org/springframework/data/gemfire/wan/OrderPolicyType.java index e6a3006e..5f0e3842 100644 --- a/src/main/java/org/springframework/data/gemfire/wan/OrderPolicyType.java +++ b/src/main/java/org/springframework/data/gemfire/wan/OrderPolicyType.java @@ -19,7 +19,7 @@ package org.springframework.data.gemfire.wan; import org.apache.geode.cache.util.Gateway; /** - * The OrderPolicyType class is an enumeration of GemFire Gateway Order Policies. + * The OrderPolicyType class is an enumeration of Pivotal GemFire Gateway Order Policies. * * @author John Blum * @see org.apache.geode.cache.util.Gateway.OrderPolicy @@ -27,6 +27,7 @@ import org.apache.geode.cache.util.Gateway; */ @SuppressWarnings({ "deprecation", "unused" }) public enum OrderPolicyType { + KEY(Gateway.OrderPolicy.KEY), PARTITION(Gateway.OrderPolicy.PARTITION), THREAD(Gateway.OrderPolicy.THREAD); @@ -34,10 +35,10 @@ public enum OrderPolicyType { private final Gateway.OrderPolicy orderPolicy; /** - * Constructs an instance of the OrderPolicyType enum initialized with the matching GemFire Gateway.OrderPolicy + * Constructs an instance of the OrderPolicyType enum initialized with the matching Pivotal GemFire Gateway.OrderPolicy * enumerated value. * - * @param orderPolicy the matching GemFire Gateway.OrderPolicy enumerated value. + * @param orderPolicy the matching Pivotal GemFire Gateway.OrderPolicy enumerated value. * @see org.apache.geode.cache.util.Gateway.OrderPolicy */ OrderPolicyType(final Gateway.OrderPolicy orderPolicy) { @@ -45,12 +46,12 @@ public enum OrderPolicyType { } /** - * Null-safe operation to extract the matching GemFire Gateway.OrderPolicy enumerated value from + * Null-safe operation to extract the matching Pivotal GemFire Gateway.OrderPolicy enumerated value from * the specified OrderPolicyType. * - * @param orderPolicyType the OrderPolicyType enum from which to extract the GemFire-based + * @param orderPolicyType {@link OrderPolicyType} enum from which to extract the Pivotal GemFire-based * Gateway.OrderPolicy enumerated value. - * @return the GemFire Gateway.OrderPolicy enumerated value for the given OrderPolicyType. + * @return the Pivotal GemFire Gateway.OrderPolicy enumerated value for the given OrderPolicyType. * @see org.apache.geode.cache.util.Gateway.OrderPolicy * @see #getOrderPolicy() */ @@ -59,11 +60,11 @@ public enum OrderPolicyType { } /** - * Returns the matching OrderPolicyType given a GemFire Gateway.OrderPolicy enumerated value. + * Returns the matching OrderPolicyType given a Pivotal GemFire Gateway.OrderPolicy enumerated value. * - * @param orderPolicy the GemFire Gateway.OrderPolicy enumerated value used to match + * @param orderPolicy the Pivotal GemFire Gateway.OrderPolicy enumerated value used to match * the desired OrderPolicyType. - * @return a OrderPolicyType matching the given GemFire Gateway.OrderPolicy enumerated value. + * @return a OrderPolicyType matching the given Pivotal GemFire Gateway.OrderPolicy enumerated value. * @see org.apache.geode.cache.util.Gateway.OrderPolicy * @see #getOrderPolicy() */ @@ -78,7 +79,7 @@ public enum OrderPolicyType { } /** - * Returns a matching OrderPolicyType given the case-insensitive, name of the GemFire Gateway OrderPolicy. + * Returns a matching OrderPolicyType given the case-insensitive, name of the Pivotal GemFire Gateway OrderPolicy. * * @param name a String name used to match the desired OrderPolicyType. * @return a OrderPolicyType enumerated value for the given name. @@ -96,13 +97,12 @@ public enum OrderPolicyType { } /** - * Gets the GemFire Gateway.OrderPolicy corresponding to this OrderPolicyType enum. + * Gets the Pivotal GemFire Gateway.OrderPolicy corresponding to this OrderPolicyType enum. * - * @return a GemFire Gateway.OrderPolicy for this enum. + * @return a Pivotal GemFire Gateway.OrderPolicy for this enum. * @see org.apache.geode.cache.util.Gateway.OrderPolicy */ public Gateway.OrderPolicy getOrderPolicy() { return orderPolicy; } - } diff --git a/src/main/java/org/springframework/data/gemfire/wan/package-info.java b/src/main/java/org/springframework/data/gemfire/wan/package-info.java index 02864892..725697ab 100644 --- a/src/main/java/org/springframework/data/gemfire/wan/package-info.java +++ b/src/main/java/org/springframework/data/gemfire/wan/package-info.java @@ -1,5 +1,5 @@ /** - * Base package for Spring GemFire WAN support + * Base package for Spring Pivotal GemFire WAN support */ package org.springframework.data.gemfire.wan; diff --git a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupDao.java b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupDao.java index 29972b2f..53def01a 100644 --- a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupDao.java +++ b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupDao.java @@ -29,10 +29,10 @@ import org.springframework.dao.support.DaoSupport; import org.springframework.stereotype.Repository; /** - * The AutoRegionLookupDao class is a Data Access Object (DAO) encapsulating references to several GemFire Cache Regions - * defined in native GemFire cache.xml and registered as beans in the Spring context using Spring Data GemFire's - * auto Region lookup functionality. This class is used in the AutoRegionLookupWithComponentScanningIntegrationTests - * class to ensure this @Repository component is auto-wired properly. + * The AutoRegionLookupDao class is a Data Access Object (DAO) encapsulating references to several Pivotal GemFireCache Regions + * defined in native Pivotal GemFirecache.xml and registered as beans in the Spring context using SDG's auto Region lookup + * functionality. This class is used in the AutoRegionLookupWithComponentScanningIntegrationTests class to ensure + * this @Repository component is auto-wired properly. * * @author John Blum * @see org.springframework.dao.support.DaoSupport @@ -40,8 +40,6 @@ import org.springframework.stereotype.Repository; * @see org.apache.geode.cache.Region * @since 1.5.0 */ -/* -*/ @DependsOn("gemfireCache") //@Lazy @Repository("autoRegionLookupDao") @@ -85,5 +83,4 @@ public class AutoRegionLookupDao extends DaoSupport { assertRegionMetaData(nativeReplicateGrandchild, "NativeReplicateGrandchild", "/NativeReplicateParent/NativeReplicateChild/NativeReplicateGrandchild", DataPolicy.REPLICATE); } - } diff --git a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupIntegrationTests.java index 276d8c68..cff8642d 100644 --- a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupIntegrationTests.java @@ -26,8 +26,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** - * The AutoRegionLookupIntegrationTests class is a test suite of test cases testing the contract and functionality - * of Spring Data GemFire's new auto Region lookup feature. + * Integration tests to test the contract and functionality of SDG's Auto Region Lookup functionality. * * @author John Blum * @see org.junit.Test @@ -54,5 +53,4 @@ public class AutoRegionLookupIntegrationTests { assertTrue(applicationContext.containsBean("/NativeReplicateParent/NativeReplicateChild")); assertTrue(applicationContext.containsBean("/NativeReplicateParent/NativeReplicateChild/NativeReplicateGrandchild")); } - } diff --git a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests.java index 6dcd840f..31d188d3 100644 --- a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests.java @@ -29,11 +29,11 @@ import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; /** - * The AutoRegionLookupWithAutowiringIntegrationTests class is a test suite class testing the behavior of - * Spring Data GemFire's auto Region lookup functionality when combined with Spring's component auto-wiring capabilities. + * Integration tests to test the behavior of SDG's Auto Region Lookup functionality + * when combined with Spring's component auto-wiring capabilities. * * @author John Blum * @see org.junit.Test @@ -42,7 +42,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner * @since 1.5.0 */ -@RunWith(SpringJUnit4ClassRunner.class) +@RunWith(SpringRunner.class) @ContextConfiguration @SuppressWarnings("unused") public class AutoRegionLookupWithAutowiringIntegrationTests { @@ -92,5 +92,4 @@ public class AutoRegionLookupWithAutowiringIntegrationTests { Region nativeReplicateGrandchild; } - } diff --git a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithComponentScanningIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithComponentScanningIntegrationTests.java index 0800dec9..974a467b 100644 --- a/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithComponentScanningIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/AutoRegionLookupWithComponentScanningIntegrationTests.java @@ -24,11 +24,11 @@ import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; /** - * The AutoRegionLookupWithComponentScanningIntegrationTests class is a test suite class testing the behavior of - * Spring Data GemFire's auto Region lookup behavior with Spring component scanning functionality. + * Integration tests to test the behavior of SDG's Auto Region Lookup behavior + * with Spring component scanning functionality. * * @author John Blum * @see org.junit.Test @@ -37,7 +37,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner * @since 1.5.0 */ -@RunWith(SpringJUnit4ClassRunner.class) +@RunWith(SpringRunner.class) @ContextConfiguration @SuppressWarnings("unused") public class AutoRegionLookupWithComponentScanningIntegrationTests { @@ -51,5 +51,4 @@ public class AutoRegionLookupWithComponentScanningIntegrationTests { context.containsBean("autoRegionLookupDao")); assertNotNull(context.getBean("autoRegionLookupDao", AutoRegionLookupDao.class)); } - } diff --git a/src/test/java/org/springframework/data/gemfire/CacheAutoReconnectIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/CacheAutoReconnectIntegrationTests.java index f8b35c9b..4ae11f84 100644 --- a/src/test/java/org/springframework/data/gemfire/CacheAutoReconnectIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/CacheAutoReconnectIntegrationTests.java @@ -31,8 +31,8 @@ import org.springframework.context.support.ClassPathXmlApplicationContext; import org.springframework.data.gemfire.config.xml.GemfireConstants; /** - * The CacheAutoReconnectIntegrationTests class is a tests suite of test cases testing Spring Data GemFire's support - * of GemFire's Auto-Reconnect functionality release in 8.0. + * The CacheAutoReconnectIntegrationTests class is a tests suite of test cases testing SDG's support + * of Pivotal GemFire's Auto-Reconnect functionality release in 8.0. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/CacheClusterConfigurationIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/CacheClusterConfigurationIntegrationTest.java index abfb436d..c6143c60 100644 --- a/src/test/java/org/springframework/data/gemfire/CacheClusterConfigurationIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/CacheClusterConfigurationIntegrationTest.java @@ -57,7 +57,7 @@ import org.springframework.util.StringUtils; /** * The CacheClusterConfigurationIntegrationTest class is a test suite of test cases testing the integration of - * Spring Data GemFire with GemFire 8's new shared, persistent, cluster configuration service. + * SDG with Pivotal GemFire8's new shared, persistent, cluster configuration service. * * @author John Blum * @see org.junit.Test @@ -233,7 +233,7 @@ public class CacheClusterConfigurationIntegrationTest { fail("Loading the 'cacheUsingLocalOnlyConfigurationIntegrationTest.xml' Spring ApplicationContext" + " configuration file should have resulted in an Exception due to the Region lookup on" - + " 'ClusterConfigRegion' when GemFire Cluster Configuration is disabled!"); + + " 'ClusterConfigRegion' when Cluster Configuration is disabled!"); } catch (BeanCreationException expected) { assertTrue(expected.getCause() instanceof BeanInitializationException); diff --git a/src/test/java/org/springframework/data/gemfire/CacheIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/CacheIntegrationTest.java index fde9d288..63804643 100644 --- a/src/test/java/org/springframework/data/gemfire/CacheIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/CacheIntegrationTest.java @@ -28,7 +28,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** - * Integration test trying various basic configurations of GemFire through + * Integration test trying various basic configurations of Pivotal GemFirethrough * Spring. * * Made abstract to avoid multiple caches running at the same time. diff --git a/src/test/java/org/springframework/data/gemfire/CacheServerIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/CacheServerIntegrationTest.java index c3a17d11..311b35d6 100644 --- a/src/test/java/org/springframework/data/gemfire/CacheServerIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/CacheServerIntegrationTest.java @@ -33,8 +33,8 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** - * The CacheServerIntegrationTest class is a test suite of test cases testing the functionality of GemFire Cache Servers - * configured using the Spring Data GemFire XML namespace. + * The CacheServerIntegrationTest class is a test suite of test cases testing the functionality of Pivotal GemFireCache Servers + * configured using the SDG XML namespace. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/GemfireTemplateQueriesOnGroupedPooledClientCacheRegionsIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/GemfireTemplateQueriesOnGroupedPooledClientCacheRegionsIntegrationTests.java index cd17185a..a5d0cb98 100644 --- a/src/test/java/org/springframework/data/gemfire/GemfireTemplateQueriesOnGroupedPooledClientCacheRegionsIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/GemfireTemplateQueriesOnGroupedPooledClientCacheRegionsIntegrationTests.java @@ -62,14 +62,14 @@ import lombok.RequiredArgsConstructor; /** * Integrations tests for {@link GemfireTemplate} testing proper function and behavior of executing (OQL) queries - * from a cache client application using the {@link GemfireTemplate} to a cluster of GemFire servers that have + * from a cache client application using the {@link GemfireTemplate} to a cluster of Pivotal GemFire'servers that have * been grouped according to business function and data access, primarily to distribute the load. * - * Each GemFire {@link Pool} is configured to target a specific server group. Each group of servers in the cluster + * Each Pivotal GemFire{@link Pool} is configured to target a specific server group. Each group of servers in the cluster * defines specific {@link Region Regions} to manage data independently and separately from other data that might * garner high frequency access. * - * Spring Data GemFire's {@link GemfireTemplate} should intelligently employ the right + * SDG's {@link GemfireTemplate} should intelligently employ the right * {@link org.apache.geode.cache.query.QueryService} configured with the {@link Region Region's} {@link Pool} * meta-data when executing the query in order to ensure the right servers containing the {@link Region Region's} * with the data of interest are targeted. diff --git a/src/test/java/org/springframework/data/gemfire/GenericRegionFactoryBeanTest.java b/src/test/java/org/springframework/data/gemfire/GenericRegionFactoryBeanTest.java index 00688589..7a454bc1 100644 --- a/src/test/java/org/springframework/data/gemfire/GenericRegionFactoryBeanTest.java +++ b/src/test/java/org/springframework/data/gemfire/GenericRegionFactoryBeanTest.java @@ -43,7 +43,6 @@ import org.springframework.data.gemfire.util.CacheUtils; */ public class GenericRegionFactoryBeanTest { - // As defined in com.gemstone.gemfire.internal.cache.AbstractRegion private static final Scope DEFAULT_SCOPE = Scope.DISTRIBUTED_NO_ACK; private static Region defaultRegion; @@ -56,6 +55,7 @@ public class GenericRegionFactoryBeanTest { @BeforeClass public static void setup() throws Exception { + Cache gemfireCache = new CacheFactory() .set("name", GenericRegionFactoryBeanTest.class.getSimpleName()) .set("mcast-port", "0") @@ -125,6 +125,7 @@ public class GenericRegionFactoryBeanTest { @AfterClass public static void tearDown() { + CacheUtils.closeCache(); FileFilter fileFilter = FileSystemUtils.CompositeFileFilter.or( @@ -134,20 +135,20 @@ public class GenericRegionFactoryBeanTest { FileSystemUtils.deleteRecursive(FileSystemUtils.WORKING_DIRECTORY, fileFilter); } - protected void assertRegionAttributes(Region region, String expectedRegionName, DataPolicy expectedDataPolicy, + private void assertRegionAttributes(Region region, String expectedRegionName, DataPolicy expectedDataPolicy, Scope expectedScope) { assertRegionAttributes(region, expectedRegionName, String.format("%1$s%2$s", Region.SEPARATOR, expectedRegionName), expectedDataPolicy, expectedScope); } - protected void assertRegionAttributes(Region region, String expectedRegionName, String expectedRegionPath, + private void assertRegionAttributes(Region region, String expectedRegionName, String expectedRegionPath, DataPolicy expectedDataPolicy, Scope expectedScope) { - assertNotNull("The GemFire Cache Region must not be null!", region); + assertNotNull("The Cache Region must not be null", region); assertEquals(expectedRegionName, region.getName()); assertEquals(expectedRegionPath, region.getFullPath()); - assertNotNull("The RegionAttributes must be specified!", region.getAttributes()); + assertNotNull("The RegionAttributes must be specified", region.getAttributes()); assertEquals(expectedDataPolicy, region.getAttributes().getDataPolicy()); assertEquals(expectedScope, region.getAttributes().getScope()); } diff --git a/src/test/java/org/springframework/data/gemfire/IndexConflictsIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/IndexConflictsIntegrationTest.java index 46c17190..51830269 100644 --- a/src/test/java/org/springframework/data/gemfire/IndexConflictsIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/IndexConflictsIntegrationTest.java @@ -56,7 +56,7 @@ import org.springframework.context.annotation.Import; * @see org.springframework.context.annotation.Configuration * @see org.springframework.context.annotation.Import * @see IndexFactoryBean traps IndexExistsException instead of IndexNameConflictException - * @see Improve IndexFactoryBean's resilience and options for handling GemFire IndexExistsExceptions and IndexNameConflictExceptions + * @see Improve IndexFactoryBean's resilience and options for handling Pivotal GemFireIndexExistsExceptions and IndexNameConflictExceptions * @since 1.6.3 */ public class IndexConflictsIntegrationTest { diff --git a/src/test/java/org/springframework/data/gemfire/LookupRegionMutationIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/LookupRegionMutationIntegrationTest.java index 811e8e87..1ca6a661 100644 --- a/src/test/java/org/springframework/data/gemfire/LookupRegionMutationIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/LookupRegionMutationIntegrationTest.java @@ -50,12 +50,12 @@ import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.BeanNameAware; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; import org.springframework.util.StringUtils; /** * The LookupRegionMutationIntegrationTest class is a test suite of test cases testing the contract and integrated - * functionality between natively-defined GemFire Cache Regions and SDG's Region lookup functionality combined with + * functionality between natively-defined Pivotal GemFireCache Regions and SDG's Region lookup functionality combined with * Region attribute(s) mutation. * * @author John Blum @@ -66,7 +66,7 @@ import org.springframework.util.StringUtils; * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner * @since 1.7.0 */ -@RunWith(SpringJUnit4ClassRunner.class) +@RunWith(SpringRunner.class) @ContextConfiguration @SuppressWarnings("unused") public class LookupRegionMutationIntegrationTest { @@ -74,7 +74,8 @@ public class LookupRegionMutationIntegrationTest { @Resource(name = "Example") private Region example; - protected void assertCacheListeners(CacheListener[] cacheListeners, Collection expectedCacheListenerNames) { + private void assertCacheListeners(CacheListener[] cacheListeners, Collection expectedCacheListenerNames) { + if (!expectedCacheListenerNames.isEmpty()) { assertNotNull("CacheListeners must not be null!", cacheListeners); assertEquals(expectedCacheListenerNames.size(), cacheListeners.length); @@ -82,27 +83,40 @@ public class LookupRegionMutationIntegrationTest { } } - protected void assertEvictionAttributes(EvictionAttributes evictionAttributes, EvictionAction expectedAction, EvictionAlgorithm expectedAlgorithm, int expectedMaximum) { + private void assertEvictionAttributes(EvictionAttributes evictionAttributes, EvictionAction expectedAction, + EvictionAlgorithm expectedAlgorithm, int expectedMaximum) { + assertNotNull("EvictionAttributes must not be null!", evictionAttributes); assertEquals(expectedAction, evictionAttributes.getAction()); assertEquals(expectedAlgorithm, evictionAttributes.getAlgorithm()); assertEquals(expectedMaximum, evictionAttributes.getMaximum()); } - protected void assertExpirationAttributes(ExpirationAttributes expirationAttributes, - String description, int expectedTimeout, ExpirationAction expectedAction) { + private void assertExpirationAttributes(ExpirationAttributes expirationAttributes, + String description, int expectedTimeout, ExpirationAction expectedAction) { + assertNotNull(String.format("ExpirationAttributes for '%1$s' must not be null!", description), expirationAttributes); assertEquals(expectedAction, expirationAttributes.getAction()); assertEquals(expectedTimeout, expirationAttributes.getTimeout()); } - protected void assertGemFireComponent(Object gemfireComponent, String expectedName) { - assertNotNull("The GemFire component must not be null!", gemfireComponent); + private void assertGatewaySenders(Region region, List expectedGatewaySenderIds) { + + assertNotNull(region.getAttributes()); + assertNotNull(region.getAttributes().getGatewaySenderIds()); + assertEquals(expectedGatewaySenderIds.size(), region.getAttributes().getGatewaySenderIds().size()); + assertTrue(expectedGatewaySenderIds.containsAll(region.getAttributes().getGatewaySenderIds())); + } + + private void assertGemFireComponent(Object gemfireComponent, String expectedName) { + + assertNotNull("Component must not be null", gemfireComponent); assertEquals(expectedName, gemfireComponent.toString()); } - protected Collection toStrings(Object[] objects) { - List cacheListenerNames = new ArrayList(objects.length); + private Collection toStrings(Object[] objects) { + + List cacheListenerNames = new ArrayList<>(objects.length); for (Object object : objects) { cacheListenerNames.add(object.toString()); @@ -232,11 +246,13 @@ public class LookupRegionMutationIntegrationTest { public static final class TestCustomExpiry extends AbstractNameable implements CustomExpiry { - @Override public ExpirationAttributes getExpiry(Region.Entry entry) { + @Override + public ExpirationAttributes getExpiry(Region.Entry entry) { throw new UnsupportedOperationException("Not Implemented!"); } - @Override public void close() { } - } + @Override + public void close() { } + } } diff --git a/src/test/java/org/springframework/data/gemfire/LookupSubRegionTest.java b/src/test/java/org/springframework/data/gemfire/LookupSubRegionTest.java index 1bffe78d..30847c68 100644 --- a/src/test/java/org/springframework/data/gemfire/LookupSubRegionTest.java +++ b/src/test/java/org/springframework/data/gemfire/LookupSubRegionTest.java @@ -30,7 +30,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The LookupSubRegionTest class is a test suite of test cases testing the contract and functionality of Region lookups - * using Spring Data GemFire configuration and GemFire native cache.xml. + * using SDG configuration and Pivotal GemFirenative cache.xml. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/PartitionedRegionFactoryBeanTest.java b/src/test/java/org/springframework/data/gemfire/PartitionedRegionFactoryBeanTest.java index 2c277814..9bf343c1 100644 --- a/src/test/java/org/springframework/data/gemfire/PartitionedRegionFactoryBeanTest.java +++ b/src/test/java/org/springframework/data/gemfire/PartitionedRegionFactoryBeanTest.java @@ -134,7 +134,7 @@ public class PartitionedRegionFactoryBeanTest { factoryBean.resolveDataPolicy(mockRegionFactory, null, "REPLICATE"); } catch (IllegalArgumentException e) { - assertEquals("Data Policy 'REPLICATE' is not supported in Partitioned Regions.", e.getMessage()); + assertEquals("Data Policy [REPLICATE] is not supported in Partitioned Regions", e.getMessage()); throw e; } finally { diff --git a/src/test/java/org/springframework/data/gemfire/PdxDiskStoreIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/PdxDiskStoreIntegrationTest.java index f0f3ea46..bbaed7c5 100644 --- a/src/test/java/org/springframework/data/gemfire/PdxDiskStoreIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/PdxDiskStoreIntegrationTest.java @@ -31,9 +31,10 @@ import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.junit.runner.RunWith; +import org.springframework.data.gemfire.test.support.FileSystemUtils; import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; import org.springframework.util.Assert; /** @@ -48,42 +49,35 @@ import org.springframework.util.Assert; * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner * @since 1.3.3 */ +@RunWith(SpringRunner.class) @ContextConfiguration("/org/springframework/data/gemfire/pdxdiskstore-config.xml") @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD) -@RunWith(SpringJUnit4ClassRunner.class) public class PdxDiskStoreIntegrationTest { - protected static final int NUMBER_OF_REGION_ENTRIES = 1000; + private static final int NUMBER_OF_REGION_ENTRIES = 1000; @Resource(name = "pdxDataRegion") private Region, ValueHolder> pdxDataRegion; - protected static void assertRegionExists(final String expectedRegionName, final String expectedRegionPath, final Region region) { + private static void assertRegionExists(String expectedRegionName, String expectedRegionPath, Region region) { + assertNotNull(region); + assertEquals(String.format("Expected Region with name %1$s; but was %2$s!", expectedRegionName, region.getName()), expectedRegionName, region.getName()); + assertEquals(String.format("Expected Region with path %1$s; but was %2$s!", expectedRegionPath, region.getFullPath()), expectedRegionPath, region.getFullPath()); } - protected static boolean createDirectory(final File path) { - return (path != null && (path.isDirectory() || path.mkdirs())); + private static boolean createDirectory(final File path) { + return path != null && (path.isDirectory() || path.mkdirs()); } - protected static File createFile(final String pathname) { + private static File createFile(final String pathname) { return new File(pathname); } - protected static void deleteRecursive(final File path) { - if (path.isDirectory()) { - for (File file : path.listFiles()) { - deleteRecursive(file); - } - } - - path.delete(); - } - @BeforeClass public static void setupBeforeClass() { assertTrue(createDirectory(createFile("./gemfire/data-store"))); @@ -92,15 +86,15 @@ public class PdxDiskStoreIntegrationTest { @AfterClass public static void tearDownAfterClass() { - deleteRecursive(createFile("./gemfire")); + FileSystemUtils.deleteRecursive(createFile("./gemfire")); } @Before public void setup() { - assertNotNull("The PdxData GemFire Region was not created successfully!", pdxDataRegion); + + assertNotNull("PdxData Region was not created successfully", pdxDataRegion); if (pdxDataRegion.size() == 0) { - System.out.printf("Creating entries for Region (%1$s)...%n", pdxDataRegion.getName()); for (int index = 1; index <= NUMBER_OF_REGION_ENTRIES; index++) { pdxDataRegion.put(new KeyHolder("key" + index), new ValueHolder(index)); } @@ -135,11 +129,10 @@ public class PdxDiskStoreIntegrationTest { private T key; - public KeyHolder() { - } + public KeyHolder() { } public KeyHolder(final T key) { - Assert.notNull(key, "The key cannot be null!"); + Assert.notNull(key, "Key must not be null"); this.key = key; } @@ -153,7 +146,8 @@ public class PdxDiskStoreIntegrationTest { @Override public boolean equals(final Object obj) { - if (obj == this) { + + if (this == obj) { return true; } @@ -168,8 +162,11 @@ public class PdxDiskStoreIntegrationTest { @Override public int hashCode() { + int hashValue = 17; + hashValue = 37 * hashValue + hashCode(this.getKey()); + return hashValue; } @@ -184,8 +181,7 @@ public class PdxDiskStoreIntegrationTest { private T value; - public ValueHolder() { - } + public ValueHolder() { } public ValueHolder(final T value) { this.value = value; @@ -201,7 +197,8 @@ public class PdxDiskStoreIntegrationTest { @Override public boolean equals(final Object obj) { - if (obj == this) { + + if (this == obj) { return true; } @@ -216,8 +213,11 @@ public class PdxDiskStoreIntegrationTest { @Override public int hashCode() { + int hashValue = 17; + hashValue = 17 * hashValue + hashCode(this.getValue()); + return hashValue; } @@ -226,5 +226,4 @@ public class PdxDiskStoreIntegrationTest { return String.valueOf(getValue()); } } - } diff --git a/src/test/java/org/springframework/data/gemfire/RegionDataPolicyShortcutsIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/RegionDataPolicyShortcutsIntegrationTest.java index f4aa5db4..e4cb06bb 100644 --- a/src/test/java/org/springframework/data/gemfire/RegionDataPolicyShortcutsIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/RegionDataPolicyShortcutsIntegrationTest.java @@ -34,7 +34,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RegionShortcutsIntegrationTest class is a test suite of test cases testing the use of RegionShortcuts in the - * Spring Data GemFire XML Namespace! + * SDG XML Namespace! * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/SubRegionIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/SubRegionIntegrationTest.java index b2513079..514f9213 100644 --- a/src/test/java/org/springframework/data/gemfire/SubRegionIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/SubRegionIntegrationTest.java @@ -41,11 +41,11 @@ import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.gemfire.test.GemfireTestApplicationContextInitializer; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; /** * The SubRegionIntegrationTest class is a test suite of test cases testing the functionality of SubRegions in GemFire - * configured with Spring Data GemFire's XML namespace configuration meta-data. This test class tests a complex + * configured with SDG's XML namespace configuration meta-data. This test class tests a complex * SubRegion configuration in order to ensure functional completeness. * * @author John Blum @@ -56,8 +56,8 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; * @since 1.4.0 * @since 7.0.1 (GemFire) */ +@RunWith(SpringRunner.class) @ContextConfiguration(value = "complex-subregion.xml", initializers = GemfireTestApplicationContextInitializer.class) -@RunWith(SpringJUnit4ClassRunner.class) @SuppressWarnings("unused") public class SubRegionIntegrationTest { @@ -72,7 +72,8 @@ public class SubRegionIntegrationTest { @Test public void testGemFireAccountsSubRegionCreation() { - assertNotNull("The GemFire Cache was not properly initialized!", cache); + + assertNotNull("Cache was not properly initialized", cache); Region customers = cache.getRegion("Customers"); @@ -93,6 +94,7 @@ public class SubRegionIntegrationTest { @Test public void testSpringSubRegionConfiguration() { + assertNotNull("The /Customers/Accounts SubRegion was not properly initialized!", accounts); assertEquals("Accounts", accounts.getName()); assertEquals("/Customers/Accounts", accounts.getFullPath()); @@ -136,5 +138,4 @@ public class SubRegionIntegrationTest { assertNotNull(subscriptionAttributes); assertEquals(InterestPolicy.CACHE_CONTENT, subscriptionAttributes.getInterestPolicy()); } - } diff --git a/src/test/java/org/springframework/data/gemfire/cache/CachingWithGemFireIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/cache/CachingWithGemFireIntegrationTest.java index f6f324ba..53cdcf03 100644 --- a/src/test/java/org/springframework/data/gemfire/cache/CachingWithGemFireIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/cache/CachingWithGemFireIntegrationTest.java @@ -38,7 +38,7 @@ import org.springframework.util.Assert; /** * The CachingWithGemFireIntegrationTest class is a test suite of test cases testing the contract and functionality - * of Spring Framework's Cache Abstraction using GemFire as a caching provider applied with Spring Data GemFire. + * of Spring Framework's Cache Abstraction using Pivotal GemFireas a caching provider applied with SDG. * * @author John Blum * @see org.junit.Test @@ -73,7 +73,7 @@ public class CachingWithGemFireIntegrationTest { assertFalse(namedNumbersService.wasCacheMiss()); try { - namedNumbersRegion.put("eleven", null); // GemFire does not accept null values on put(key, value) + namedNumbersRegion.put("eleven", null); // Pivotal GemFiredoes not accept null values on put(key, value) } finally { assertTrue(namedNumbersRegion.containsKey("eleven")); diff --git a/src/test/java/org/springframework/data/gemfire/cache/CallableCacheLoaderAdapterTest.java b/src/test/java/org/springframework/data/gemfire/cache/CallableCacheLoaderAdapterTest.java index 1760400a..6bf617ca 100644 --- a/src/test/java/org/springframework/data/gemfire/cache/CallableCacheLoaderAdapterTest.java +++ b/src/test/java/org/springframework/data/gemfire/cache/CallableCacheLoaderAdapterTest.java @@ -38,7 +38,7 @@ import org.mockito.stubbing.Answer; /** * Unit tests to test the adaption of the {@link java.util.concurrent.Callable} - * into GemFire's {@link org.apache.geode.cache.CacheLoader} interface. + * into Pivotal GemFire's {@link org.apache.geode.cache.CacheLoader} interface. * * @author John Blum * @see org.junit.Rule diff --git a/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheManagerUnitTests.java b/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheManagerUnitTests.java index 271f4679..126b74ff 100644 --- a/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheManagerUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheManagerUnitTests.java @@ -17,10 +17,17 @@ package org.springframework.data.gemfire.cache; -import static org.assertj.core.api.Assertions.*; -import static org.hamcrest.Matchers.*; -import static org.mockito.ArgumentMatchers.*; -import static org.mockito.Mockito.*; +import static org.assertj.core.api.Assertions.assertThat; +import static org.hamcrest.Matchers.equalTo; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.nullValue; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; import java.util.Collection; import java.util.Collections; @@ -44,7 +51,7 @@ import org.springframework.cache.Cache; * @author John Blum * @see org.junit.Test * @see org.mockito.Mock - * @see org.mockito.runners.MockitoJUnitRunner + * @see org.mockito.junit.MockitoJUnitRunner * @since 1.9.0 */ @RunWith(MockitoJUnitRunner.class) @@ -66,20 +73,22 @@ public class GemfireCacheManagerUnitTests { cacheManager = new GemfireCacheManager(); } - protected Set asSet(T... elements) { + @SafeVarargs + private static Set asSet(T... elements) { Set set = new HashSet(elements.length); Collections.addAll(set, elements); return set; } @SuppressWarnings("unchecked") - protected Region mockRegion(String name) { + private Region mockRegion(String name) { Region mockRegion = mock(Region.class, name); when(mockRegion.getName()).thenReturn(name); return mockRegion; } - protected Region regionFor(Iterable> regions, String name) { + private Region regionFor(Iterable> regions, String name) { + for (Region region : regions) { if (region.getName().equals(name)) { return region; @@ -99,22 +108,24 @@ public class GemfireCacheManagerUnitTests { @Test public void assertGemFireCacheAvailableWithNullThrowsIllegalStateException() { + exception.expect(IllegalStateException.class); exception.expectCause(is(nullValue(Throwable.class))); - exception.expectMessage(is(equalTo("A GemFire cache instance is required"))); + exception.expectMessage(is(equalTo("A cache instance is required"))); cacheManager.assertGemFireCacheAvailable(null); } @Test public void assertGemFireCacheAvailableWithNamedClosedGemFireCacheThrowsIllegalStateException() { + when(mockGemFireCache.isClosed()).thenReturn(true); when(mockGemFireCache.getName()).thenReturn("Example"); try { exception.expect(IllegalStateException.class); exception.expectCause(is(nullValue(Throwable.class))); - exception.expectMessage(is(equalTo("GemFire cache [Example] has been closed"))); + exception.expectMessage(is(equalTo("The cache [Example] has been closed"))); cacheManager.assertGemFireCacheAvailable(mockGemFireCache); } @@ -126,6 +137,7 @@ public class GemfireCacheManagerUnitTests { @Test public void assertGemFireRegionAvailableWithAvailableGemFireRegionIsSuccessful() { + when(mockRegion.isDestroyed()).thenReturn(false); assertThat(cacheManager.assertGemFireRegionAvailable(mockRegion, "Example")).isSameAs(mockRegion); verify(mockRegion, times(1)).isDestroyed(); @@ -133,6 +145,7 @@ public class GemfireCacheManagerUnitTests { @Test public void assertGemFireRegionAvailableWithNullThrowIllegalStateException() { + exception.expect(IllegalStateException.class); exception.expectCause(is(nullValue(Throwable.class))); exception.expectMessage(is(equalTo("No Region for cache name [Example] was found"))); @@ -142,6 +155,7 @@ public class GemfireCacheManagerUnitTests { @Test public void assertGemFireRegionAvailableWithDestroyedGemFireRegionThrowIllegalStateException() { + when(mockRegion.isDestroyed()).thenReturn(true); try { @@ -159,6 +173,7 @@ public class GemfireCacheManagerUnitTests { @Test @SuppressWarnings("unchecked") public void loadCachesIsSuccessful() { + Set> regions = asSet(mockRegion("one"), mockRegion("two"), mockRegion("three")); cacheManager.setRegions(regions); @@ -176,6 +191,7 @@ public class GemfireCacheManagerUnitTests { @Test public void resolveRegionsReturnsGivenRegions() { + Set> regions = asSet(mockRegion("one"), mockRegion("two")); assertThat(cacheManager.resolveRegions(mockGemFireCache, regions, asSet("three", "four"))).isSameAs(regions); @@ -188,6 +204,7 @@ public class GemfireCacheManagerUnitTests { @Test @SuppressWarnings("unchecked") public void resolveRegionsReturnsRegionsForCacheNamesOnly() { + Region mockRegionOne = mockRegion("one"); Region mockRegionTwo = mockRegion("two"); @@ -208,6 +225,7 @@ public class GemfireCacheManagerUnitTests { @Test public void resolveRegionsReturnsGemFireCacheRootRegions() { + Set> rootRegions = asSet(mockRegion("one"), mockRegion("two")); when(mockGemFireCache.rootRegions()).thenReturn(rootRegions); @@ -237,6 +255,7 @@ public class GemfireCacheManagerUnitTests { @Test @SuppressWarnings("unchecked") public void regionForCacheNameReturnsRegion() { + when(mockGemFireCache.isClosed()).thenReturn(false); when(mockGemFireCache.getName()).thenReturn("regionForCacheNameReturnsRegion"); when(mockGemFireCache.getRegion(eq("Example"))).thenReturn(mockRegion); @@ -253,6 +272,7 @@ public class GemfireCacheManagerUnitTests { @Test @SuppressWarnings("unchecked") public void getMissingCacheReturnsMissingCache() { + Region mockRegion = mockRegion("missing"); when(mockGemFireCache.getRegion(eq("missing"))).thenReturn(mockRegion); @@ -269,7 +289,8 @@ public class GemfireCacheManagerUnitTests { @Test public void getMissingCacheReturnsNull() { - cacheManager.setRegions(Collections.>singleton(mockRegion("one"))); + + cacheManager.setRegions(Collections.singleton(mockRegion("one"))); cacheManager.afterPropertiesSet(); assertThat(cacheManager.isDynamic()).isFalse(); @@ -278,6 +299,7 @@ public class GemfireCacheManagerUnitTests { @Test public void setAndGetCache() { + assertThat(cacheManager.getCache()).isNull(); cacheManager.setCache(mockGemFireCache); @@ -291,6 +313,7 @@ public class GemfireCacheManagerUnitTests { @Test public void setAndGetCacheNames() { + Set> regions = asSet(mockRegion("one"), mockRegion("two")); cacheManager.setRegions(regions); @@ -301,6 +324,7 @@ public class GemfireCacheManagerUnitTests { @Test public void setAndGetRegions() { + Set> regions = asSet(mockRegion("one"), mockRegion("two")); assertThat(cacheManager.getRegions()).isNull(); diff --git a/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheUnitTests.java b/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheUnitTests.java index 7c69b5b4..0684ab29 100644 --- a/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/cache/GemfireCacheUnitTests.java @@ -75,9 +75,10 @@ public class GemfireCacheUnitTests { @Test public void constructGemfireCacheWithNullRegion() { + exception.expect(IllegalArgumentException.class); exception.expectCause(is(nullValue(Throwable.class))); - exception.expectMessage(is(equalTo("GemFire Region must not be null"))); + exception.expectMessage(is(equalTo("Region must not be null"))); new GemfireCache(null); } diff --git a/src/test/java/org/springframework/data/gemfire/client/ClientCacheIndexingTest.java b/src/test/java/org/springframework/data/gemfire/client/ClientCacheIndexingTest.java index d93663b1..f9db25ce 100644 --- a/src/test/java/org/springframework/data/gemfire/client/ClientCacheIndexingTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/ClientCacheIndexingTest.java @@ -47,7 +47,7 @@ import org.springframework.util.Assert; /** * The ClientCacheIndexingTest class is a test suite of test cases testing the creation and application of indexes - * on client Regions of a GemFire ClientCache using the <gfe:index/> tag element in the Spring Data GemFire + * on client Regions of a Pivotal GemFireClientCache using the <gfe:index/> tag element in the SDG * XML namespace and configuration meta-data, which is backed by the IndexFactoryBean. * * @author John Blum @@ -77,13 +77,15 @@ public class ClientCacheIndexingTest { @BeforeClass public static void setup() throws IOException { + String serverName = "GemFireIndexingCacheServer"; File serverWorkingDirectory = new File(FileSystemUtils.WORKING_DIRECTORY, serverName.toLowerCase()); - Assert.isTrue(serverWorkingDirectory.isDirectory() || serverWorkingDirectory.mkdirs()); + Assert.isTrue(serverWorkingDirectory.isDirectory() || serverWorkingDirectory.mkdirs(), + String.format("Working directory [%s] could not be created", serverWorkingDirectory)); - List arguments = new ArrayList(); + List arguments = new ArrayList<>(); arguments.add("-Dgemfire.name=" + serverName); arguments.add("/org/springframework/data/gemfire/client/ClientCacheIndexingTest-server-context.xml"); @@ -97,6 +99,7 @@ public class ClientCacheIndexingTest { } private static void waitForServerStart(final long milliseconds) { + ThreadUtils.timedWait(milliseconds, TimeUnit.MILLISECONDS.toMillis(500), new ThreadUtils.WaitCondition() { private File serverPidControlFile = new File(serverProcess.getWorkingDirectory(), ServerProcess.getServerProcessControlFilename()); @@ -109,6 +112,7 @@ public class ClientCacheIndexingTest { @AfterClass public static void tearDown() { + serverProcess.shutdown(); if (Boolean.valueOf(System.getProperty("spring.gemfire.fork.clean", Boolean.TRUE.toString()))) { @@ -116,9 +120,10 @@ public class ClientCacheIndexingTest { } } - protected Index getIndex(final GemFireCache gemfireCache, final String indexName) { - QueryService queryService = (gemfireCache instanceof ClientCache - ? ((ClientCache) gemfireCache).getLocalQueryService() : gemfireCache.getQueryService()); + private Index getIndex(GemFireCache gemfireCache, String indexName) { + + QueryService queryService = gemfireCache instanceof ClientCache + ? ((ClientCache) gemfireCache).getLocalQueryService() : gemfireCache.getQueryService(); for (Index index : queryService.getIndexes()) { if (index.getName().equals(indexName)) { @@ -132,7 +137,8 @@ public class ClientCacheIndexingTest { @Test @SuppressWarnings("deprecation") public void testIndexByName() { - assertNotNull("The GemFire ClientCache was not properly configured and initialized!", clientCache); + + assertNotNull("ClientCache was not properly configured and initialized", clientCache); Index actualIndex = getIndex(clientCache, "ExampleIndex"); @@ -141,5 +147,4 @@ public class ClientCacheIndexingTest { assertEquals(IndexType.HASH, actualIndex.getType()); assertSame(exampleIndex, actualIndex); } - } diff --git a/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest.java b/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest.java index ea383040..7cc19721 100644 --- a/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest.java @@ -85,9 +85,6 @@ public class ClientCacheVariableLocatorsTest { arguments.toArray(new String[arguments.size()])); waitForServerToStart(TimeUnit.SECONDS.toMillis(20)); - - System.out.printf("Spring-based, GemFire Cache Server process for %1$s should be running...%n", - ClientCacheVariableLocatorsTest.class.getSimpleName()); } private static void waitForServerToStart(final long milliseconds) { @@ -131,5 +128,4 @@ public class ClientCacheVariableLocatorsTest { cacheMissCounter.set(0); } } - } diff --git a/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableServersTest.java b/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableServersTest.java index 9a87f451..0c65b394 100644 --- a/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableServersTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/ClientCacheVariableServersTest.java @@ -85,9 +85,6 @@ public class ClientCacheVariableServersTest { arguments.toArray(new String[arguments.size()])); waitForServerToStart(TimeUnit.SECONDS.toMillis(20)); - - System.out.printf("Spring-based, GemFire Cache Server process for %1$s should be running...%n", - ClientCacheVariableServersTest.class.getSimpleName()); } private static void waitForServerToStart(final long milliseconds) { @@ -131,5 +128,4 @@ public class ClientCacheVariableServersTest { cacheMissCounter.set(0); } } - } diff --git a/src/test/java/org/springframework/data/gemfire/client/ClientRegionWithCacheLoaderWriterTest.java b/src/test/java/org/springframework/data/gemfire/client/ClientRegionWithCacheLoaderWriterTest.java index ebd3813f..d9f37d1b 100644 --- a/src/test/java/org/springframework/data/gemfire/client/ClientRegionWithCacheLoaderWriterTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/ClientRegionWithCacheLoaderWriterTest.java @@ -41,7 +41,7 @@ import org.springframework.test.context.junit4.SpringRunner; /** * The ClientRegionWithCacheLoaderWriterTest class is a test suite of test cases testing the addition of CacheLoaders - * and CacheWriters to a client, local Region inside a GemFire Cache. + * and CacheWriters to a client, local Region inside a Pivotal GemFireCache. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/client/ClientSubRegionIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/client/ClientSubRegionIntegrationTests.java index d6bdb674..4536b1d5 100644 --- a/src/test/java/org/springframework/data/gemfire/client/ClientSubRegionIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/client/ClientSubRegionIntegrationTests.java @@ -35,7 +35,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * Integration test testing {@link Region sub-Region} functionality from a GemFire cache client. + * Integration test testing {@link Region sub-Region} functionality from a Pivotal GemFirecache client. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/client/DurableClientCacheIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/client/DurableClientCacheIntegrationTest.java index 163097a4..7e903e72 100644 --- a/src/test/java/org/springframework/data/gemfire/client/DurableClientCacheIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/DurableClientCacheIntegrationTest.java @@ -65,8 +65,8 @@ import org.springframework.util.Assert; import org.springframework.util.SocketUtils; /** - * The DurableClientCacheIntegrationTest class is a test suite of test cases testing GemFire's Durable Client - * functionality in the context of Spring Data GemFire. + * The DurableClientCacheIntegrationTest class is a test suite of test cases testing Pivotal GemFire's Durable Client + * functionality in the context of SDG. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTest.java index 31ef9aa4..5ab6c231 100644 --- a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTest.java @@ -50,8 +50,8 @@ import org.springframework.util.Assert; /** * The GemFireDataSourceIntegrationTest class is a test suite of test cases testing the contract and functionality - * of the <gfe-data:datasource> element in the context of a GemFire cluster running both native, - * non-Spring configured GemFire Server(s) in addition to Spring configured and bootstrapped GemFire Server(s). + * of the <gfe-data:datasource> element in the context of a Pivotal GemFirecluster running both native, + * non-Spring configured Pivotal GemFireServer(s) in addition to Spring configured and bootstrapped Pivotal GemFireServer(s). * * @author John Blum * @see org.junit.Test @@ -105,8 +105,6 @@ public class GemFireDataSourceIntegrationTest { arguments.toArray(new String[arguments.size()])); waitForProcessStart(TimeUnit.SECONDS.toMillis(20), serverProcess, ServerProcess.getServerProcessControlFilename()); - - System.out.println("Spring configured/bootstrapped GemFire Cache Server Process for ClientCache DataSource Test should be running..."); } private static void waitForProcessStart(final long milliseconds, final ProcessWrapper process, final String processControlFilename) { @@ -145,5 +143,4 @@ public class GemFireDataSourceIntegrationTest { assertRegion(clientServerRegion, "ClientServerRegion"); assertRegion(serverOnlyRegion, "ServerOnlyRegion"); } - } diff --git a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTests.java index f757c3be..5f08bd86 100644 --- a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceIntegrationTests.java @@ -37,7 +37,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * Integration tests for a GemFire DataSource. + * Integration tests for a Pivotal GemFireDataSource. * * @author David Turanski * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceUsingNonSpringConfiguredGemFireServerIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceUsingNonSpringConfiguredGemFireServerIntegrationTest.java index 74349f61..e00f8acb 100644 --- a/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceUsingNonSpringConfiguredGemFireServerIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/GemFireDataSourceUsingNonSpringConfiguredGemFireServerIntegrationTest.java @@ -56,7 +56,7 @@ import org.springframework.util.StringUtils; /** * The GemFireDataSourceUsingNonSpringConfiguredGemFireServerIntegrationTest class is a test suite of test cases * testing the contract and functionality of the GemfireDataSourcePostProcessor using the <gfe-data:datasource> - * element in Spring config to setup a GemFire ClientCache connecting to a native, non-Spring configured GemFire Server + * element in Spring config to setup a Pivotal GemFireClientCache connecting to a native, non-Spring configured Pivotal GemFireServer * as the DataSource to assert that client Region Proxies are registered as Spring beans * in the Spring ApplicationContext correctly. * diff --git a/src/test/java/org/springframework/data/gemfire/client/SpringJavaConfiguredClientCacheIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/client/SpringJavaConfiguredClientCacheIntegrationTest.java index f250260f..3e380705 100644 --- a/src/test/java/org/springframework/data/gemfire/client/SpringJavaConfiguredClientCacheIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/SpringJavaConfiguredClientCacheIntegrationTest.java @@ -35,7 +35,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The SpringJavaConfiguredClientCacheIntegrationTest class is a test suite of test cases testing - * the proper configuration of a GemFire ClientCache instance using Spring Java-based configuration meta-data. + * the proper configuration of a Pivotal GemFireClientCache instance using Spring Java-based configuration meta-data. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunctionTest.java b/src/test/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunctionTest.java index cd711c69..eb2a78d6 100644 --- a/src/test/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunctionTest.java +++ b/src/test/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunctionTest.java @@ -38,7 +38,7 @@ import org.mockito.stubbing.Answer; /** * The ListRegionsOnServerFunctionTest class is a test suite of test cases testing the contract and functionality - * of the ListRegionsOnServerFunction GemFire Function class. + * of the ListRegionsOnServerFunction Pivotal GemFireFunction class. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspectUnitTests.java b/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspectUnitTests.java index cc94bbea..0ccaf73f 100644 --- a/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspectUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionAcquiringAspectUnitTests.java @@ -96,7 +96,7 @@ public class GemFireAsLastResourceConnectionAcquiringAspectUnitTests { verify(aspect, times(1)).resolveGemFireJcaResourceAdapterJndiName(); verify(mockGemFireConnectionFactory, times(1)).getConnection(); verify(mockLogger, times(1)) - .trace(eq(String.format("Acquiring GemFire Connection from GemFire JCA ResourceAdapter registered at [%s]...", + .trace(eq(String.format("Acquiring Pivotal GemFire Connection from Pivotal GemFire JCA ResourceAdapter registered at [%s]...", GemFireAsLastResourceConnectionAcquiringAspect.DEFAULT_GEMFIRE_JCA_RESOURCE_ADAPTER_JNDI_NAME))); } diff --git a/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspectUnitTests.java b/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspectUnitTests.java index 255c21dd..dace86ea 100644 --- a/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspectUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/config/annotation/support/GemFireAsLastResourceConnectionClosingAspectUnitTests.java @@ -75,9 +75,9 @@ public class GemFireAsLastResourceConnectionClosingAspectUnitTests { when(mockLogger.isTraceEnabled()).thenReturn(true); - aspect.doGemFireConnectionClose();; + aspect.doGemFireConnectionClose(); verify(mockGemFireConnection, times(1)).close(); - verify(mockLogger, times(1)).trace(eq("Closing GemFire Connection...")); + verify(mockLogger, times(1)).trace(eq("Closing Pivotal GemFire Connection...")); } } diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/CacheServerNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/CacheServerNamespaceTest.java index 800ed278..3ffa49ef 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/CacheServerNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/CacheServerNamespaceTest.java @@ -33,7 +33,7 @@ import org.springframework.util.StringUtils; /** * The CacheServerNamespaceTest class is a test suite of test cases testing the functionality of the SDG XML namespace - * when configuring a GemFire Cache Servers and Client Subscription. + * when configuring a Pivotal GemFireCache Servers and Client Subscription. * * @author Costin Leau * @author David Turanski diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/CacheUsingPdxNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/CacheUsingPdxNamespaceTest.java index 60bb5e77..3ea2523e 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/CacheUsingPdxNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/CacheUsingPdxNamespaceTest.java @@ -33,7 +33,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** - * The CacheUsingPdxNamespaceTest class is a test suite of test case testing the Spring Data GemFire XML namespace + * The CacheUsingPdxNamespaceTest class is a test suite of test case testing the SDG XML namespace * when PDX is configured in GemFire. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/ClientCacheNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/ClientCacheNamespaceTest.java index d15f94c6..ad4b701a 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/ClientCacheNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/ClientCacheNamespaceTest.java @@ -34,7 +34,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The ClientCacheNamespaceTest class is a test suite of test cases testing the contract and functionality - * of the Spring Data GemFire ClientCacheParser. + * of the SDG ClientCacheParser. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/ClientRegionNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/ClientRegionNamespaceTest.java index 4b3ce6a9..bc5efe3f 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/ClientRegionNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/ClientRegionNamespaceTest.java @@ -69,7 +69,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; import org.springframework.util.ObjectUtils; /** - * Unit tests for Spring Data GemFire's XML namespace support for client {@link Region Regions}. + * Unit tests for SDG's XML namespace support for client {@link Region Regions}. * * @author Costin Leau * @author David Turanski diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreAndEvictionRegionParsingTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreAndEvictionRegionParsingTest.java index 1b4728c3..40671828 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreAndEvictionRegionParsingTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreAndEvictionRegionParsingTest.java @@ -155,7 +155,7 @@ public class DiskStoreAndEvictionRegionParsingTest { EvictionAttributes evicAttr = attrs.getEvictionAttributes(); assertEquals(EvictionAction.LOCAL_DESTROY, evicAttr.getAction()); assertEquals(EvictionAlgorithm.LRU_MEMORY, evicAttr.getAlgorithm()); - // for some reason GemFire resets this to 56 on my machine (not sure + // for some reason Pivotal GemFireresets this to 56 on my machine (not sure // why) // assertEquals(10, evicAttr.getMaximum()); ObjectSizer sizer = evicAttr.getObjectSizer(); diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreNamespaceTest.java index c873c433..0ac30cb0 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/DiskStoreNamespaceTest.java @@ -33,7 +33,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The DiskStoreNamespaceTest class is a test suite of test cases testing the contract and functionality of using - * Spring Data GemFire's XML namespace to configure GemFire Disk Stores. + * SDG's XML namespace to configure Pivotal GemFireDisk Stores. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverAutoStartNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverAutoStartNamespaceTest.java index 1be08711..faf85d52 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverAutoStartNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverAutoStartNamespaceTest.java @@ -34,7 +34,7 @@ import org.springframework.util.StringUtils; /** * The GatewayReceiverAutoStartNamespaceTest class is a test suite of test cases testing the contract - * and functionality of Gateway Receiver configuration in Spring Data GemFire using the XML namespace (XSD). + * and functionality of Gateway Receiver configuration in SDG using the XML namespace (XSD). * This test class tests the auto start configuration of the GatewayReceiver Gemfire Component in SDG. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverDefaultStartNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverDefaultStartNamespaceTest.java index f307b960..52c9cc30 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverDefaultStartNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverDefaultStartNamespaceTest.java @@ -34,7 +34,7 @@ import org.springframework.util.StringUtils; /** * The GatewayReceiverDefaultStartNamespaceTest class is a test suite of test cases testing the contract - * and functionality of Gateway Receiver configuration in Spring Data GemFire using the XML namespace (XSD). + * and functionality of Gateway Receiver configuration in SDG using the XML namespace (XSD). * This test class tests the default start configuration of the GatewayReceiver Gemfire Component in SDG. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverManualStartNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverManualStartNamespaceTest.java index a7768e4e..9c2513d9 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverManualStartNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/GatewayReceiverManualStartNamespaceTest.java @@ -33,7 +33,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The GatewayReceiverManualStartNamespaceTest class is a test suite of test cases testing the contract - * and functionality of Gateway Receiver configuration in Spring Data GemFire using the XML namespace (XSD). + * and functionality of Gateway Receiver configuration in SDG using the XML namespace (XSD). * This test class tests the manual start configuration of the GatewayReceiver Gemfire Component in SDG. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/GemfireV8GatewayNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/GemfireV8GatewayNamespaceTest.java index cd82d20f..a66d8904 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/GemfireV8GatewayNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/GemfireV8GatewayNamespaceTest.java @@ -34,7 +34,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The GemfireV8GatewayNamespaceTest class is a test suite of test cases testing the contract and functionality of - * GemFire 8 Gateway Sender/Receiver support. + * Pivotal GemFire8 Gateway Sender/Receiver support. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/IndexNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/IndexNamespaceTest.java index a492c04b..2c086ee7 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/IndexNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/IndexNamespaceTest.java @@ -33,8 +33,8 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * Integration tests with test cases testing the functionality of GemFire Index creation using - * the Spring Data GemFire XML namespace (XSD) and the {@link IndexParser}. + * Integration tests with test cases testing the functionality of Pivotal GemFireIndex creation using + * the SDG XML namespace (XSD) and the {@link IndexParser}. * * @author Costin Leau * @author David Turanski diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/RegionDefinitionUsingBeansNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/RegionDefinitionUsingBeansNamespaceTest.java index 390b0aa1..dbcda6e3 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/RegionDefinitionUsingBeansNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/RegionDefinitionUsingBeansNamespaceTest.java @@ -38,7 +38,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RawRegionBeanDefinitionTest class is a test suite of test cases testing the contract and functionality - * of the SDG RegionFactoryBean class, and specifically the specification of the GemFire Region DataPolicy, + * of the SDG RegionFactoryBean class, and specifically the specification of the Pivotal GemFireRegion DataPolicy, * when used as raw bean definition in Spring XML configuration meta-data. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/RegionSubscriptionAttributesNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/RegionSubscriptionAttributesNamespaceTest.java index 31324807..78de5d8f 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/RegionSubscriptionAttributesNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/RegionSubscriptionAttributesNamespaceTest.java @@ -32,7 +32,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RegionSubscriptionAttributesNamespaceTest class is a test suite of test cases testing the contract - * and functionality of declaring and defining Subscription Attributes for a Region in the Spring Data GemFire + * and functionality of declaring and defining Subscription Attributes for a Region in the SDG * XML namespace (XSD) configuration meta-data. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/RegionWithSubRegionBeanDefinitionHashCodeTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/RegionWithSubRegionBeanDefinitionHashCodeTest.java index a53169b6..46f583b6 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/RegionWithSubRegionBeanDefinitionHashCodeTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/RegionWithSubRegionBeanDefinitionHashCodeTest.java @@ -30,7 +30,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RegionWithSubRegionBeanDefinitionHashCodeTest class is a test suite for testing the hashCode() method of a - * Spring container BeanDefinition representing a GemFire Region having SubRegions. This test suite is meant to + * Spring container BeanDefinition representing a Pivotal GemFireRegion having SubRegions. This test suite is meant to * ensure the correct behavior of and provide regression coverage for, JIRA issue SGF-178, "parent attribute causes * endless loop in hashCode". * diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/RegionsWithDiskStoreAndPersistenceEvictionSettingsTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/RegionsWithDiskStoreAndPersistenceEvictionSettingsTest.java index 8e370524..6e351c8c 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/RegionsWithDiskStoreAndPersistenceEvictionSettingsTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/RegionsWithDiskStoreAndPersistenceEvictionSettingsTest.java @@ -33,7 +33,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RegionsWithDiskStoreAndPersistenceEvictionSettingsTest class is a test suite testing the functionality - * of GemFire Cache Regions when persistent/non-persistent with and without Eviction settings when specifying a + * of Pivotal GemFireCache Regions when persistent/non-persistent with and without Eviction settings when specifying a * Disk Store. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionNamespaceTest.java index b9730a41..34f20355 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionNamespaceTest.java @@ -35,7 +35,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The SubRegionNamespaceTest class is a test suite of test cases testing the contract and functionality of - * Region/SubRegion creation in a GemFire Cache. + * Region/SubRegion creation in a Pivotal GemFireCache. * * @author David Turanski * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionSubElementNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionSubElementNamespaceTest.java index d5d6927d..183e86c8 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionSubElementNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionSubElementNamespaceTest.java @@ -66,6 +66,7 @@ public class SubRegionSubElementNamespaceTest { @Test public void testCustomersAccountsSubRegionCacheListener() { + assertNotNull(customersAccountsRegion); assertNotNull(customersAccountsRegion.getAttributes()); assertNotNull(customersAccountsRegion.getAttributes().getCacheListeners()); @@ -76,12 +77,13 @@ public class SubRegionSubElementNamespaceTest { found |= (listener instanceof TestNoOpCacheListener); } - assertTrue(String.format("Expected a GemFire CacheListener of type (%1$s) to be registered on Region (%2$s)!", + assertTrue(String.format("Expected a CacheListener of type (%1$s) to be registered on Region (%2$s)!", TestNoOpCacheListener.class.getName(), customersAccountsRegion.getName()), found); } @Test public void testOrderItemsSubRegionGatewaySender() { + assertNotNull(orderItemsRegion); assertNotNull(orderItemsRegion.getAttributes()); assertNotNull(orderItemsRegion.getAttributes().getGatewaySenderIds()); @@ -90,14 +92,14 @@ public class SubRegionSubElementNamespaceTest { @Test public void testParentChildSubRegionAsyncEventQueue() { + assertNotNull(parentChildRegion); assertNotNull(parentChildRegion.getAttributes()); assertNotNull(parentChildRegion.getAttributes().getAsyncEventQueueIds()); assertTrue(parentChildRegion.getAttributes().getAsyncEventQueueIds().contains("testQueue")); } - public static final class TestNoOpCacheListener extends CacheListenerAdapter { - } + public static final class TestNoOpCacheListener extends CacheListenerAdapter { } public static final class TestNoOpAsyncEventListener implements AsyncEventListener { @@ -107,8 +109,6 @@ public class SubRegionSubElementNamespaceTest { } @Override - public void close() { - } + public void close() { } } - } diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionWithInvalidDataPolicyTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionWithInvalidDataPolicyTest.java index f6925655..fe5dcc0b 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionWithInvalidDataPolicyTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/SubRegionWithInvalidDataPolicyTest.java @@ -27,13 +27,13 @@ import org.xml.sax.SAXParseException; /** * The SubRegionWithInvalidDataPolicyTest class is a test suite of test cases testing the data-policy and persistent - * attributes settings are consistent for GemFire SubRegion bean definitions. + * attributes settings are consistent for Pivotal GemFireSubRegion bean definitions. * * @author John Blum * @see org.junit.Test * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner - * @since GemFire 7.0.1 - * @since Spring Data GemFire 1.4.0 + * @since Pivotal GemFire7.0.1 + * @since SDG 1.4.0 */ public class SubRegionWithInvalidDataPolicyTest { diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/TemplateClientRegionNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/TemplateClientRegionNamespaceTest.java index 9585f4cb..eda1bd6c 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/TemplateClientRegionNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/TemplateClientRegionNamespaceTest.java @@ -49,7 +49,7 @@ import org.springframework.util.StringUtils; /** * The TemplateClientRegionNamespaceTest class is a test suite of test cases testing the contract and functionality - * of Client Region Templates using Spring Data GemFire XML namespace configuration meta-data. + * of Client Region Templates using SDG XML namespace configuration meta-data. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/TemplatePersistentPartitionRegionNamespaceTest.java b/src/test/java/org/springframework/data/gemfire/config/xml/TemplatePersistentPartitionRegionNamespaceTest.java index 0f3f6d06..f070db0b 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/TemplatePersistentPartitionRegionNamespaceTest.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/TemplatePersistentPartitionRegionNamespaceTest.java @@ -41,7 +41,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The PersistentPartitionRegionTemplateTest class is a test suite of test cases testing the functionality of - * Spring Data GemFire's Region templates with a 'persistent', PARTITION Region configuration. + * SDG's Region templates with a 'persistent', PARTITION Region configuration. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/config/xml/TemplateRegionsNamespaceTests.java b/src/test/java/org/springframework/data/gemfire/config/xml/TemplateRegionsNamespaceTests.java index 3a615fe4..47cbfc01 100644 --- a/src/test/java/org/springframework/data/gemfire/config/xml/TemplateRegionsNamespaceTests.java +++ b/src/test/java/org/springframework/data/gemfire/config/xml/TemplateRegionsNamespaceTests.java @@ -71,7 +71,7 @@ import org.springframework.util.StringUtils; /** * The TemplateRegionsNamespaceTests class is a test suite of test cases testing the functionality and support for - * Region Templating in Spring Data GemFire. + * Region Templating in SDG. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/dao/GemfireDaoSupportUnitTests.java b/src/test/java/org/springframework/data/gemfire/dao/GemfireDaoSupportUnitTests.java index e7a270e3..3715a056 100644 --- a/src/test/java/org/springframework/data/gemfire/dao/GemfireDaoSupportUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/dao/GemfireDaoSupportUnitTests.java @@ -52,6 +52,7 @@ public class GemfireDaoSupportUnitTests { @Test public void setAndGetGemfireTemplate() { + GemfireTemplate expectedGemfireTemplate = new GemfireTemplate(mockRegion); GemfireDaoSupport dao = new TestGemfireDaoSupport(); @@ -68,6 +69,7 @@ public class GemfireDaoSupportUnitTests { @Test public void setRegion() { + GemfireDaoSupport dao = new TestGemfireDaoSupport(); dao.setRegion(mockRegion); @@ -82,6 +84,7 @@ public class GemfireDaoSupportUnitTests { @Test @SuppressWarnings("rawtypes") public void createProperlyInitializedGemfireDaoSupportWithTemplate() throws Exception { + GemfireTemplate expectedGemfireTemplate = new GemfireTemplate(); GemfireDaoSupport dao = new TestGemfireDaoSupport(); @@ -94,9 +97,10 @@ public class GemfireDaoSupportUnitTests { @Test public void invalidGemfireDaoSupportInstanceThrowsIllegalStateException() throws Exception { + exception.expect(IllegalStateException.class); exception.expectCause(is(nullValue(Throwable.class))); - exception.expectMessage("A GemFire Cache Region or instance of GemfireTemplate is required"); + exception.expectMessage("A Cache Region or instance of GemfireTemplate is required"); new TestGemfireDaoSupport().afterPropertiesSet(); } diff --git a/src/test/java/org/springframework/data/gemfire/fork/GemFireBasedServerProcess.java b/src/test/java/org/springframework/data/gemfire/fork/GemFireBasedServerProcess.java index 6223d60b..9ed783a0 100644 --- a/src/test/java/org/springframework/data/gemfire/fork/GemFireBasedServerProcess.java +++ b/src/test/java/org/springframework/data/gemfire/fork/GemFireBasedServerProcess.java @@ -24,8 +24,8 @@ import org.springframework.data.gemfire.process.support.ProcessUtils; import org.springframework.data.gemfire.test.support.FileSystemUtils; /** - * The {@link GemFireBasedServerProcess} class is a main Java class used to launch a GemFire Server - * using GemFire's {@link ServerLauncher} API. + * The {@link GemFireBasedServerProcess} class is a main Java class used to launch a Pivotal GemFireServer + * using Pivotal GemFire's {@link ServerLauncher} API. * * @author John Blum * @see org.apache.geode.distributed.ServerLauncher @@ -52,7 +52,7 @@ public class GemFireBasedServerProcess { private static ServerLauncher runServer(String[] args) { ServerLauncher serverLauncher = buildServerLauncher(args); - // start the GemFire Server process... + // start the Pivotal GemFireServer process... serverLauncher.start(); return serverLauncher; diff --git a/src/test/java/org/springframework/data/gemfire/fork/ServerProcess.java b/src/test/java/org/springframework/data/gemfire/fork/ServerProcess.java index d465e552..44dca9ef 100644 --- a/src/test/java/org/springframework/data/gemfire/fork/ServerProcess.java +++ b/src/test/java/org/springframework/data/gemfire/fork/ServerProcess.java @@ -28,8 +28,8 @@ import org.springframework.data.gemfire.test.support.FileSystemUtils; import org.springframework.util.Assert; /** - * The ServerProcess class is a main Java class using Spring Data GemFire to configure and bootstrap - * a GemFire Cache Server process. + * The ServerProcess class is a main Java class using SDG to configure and bootstrap + * a Pivotal GemFireCache Server process. * * @author John Blum * @see org.springframework.context.ConfigurableApplicationContext diff --git a/src/test/java/org/springframework/data/gemfire/function/ClientCacheFunctionExecutionWithPdxIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/function/ClientCacheFunctionExecutionWithPdxIntegrationTest.java index ebdbfc94..257b8447 100644 --- a/src/test/java/org/springframework/data/gemfire/function/ClientCacheFunctionExecutionWithPdxIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/function/ClientCacheFunctionExecutionWithPdxIntegrationTest.java @@ -52,7 +52,7 @@ import org.springframework.util.ObjectUtils; /** * The ClientCacheFunctionExecutionWithPdxIntegrationTest class is a test suite of test cases testing Spring Data - * GemFire's Function annotation support and interaction between a GemFire client and server Cache + * Pivotal GemFire's Function annotation support and interaction between a Pivotal GemFireclient and server Cache * when PDX is configured and read-serialized is set to true. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/function/ExceptionThrowingFunctionExecutionIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/function/ExceptionThrowingFunctionExecutionIntegrationTest.java index 2b49ac18..90457ffd 100644 --- a/src/test/java/org/springframework/data/gemfire/function/ExceptionThrowingFunctionExecutionIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/function/ExceptionThrowingFunctionExecutionIntegrationTest.java @@ -47,7 +47,7 @@ import org.springframework.util.Assert; /** * The ExceptionThrowingFunctionExecutionIntegrationTest class is a test suite of test cases testing the invocation - * of a GemFire Function using Spring Data GemFire Function Execution Annotation support when that Function throws + * of a Pivotal GemFireFunction using SDG Function Execution Annotation support when that Function throws * an Exception. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/function/execution/FunctionIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/function/execution/FunctionIntegrationTests.java index 16258770..0431f522 100644 --- a/src/test/java/org/springframework/data/gemfire/function/execution/FunctionIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/function/execution/FunctionIntegrationTests.java @@ -143,7 +143,7 @@ public class FunctionIntegrationTests extends ClientServerIntegrationTestsSuppor } /* - * This gets wrapped in a GemFire Function and registered on the forked server. + * This gets wrapped in a Pivotal GemFireFunction and registered on the forked server. */ @Component @SuppressWarnings("unused") diff --git a/src/test/java/org/springframework/data/gemfire/function/sample/ApplicationDomainFunctionExecutions.java b/src/test/java/org/springframework/data/gemfire/function/sample/ApplicationDomainFunctionExecutions.java index 291e4fa3..df6d4323 100644 --- a/src/test/java/org/springframework/data/gemfire/function/sample/ApplicationDomainFunctionExecutions.java +++ b/src/test/java/org/springframework/data/gemfire/function/sample/ApplicationDomainFunctionExecutions.java @@ -21,8 +21,8 @@ import org.springframework.data.gemfire.function.ClientCacheFunctionExecutionWit import org.springframework.data.gemfire.function.annotation.OnServer; /** - * The ApplicationDomainFunctionExecutions class defines a GemFire Client Cache Function execution targeted at a - * GemFire Server. + * The ApplicationDomainFunctionExecutions class defines a Pivotal GemFireClient Cache Function execution targeted at a + * Pivotal GemFireServer. * * @author John Blum * @see org.springframework.data.gemfire.function.ClientCacheFunctionExecutionWithPdxIntegrationTest diff --git a/src/test/java/org/springframework/data/gemfire/function/sample/ExceptionThrowingFunctionExecution.java b/src/test/java/org/springframework/data/gemfire/function/sample/ExceptionThrowingFunctionExecution.java index 0c937747..ba8973e4 100644 --- a/src/test/java/org/springframework/data/gemfire/function/sample/ExceptionThrowingFunctionExecution.java +++ b/src/test/java/org/springframework/data/gemfire/function/sample/ExceptionThrowingFunctionExecution.java @@ -19,7 +19,7 @@ package org.springframework.data.gemfire.function.sample; import org.springframework.data.gemfire.function.annotation.OnServer; /** - * The ExceptionThrowingFunctionExecution interface defines a GemFire Function that throws a RuntimeException. + * The ExceptionThrowingFunctionExecution interface defines a Pivotal GemFireFunction that throws a RuntimeException. * * @author John Blum * @see org.springframework.data.gemfire.function.annotation.OnServer diff --git a/src/test/java/org/springframework/data/gemfire/function/sample/HelloFunctionExecution.java b/src/test/java/org/springframework/data/gemfire/function/sample/HelloFunctionExecution.java index 7dfd5aa2..5e651b25 100644 --- a/src/test/java/org/springframework/data/gemfire/function/sample/HelloFunctionExecution.java +++ b/src/test/java/org/springframework/data/gemfire/function/sample/HelloFunctionExecution.java @@ -19,8 +19,8 @@ package org.springframework.data.gemfire.function.sample; import org.springframework.data.gemfire.function.annotation.OnMember; /** - * The HelloFunctionExecution interface is a Spring Data GemFire Function Execution interface - * for the 'hello' GemFire Function and hello greetings. + * The HelloFunctionExecution interface is a SDG Function Execution interface + * for the 'hello' Pivotal GemFireFunction and hello greetings. * * @author John Blum * @see org.springframework.data.gemfire.function.annotation.OnMember diff --git a/src/test/java/org/springframework/data/gemfire/repository/OqlKeywordUnitTests.java b/src/test/java/org/springframework/data/gemfire/repository/OqlKeywordUnitTests.java index 3312a3de..34072965 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/OqlKeywordUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/repository/OqlKeywordUnitTests.java @@ -58,6 +58,7 @@ public class OqlKeywordUnitTests { @Test public void valueOfIgnoreCaseWithIllegalValuesThrowsIllegalArgumentException() { + assertIllegalOqlKeyword("AN"); assertIllegalOqlKeyword("ASS"); assertIllegalOqlKeyword("CNT"); @@ -81,15 +82,17 @@ public class OqlKeywordUnitTests { } protected void assertIllegalOqlKeyword(String keyword) { + exception.expect(IllegalArgumentException.class); exception.expectCause(is(nullValue(Throwable.class))); - exception.expectMessage(String.format("[%s] is not a valid GemFire OQL Keyword", keyword)); + exception.expectMessage(String.format("[%s] is not a valid OQL Keyword", keyword)); OqlKeyword.valueOfIgnoreCase(keyword); } @Test public void getKeywordEqualsNameExceptForOrderBy() { + for (OqlKeyword oqlKeyword : OqlKeyword.values()) { if (!OqlKeyword.ORDER_BY.equals(oqlKeyword)) { assertThat(oqlKeyword.getKeyword()).isEqualTo(oqlKeyword.name()); diff --git a/src/test/java/org/springframework/data/gemfire/repository/cdi/GemfireCacheRegionProducer.java b/src/test/java/org/springframework/data/gemfire/repository/cdi/GemfireCacheRegionProducer.java index 69061dc4..65addcac 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/cdi/GemfireCacheRegionProducer.java +++ b/src/test/java/org/springframework/data/gemfire/repository/cdi/GemfireCacheRegionProducer.java @@ -30,7 +30,7 @@ import org.springframework.util.Assert; /** * The GemfireCacheRegionProducer class is an application scoped CDI context bean that is responsible - * for creating the GemFire Cache "People" Region used to store {@link Person} instances. + * for creating the Pivotal GemFireCache "People" Region used to store {@link Person} instances. * * @author John Blum * @see javax.enterprise.context.ApplicationScoped diff --git a/src/test/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethodUnitTests.java b/src/test/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethodUnitTests.java index b7a2e1eb..8ab2cd1f 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethodUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethodUnitTests.java @@ -58,7 +58,7 @@ import org.springframework.util.ObjectUtils; public class GemfireQueryMethodUnitTests { @Rule - public ExpectedException expectedException = ExpectedException.none(); + public ExpectedException exception = ExpectedException.none(); private GemfireMappingContext context = new GemfireMappingContext(); @@ -148,15 +148,17 @@ public class GemfireQueryMethodUnitTests { */ @Test public void rejectsQueryMethodWithPageableParameter() throws Exception { - expectedException.expect(IllegalStateException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage(Matchers.startsWith("Pagination is not supported by GemFire Repositories; Offending method: someMethod")); + + exception.expect(IllegalStateException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage(Matchers.startsWith("Pagination is not supported by Pivotal GemFire Repositories; Offending method: someMethod")); new GemfireQueryMethod(Invalid.class.getMethod("someMethod", Pageable.class), metadata, factory, context); } @Test public void detectsQueryHintsCorrectly() throws Exception { + assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithHint"), metadata, factory, context).hasHint(), is(true)); assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithImport"), @@ -169,6 +171,7 @@ public class GemfireQueryMethodUnitTests { @Test public void detectsQueryImportsCorrectly() throws Exception { + assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithHint"), metadata, factory, context).hasImport(), is(false)); assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithImport"), @@ -181,6 +184,7 @@ public class GemfireQueryMethodUnitTests { @Test public void detectsQueryLimitsCorrectly() throws Exception { + assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithHint"), metadata, factory, context).hasLimit(), is(false)); assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithImport"), @@ -193,6 +197,7 @@ public class GemfireQueryMethodUnitTests { @Test public void detectsQueryTracingCorrectly() throws Exception { + assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithHint"), metadata, factory, context).hasTrace(), is(true)); assertThat(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithImport"), @@ -205,6 +210,7 @@ public class GemfireQueryMethodUnitTests { @Test public void hintOnQueryWithHint() throws Exception { + assertQueryHints(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithHint"), metadata, factory, context), "IdIdx", "LastNameIdx"); @@ -220,6 +226,7 @@ public class GemfireQueryMethodUnitTests { @Test public void importOnQueryWithImport() throws Exception { + assertImportStatement(new GemfireQueryMethod(AnnotatedQueryMethods.class.getMethod("queryWithImport"), metadata, factory, context), "org.example.app.domain.ExampleType"); diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepository.java b/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepository.java index 7a0a3158..8ab267a4 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepository.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepository.java @@ -20,7 +20,7 @@ import org.springframework.data.gemfire.repository.GemfireRepository; /** * The AlgorithmRepository class is a Data Access Object (DAO) for accessing and persistent data/state about Algorithms - * to a GemFire Cache/Region. + * to a Pivotal GemFireCache/Region. * * @author John Blum * @see org.springframework.data.gemfire.repository.GemfireRepository diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepositoryTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepositoryTest.java index 7f12a073..193d1b1e 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepositoryTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/AlgorithmRepositoryTest.java @@ -31,7 +31,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * The AlgorithmRepositoryTest class is a test suite of test cases testing the contract and functionality of GemFire's + * The AlgorithmRepositoryTest class is a test suite of test cases testing the contract and functionality of Pivotal GemFire's * Repository extension when using a plain old Java interface for defining the application domain object/entity type, * rather than a Java class, that is the subject of the persistence operations. * @@ -55,8 +55,9 @@ public class AlgorithmRepositoryTest { @Test public void algorithmsRepositoryFunctionsCorrectly() { + assertNotNull("A reference to the AlgorithmRepository was not properly configured!", algorithmRepo); - assertNotNull("A reference to the 'Algorithms' GemFire Cache Region was not properly configured!", + assertNotNull("A reference to the 'Algorithms' Cache Region was not properly configured!", algorithmsRegion); assertEquals("Algorithms", algorithmsRegion.getName()); assertEquals("/Algorithms", algorithmsRegion.getFullPath()); @@ -90,9 +91,8 @@ public class AlgorithmRepositoryTest { } } - protected static final class BinarySearch extends AbstractAlgorithm { - } + protected static final class BinarySearch extends AbstractAlgorithm { } + + protected static final class HeapSort extends AbstractAlgorithm { } - protected static final class HeapSort extends AbstractAlgorithm { - } } diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/AnimalRepositoryTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/AnimalRepositoryTest.java index 1476bc2d..dc49c2a2 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/AnimalRepositoryTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/AnimalRepositoryTest.java @@ -28,7 +28,7 @@ import org.springframework.test.context.junit4.SpringRunner; /** * Integration test testing the functionality behind PR #55 involving persisting application domain object/entities - * to multiple Regions in a GemFire Cache. + * to multiple Regions in a Pivotal GemFireCache. * * @author Stuart Williams * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/PlantRepository.java b/src/test/java/org/springframework/data/gemfire/repository/sample/PlantRepository.java index c29c9d5a..d1f4498e 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/PlantRepository.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/PlantRepository.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.repository.Query; /** * The PlantRepository class is a Repository extension for accessing and storing Plants. - * Note, this Spring GemFire Repository extension incorrectly maps Plants to the Plants Region on purpose + * Note, this Spring Pivotal GemFireRepository extension incorrectly maps Plants to the Plants Region on purpose * * @author John Blum * @see org.springframework.data.gemfire.repository.GemfireRepository diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/RabbitRepository.java b/src/test/java/org/springframework/data/gemfire/repository/sample/RabbitRepository.java index f5f4b759..c9f9d4d8 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/RabbitRepository.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/RabbitRepository.java @@ -21,7 +21,7 @@ import org.springframework.data.gemfire.repository.GemfireRepository; import org.springframework.data.gemfire.repository.Query; /** - * The RabbitRepository class is a Spring Data GemFire Repository extension for accessing and persistent Rabbits + * The RabbitRepository class is a SDG Repository extension for accessing and persistent Rabbits * from/to an underlying data store (GemFire). * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/RepositoryQueriesWithJoinsIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/RepositoryQueriesWithJoinsIntegrationTest.java index eb585887..95a5aee8 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/RepositoryQueriesWithJoinsIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/RepositoryQueriesWithJoinsIntegrationTest.java @@ -30,7 +30,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The RepositoryQueriesWithJoinsTest class is a test suite of test cases testing the use of JOINS between 2 Regions - * in GemFire OQL queries (SELECT statements). + * in Pivotal GemFireOQL queries (SELECT statements). * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/SubRegionRepositoryIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/SubRegionRepositoryIntegrationTest.java index d9dfdee7..e6737d6e 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/SubRegionRepositoryIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/SubRegionRepositoryIntegrationTest.java @@ -40,7 +40,7 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * Integration tests testing the use of GemFire Repositories on GemFire Cache Subregions. + * Integration tests testing the use of Pivotal GemFireRepositories on Pivotal GemFireCache Subregions. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepository.java b/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepository.java index 09b9677b..9dd81e90 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepository.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepository.java @@ -45,7 +45,7 @@ public interface UserRepository extends GemfireRepository { List findDistinctByUsernameLike(String username); /* - //NOTE unfortunately, the 'NOT LIKE' operator is unsupported in GemFire's Query/OQL syntax + //NOTE unfortunately, the 'NOT LIKE' operator is unsupported in Pivotal GemFire's Query/OQL syntax List findDistinctByUsernameNotLike(String username); */ diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepositoryQueriesIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepositoryQueriesIntegrationTest.java index 824406a9..9e571abf 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepositoryQueriesIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/UserRepositoryQueriesIntegrationTest.java @@ -34,11 +34,11 @@ import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.junit4.SpringRunner; /** - * The RepositoryQueriesTest class is a test suite of test cases testing the GemFire Query capability of Spring Data - * GemFire Repositories. + * The RepositoryQueriesTest class is a test suite of test cases testing the Pivotal GemFireQuery capability of Spring Data + * Pivotal GemFireRepositories. * * @author John Blum * @see org.junit.Test @@ -47,7 +47,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; * @see org.springframework.test.context.junit4.SpringJUnit4ClassRunner * @since 1.3.3 */ -@RunWith(SpringJUnit4ClassRunner.class) +@RunWith(SpringRunner.class) @ContextConfiguration("userRepositoryQueriesIntegrationTest.xml") @SuppressWarnings("unused") public class UserRepositoryQueriesIntegrationTest { @@ -93,7 +93,8 @@ public class UserRepositoryQueriesIntegrationTest { @Before public void setup() { - assertNotNull("The 'Users' GemFire Cache Region cannot be null!", users); + + assertNotNull("The 'Users' Cache Region cannot be null!", users); if (users.isEmpty()) { userRepository.save(createUser("blumj", true)); diff --git a/src/test/java/org/springframework/data/gemfire/repository/sample/UsingQueryAnnotationExtensionsInUserRepositoryIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/repository/sample/UsingQueryAnnotationExtensionsInUserRepositoryIntegrationTest.java index 32fd6d1f..f8119505 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/sample/UsingQueryAnnotationExtensionsInUserRepositoryIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/sample/UsingQueryAnnotationExtensionsInUserRepositoryIntegrationTest.java @@ -36,7 +36,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The UsingQueryAnnotationExtensionsInUserRepositoryIntegrationTest class is a test suite of test cases testing - * the contract and functionality of the Spring Data Commons Repository abstraction, Spring Data GemFire Repository + * the contract and functionality of the Spring Data Commons Repository abstraction, SDG Repository * extention with custom OQL Query annotations. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryUnitTests.java b/src/test/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryUnitTests.java index fc1a76b7..fbb91079 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryUnitTests.java +++ b/src/test/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryUnitTests.java @@ -480,7 +480,7 @@ public class GemfireRepositoryFactoryUnitTests { } catch (IllegalStateException expected) { - assertThat(expected).hasMessageStartingWith("Pagination is not supported by GemFire Repositories"); + assertThat(expected).hasMessageStartingWith("Pagination is not supported by Pivotal GemFire Repositories"); assertThat(expected).hasNoCause(); throw expected; diff --git a/src/test/java/org/springframework/data/gemfire/repository/support/SimpleGemfireRepositoryTransactionalIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/repository/support/SimpleGemfireRepositoryTransactionalIntegrationTest.java index 0cc788f0..bb5afd2f 100644 --- a/src/test/java/org/springframework/data/gemfire/repository/support/SimpleGemfireRepositoryTransactionalIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/repository/support/SimpleGemfireRepositoryTransactionalIntegrationTest.java @@ -47,7 +47,7 @@ import org.springframework.transaction.support.TransactionTemplate; /** * Integration tests testing the {@link SimpleGemfireRepository} class and SDC Repository abstraction implementation - * in the context of GemFire "Cache" Transactions. + * in the context of Pivotal GemFire"Cache" Transactions. * * @author John Blum * @see org.junit.Test @@ -80,7 +80,8 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { @Before public void setup() { - assertNotNull("The 'Customers' GemFire Cache Region was not properly configured and initialized!", customers); + + assertNotNull("The 'Customers' Cache Region was not properly configured and initialized!", customers); assertEquals("Customers", customers.getName()); assertEquals("/Customers", customers.getFullPath()); assertTrue(customers.isEmpty()); @@ -93,7 +94,8 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { @Test public void testDeleteAll() { - Collection expectedCustomers = new ArrayList(4); + + Collection expectedCustomers = new ArrayList<>(4); expectedCustomers.add(createCustomer("Jon", "Doe")); expectedCustomers.add(createCustomer("Jane", "Doe")); @@ -122,14 +124,13 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { public static class SerializableCustomer extends Customer implements Serializable { - public SerializableCustomer() { - } + public SerializableCustomer() { } - public SerializableCustomer(final Long id) { + public SerializableCustomer(Long id) { super(id); } - public SerializableCustomer(final String firstName, final String lastName) { + public SerializableCustomer(String firstName, String lastName) { super(firstName, lastName); } } @@ -150,7 +151,7 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { void saveAll(final Iterable customers) { transactionTemplate.execute(new TransactionCallbackWithoutResult() { - @Override protected void doInTransactionWithoutResult(final TransactionStatus status) { + @Override protected void doInTransactionWithoutResult(TransactionStatus status) { customerRepository.saveAll(customers); } }); @@ -158,7 +159,7 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { void removeAllCausingTransactionRollback() { transactionTemplate.execute(new TransactionCallbackWithoutResult() { - @Override protected void doInTransactionWithoutResult(final TransactionStatus status) { + @Override protected void doInTransactionWithoutResult(TransactionStatus status) { removeAll(); throw new IllegalStateException("'removeAll' operation not permitted"); } @@ -167,7 +168,7 @@ public class SimpleGemfireRepositoryTransactionalIntegrationTest { void removeAll() { transactionTemplate.execute(new TransactionCallbackWithoutResult() { - @Override protected void doInTransactionWithoutResult(final TransactionStatus status) { + @Override protected void doInTransactionWithoutResult(TransactionStatus status) { customerRepository.deleteAll(); } }); diff --git a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotApplicationEventTriggeredImportsExportsIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotApplicationEventTriggeredImportsExportsIntegrationTest.java index 89a47354..0e603e5b 100644 --- a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotApplicationEventTriggeredImportsExportsIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotApplicationEventTriggeredImportsExportsIntegrationTest.java @@ -52,7 +52,7 @@ import org.springframework.util.StringUtils; /** * The SnapshotApplicationEventTriggeredImportsExportsIntegrationTest class is a test suite of test cases testing * the effects of the SnapshotServiceFactoryBean using Spring ApplicationEvents to trigger imports and exports - * of GemFire Cache Region data. + * of Pivotal GemFireCache Region data. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceFactoryBeanTest.java b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceFactoryBeanTest.java index 6fdf0d8f..fbfcdcc9 100644 --- a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceFactoryBeanTest.java +++ b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceFactoryBeanTest.java @@ -86,7 +86,7 @@ public class SnapshotServiceFactoryBeanTest { private static File snapshotDat; @Rule - public ExpectedException expectedException = ExpectedException.none(); + public ExpectedException exception = ExpectedException.none(); private SnapshotServiceFactoryBean factoryBean = new SnapshotServiceFactoryBean(); @@ -184,17 +184,21 @@ public class SnapshotServiceFactoryBeanTest { @Test public void setCacheToNull() { - expectedException.expect(IllegalArgumentException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage("The GemFire Cache must not be null"); + + exception.expect(IllegalArgumentException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage("Cache must not be null"); + factoryBean.setCache(null); } @Test public void getCacheWhenUninitialized() { - expectedException.expect(IllegalStateException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage("The GemFire Cache was not properly initialized"); + + exception.expect(IllegalStateException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage("The cache was not properly initialized"); + factoryBean.getCache(); } @@ -366,17 +370,17 @@ public class SnapshotServiceFactoryBeanTest { @Test public void wrapNullCacheSnapshotService() { - expectedException.expect(IllegalArgumentException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage("The backing CacheSnapshotService must not be null"); + exception.expect(IllegalArgumentException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage("The backing CacheSnapshotService must not be null"); factoryBean.wrap((CacheSnapshotService) null); } @Test public void wrapNullRegionSnapshotService() { - expectedException.expect(IllegalArgumentException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage("The backing RegionSnapshotService must not be null"); + exception.expect(IllegalArgumentException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage("The backing RegionSnapshotService must not be null"); factoryBean.wrap((RegionSnapshotService) null); } @@ -1162,9 +1166,9 @@ public class SnapshotServiceFactoryBeanTest { @Test public void createSnapshotMetadataWithNullLocation() { - expectedException.expect(IllegalArgumentException.class); - expectedException.expectCause(is(nullValue(Throwable.class))); - expectedException.expectMessage("Location must not be null"); + exception.expect(IllegalArgumentException.class); + exception.expectCause(is(nullValue(Throwable.class))); + exception.expectMessage("Location must not be null"); new SnapshotMetadata(null, mock(SnapshotFilter.class), SnapshotFormat.GEMFIRE); } @@ -1247,5 +1251,4 @@ public class SnapshotServiceFactoryBeanTest { throw new UnsupportedOperationException("not implemented"); } } - } diff --git a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceImportExportIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceImportExportIntegrationTest.java index 86a82da7..d76f1491 100644 --- a/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceImportExportIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/snapshot/SnapshotServiceImportExportIntegrationTest.java @@ -40,7 +40,7 @@ import org.springframework.util.FileCopyUtils; /** * The SnapshotServiceImportExportIntegrationTest class is a test suite of test cases testing the import and export - * of GemFire Cache Region data configured with SDG's Data Namespace >gfe-data:snapshot-service< (XML) element. + * of Pivotal GemFireCache Region data configured with SDG's Data Namespace >gfe-data:snapshot-service< (XML) element. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/support/ConnectionEndpointTest.java b/src/test/java/org/springframework/data/gemfire/support/ConnectionEndpointTest.java index d65c9490..ab96a7fa 100644 --- a/src/test/java/org/springframework/data/gemfire/support/ConnectionEndpointTest.java +++ b/src/test/java/org/springframework/data/gemfire/support/ConnectionEndpointTest.java @@ -32,7 +32,7 @@ import org.junit.rules.ExpectedException; /** * The ConnectionEndpointTest class is a test suite of test cases testing the contract and functionality - * of the ConnectionEndpoint class representing GemFire Socket connection endpoints to GemFire services + * of the ConnectionEndpoint class representing Pivotal GemFireSocket connection endpoints to Pivotal GemFire'services * (such as Locators, etc). * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupportFunctionBasedIntegrationTests.java b/src/test/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupportFunctionBasedIntegrationTests.java index 7f319b0a..32eff3ac 100644 --- a/src/test/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupportFunctionBasedIntegrationTests.java +++ b/src/test/java/org/springframework/data/gemfire/support/LazyWiringDeclarableSupportFunctionBasedIntegrationTests.java @@ -35,8 +35,8 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * Integration test to test the functionality of a GemFire Function implementing the Spring Data GemFire - * {@link LazyWiringDeclarableSupport} class, defined using native GemFire configuration meta-data + * Integration test to test the functionality of a Pivotal GemFireFunction implementing the SDG + * {@link LazyWiringDeclarableSupport} class, defined using native Pivotal GemFireconfiguration meta-data * (i.e {@literal cache.xml}). * * @author John Blum @@ -146,7 +146,7 @@ public class LazyWiringDeclarableSupportFunctionBasedIntegrationTests { context.getResultSender().lastResult(formatHelloGreeting(addressTo(context))); } - // precedence is... 1. Caller 2. GemFire 3. Spring + // precedence is... 1. Caller 2. Pivotal GemFire3. Spring protected String addressTo(FunctionContext context) { Object arguments = context.getArguments(); String addressTo = null; diff --git a/src/test/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializerIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializerIntegrationTest.java index 427256fe..1046bbe8 100644 --- a/src/test/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializerIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/support/SpringContextBootstrappingInitializerIntegrationTest.java @@ -127,7 +127,7 @@ public class SpringContextBootstrappingInitializerIntegrationTest { System.out.printf("Closing Cache...%n"); cache.close(); - // Now, wait for the GemFire Hog to shutdown, OIY! + // Now, wait for the Pivotal GemFireHog to shutdown, OIY! synchronized (MUTEX_LOCK) { while (!cache.isClosed()) { try { @@ -162,8 +162,8 @@ public class SpringContextBootstrappingInitializerIntegrationTest { //.set("jmx-manager-start", GEMFIRE_JMX_MANAGER_START) .create(); - assertNotNull("The GemFire Cache was not properly created and initialized!", gemfireCache); - assertFalse("The GemFire Cache is closed!", gemfireCache.isClosed()); + assertNotNull("The cache was not properly created and initialized", gemfireCache); + assertFalse("The cache is closed", gemfireCache.isClosed()); Set> rootRegions = gemfireCache.rootRegions(); @@ -178,7 +178,7 @@ public class SpringContextBootstrappingInitializerIntegrationTest { assertNotNull(applicationContext); assertTrue(applicationContext.containsBean(GemfireConstants.DEFAULT_GEMFIRE_CACHE_NAME)); assertTrue(applicationContext.containsBean("TestRegion")); - assertFalse(applicationContext.containsBean("Users")); // Region 'Users' is defined in GemFire cache.xml + assertFalse(applicationContext.containsBean("Users")); // Region 'Users' is defined in Pivotal GemFirecache.xml assertTrue(applicationContext.containsBean("userDataSource")); assertTrue(applicationContext.containsBean("userDao")); assertTrue(applicationContext.containsBean("userService")); @@ -190,7 +190,7 @@ public class SpringContextBootstrappingInitializerIntegrationTest { assertSame(userDataSource, userDao.getDataSource()); assertSame(userDao, userService.getUserDao()); - // NOTE a GemFire declared component initialized by Spring! + // NOTE a Pivotal GemFiredeclared component initialized by Spring! UserDataStoreCacheLoader usersCacheLoader = UserDataStoreCacheLoader.getInstance(); assertSame(userDataSource, usersCacheLoader.getDataSource()); diff --git a/src/test/java/org/springframework/data/gemfire/test/GemfireTestApplicationContextInitializer.java b/src/test/java/org/springframework/data/gemfire/test/GemfireTestApplicationContextInitializer.java index 26652917..0d9bf2f3 100644 --- a/src/test/java/org/springframework/data/gemfire/test/GemfireTestApplicationContextInitializer.java +++ b/src/test/java/org/springframework/data/gemfire/test/GemfireTestApplicationContextInitializer.java @@ -20,7 +20,7 @@ import org.springframework.context.ConfigurableApplicationContext; import org.springframework.util.StringUtils; /** - * Spring {@link ApplicationContextInitializer} used to configure the Spring Data GemFire test suite + * Spring {@link ApplicationContextInitializer} used to configure the SDG test suite * with mocking enabled or disabled. * * @author David Turanski @@ -40,10 +40,11 @@ public class GemfireTestApplicationContextInitializer implements ApplicationCont */ @Override public void initialize(ConfigurableApplicationContext applicationContext) { + String gemfireTestRunnerDisabled = System.getProperty(GEMFIRE_TEST_RUNNER_DISABLED, Boolean.FALSE.toString()); if (isGemFireTestRunnerDisabled(gemfireTestRunnerDisabled)) { - log.warn(String.format("WARNING - Mocks disabled; Using real GemFire components (%1$s = %2$s)", + log.warn(String.format("WARNING - Mocks disabled; Using real Pivotal GemFire objects [%1$s = %2$s]", GEMFIRE_TEST_RUNNER_DISABLED, gemfireTestRunnerDisabled)); } else { @@ -51,8 +52,8 @@ public class GemfireTestApplicationContextInitializer implements ApplicationCont } } - /* (non-Javadoc) */ private boolean isGemFireTestRunnerDisabled(String systemPropertyValue) { + return (Boolean.valueOf(StringUtils.trimAllWhitespace(systemPropertyValue)) || "yes".equalsIgnoreCase(systemPropertyValue) || "y".equalsIgnoreCase(systemPropertyValue)); diff --git a/src/test/java/org/springframework/data/gemfire/test/MockRegionFactory.java b/src/test/java/org/springframework/data/gemfire/test/MockRegionFactory.java index 4ae95214..0d6be6b5 100644 --- a/src/test/java/org/springframework/data/gemfire/test/MockRegionFactory.java +++ b/src/test/java/org/springframework/data/gemfire/test/MockRegionFactory.java @@ -71,7 +71,7 @@ public class MockRegionFactory { attributesFactory = (attributes != null ? new org.apache.geode.cache.AttributesFactory(attributes) : new org.apache.geode.cache.AttributesFactory()); - // Workaround for GemFire bug??? + // Workaround for Pivotal GemFirebug??? if (attributes != null) { attributesFactory.setLockGrantor(attributes.isLockGrantor()); } diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/GemFireMockObjectsSupport.java b/src/test/java/org/springframework/data/gemfire/test/mock/GemFireMockObjectsSupport.java index 0590e26e..8e784bfb 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/GemFireMockObjectsSupport.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/GemFireMockObjectsSupport.java @@ -137,7 +137,7 @@ import org.springframework.util.Assert; /** * The {@link GemFireMockObjectsSupport} class is an abstract base class encapsulating factory methods for creating - * Mock GemFire Objects (e.g. {@link Cache}, {@link ClientCache}, {@link Region}, etc). + * Mock Pivotal GemFireObjects (e.g. {@link Cache}, {@link ClientCache}, {@link Region}, etc). * * @author John Blum * @see org.apache.geode.cache.Cache @@ -394,10 +394,10 @@ public abstract class GemFireMockObjectsSupport extends MockObjectsSupport { } /** - * Resolves the single, remembered {@link GemFireCache} if using GemFire in Singleton-mode. + * Resolves the single, remembered {@link GemFireCache} if using Pivotal GemFirein Singleton-mode. * * @param {@link Class sub-type} of the {@link GemFireCache} instance. - * @param useSingletonCache boolean value indicating if mock infrastructure is using GemFire Singletons. + * @param useSingletonCache boolean value indicating if mock infrastructure is using Pivotal GemFireSingletons. * @return an {@link Optional}, single remembered instance of the {@link GemFireCache}. * @see org.apache.geode.cache.GemFireCache */ diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/EnableGemFireMockObjects.java b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/EnableGemFireMockObjects.java index 98857831..f1c62117 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/EnableGemFireMockObjects.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/EnableGemFireMockObjects.java @@ -27,7 +27,7 @@ import org.apache.geode.cache.GemFireCache; import org.springframework.context.annotation.Import; /** - * The {@link EnableGemFireMockObjects} annotation enables mocking of GemFire Objects in Unit Tests. + * The {@link EnableGemFireMockObjects} annotation enables mocking of Pivotal GemFireObjects in Unit Tests. * * @author John Blum * @see java.lang.annotation.Documented diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireMockObjectsConfiguration.java b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireMockObjectsConfiguration.java index 2b69e59a..9ed45424 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireMockObjectsConfiguration.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireMockObjectsConfiguration.java @@ -31,7 +31,7 @@ import org.springframework.data.gemfire.test.mock.config.GemFireMockObjectsBeanP /** * The {@link GemFireMockObjectsConfiguration} class is a Spring {@link Configuration @Configuration} class - * containing bean definitions to configure GemFire Object mocking. + * containing bean definitions to configure Pivotal GemFireObject mocking. * * @author John Blum * @see java.lang.annotation.Annotation diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireUnitTest.java b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireUnitTest.java index bcba704b..b45b7bbd 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireUnitTest.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/annotation/GemFireUnitTest.java @@ -29,8 +29,8 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit4.SpringRunner; /** - * The {@link GemFireUnitTest} annotation marks a test class as a GemFire Unit Test - * with GemFire Object mocking enabled. + * The {@link GemFireUnitTest} annotation marks a test class as a Pivotal GemFireUnit Test + * with Pivotal GemFireObject mocking enabled. * * Additionally, this annotation enables Spring's {@link SpringRunner} JUnit Runner implementation * using JUnit's {@link RunWith} annotation. diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/config/GemFireMockObjectsBeanPostProcessor.java b/src/test/java/org/springframework/data/gemfire/test/mock/config/GemFireMockObjectsBeanPostProcessor.java index 96b24a11..422f039e 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/config/GemFireMockObjectsBeanPostProcessor.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/config/GemFireMockObjectsBeanPostProcessor.java @@ -35,7 +35,7 @@ import org.springframework.lang.Nullable; /** * The {@link GemFireMockObjectsBeanPostProcessor} class is a Spring {@link BeanPostProcessor} that applies - * mocks and spies to Spring Data GemFire / Spring Data Geode and Pivotal GemFire / Apache Geode objects + * mocks and spies to SDG / Spring Data Geode and Pivotal GemFire / Apache Geode objects * and components. * * @author John Blum diff --git a/src/test/java/org/springframework/data/gemfire/test/mock/context/GemFireMockObjectsApplicationContextInitializer.java b/src/test/java/org/springframework/data/gemfire/test/mock/context/GemFireMockObjectsApplicationContextInitializer.java index 0af3a85c..6b50e6f0 100644 --- a/src/test/java/org/springframework/data/gemfire/test/mock/context/GemFireMockObjectsApplicationContextInitializer.java +++ b/src/test/java/org/springframework/data/gemfire/test/mock/context/GemFireMockObjectsApplicationContextInitializer.java @@ -22,7 +22,7 @@ import org.springframework.data.gemfire.test.mock.config.GemFireMockObjectsBeanP /** * The {@link GemFireMockObjectsApplicationContextInitializer} class is a Spring {@link ApplicationContextInitializer} - * used to initialize the Spring {@link ConfigurableApplicationContext} with GemFire Object mocking. + * used to initialize the Spring {@link ConfigurableApplicationContext} with Pivotal GemFireObject mocking. * * @author John Blum * @see org.springframework.context.ApplicationContextInitializer diff --git a/src/test/java/org/springframework/data/gemfire/test/support/AbstractGemFireClientServerIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/test/support/AbstractGemFireClientServerIntegrationTest.java index e510f907..69a77f21 100644 --- a/src/test/java/org/springframework/data/gemfire/test/support/AbstractGemFireClientServerIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/test/support/AbstractGemFireClientServerIntegrationTest.java @@ -30,7 +30,7 @@ import org.springframework.util.Assert; /** * The AbstractGemFireClientServerIntegrationTest class is an abstract test suite base class encapsulating functionality - * common to all test classes implementing GemFire client/server test cases. + * common to all test classes implementing Pivotal GemFireclient/server test cases. * * @author John Blum * @see org.springframework.data.gemfire.fork.ServerProcess @@ -88,9 +88,6 @@ public abstract class AbstractGemFireClientServerIntegrationTest { waitForServerToStart(gemfireServerProcess, waitTimeInMilliseconds); - System.out.printf("The Spring-based, GemFire Cache Server process for %1$s should be running...%n", - testClass.getSimpleName()); - return gemfireServerProcess; } diff --git a/src/test/java/org/springframework/data/gemfire/test/support/AbstractUnitAndIntegrationTestsWithMockSupport.java b/src/test/java/org/springframework/data/gemfire/test/support/AbstractUnitAndIntegrationTestsWithMockSupport.java index ab24dde1..f2c01791 100644 --- a/src/test/java/org/springframework/data/gemfire/test/support/AbstractUnitAndIntegrationTestsWithMockSupport.java +++ b/src/test/java/org/springframework/data/gemfire/test/support/AbstractUnitAndIntegrationTestsWithMockSupport.java @@ -22,7 +22,7 @@ import org.springframework.util.StringUtils; /** * {@link AbstractUnitAndIntegrationTestsWithMockSupport} is an abstract base class for test classes * having support for the creation and use of mock objects in test cases, but that may also be ran - * as integration tests using actual GemFire components (e.g. Regions, etc). + * as integration tests using actual Pivotal GemFirecomponents (e.g. Regions, etc). * * @author John Blum * @see org.springframework.data.gemfire.test.GemfireTestApplicationContextInitializer diff --git a/src/test/java/org/springframework/data/gemfire/test/support/ClientServerIntegrationTestsSupport.java b/src/test/java/org/springframework/data/gemfire/test/support/ClientServerIntegrationTestsSupport.java index 4092a943..80d5b9dd 100644 --- a/src/test/java/org/springframework/data/gemfire/test/support/ClientServerIntegrationTestsSupport.java +++ b/src/test/java/org/springframework/data/gemfire/test/support/ClientServerIntegrationTestsSupport.java @@ -38,7 +38,7 @@ import org.springframework.data.gemfire.util.CollectionUtils; /** * The {@link ClientServerIntegrationTestsSupport} class is a abstract base class encapsulating common functionality - * to support the implementation of GemFire client/server tests. + * to support the implementation of Pivotal GemFireclient/server tests. * * @author John Blum * @see java.io.File diff --git a/src/test/java/org/springframework/data/gemfire/wan/CachePartitionRegionWithConcurrentParallelAsyncEventQueueAndGatewaySenderIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/wan/CachePartitionRegionWithConcurrentParallelAsyncEventQueueAndGatewaySenderIntegrationTest.java index 9d84872b..47236c4c 100644 --- a/src/test/java/org/springframework/data/gemfire/wan/CachePartitionRegionWithConcurrentParallelAsyncEventQueueAndGatewaySenderIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/wan/CachePartitionRegionWithConcurrentParallelAsyncEventQueueAndGatewaySenderIntegrationTest.java @@ -39,8 +39,8 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The CachePartitionRegionWithConcurrentParallelAsyncEventQueueAndGatewaySenderIntegrationTest class is a test suite - * of test cases testing the concurrent, parallel functionality configuration of GemFire AsyncEventQueues - * and GatewaySenders using Spring Data GemFire. + * of test cases testing the concurrent, parallel functionality configuration of Pivotal GemFireAsyncEventQueues + * and GatewaySenders using SDG. * * @author John Blum * @see org.junit.Test diff --git a/src/test/java/org/springframework/data/gemfire/wan/ManualGatewayReceiverStartIntegrationTest.java b/src/test/java/org/springframework/data/gemfire/wan/ManualGatewayReceiverStartIntegrationTest.java index 51062f38..9c1ec30a 100644 --- a/src/test/java/org/springframework/data/gemfire/wan/ManualGatewayReceiverStartIntegrationTest.java +++ b/src/test/java/org/springframework/data/gemfire/wan/ManualGatewayReceiverStartIntegrationTest.java @@ -34,7 +34,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; /** * The ManualGatewayReceiverStartIntegrationTest class is a test suite of test cases testing the manual start capability - * of Gateway Receivers when configured with the Spring Data GemFire XML namespace. + * of Gateway Receivers when configured with the SDG XML namespace. * * @author John Blum * @see org.junit.Test diff --git a/src/test/resources/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests-context.xml b/src/test/resources/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests-context.xml index 847cbd48..57ef63c8 100644 --- a/src/test/resources/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests-context.xml +++ b/src/test/resources/org/springframework/data/gemfire/AutoRegionLookupWithAutowiringIntegrationTests-context.xml @@ -24,8 +24,8 @@ + diff --git a/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest-context.xml b/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest-context.xml index 0dbcdc22..6dc47c7b 100644 --- a/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest-context.xml +++ b/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableLocatorsTest-context.xml @@ -26,7 +26,7 @@ - + diff --git a/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableServersTest-context.xml b/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableServersTest-context.xml index f600051b..00c9de59 100644 --- a/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableServersTest-context.xml +++ b/src/test/resources/org/springframework/data/gemfire/client/ClientCacheVariableServersTest-context.xml @@ -28,7 +28,7 @@ - + diff --git a/src/test/resources/org/springframework/data/gemfire/config/xml/RegionExpirationAttributesNamespaceTest-context.xml b/src/test/resources/org/springframework/data/gemfire/config/xml/RegionExpirationAttributesNamespaceTest-context.xml index dd6593e7..3a266d98 100644 --- a/src/test/resources/org/springframework/data/gemfire/config/xml/RegionExpirationAttributesNamespaceTest-context.xml +++ b/src/test/resources/org/springframework/data/gemfire/config/xml/RegionExpirationAttributesNamespaceTest-context.xml @@ -32,7 +32,7 @@ diff --git a/src/test/resources/org/springframework/data/gemfire/pdxdiskstore-config.xml b/src/test/resources/org/springframework/data/gemfire/pdxdiskstore-config.xml index 51a5d3c8..b0b90141 100644 --- a/src/test/resources/org/springframework/data/gemfire/pdxdiskstore-config.xml +++ b/src/test/resources/org/springframework/data/gemfire/pdxdiskstore-config.xml @@ -29,7 +29,7 @@ diff --git a/src/test/resources/org/springframework/data/gemfire/support/sample/initializer-gemfire-context.xml b/src/test/resources/org/springframework/data/gemfire/support/sample/initializer-gemfire-context.xml index 96d9987d..458b050f 100644 --- a/src/test/resources/org/springframework/data/gemfire/support/sample/initializer-gemfire-context.xml +++ b/src/test/resources/org/springframework/data/gemfire/support/sample/initializer-gemfire-context.xml @@ -1,5 +1,5 @@ - +