helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r1407678 [31/47] - in /incubator/helix/site-content: ./ apidocs/assets/ apidocs/reference/ apidocs/reference/org/apache/helix/ apidocs/reference/org/apache/helix/alerts/ apidocs/reference/org/apache/helix/controller/ apidocs/reference/org/a...
Date Fri, 09 Nov 2012 22:55:15 GMT
Modified: incubator/helix/site-content/xref/org/apache/helix/ClusterMessagingService.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/ClusterMessagingService.html?rev=1407678&r1=1407677&r2=1407678&view=diff
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/ClusterMessagingService.html (original)
+++ incubator/helix/site-content/xref/org/apache/helix/ClusterMessagingService.html Fri Nov  9 22:54:26 2012
@@ -36,98 +36,96 @@
 <a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment">/**</em>
 <a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * Provides the ability to &lt;br&gt;</em>
 <a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Send message to a specific component in the cluster[ participant,</em>
-<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * controller, Router(probably not needed) ]&lt;/li&gt; &lt;li&gt;Broadcast message to all</em>
-<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * nodes&lt;/li&gt; &lt;li&gt;Send message to instances that hold a specific resource&lt;/li&gt;</em>
+<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * controller, Spectator(probably not needed) ]&lt;/li&gt; &lt;li&gt;Broadcast message to all</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * participants&lt;/li&gt; &lt;li&gt;Send message to instances that hold a specific resource&lt;/li&gt;</em>
 <a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Asynchronous request response api. Send message with a co-relation id and</em>
 <a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * invoke a method when there is a response. Can support timeout.&lt;/li&gt;</em>
 <a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * </em>
-<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * @author kgopalak</em>
-<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * </em>
-<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="37" href="#37">37</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/ClusterMessagingService.html">ClusterMessagingService</a>
-<a class="jxr_linenumber" name="38" href="#38">38</a>  {
-<a class="jxr_linenumber" name="39" href="#39">39</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * Send message matching the specifications mentioned in recipientCriteria.</em>
-<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
-<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   * @See Criteria</em>
-<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">   * @param message</em>
-<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">   *          message to be sent. Some attributes of this message will be</em>
-<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   *          changed as required</em>
-<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">   * @return returns how many messages were successfully sent.</em>
-<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="49" href="#49">49</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> recipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message);
-<a class="jxr_linenumber" name="50" href="#50">50</a>  
-<a class="jxr_linenumber" name="51" href="#51">51</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * This will send the message to all instances matching the criteria&lt;br&gt;</em>
-<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * When there is a reply to the message sent AsynCallback.onReply will be</em>
-<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * invoked. Application can specify a timeout on AsyncCallback. After every</em>
-<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * reply is processed AsyncCallback.isDone will be invoked.&lt;br&gt;</em>
-<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   * This method will return after sending the messages. &lt;br&gt;</em>
-<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   * This is useful when message need to be sent and current thread need not</em>
-<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   * wait for response since processing will be done in another thread.</em>
-<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
-<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * @param message</em>
-<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * @param callbackOnReply</em>
-<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * @param timeOut</em>
-<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   * @param retryCount</em>
-<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="67" href="#67">67</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
-<a class="jxr_linenumber" name="68" href="#68">68</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut);
-<a class="jxr_linenumber" name="69" href="#69">69</a>  
-<a class="jxr_linenumber" name="70" href="#70">70</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
-<a class="jxr_linenumber" name="71" href="#71">71</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut, <strong class="jxr_keyword">int</strong> retryCount);
-<a class="jxr_linenumber" name="72" href="#72">72</a>  
-<a class="jxr_linenumber" name="73" href="#73">73</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * This will send the message to all instances matching the criteria&lt;br&gt;</em>
-<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   * When there is a reply to the message sent AsynCallback.onReply will be</em>
-<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * invoked. Application can specify a timeout on AsyncCallback. After every</em>
-<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * reply is processed AsyncCallback.isDone will be invoked.&lt;br&gt;</em>
-<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   * This method will return only after the AsyncCallback.isDone() returns true &lt;br&gt;</em>
-<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * This is useful when message need to be sent and current thread has to wait</em>
-<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   * for response. &lt;br&gt;</em>
-<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">   * The current thread can use callbackOnReply instance to store application</em>
-<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">   * specific data.</em>
-<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
-<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * @param message</em>
-<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * @param callbackOnReply</em>
-<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * @param timeOut</em>
-<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   * @param retryCount</em>
-<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="91" href="#91">91</a>    <strong class="jxr_keyword">int</strong> sendAndWait(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
-<a class="jxr_linenumber" name="92" href="#92">92</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut);
-<a class="jxr_linenumber" name="93" href="#93">93</a>  
-<a class="jxr_linenumber" name="94" href="#94">94</a>    <strong class="jxr_keyword">int</strong> sendAndWait(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
-<a class="jxr_linenumber" name="95" href="#95">95</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut, <strong class="jxr_keyword">int</strong> retryCount);
-<a class="jxr_linenumber" name="96" href="#96">96</a>  
-<a class="jxr_linenumber" name="97" href="#97">97</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * This will register a message handler factory to create handlers for</em>
-<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * message. In case client code defines its own message type, it can define a</em>
-<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   * message handler factory to create handlers to process those messages.</em>
-<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * Messages are processed in a threadpool which is hosted by cluster manager,</em>
-<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   * and cluster manager will call the factory to create handler, and the</em>
-<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">   * handler is called in the threadpool.</em>
-<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">   * Note that only one message handler factory can be registered with one</em>
-<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * message type.</em>
-<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * @param type</em>
-<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">   *          The message type that the factory will create handler for</em>
-<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">   * @param factory</em>
-<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">   *          The per-type message factory</em>
-<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">   * @param threadpoolSize</em>
-<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">   *        size of the execution threadpool that handles the message </em>
-<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="116" href="#116">116</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> registerMessageHandlerFactory(String type,
-<a class="jxr_linenumber" name="117" href="#117">117</a>       <a href="../../../org/apache/helix/messaging/handling/MessageHandlerFactory.html">MessageHandlerFactory</a> factory);
-<a class="jxr_linenumber" name="118" href="#118">118</a>   
-<a class="jxr_linenumber" name="119" href="#119">119</a> 
-<a class="jxr_linenumber" name="120" href="#120">120</a> }
+<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/ClusterMessagingService.html">ClusterMessagingService</a>
+<a class="jxr_linenumber" name="36" href="#36">36</a>  {
+<a class="jxr_linenumber" name="37" href="#37">37</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * Send message matching the specifications mentioned in recipientCriteria.</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * @See Criteria</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * @param message</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   *          message to be sent. Some attributes of this message will be</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">   *          changed as required</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">   * @return returns how many messages were successfully sent.</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> recipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message);
+<a class="jxr_linenumber" name="48" href="#48">48</a>  
+<a class="jxr_linenumber" name="49" href="#49">49</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * This will send the message to all instances matching the criteria&lt;br&gt;</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * When there is a reply to the message sent AsynCallback.onReply will be</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * invoked. Application can specify a timeout on AsyncCallback. After every</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * reply is processed AsyncCallback.isDone will be invoked.&lt;br&gt;</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * This method will return after sending the messages. &lt;br&gt;</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * This is useful when message need to be sent and current thread need not</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   * wait for response since processing will be done in another thread.</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * @param message</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * @param callbackOnReply</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * @param timeOut</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * @param retryCount</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
+<a class="jxr_linenumber" name="66" href="#66">66</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut);
+<a class="jxr_linenumber" name="67" href="#67">67</a>  
+<a class="jxr_linenumber" name="68" href="#68">68</a>    <strong class="jxr_keyword">int</strong> send(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
+<a class="jxr_linenumber" name="69" href="#69">69</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut, <strong class="jxr_keyword">int</strong> retryCount);
+<a class="jxr_linenumber" name="70" href="#70">70</a>  
+<a class="jxr_linenumber" name="71" href="#71">71</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   * This will send the message to all instances matching the criteria&lt;br&gt;</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * When there is a reply to the message sent AsynCallback.onReply will be</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * invoked. Application can specify a timeout on AsyncCallback. After every</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   * reply is processed AsyncCallback.isDone will be invoked.&lt;br&gt;</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * This method will return only after the AsyncCallback.isDone() returns true &lt;br&gt;</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * This is useful when message need to be sent and current thread has to wait</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   * for response. &lt;br&gt;</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * The current thread can use callbackOnReply instance to store application</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   * specific data.</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">   * @param receipientCriteria</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   * @param message</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * @param callbackOnReply</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * @param timeOut</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * @param retryCount</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a>    <strong class="jxr_keyword">int</strong> sendAndWait(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
+<a class="jxr_linenumber" name="90" href="#90">90</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut);
+<a class="jxr_linenumber" name="91" href="#91">91</a>  
+<a class="jxr_linenumber" name="92" href="#92">92</a>    <strong class="jxr_keyword">int</strong> sendAndWait(<a href="../../../org/apache/helix/Criteria.html">Criteria</a> receipientCriteria, <a href="../../../org/apache/helix/model/Message.html">Message</a> message,
+<a class="jxr_linenumber" name="93" href="#93">93</a>        <a href="../../../org/apache/helix/messaging/AsyncCallback.html">AsyncCallback</a> callbackOnReply, <strong class="jxr_keyword">int</strong> timeOut, <strong class="jxr_keyword">int</strong> retryCount);
+<a class="jxr_linenumber" name="94" href="#94">94</a>  
+<a class="jxr_linenumber" name="95" href="#95">95</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   * This will register a message handler factory to create handlers for</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * message. In case client code defines its own message type, it can define a</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * message handler factory to create handlers to process those messages.</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * Messages are processed in a threadpool which is hosted by cluster manager,</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   * and cluster manager will call the factory to create handler, and the</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * handler is called in the threadpool.</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">   * Note that only one message handler factory can be registered with one</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">   * message type.</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * @param type</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">   *          The message type that the factory will create handler for</em>
+<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * @param factory</em>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">   *          The per-type message factory</em>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">   * @param threadpoolSize</em>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">   *        size of the execution threadpool that handles the message </em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> registerMessageHandlerFactory(String type,
+<a class="jxr_linenumber" name="115" href="#115">115</a>       <a href="../../../org/apache/helix/messaging/handling/MessageHandlerFactory.html">MessageHandlerFactory</a> factory);
+<a class="jxr_linenumber" name="116" href="#116">116</a>   
+<a class="jxr_linenumber" name="117" href="#117">117</a> 
+<a class="jxr_linenumber" name="118" href="#118">118</a> }
 </pre>
 <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 </html>

Modified: incubator/helix/site-content/xref/org/apache/helix/ConfigChangeListener.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/ConfigChangeListener.html?rev=1407678&r1=1407677&r2=1407678&view=diff
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/ConfigChangeListener.html (original)
+++ incubator/helix/site-content/xref/org/apache/helix/ConfigChangeListener.html Fri Nov  9 22:54:26 2012
@@ -35,22 +35,21 @@
 <a class="jxr_linenumber" name="25" href="#25">25</a>  
 <a class="jxr_linenumber" name="26" href="#26">26</a>  
 <a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * @author kgopalak</em>
-<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * </em>
-<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/ConfigChangeListener.html">ConfigChangeListener</a>
-<a class="jxr_linenumber" name="32" href="#32">32</a>  {
-<a class="jxr_linenumber" name="33" href="#33">33</a>  
-<a class="jxr_linenumber" name="34" href="#34">34</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment">   * Invoked when participant config changes</em>
-<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   * @param configs</em>
-<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * @param changeContext</em>
-<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="40" href="#40">40</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onConfigChange(List&lt;InstanceConfig&gt; configs,
-<a class="jxr_linenumber" name="41" href="#41">41</a>                               <a href="../../../org/apache/helix/NotificationContext.html">NotificationContext</a> changeContext);
-<a class="jxr_linenumber" name="42" href="#42">42</a>  
-<a class="jxr_linenumber" name="43" href="#43">43</a>  }
+<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/ConfigChangeListener.html">ConfigChangeListener</a>
+<a class="jxr_linenumber" name="31" href="#31">31</a>  {
+<a class="jxr_linenumber" name="32" href="#32">32</a>  
+<a class="jxr_linenumber" name="33" href="#33">33</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   * Invoked when participant config changes</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment">   * @param configs</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   * @param changeContext</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onConfigChange(List&lt;InstanceConfig&gt; configs,
+<a class="jxr_linenumber" name="40" href="#40">40</a>                               <a href="../../../org/apache/helix/NotificationContext.html">NotificationContext</a> changeContext);
+<a class="jxr_linenumber" name="41" href="#41">41</a>  
+<a class="jxr_linenumber" name="42" href="#42">42</a>  }
 </pre>
 <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 </html>

Modified: incubator/helix/site-content/xref/org/apache/helix/HelixDataAccessor.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/HelixDataAccessor.html?rev=1407678&r1=1407677&r2=1407678&view=diff
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/HelixDataAccessor.html (original)
+++ incubator/helix/site-content/xref/org/apache/helix/HelixDataAccessor.html Fri Nov  9 22:54:26 2012
@@ -39,140 +39,139 @@
 <a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * LiveInstance, Message, ExternalView etc PropertyKey represent the HelixData</em>
 <a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * type. See {@link Builder} to get more information on building a propertyKey.</em>
 <a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * </em>
-<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @author kgopalak</em>
-<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * </em>
-<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/HelixDataAccessor.html">HelixDataAccessor</a>
-<a class="jxr_linenumber" name="36" href="#36">36</a>  {
-<a class="jxr_linenumber" name="37" href="#37">37</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * Create a helix property only if it does not exist.</em>
-<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * @param value</em>
-<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * @return true if creation was successful. False if already exists or if it</em>
-<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   *         failed to create</em>
-<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="45" href="#45">45</a>  
-<a class="jxr_linenumber" name="46" href="#46">46</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> createProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
-<a class="jxr_linenumber" name="47" href="#47">47</a>  
-<a class="jxr_linenumber" name="48" href="#48">48</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   * Set a property, overwrite if it exists and creates if not exists. This api</em>
-<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * assumes the node exists and only tries to update it only if the call fail</em>
-<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * it will create the node. So there is a performance cost if always ends up</em>
-<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * creating the node.</em>
-<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * @param value</em>
-<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   * @true if the operation was successful</em>
-<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="58" href="#58">58</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> setProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
-<a class="jxr_linenumber" name="59" href="#59">59</a>  
-<a class="jxr_linenumber" name="60" href="#60">60</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * Updates a property using newvalue.merge(oldvalue)</em>
-<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   * @param value</em>
-<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * @return true if the update was successful</em>
-<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="67" href="#67">67</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> updateProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
-<a class="jxr_linenumber" name="68" href="#68">68</a>  
-<a class="jxr_linenumber" name="69" href="#69">69</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   * Return the property value, it must be refer to a single Helix Property. i.e</em>
-<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   * PropertyKey.isLeaf() must return true.</em>
-<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * @return value, Null if absent or on error</em>
-<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="76" href="#76">76</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; T getProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
-<a class="jxr_linenumber" name="77" href="#77">77</a>  
-<a class="jxr_linenumber" name="78" href="#78">78</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * Return a list of property values, each of which must be refer to a single Helix</em>
-<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   * Property. Property may be bucketized.</em>
-<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">   * @param keys</em>
-<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="85" href="#85">85</a>    <strong class="jxr_keyword">public</strong> &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; List&lt;T&gt; getProperty(List&lt;PropertyKey&gt; keys);
-<a class="jxr_linenumber" name="86" href="#86">86</a>  
-<a class="jxr_linenumber" name="87" href="#87">87</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   * Removes the property</em>
-<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">   * @return true if removal was successful or node does not exist. false if the</em>
-<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   *         node existed and failed to remove it</em>
-<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="94" href="#94">94</a>    <strong class="jxr_keyword">boolean</strong> removeProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
-<a class="jxr_linenumber" name="95" href="#95">95</a>  
-<a class="jxr_linenumber" name="96" href="#96">96</a>    <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * Return the child names for a property. PropertyKey needs to refer to a</em>
-<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * collection like instances, resources. PropertyKey.isLeaf must be false</em>
-<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   * @param type</em>
-<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * @return SubPropertyNames</em>
-<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="103" href="#103">103</a>   List&lt;String&gt; getChildNames(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
-<a class="jxr_linenumber" name="104" href="#104">104</a> 
-<a class="jxr_linenumber" name="105" href="#105">105</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * Get the child values for a property. PropertyKey needs to refer to just one</em>
-<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">   * level above the non leaf. PropertyKey.isCollection must be true.</em>
-<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">   * @param type</em>
-<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">   * @return subPropertyValues</em>
-<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="112" href="#112">112</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; List&lt;T&gt; getChildValues(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
-<a class="jxr_linenumber" name="113" href="#113">113</a> 
-<a class="jxr_linenumber" name="114" href="#114">114</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment">   * Same as getChildValues except that it converts list into a map using the id</em>
-<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">   * of the HelixProperty</em>
-<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="121" href="#121">121</a> 
-<a class="jxr_linenumber" name="122" href="#122">122</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; Map&lt;String, T&gt; getChildValuesMap(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
-<a class="jxr_linenumber" name="123" href="#123">123</a> 
-<a class="jxr_linenumber" name="124" href="#124">124</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">   * Adds multiple children to a parent.</em>
-<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">   * @param key</em>
-<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">   * @param children</em>
-<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="131" href="#131">131</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] createChildren(List&lt;PropertyKey&gt; keys,
-<a class="jxr_linenumber" name="132" href="#132">132</a>       List&lt;T&gt; children);
-<a class="jxr_linenumber" name="133" href="#133">133</a> 
-<a class="jxr_linenumber" name="134" href="#134">134</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">   * Sets multiple children under one parent</em>
-<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">   * @param externalViews</em>
-<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">   * @param views</em>
-<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="140" href="#140">140</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] setChildren(List&lt;PropertyKey&gt; keys, List&lt;T&gt; children);
-<a class="jxr_linenumber" name="141" href="#141">141</a>   
-<a class="jxr_linenumber" name="142" href="#142">142</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">   * Updates multiple children under one parent</em>
-<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * @param externalViews</em>
-<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">   * @param views</em>
-<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="148" href="#148">148</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] updateChildren(List&lt;String&gt; paths,
-<a class="jxr_linenumber" name="149" href="#149">149</a>       List&lt;DataUpdater&lt;ZNRecord&gt;&gt; updaters,
-<a class="jxr_linenumber" name="150" href="#150">150</a>       <strong class="jxr_keyword">int</strong> options);
-<a class="jxr_linenumber" name="151" href="#151">151</a>   
-<a class="jxr_linenumber" name="152" href="#152">152</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">   * Get key builder for the accessor</em>
-<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="157" href="#157">157</a>   PropertyKey.Builder keyBuilder();
-<a class="jxr_linenumber" name="158" href="#158">158</a> 
-<a class="jxr_linenumber" name="159" href="#159">159</a>   <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">   * Get underlying base data accessor</em>
-<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">   * </em>
-<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">   * @return</em>
-<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">   */</em>
-<a class="jxr_linenumber" name="164" href="#164">164</a>   BaseDataAccessor&lt;ZNRecord&gt; getBaseDataAccessor();
-<a class="jxr_linenumber" name="165" href="#165">165</a> }
+<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/helix/HelixDataAccessor.html">HelixDataAccessor</a>
+<a class="jxr_linenumber" name="35" href="#35">35</a>  {
+<a class="jxr_linenumber" name="36" href="#36">36</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   * Create a helix property only if it does not exist.</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * @param value</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * @return true if creation was successful. False if already exists or if it</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   *         failed to create</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a>  
+<a class="jxr_linenumber" name="45" href="#45">45</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> createProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
+<a class="jxr_linenumber" name="46" href="#46">46</a>  
+<a class="jxr_linenumber" name="47" href="#47">47</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * Set a property, overwrite if it exists and creates if not exists. This api</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   * assumes the node exists and only tries to update it only if the call fail</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * it will create the node. So there is a performance cost if always ends up</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * creating the node.</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * @param value</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * @true if the operation was successful</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> setProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
+<a class="jxr_linenumber" name="58" href="#58">58</a>  
+<a class="jxr_linenumber" name="59" href="#59">59</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * Updates a property using newvalue.merge(oldvalue)</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * @param value</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   * @return true if the update was successful</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong> updateProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key, T value);
+<a class="jxr_linenumber" name="67" href="#67">67</a>  
+<a class="jxr_linenumber" name="68" href="#68">68</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   * Return the property value, it must be refer to a single Helix Property. i.e</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   * PropertyKey.isLeaf() must return true.</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * @return value, Null if absent or on error</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a>    &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; T getProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
+<a class="jxr_linenumber" name="76" href="#76">76</a>  
+<a class="jxr_linenumber" name="77" href="#77">77</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   * Return a list of property values, each of which must be refer to a single Helix</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * Property. Property may be bucketized.</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">   * @param keys</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a>    <strong class="jxr_keyword">public</strong> &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; List&lt;T&gt; getProperty(List&lt;PropertyKey&gt; keys);
+<a class="jxr_linenumber" name="85" href="#85">85</a>  
+<a class="jxr_linenumber" name="86" href="#86">86</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * Removes the property</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   * @return true if removal was successful or node does not exist. false if the</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">   *         node existed and failed to remove it</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a>    <strong class="jxr_keyword">boolean</strong> removeProperty(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
+<a class="jxr_linenumber" name="94" href="#94">94</a>  
+<a class="jxr_linenumber" name="95" href="#95">95</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   * Return the child names for a property. PropertyKey needs to refer to a</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * collection like instances, resources. PropertyKey.isLeaf must be false</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * @param type</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   * @return SubPropertyNames</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a>   List&lt;String&gt; getChildNames(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
+<a class="jxr_linenumber" name="103" href="#103">103</a> 
+<a class="jxr_linenumber" name="104" href="#104">104</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">   * Get the child values for a property. PropertyKey needs to refer to just one</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * level above the non leaf. PropertyKey.isCollection must be true.</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment">   * @param type</em>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">   * @return subPropertyValues</em>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="111" href="#111">111</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; List&lt;T&gt; getChildValues(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
+<a class="jxr_linenumber" name="112" href="#112">112</a> 
+<a class="jxr_linenumber" name="113" href="#113">113</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">   * Same as getChildValues except that it converts list into a map using the id</em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment">   * of the HelixProperty</em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> 
+<a class="jxr_linenumber" name="121" href="#121">121</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; Map&lt;String, T&gt; getChildValuesMap(<a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a> key);
+<a class="jxr_linenumber" name="122" href="#122">122</a> 
+<a class="jxr_linenumber" name="123" href="#123">123</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">   * Adds multiple children to a parent.</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">   * @param key</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">   * @param children</em>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] createChildren(List&lt;PropertyKey&gt; keys,
+<a class="jxr_linenumber" name="131" href="#131">131</a>       List&lt;T&gt; children);
+<a class="jxr_linenumber" name="132" href="#132">132</a> 
+<a class="jxr_linenumber" name="133" href="#133">133</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">   * Sets multiple children under one parent</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">   * @param externalViews</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">   * @param views</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="139" href="#139">139</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] setChildren(List&lt;PropertyKey&gt; keys, List&lt;T&gt; children);
+<a class="jxr_linenumber" name="140" href="#140">140</a>   
+<a class="jxr_linenumber" name="141" href="#141">141</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment">   * Updates multiple children under one parent</em>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * @param externalViews</em>
+<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * @param views</em>
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a>   &lt;T <strong class="jxr_keyword">extends</strong> HelixProperty&gt; <strong class="jxr_keyword">boolean</strong>[] updateChildren(List&lt;String&gt; paths,
+<a class="jxr_linenumber" name="148" href="#148">148</a>       List&lt;DataUpdater&lt;ZNRecord&gt;&gt; updaters,
+<a class="jxr_linenumber" name="149" href="#149">149</a>       <strong class="jxr_keyword">int</strong> options);
+<a class="jxr_linenumber" name="150" href="#150">150</a>   
+<a class="jxr_linenumber" name="151" href="#151">151</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">   * Get key builder for the accessor</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a>   PropertyKey.Builder keyBuilder();
+<a class="jxr_linenumber" name="157" href="#157">157</a> 
+<a class="jxr_linenumber" name="158" href="#158">158</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment">   * Get underlying base data accessor</em>
+<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">   * </em>
+<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">   * @return</em>
+<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="163" href="#163">163</a>   BaseDataAccessor&lt;ZNRecord&gt; getBaseDataAccessor();
+<a class="jxr_linenumber" name="164" href="#164">164</a> }
 </pre>
 <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 </html>



Mime
View raw message