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 2014/11/04 22:19:21 UTC
svn commit: r1636739 - in /curator/site/trunk/curator-recipes:
Tree-cache.html tree-cache.html
Author: randgalt
Date: Tue Nov 4 21:19:20 2014
New Revision: 1636739
URL: http://svn.apache.org/r1636739
Log:
fixed caps
Added:
curator/site/trunk/curator-recipes/tree-cache.html
Removed:
curator/site/trunk/curator-recipes/Tree-cache.html
Added: curator/site/trunk/curator-recipes/tree-cache.html
URL: http://svn.apache.org/viewvc/curator/site/trunk/curator-recipes/tree-cache.html?rev=1636739&view=auto
==============================================================================
--- curator/site/trunk/curator-recipes/tree-cache.html (added)
+++ curator/site/trunk/curator-recipes/tree-cache.html Tue Nov 4 21:19:20 2014
@@ -0,0 +1,402 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-11-03
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20141103" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Curator Recipes - </title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<link rel="stylesheet" href="../css/site.css"/>
+
+
+<script type="text/javascript">$(function(){
+ if ( location.pathname.match(".*index\.html") )
+ {
+ $('a[title="Recipes"]').parent().addClass("active");
+ }
+ });</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../index.html" id="bannerLeft">
+ <img src="../images/curator-logo.png" alt="Apache Curator"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://apache.org" id="bannerRight">
+ <img src="http://apache.org/images/feather-small.gif" alt="Apache"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2014-11-03</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://zookeeper.apache.org" class="externalLink" title="Apache ZooKeeper">
+ Apache ZooKeeper</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Curator</li>
+
+ <li>
+
+ <a href="../index.html" title="About">
+ <i class="none"></i>
+ About</a>
+ </li>
+
+ <li>
+
+ <a href="../getting-started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-examples/index.html" title="Examples">
+ <i class="none"></i>
+ Examples</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-recipes/index.html" title="Recipes">
+ <i class="none"></i>
+ Recipes</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-framework/index.html" title="Framework">
+ <i class="none"></i>
+ Framework</a>
+ </li>
+
+ <li>
+
+ <a href="../utilities.html" title="Utilities">
+ <i class="none"></i>
+ Utilities</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-client/index.html" title="Client">
+ <i class="none"></i>
+ Client</a>
+ </li>
+ <li class="nav-header">Details</li>
+
+ <li>
+
+ <a href="../errors.html" title="Error Handling">
+ <i class="none"></i>
+ Error Handling</a>
+ </li>
+
+ <li>
+
+ <a href="../logging.html" title="Logging and Tracing">
+ <i class="none"></i>
+ Logging and Tracing</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Tech+Notes" class="externalLink" title="Tech Notes">
+ <i class="none"></i>
+ Tech Notes</a>
+ </li>
+
+ <li>
+
+ <a href="../exhibitor.html" title="Exhibitor Integration">
+ <i class="none"></i>
+ Exhibitor Integration</a>
+ </li>
+
+ <li>
+
+ <a href="../source-repository.html" title="Source Code">
+ <i class="none"></i>
+ Source Code</a>
+ </li>
+
+ <li>
+
+ <a href="../team-list.html" title="Project Team">
+ <i class="none"></i>
+ Project Team</a>
+ </li>
+
+ <li>
+
+ <a href="../project-info.html" title="Project Information">
+ <i class="none"></i>
+ Project Information</a>
+ </li>
+
+ <li>
+
+ <a href="../apidocs/index.html" title="Javadoc">
+ <i class="none"></i>
+ Javadoc</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR" class="externalLink" title="Wiki">
+ <i class="none"></i>
+ Wiki</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Releases" class="externalLink" title="Releases">
+ <i class="none"></i>
+ Releases</a>
+ </li>
+ <li class="nav-header">Extensions</li>
+
+ <li>
+
+ <a href="../curator-x-discovery/index.html" title="Service Discovery">
+ <i class="none"></i>
+ Service Discovery</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-x-discovery-server/index.html" title="Service Discovery Server">
+ <i class="none"></i>
+ Service Discovery Server</a>
+ </li>
+
+ <li>
+
+ <a href="../curator-x-rpc/index.html" title="Curator RPC Proxy">
+ <i class="none"></i>
+ Curator RPC Proxy</a>
+ </li>
+ <li class="nav-header">Community</li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Submitting+Pull+Requests" class="externalLink" title="Submitting Pull Requests">
+ <i class="none"></i>
+ Submitting Pull Requests</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Curator's+History" class="externalLink" title="History">
+ <i class="none"></i>
+ History</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Third+Party+Articles" class="externalLink" title="Third Party Articles">
+ <i class="none"></i>
+ Third Party Articles</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/Contributions+to+Curator" class="externalLink" title="Third Party Contributions">
+ <i class="none"></i>
+ Third Party Contributions</a>
+ </li>
+
+ <li>
+
+ <a href="https://cwiki.apache.org/confluence/display/CURATOR/For+Curator+Committers" class="externalLink" title="For Committers">
+ <i class="none"></i>
+ For Committers</a>
+ </li>
+ <li class="nav-header">ASF</li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ <i class="none"></i>
+ How the ASF works</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ <i class="none"></i>
+ Get Involved</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ <i class="none"></i>
+ Developer Resources</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ <i class="none"></i>
+ Sponsorship</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ <i class="none"></i>
+ Thanks</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://curator.apache.org/curator-recipes" data-size="tall" ></div>
+
+ <div class="clear"></div>
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://curator.apache.org/curator-recipes&send=false&layout=box_count&show-faces=false&action=like&colorscheme=light"
+ scrolling="no" frameborder="0"
+ style="border:none; width:48px; height:63px; margin-top: 10px;" ></iframe>
+ <div class="clear"></div>
+
+
+
+ <div id="twitter">
+
+ <a href="https://twitter.com/ApacheCurator" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="false" data-lang="en">Follow ApacheCurator</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+ </div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <div class="section">
+<h2>Tree Cache<a name="Tree_Cache"></a></h2></div>
+<div class="section">
+<h3>Description<a name="Description"></a></h3></div>
+<p>A utility that attempts to keep all data from all children of a ZK path locally cached. This class will watch the ZK path, respond to update/create/delete events, pull down the data, etc. You can register a listener that will get notified when changes occur.</p>
+<div class="section">
+<h3>Participating Classes<a name="Participating_Classes"></a></h3></div>
+<ul>
+<li>TreeCache</li>
+<li>TreeCacheListener</li>
+<li>TreeCacheEvent</li>
+<li>ChildData</li></ul>
+<div class="section">
+<h3>Usage<a name="Usage"></a></h3></div>
+<div class="section">
+<h4>Creating a TreeCache<a name="Creating_a_TreeCache"></a></h4></div>
+<div class="source">
+<pre>public TreeCache(CuratorFramework client,
+ String path,
+ boolean cacheData)
+Parameters:
+client - the client
+path - path to watch
+cacheData - if true, node contents are cached in addition to the stat
+</pre></div>
+<div class="section">
+<h3>General Usage<a name="General_Usage"></a></h3></div>
+<p>The cache must be started by calling <tt>start()</tt>. Call <tt>close()</tt> when you are through with the cache.</p>
+<p>At any time, call <tt>getCurrentChildren()</tt> to get the current state of the cache. Alternatively, call <tt>getCurrentData()</tt> to get the data for a given path that's being monitored.</p>
+<p>You can also register to be notified when a change occurs by calling <tt>getListenable()</tt> and then:</p>
+<div class="source">
+<pre>public void addListener(TreeCacheListener listener)
+ Add a change listener
+Parameters:
+listener - the listener
+</pre></div>
+<div class="section">
+<h3>Error Handling<a name="Error_Handling"></a></h3></div>
+<p>TreeCache instances internally monitor a <tt>ConnectionStateListener</tt>. If the connection state changes, the cache will receive messages detailing the change.</p>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2011-2014
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div style="margin-bottom: 8px;" class="row span12">Apache Curator, the Apache feather logo, and the Apache Curator project logos are
+ trademarks of The Apache Software Foundation. All other marks mentioned may be
+ trademarks or registered trademarks of their respective owners.</div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/apache-curator/widgets/project_factoids.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>