You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ra...@apache.org on 2017/05/10 12:09:17 UTC

curator git commit: doc updates

Repository: curator
Updated Branches:
  refs/heads/CURATOR-397 13e17cbbf -> cba43b342


doc updates


Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/cba43b34
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/cba43b34
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/cba43b34

Branch: refs/heads/CURATOR-397
Commit: cba43b342400461e0d4f0dfd894b69a8b1891438
Parents: 13e17cb
Author: randgalt <ra...@apache.org>
Authored: Wed May 10 14:09:12 2017 +0200
Committer: randgalt <ra...@apache.org>
Committed: Wed May 10 14:09:12 2017 +0200

----------------------------------------------------------------------
 .../site/confluence/modeled-components.confluence   | 16 ++++++++++++++++
 .../src/site/confluence/modeled-typed.confluence    |  2 ++
 .../src/site/confluence/modeled.confluence          |  7 +++++++
 3 files changed, 25 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/curator/blob/cba43b34/curator-x-async/src/site/confluence/modeled-components.confluence
----------------------------------------------------------------------
diff --git a/curator-x-async/src/site/confluence/modeled-components.confluence b/curator-x-async/src/site/confluence/modeled-components.confluence
index 4c3d1dc..7bcc87f 100644
--- a/curator-x-async/src/site/confluence/modeled-components.confluence
+++ b/curator-x-async/src/site/confluence/modeled-components.confluence
@@ -68,6 +68,22 @@ ModelSpec<MyModel> spec = ModelSpec.builder(path, JacksonModelSerializer.build(M
 ModelSpec<MyModel> resolvedSpec = spec.resolve(param1, param2);
 {code}
 
+h3. JacksonModelSerializer
+
+A Jackson serializer, {{JacksonModelSerializer}}, is included. However, the Jackson dependency for it is
+specified as "provided" in the curator\-x\-async Maven POM file to avoid adding a new dependency to Curator.
+Therefore, if you wish to use the JacksonModelSerializer you must manually add the dependency to your build system.
+
+E.g. for Maven:
+
+{code}
+<dependency>
+    <groupId>com.fasterxml.jackson.core</groupId>
+    <artifactId>jackson-databind</artifactId>
+    <version>XXXX</version>
+</dependency>
+{code}
+
 h2. ModeledFramework
 
 {{ModeledFramework}} ties together all the metadata into a Curator\-style instance that is

http://git-wip-us.apache.org/repos/asf/curator/blob/cba43b34/curator-x-async/src/site/confluence/modeled-typed.confluence
----------------------------------------------------------------------
diff --git a/curator-x-async/src/site/confluence/modeled-typed.confluence b/curator-x-async/src/site/confluence/modeled-typed.confluence
index 967ae64..2a73a75 100644
--- a/curator-x-async/src/site/confluence/modeled-typed.confluence
+++ b/curator-x-async/src/site/confluence/modeled-typed.confluence
@@ -45,6 +45,8 @@ TypedModeledFramework2<Person, Group, Organization> clientTemplate = TypedModele
 
 ...
 
+Group group = ...
+Organization organization = ...
 ModeledFramework<Person> client = clientTemplate.resolve(group, organization);
 client.set(person);
 {code}

http://git-wip-us.apache.org/repos/asf/curator/blob/cba43b34/curator-x-async/src/site/confluence/modeled.confluence
----------------------------------------------------------------------
diff --git a/curator-x-async/src/site/confluence/modeled.confluence b/curator-x-async/src/site/confluence/modeled.confluence
index d4972b1..32e8727 100644
--- a/curator-x-async/src/site/confluence/modeled.confluence
+++ b/curator-x-async/src/site/confluence/modeled.confluence
@@ -39,3 +39,10 @@ h2. Example
 
 A complete example usage of Modeled Curator along with CachedModeledFramework and Typed Parameter Templates
 can be found here: [[https://github.com/apache/curator/tree/master/curator-examples/src/main/java/pubsub]].
+
+h2. Details
+
+For more details see:
+
+* [[Components|modeled-components.html]]
+* [[Caching, Typed Parameters and Versioning|modeled-typed.html]]