[CURATOR-322] Schema support - path validation and documentation - ASF JIRA

Attach files

Attach Screenshot

Voters

Watch issue

Watchers

Create sub-task

Link

Clone

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: New Feature
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: 3.1.0
Fix Version/s: 3.2.0
Component/s: Framework
Labels:
None

Description

ZooKeeper applications are heavily dependent on correct usage of paths, watchers, ZNode data, etc. Currently, there is no mechanism for validating and documenting this. It would be nice to have some kind of schema system that allows for this.

This issue provides several items of functionality: a) ZNode path documentation; b) ZNode path validation; c) keyed reference to ZNode paths. Both items are defined in a new class, Schema. A Curator Schema specifies a ZNode path (or regex pattern), documentation for that path, and the operations that are allowed on that path. Additionally, a set of Schema objects are collected into a SchemaSet object that allows any Schema (and thereby its path) to be retrieved via a symbolic name. This should make path management in ZK applications easier. Lastly, a utility is provided to load SchemaSets from a file/stream in JSON format.