Skip to content

Commit

Permalink
Replace references to 'Pivotal GemFire' with 'VMware Tanzu GemFire'.
Browse files Browse the repository at this point in the history
Fix compiler syntax errors in code snippets.

Introduce documentation variables where applicable.

Format source code.

Optimize imports.
  • Loading branch information
jxblum committed Sep 18, 2020
1 parent 998d37d commit 8fb0c21
Show file tree
Hide file tree
Showing 117 changed files with 712 additions and 776 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.adoc
@@ -1,6 +1,6 @@
= Contributing to Spring Boot for Apache Geode & Pivotal GemFire
= Contributing to Spring Boot for Apache Geode & VMware Tanzu GemFire

Spring Boot for Apache Geode & Pivotal GemFire (SBDG) is released under the Apache 2.0 license. If you would like to
Spring Boot for Apache Geode & VMware Tanzu GemFire (SBDG) is released under the Apache 2.0 license. If you would like to
contribute something, or simply want to hack on the code this document should help you get started.

== Sign the Contributor License Agreement
Expand Down
36 changes: 18 additions & 18 deletions README.adoc
@@ -1,45 +1,45 @@
image:https://api.travis-ci.org/spring-projects/spring-boot-data-geode.svg?branch=master["Build Status", link="https://travis-ci.org/spring-projects/spring-boot-data-geode"]

[[about]]
== Spring Boot for Apache Geode & Pivotal GemFire
== Spring Boot for Apache Geode & VMware Tanzu GemFire

_Spring Boot for Apache Geode & Pivotal GemFire_ extends https://projects.spring.io/spring-boot/[_Spring Boot_] with
_Spring Boot for Apache Geode & VMware Tanzu GemFire_ extends https://projects.spring.io/spring-boot/[_Spring Boot_] with
_auto-configuration_ support as well as other _convention or configuration_ features to simplify the development
of _Spring_ applications using either https://geode.apache.org/[Apache Geode] or https://pivotal.io/pivotal-gemfire[Pivotal GemFire]
of _Spring_ applications using either https://geode.apache.org/[Apache Geode] or https://pivotal.io/pivotal-gemfire[VMware Tanzu GemFire]
in a _Spring_ context.

This project builds on both https://github.com/spring-projects/spring-data-geode[_Spring Data for Apache Geode_]
and https://projects.spring.io/spring-data-gemfire/[_Spring Data for Pivotal GemFire_]
and https://projects.spring.io/spring-data-gemfire/[_Spring Data for VMware Tanzu GemFire_]
as well as https://spring.io/projects/spring-boot[Spring Boot].

[[project-goals]]
=== Project Goals

This project adds _Spring Boot_ **auto-configuration** support for both https://geode.apache.org/[Apache Geode]
and https://pivotal.io/pivotal-gemfire[Pivotal GemFire].
and https://pivotal.io/pivotal-gemfire[VMware Tanzu GemFire].

Among other things, this project builds on https://projects.spring.io/spring-boot/[_Spring Boot_]
as well as https://projects.spring.io/spring-data-gemfire/[_Spring Data for Apache Geode & Pivotal GemFire_]
as well as https://projects.spring.io/spring-data-gemfire/[_Spring Data for Apache Geode & VMware Tanzu GemFire_]
and additionally offers...

1. _Auto-configures_ an _Apache Geode_ or _Pivotal GemFire_ (PCC)
1. _Auto-configures_ an _Apache Geode_ or _VMware Tanzu GemFire_ (PCC)
https://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/client/ClientCache.html[ClientCache]
instance automatically when either _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_
instance automatically when either _Spring Data for Apache Geode_ or _Spring Data for VMware Tanzu GemFire_
are on the application's CLASSPATH.

2. _Auto-configures_ either _Apache Geode_ or _Pivotal GemFire_ (PCC) as a _caching provider_ in
2. _Auto-configures_ either _Apache Geode_ or _VMware Tanzu GemFire_ (PCC) as a _caching provider_ in
https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#cache[_Spring's Cache Abstraction_]
when either _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_ are on the application's CLASSPATH.
when either _Spring Data for Apache Geode_ or _Spring Data for VMware Tanzu GemFire_ are on the application's CLASSPATH.

