Google Git
Sign in
apache / geode-examples / refs/tags/rel/v1.2.1
tagf9af8710c54f20617bb1ddb53f4f54022a2f7422
taggerAnthony Baker <abaker@apache.org>Wed Sep 20 10:37:14 2017 -0700
object5d034de588a43cdefb8fbb3a6259579785768340 
Apache Geode v1.2.1 release
commit5d034de588a43cdefb8fbb3a6259579785768340[log] [tgz]
authorDan Smith <upthewaterspout@apache.org>Wed Jul 12 15:30:13 2017 -0700
committerAnthony Baker <abaker@apache.org>Thu Jul 20 13:40:03 2017 -0700
treeb2f1c1a52621cc01c8459af6c0d670784333fb3c
parent1067c21e43f436b6efb17f35344c0fd59462426f [diff]
GEODE-3199: Make signing with a gpg key optional

Make it optional to sign the archives with a gpg key, to avoid annoying
users trying to build the examples. You must specify the property
-PsignArchives to sign with a gpg key.

(cherry picked from commit 76cce858773dd390c27de717a5d7c92a9d7aaf9b)
1 file changed
tree: b2f1c1a52621cc01c8459af6c0d670784333fb3c
  1. buildSrc/
  2. etc/
  3. gradle/
  4. loader/
  5. partitioned/
  6. replicated/
  7. src/
  8. .gitignore
  9. .travis.yml
  10. build.gradle
  11. gradle.properties
  12. gradlew
  13. KEYS
  14. LICENSE
  15. NOTICE
  16. README.md
  17. settings.gradle
README.md

Build Status License

Apache Geode examples

This is the home of Apache Geode examples that are bundled with the project. Contributions[2] and corrections are welcome. Please talk to us about your suggestions at dev@geode.apache.org or submit a pull request.

Adding a new example

Follow this approach to add a new example:

  • Create a subdirectory with a descriptive name like cache-writer
  • Create a README.md file in the example subproject to walk the user through the tutorial
  • Create a Java class with a main method in the org.apache.geode.examples.$name.Example class
  • Create a cluster initialization script in scripts/start.gfsh
  • Create a cluster shutdown script in scripts/stop.gfsh

The scripts should contain gfsh commands for starting locators, servers, and creating regions--everything that the example program will need to use. Where appropriate you should also add unit tests. To customize the build you can add a build.gradle file.

Note that the build may fail if you do not add ASF license headers or use the correct formatting (you can fix formatting with gradle spotlessApply).

Running an example

The gradle build will automatically download and install a Geode release in the build directory. You can run an example with the following gradle targets:

  • build - compiles the example and runs unit tests
  • start - initializes the Geode cluster
  • run - runs the example Application
  • stop - shuts down the cluster
  • runAll - invokes start, run, stop

The commands you need to invoke will be given in the README.md file. Sample usage:

$ ./gradle :replicated:start
$ ./gradle :replicated:run
$ ./gradle :replicated:stop
$ ./gradle runAll

Catalog of examples

The following sections call out ready-made examples or new examples that could be built. You may want to start your journey with the Apache Geode in 15 minutes or Less tutorial.

Basics

Intermediate

  • PDX & Serialization
  • Lucene Indexing
  • OQL Indexing
  • Functions
  • CacheLoader & CacheWriter
  • Listeners
  • Async Event Queues
  • Continuous Querying
  • Transactions
  • Eviction
  • Expiration
  • Overflow
  • Security
  • Off-heap

Advanced

  • WAN Gateway
  • Durable subscriptions
  • Delta propagation
  • Network partition detection
  • D-lock
  • Compression
  • Resource manager
  • PDX Advanced

Use cases, integrations and external examples

This section has self-contained little projects that illustrate a use case or an integration with other projects.

  • SpringBoot Application
  • HTTP Session replication
  • Redis
  • Memcached
  • Spark Connector

References

Export Control

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software: