You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
INT-4398: Replace Gemfire dependency with Geode (#2426)
* INT-4398: Replace Gemfire dependency with Geode
JIRA: https://jira.spring.io/browse/INT-4398
* Polishing `gemfire.adoc` and mention the procedure for an
exclusion/inclusion appropriate dependency
* More Docs polishing
* * Fix tests to be based on SD Geode XML namespace
* Fix Docs according PR comments
* Polishing Docs according PR comments
Copy file name to clipboardExpand all lines: spring-integration-gemfire/src/test/java/org/springframework/integration/gemfire/inbound/CqInboundChannelAdapterTests-context.xml
Copy file name to clipboardExpand all lines: spring-integration-gemfire/src/test/java/org/springframework/integration/gemfire/inbound/GemfireInboundChannelAdapterTests-context.xml
Copy file name to clipboardExpand all lines: spring-integration-gemfire/src/test/java/org/springframework/integration/gemfire/outbound/GemfireOutboundChannelAdapterTests-context.xml
Copy file name to clipboardExpand all lines: spring-integration-gemfire/src/test/java/org/springframework/integration/gemfire/util/AggregatorWithGemfireLocksTests-context.xml
Copy file name to clipboardExpand all lines: src/reference/asciidoc/gemfire.adoc
+39-17Lines changed: 39 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,38 @@
1
1
[[gemfire]]
2
-
== GemFire Support
2
+
== Pivotal GemFire and Apache Geode Support
3
3
4
-
Spring Integration provides support for VMWare vFabric GemFire
4
+
Spring Integration provides support for Pivotal GemFire and Apache Geode
5
5
6
6
[[gemfire-intro]]
7
7
=== Introduction
8
8
9
-
VMWare vFabric GemFire (GemFire) is a distributed data management platform providing a key-value data grid along with advanced distributed system features such as event processing, continuous querying, and remote function execution.
10
-
This guide assumes some familiarity with http://www.vmware.com/support/pubs/vfabric-gemfire.html[GemFire] and its http://www.vmware.com/support/developer/vfabric-gemfire/662-api/index.html[API].
9
+
GemFire is a distributed data management platform providing a key-value data grid along with advanced distributed system features such as event processing, continuous querying, and remote function execution.
10
+
This guide assumes some familiarity with the commercial https://pivotal.io/pivotal-gemfire[Pivotal GemFire] or Open Source http://geode.apache.org[Apache Geode].
11
11
12
-
Spring integration provides support for GemFire by providing inbound adapters for entry and continuous query events, an outbound adapter to write entries to the cache, and `MessageStore` and `MessageGroupStore` implementations.
13
-
Spring integration leverages thehttp://www.springsource.org/spring-gemfire[Spring Gemfire] project, providing a thin wrapper over its components.
12
+
Spring integration provides support for GemFire implementing inbound adapters for entry and continuous query events, an outbound adapter to write entries to the cache, and Message & Metadata stores and `GemfireLockRegistry` implementations.
13
+
Spring integration leverages the http://projects.spring.io/spring-data-gemfire[Spring Data for Pivotal GemFire] project, providing a thin wrapper over its components.
14
+
15
+
Starting with _version 5.1_, the Spring Integration GemFire module uses the https://github.com/spring-projects/spring-data-geode[Spring Data for Apache Geode] transitive dependency by default.
16
+
To switch to the commercial Pivotal GemFire based Spring Data for Pivotal GemFire, exclude `spring-data-geode` from dependencies and add `spring-data-gemfire`:
The _inbound-channel-adapter_ produces messages on a channel triggered by a GemFire `EntryEvent`.
27
-
GemFire generates events whenever an entry is CREATED, UPDATED, DESTROYED, or INVALIDATED in the associated region.
49
+
GemFire generates events whenever an entry is `CREATED`, `UPDATED`, `DESTROYED` or `INVALIDATED` in the associated region.
28
50
The inbound channel adapter allows you to filter on a subset of these events.
29
51
For example, you may want to only produce messages in response to an entry being CREATED.
30
52
In addition, the inbound channel adapter can evaluate a SpEL expression if, for example, you want your message payload to contain an event property such as the new entry value.
@@ -43,7 +65,7 @@ By default CREATED and UPDATED are enabled.
43
65
Note that this adapter conforms to Spring integration conventions.
44
66
If no `channel` attribute is provided, the channel will be created from the `id` attribute.
45
67
This adapter also supports an `error-channel`.
46
-
The GemFire http://www.gemstone.com/docs/current/product/docs/japi/com/gemstone/gemfire/cache/EntryEvent.html[EntryEvent] is the `#root` object of the `expression` evaluation.
68
+
The GemFire hhttps://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/EntryEvent.html[EntryEvent] is the `#root` object of the `expression` evaluation.
47
69
Example:
48
70
[source]
49
71
----
@@ -56,13 +78,13 @@ If the `expression` attribute is not provided, the message payload will be the G
56
78
=== Continuous Query Inbound Channel Adapter
57
79
58
80
The _cq-inbound-channel-adapter_ produces messages a channel triggered by a GemFire continuous query or `CqEvent` event.
59
-
Spring GemFire introduced continuous query support in release 1.1, including a `ContinuousQueryListenerContainer` which provides a nice abstraction over the GemFire native API.
81
+
Spring Data introduced continuous query support in release `1.1`, including a `ContinuousQueryListenerContainer` which provides a nice abstraction over the GemFire native API.
60
82
This adapter requires a reference to a ContinuousQueryListenerContainer, and creates a listener for a given `query` and executes the query.
61
83
The continuous query acts as an event source that will fire whenever its result set changes state.
62
84
63
85
NOTE: GemFire queries are written in OQL and are scoped to the entire cache (not just one region).
64
86
Additionally, continuous queries require a remote (i.e., running in a separate process or remote host) cache server.
65
-
Please consult the http://www.gemstone.com/docs/6.6.RC/product/docs/html/user_guide/UserGuide_GemFire.html#Continuous%20Querying[GemFire documentation] for more information on implementing continuous queries.
87
+
Please consult the http://gemfire82.docs.pivotal.io/docs-gemfire/gemfire_nativeclient/continuous-querying/continuous-querying.html[GemFire documentation] for more information on implementing continuous queries.
66
88
67
89
68
90
[source,xml]
@@ -83,16 +105,16 @@ Please consult the http://www.gemstone.com/docs/6.6.RC/product/docs/html/user_gu
83
105
query="select * from /test"/>
84
106
----
85
107
86
-
In the above configuration, we are creating a GemFire client cache (recall a remote cache server is required for this implementation and its address is configured as a sub-element of the pool), a client region and a `ContinuousQueryListenerContainer` using Spring GemFire.
108
+
In the above configuration, we are creating a GemFire client cache (recall a remote cache server is required for this implementation and its address is configured as a sub-element of the pool), a client region and a `ContinuousQueryListenerContainer` using Spring Data.
87
109
The continuous query inbound channel adapter requires a `cq-listener-container` attribute which contains a reference to the `ContinuousQueryListenerContainer`.
88
110
Optionally, it accepts an `expression` attribute which uses SpEL to transform the `CqEvent` or extract an individual property as needed.
89
111
The cq-inbound-channel-adapter provides a `query-events` attribute, containing a comma separated list of event types for which a message will be produced on the input channel.
90
-
Available event types are CREATED, UPDATED, DESTROYED, REGION_DESTROYED, REGION_INVALIDATED.
91
-
CREATED and UPDATED are enabled by default.
112
+
Available event types are `CREATED`, `UPDATED`, `DESTROYED`, `REGION_DESTROYED` and `REGION_INVALIDATED`.
113
+
`CREATED` and `UPDATED` are enabled by default.
92
114
Additional optional attributes include, `query-name` which provides an optional query name, and `expression` which works as described in the above section, and `durable` - a boolean value indicating if the query is durable (false by default).
93
115
Note that this adapter conforms to Spring integration conventions.
94
116
If no `channel` attribute is provided, the channel will be created from the `id` attribute.
95
-
This adapter also supports an `error-channel`
117
+
This adapter also supports an `error-channel`.
96
118
97
119
[[gemfire-outbound]]
98
120
=== Outbound Channel Adapter
@@ -128,7 +150,7 @@ This adapter also supports the `order` attribute which may be useful if it is bo
128
150
129
151
As described in EIP, a http://www.eaipatterns.com/MessageStore.html[Message Store] allows you to persist Messages.
130
152
This can be very useful when dealing with components that have a capability to buffer messages (_QueueChannel, Aggregator, Resequencer_, etc.) if reliability is a concern.
131
-
In Spring Integration, the MessageStore strategy also provides the foundation for thehttp://www.eaipatterns.com/StoreInLibrary.html[ClaimCheck] pattern, which is described in EIP as well.
153
+
In Spring Integration, the MessageStore strategy also provides the foundation for the http://www.eaipatterns.com/StoreInLibrary.html[ClaimCheck] pattern, which is described in EIP as well.
132
154
133
155
Spring Integration's Gemfire module provides the `GemfireMessageStore` which is an implementation of both the the `MessageStore` strategy (mainly used by the _QueueChannel_ and _ClaimCheck_ patterns) and the `MessageGroupStore` strategy (mainly used by the _Aggregator_ and _Resequencer_ patterns).
134
156
@@ -152,7 +174,7 @@ Spring Integration's Gemfire module provides the `GemfireMessageStore` which is
152
174
----
153
175
154
176
In the above example, the cache and region are configured using the spring-gemfire namespace (not to be confused with the spring-integration-gemfire namespace).
155
-
Often it is desirable for the message store to be maintained in one or more remote cache servers in a client-server configuration (See the http://www.vmware.com/support/pubs/vfabric-gemfire.html[GemFire product documentation] for more details).
177
+
Often it is desirable for the message store to be maintained in one or more remote cache servers in a client-server configuration.
156
178
In this case, you configure a client cache, client region, and client pool and inject the region into the MessageStore.
157
179
Here is an example:
158
180
[source,xml]
@@ -175,7 +197,7 @@ Note the _pool_ element is configured with the address of a cache server (a loca
175
197
The region is configured as a 'PROXY' so that no data will be stored locally.
176
198
The region's id corresponds to a region with the same name configured in the cache server.
177
199
178
-
Starting with version _4.3.12_, the `GemfireMessageStore` supports the key `prefix` option to allow distinguishing between instances of the store on the same Gemfire region.
200
+
Starting with version _4.3.12_, the `GemfireMessageStore` supports the key `prefix` option to allow distinguishing between instances of the store on the same GemFire region.
0 commit comments