3. _Auto-configures_ _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_
3. _Auto-configures_ _Spring Data for Apache Geode_ or _Spring Data for VMware Tanzu GemFire_
https://docs.spring.io/spring-data-gemfire/docs/current/reference/html/#gemfire-repositories[Repositories]
when _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_ are on the application's CLASSPATH
when _Spring Data for Apache Geode_ or _Spring Data for VMware Tanzu GemFire_ are on the application's CLASSPATH
and _Spring Boot_ detects SDG _Repositories_ in your _Spring Boot_ application.

4. Provides additional support for _Spring Boot_/_Spring Data for Apache Geode_/_Pivotal GemFire_ applications
4. Provides additional support for _Spring Boot_/_Spring Data for Apache Geode_/_VMware Tanzu GemFire_ applications
deployed to PCF using Pivotal Cloud Cache (PCC). Additionally, if your application requires (HTTP) Session State
Caching services, you can also take advantage of
https://github.com/spring-projects/spring-session-data-geode[_Spring Session for Apache Geode/Pivotal GemFire_].
https://github.com/spring-projects/spring-session-data-geode[_Spring Session for Apache Geode/VMware Tanzu GemFire_].

This, along with many other benefits, are provided by this project.

Expand All @@ -66,17 +66,17 @@ This, along with many other benefits, are provided by this project.
=== Examples

The single, most relevant "_source of truth_" on how to get started quickly and effectively, using Spring Boot
for Apache Geode & Pivotal GemFire (SBDG) to solve problems, is to start with the
for Apache Geode & VMware Tanzu GemFire (SBDG) to solve problems, is to start with the
https://docs.spring.io/spring-boot-data-geode-build/current/reference/html5/#geode-samples[Samples].
There, you will find different examples with documentation and code showing you how to use SBDG to appropriately
handle specific application concerns, like Caching.

You can find an example of using SBDG in the Pivotal Cloud Cache (PCC) https://github.com/pivotal-cf/PCC-Sample-App-PizzaStore[Pizza Store]
GitHub repository, which is a Spring Boot, Pivotal GemFire `ClientCache` application that connects to PCC when the app
GitHub repository, which is a Spring Boot, VMware Tanzu GemFire `ClientCache` application that connects to PCC when the app
is deployed to PCF.

The https://github.com/jxblum/contacts-application/tree/master/boot-example[boot-example] found in the
_Contacts Application Reference Implementation_ for _Spring Data for Apache Geode & Pivotal GemFire_ (SDG) uses SBDG
_Contacts Application Reference Implementation_ for _Spring Data for Apache Geode & VMware Tanzu GemFire_ (SDG) uses SBDG
to manage Books in a _System of Record_ Use Case.

Then, there is a series of examples that walks a user through a series of steps starting by building a simple,
Expand Down Expand Up @@ -112,5 +112,5 @@ Please see our https://github.com/spring-projects/spring-boot-data-geode/securit
[[license]]
== License

