Fork me on GitHub

Welcome to Apache Curator

What is Curator?

Curator n ˈkyoor͝ˌātər: a keeper or custodian of a museum or other collection - A ZooKeeper Keeper.

Apache Curator is a Java/JVM client library for Apache ZooKeeper, a distributed coordination service. It includes a highlevel API framework and utilities to make using Apache ZooKeeper much easier and more reliable. It also includes recipes for common use cases and extensions such as service discovery and a Java 8 asynchronous DSL.

Download

Download Apache Curator from the release page.

Important Compatibility Updates

Note: version 5.0 of Curator has a few breaking changes. Please read the details here:

Curator 5.0 Breaking Changes.

Getting Started

See the page for quick start: Getting Started.

Stack Overflow

There's lots of great help on Stack Overflow:

Nav Bar

Use the navigation links in the left-nav menu for detailed information.

Maven / Artifacts

Curator binaries are published to Maven Central. Curator consists of several artifacts. Which artifacts to use depends on your needs. For most users, the only artifact you need is curator-recipes.

For OSGi users, there's another set of artifacts of classifier osgi available in Maven Central. These artifacts are not shaded, thus no package relocation is performed inside, so hopefully they could start as bundles when their dependencies are fulfilled by dedicated bundles, e.g. guava.

GroupID/OrgArtifactID/NameDescription
org.apache.curatorcurator-recipesAll of the recipes. Note: this artifact has dependencies on client and framework and, so, Maven (or whatever tool you're using) should pull those in automatically.
org.apache.curatorcurator-asyncAsynchronous DSL with O/R modeling, migrations and many other features.
org.apache.curatorcurator-frameworkThe Curator Framework high level API. This is built on top of the client and should pull it in automatically.
org.apache.curatorcurator-clientThe Curator Client - replacement for the ZooKeeper class in the ZK distribution.
org.apache.curatorcurator-testContains the TestingServer, the TestingCluster and a few other tools useful for testing.
org.apache.curatorcurator-examplesExample usages of various Curator features.
org.apache.curatorcurator-x-discoveryA Service Discovery implementation built on the Curator Framework.
org.apache.curatorcurator-x-discovery-serverA RESTful server that can be used with Curator Discovery.