_Spring Boot_, _Spring Boot for Apache Geode_ and _Spring Boot for Pivotal GemFire_ is Open Source Software
_Spring Boot_, _Spring Boot for Apache Geode_ and _Spring Boot for VMware Tanzu GemFire_ is Open Source Software
released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
2 changes: 1 addition & 1 deletion build.gradle
Expand Up @@ -12,7 +12,7 @@ buildscript {
apply plugin: 'io.spring.convention.root'

group = 'org.springframework.geode'
description = 'Spring Boot for Apache Geode & Pivotal GemFire'
description = 'Spring Boot for Apache Geode & VMware Tanzu GemFire'

//ext['spring.version'] = "$springVersion"
//ext['spring-framework.version'] = "$springVersion"
Expand Down
@@ -1,7 +1,7 @@
apply plugin: 'io.spring.convention.spring-module'
apply from: MAVEN_POM_EDITOR_GRADLE

description = "Spring Boot Actuator Starter for Pivotal GemFire"
description = "Spring Boot Actuator Starter for VMware Tanzu GemFire"

dependencies {

Expand Down
@@ -1,7 +1,7 @@
apply plugin: 'io.spring.convention.spring-module'
apply from: MAVEN_POM_EDITOR_GRADLE

description = "Spring Boot Logging Starter for Pivotal GemFire with Logback as the logging provider and adaptation of Log4j to SLF4J"
description = "Spring Boot Logging Starter for VMware Tanzu GemFire with Logback as the logging provider and adaptation of Log4j to SLF4J"

dependencies {

Expand Down
@@ -1,7 +1,7 @@
apply plugin: 'io.spring.convention.spring-module'
apply from: MAVEN_POM_EDITOR_GRADLE

description = "Spring Boot Starter for Spring Session using Pivotal GemFire"
description = "Spring Boot Starter for Spring Session using VMware Tanzu GemFire"

dependencies {

Expand Down
@@ -1,7 +1,7 @@
apply plugin: 'io.spring.convention.spring-module'
apply from: MAVEN_POM_EDITOR_GRADLE

description = "Spring Boot Test Starter for Pivotal GemFire"
description = "Spring Boot Test Starter for VMware Tanzu GemFire"

dependencies {

Expand Down
2 changes: 1 addition & 1 deletion spring-gemfire-starter/spring-gemfire-starter.gradle
@@ -1,7 +1,7 @@
apply plugin: 'io.spring.convention.spring-module'
apply from: MAVEN_POM_EDITOR_GRADLE

description = "Spring Boot Starter for Pivotal GemFire"
description = "Spring Boot Starter for VMware Tanzu GemFire"

dependencies {

Expand Down
Expand Up @@ -32,7 +32,7 @@
import org.springframework.geode.boot.autoconfigure.ClientCacheAutoConfiguration;

/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} for Apache Geode/Pivotal GemFire
* Spring Boot {@link EnableAutoConfiguration auto-configuration} for Apache Geode
* {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
Expand Down
Expand Up @@ -29,7 +29,7 @@
import org.springframework.geode.boot.actuate.GeodeRegionsHealthIndicator;

/**
* Spring {@link Configuration @Configuration} class declaring Spring beans for general Apache Geode/Pivotal GemFire
* Spring {@link Configuration @Configuration} class declaring Spring beans for general Apache Geode
* peer {@link Cache} and {@link ClientCache} {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
Expand Down
Expand Up @@ -33,7 +33,7 @@
import org.springframework.geode.boot.actuate.GeodePoolsHealthIndicator;

/**
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode/Pivotal GemFire
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode
* {@link ClientCache} {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
Expand Down
Expand Up @@ -43,8 +43,8 @@
import org.springframework.lang.Nullable;

/**
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode/Pivotal GemFire
* peer {@link Cache} {@link HealthIndicator HealthIndicators}.
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode peer {@link Cache}
* {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
* @see org.apache.geode.cache.Cache
Expand Down
Expand Up @@ -36,8 +36,8 @@

/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} class used to configure the Apache Geode
* / Pivotal GemFire {@link ClientCache} application or peer {@link Cache} member node name
* (i.e. {@literal gemfire.name}) with the Spring Boot {@literal spring.application.name} property.
* {@link ClientCache} application or peer {@link Cache} member node name (i.e. {@literal gemfire.name})
* with the Spring Boot {@literal spring.application.name} property.
*
* @author John Blum
* @see org.apache.geode.cache.Cache
Expand Down
Expand Up @@ -30,7 +30,7 @@
/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} class used to configure Spring Boot
* {@link ConfigurationProperties @ConfigurationProperites} classes and beans from the Spring {@link Environment}
* containing Apache Geode / Pivotal GemFire configuration properties.
* containing Apache Geode configuration properties.
*
* @author John Blum
* @see org.apache.geode.cache.GemFireCache
Expand Down
Expand Up @@ -26,7 +26,7 @@
import org.springframework.data.gemfire.config.annotation.EnableLogging;

/**
* Spring Boot {@link EnableAutoConfiguration Auto-Configuration} for Apache Geode and Pivotal GemFire logging.
* Spring Boot {@link EnableAutoConfiguration Auto-Configuration} for Apache Geode logging.
*
* @author John Blum
* @see org.springframework.boot.autoconfigure.EnableAutoConfiguration
Expand Down
Expand Up @@ -65,8 +65,8 @@

/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} class used to configure a {@link GemfireTemplate}
* for each Apache Geode / Pivotal GemFire {@link Region} declared/defined in
* the Spring {@link ConfigurableApplicationContext} in order to perform {@link Region} data access operations.
* for each Apache Geode {@link Region} declared/defined in the Spring {@link ConfigurableApplicationContext}
* in order to perform {@link Region} data access operations.
*
* @author John Blum
* @see org.apache.geode.cache.GemFireCache
Expand Down
Expand Up @@ -48,7 +48,7 @@

/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} for configuring either Apache Geode
* or Pivotal GemFire as an (HTTP) {@link Session} state management provider in Spring Session.
* as an (HTTP) {@link Session} state management provider in Spring Session.
*
* @author John Blum
* @see java.util.Properties
Expand Down
Expand Up @@ -32,8 +32,8 @@
/**
* Spring Boot {@link EnableAutoConfiguration auto-configuration} class used to configure Spring Boot
* {@link ConfigurationProperties @ConfigurationProperites} classes and beans from the Spring {@link Environment}
* containing Spring Session configuration properties used to configure either Apache Geode or Pivotal GemFire
* to manage (HTTP) Session state.
* containing Spring Session configuration properties used to configure either Apache Geode to manage (HTTP) Session
* state.
*
* @author John Blum
* @see org.apache.geode.cache.GemFireCache
Expand Down
Expand Up @@ -33,8 +33,8 @@
import org.springframework.geode.boot.autoconfigure.configuration.support.ServiceProperties;

/**
* Spring Boot {@link ConfigurationProperties} for well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* (SDG) {@link Properties}.
* Spring Boot {@link ConfigurationProperties} for well-known, documented Spring Data for Apache Geode(SDG)
* {@link Properties}.
*
* This class assists the application developer in the auto-completion / content-assist of the well-known, documented
* SDG {@link Properties}.
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration;

import org.apache.geode.cache.RegionShortcut;
Expand All @@ -23,9 +22,8 @@
import org.springframework.boot.context.properties.NestedConfigurationProperty;

/**
* Spring Boot {@link ConfigurationProperties} used to configure Spring Session for Apache Geode or Pivotal GemFire
* (SSDG) in order to manage (HTTP) Session state with Spring Session, backed by either Apache Geode
* or Pivotal GemFire.
* Spring Boot {@link ConfigurationProperties} used to configure Spring Session for Apache Geode (SSDG) in order to
* manage (HTTP) Session state with Spring Session, backed by Apache Geode.
*
* @author John Blum
* @see org.springframework.boot.context.properties.ConfigurationProperties
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration.support;

import java.util.Properties;
Expand All @@ -27,11 +26,11 @@
import org.springframework.boot.context.properties.NestedConfigurationProperty;

/**
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire peer {@link Cache},
* {@link ClientCache} and {@link CacheServer} objects.
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode peer {@link Cache}, {@link ClientCache}
* and {@link CacheServer} objects.
*
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* (SDG) {@link Properties}.
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode (SDG)
* {@link Properties}.
*
* @author John Blum
* @see java.util.Properties
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration.support;

import java.util.Properties;
Expand All @@ -25,10 +24,10 @@
import org.springframework.data.gemfire.server.SubscriptionEvictionPolicy;

/**
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link CacheServer}.
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode {@link CacheServer}.
*
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* (SDG) {@link Properties}.
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode (SDG)
* {@link Properties}.
*
* @author John Blum
* @see java.util.Properties
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration.support;

import java.util.Properties;
Expand All @@ -23,9 +22,9 @@
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link ClientCache}.
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode {@link ClientCache}.
*
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode
* (SDG) {@link Properties}.
*
* @author John Blum
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration.support;

import java.util.Properties;
Expand All @@ -23,11 +22,11 @@
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link ClientCache}
* Security (authentication & authorization).
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode {@link ClientCache} Security
* (authentication & authorization).
*
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* (SDG) {@link Properties}.
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode (SDG)
* {@link Properties}.
*
* @author John Blum
* @see java.util.Properties
Expand Down
Expand Up @@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package org.springframework.geode.boot.autoconfigure.configuration.support;

import java.util.Properties;
Expand All @@ -26,10 +25,10 @@

/**
* Spring Boot {@link ConfigurationProperties} used to configure the {@link DataPolicy} of all {@link Region Regions}
* in an Apache Geode / Pivotal GemFire cluster.
* in an Apache Geode cluster.
*
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
* (SDG) {@link Properties}.
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode (SDG)
* {@link Properties}.
*
* @author John Blum
* @see java.util.Properties
Expand Down

0 comments on commit 8fb0c21

Please sign in to comment.