You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ki...@apache.org on 2013/05/30 18:07:31 UTC
svn commit: r1487903 [2/28] - in /incubator/helix/site-content: ./
apidocs/reference/org/apache/helix/
apidocs/reference/org/apache/helix/messaging/handling/
apidocs/reference/org/apache/helix/model/
apidocs/reference/org/apache/helix/participant/state...
Added: incubator/helix/site-content/Sample_App.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Sample_App.html?rev=1487903&view=auto
==============================================================================
--- incubator/helix/site-content/Sample_App.html (added)
+++ incubator/helix/site-content/Sample_App.html Thu May 30 16:07:26 2013
@@ -0,0 +1,369 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at Dec 11, 2012
+ | 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="20121211" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Helix - </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>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Helix <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="About">About</a>
+</li>
+
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
+</li>
+
+ <li> <a href="ApiUsage.html" title="Api Usage">Api Usage</a>
+</li>
+
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="Features.html" title="Features">Features</a>
+</li>
+
+ <li> <a href="Sample_App.html" title="Sample App">Sample App</a>
+</li>
+
+ <li> <a href="UseCases.html" title="Use Cases">Use Cases</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="issue-tracking.html" title="Issues">Issues</a>
+</li>
+
+ <li> <a href="team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="source-repository.html" title="Sources">Sources</a>
+</li>
+
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
+</li>
+
+ <li> <a href="involved/release.html" title="Release Guide">Release Guide</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li class="dropdown-submenu">
+ <a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li> <a href="index.html" title="About">About</a>
+</li>
+ <li> <a href="project-summary.html" title="Project Summary">Project Summary</a>
+</li>
+ <li> <a href="dependency-info.html" title="Dependency Information">Dependency Information</a>
+</li>
+ <li> <a href="modules.html" title="Project Modules">Project Modules</a>
+</li>
+ <li> <a href="license.html" title="Project License">Project License</a>
+</li>
+ <li> <a href="team-list.html" title="Project Team">Project Team</a>
+</li>
+ <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+ <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+ <li> <a href="dependency-management.html" title="Dependency Management">Dependency Management</a>
+</li>
+ <li> <a href="dependencies.html" title="Dependencies">Dependencies</a>
+</li>
+ <li> <a href="dependency-convergence.html" title="Dependency Convergence">Dependency Convergence</a>
+</li>
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+ <li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a>
+</li>
+ <li> <a href="plugins.html" title="Project Plugins">Project Plugins</a>
+</li>
+ <li> <a href="distribution-management.html" title="Distribution Management">Distribution Management</a>
+</li>
+ </ul>
+ </li>
+
+ <li class="dropdown-submenu">
+ <a href="project-reports.html" title="Project Reports">Project Reports</a>
+ <ul class="dropdown-menu">
+ <li> <a href="xref/index.html" title="Source Xref">Source Xref</a>
+</li>
+ <li> <a href="xref-test/index.html" title="Test Source Xref">Test Source Xref</a>
+</li>
+ <li> <a href="apidocs/index.html" title="JavaDocs">JavaDocs</a>
+</li>
+ <li> <a href="checkstyle-aggregate.html" title="Checkstyle">Checkstyle</a>
+</li>
+ <li> <a href="sonar.html" title="Sonar">Sonar</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Modules <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="helix-core/index.html" title="Apache Helix :: Core">Apache Helix :: Core</a>
+</li>
+
+ <li> <a href="helix-admin-webapp/index.html" title="Apache Helix :: Admin Webapp">Apache Helix :: Admin Webapp</a>
+</li>
+
+ <li> <a href="mockservice/index.html" title="Helix :: Mockservice">Helix :: Mockservice</a>
+</li>
+
+ <li> <a href="recipes/index.html" title="Helix :: Recipes">Helix :: Recipes</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="helix.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Apache Helix</h2>
+ </div>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
+ <img src="http://incubator.apache.org/images/egg-logo.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="./" title="Apache Helix">
+ Apache Helix</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class=""></li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2012-12-11</li> <li class="divider pull-right">|</li>
+ <li id="projectVersion" class="pull-right">Version: 0.6-incubating-SNAPSHOT</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <!-- -
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. --><h1>RabbitMQ Consumer Group</h1><p><a class="externalLink" href="http://www.rabbitmq.com/">RabbitMQ</a> is a well known Open source software the provides robust messaging for applications.</p><p>One of the commonly implemented recipes using this software is a work queue. <a class="externalLink" href="http://www.rabbitmq.com/tutorials/tutorial-four-java.html">http://www.rabbitmq.com/tutorials/tutorial-four-java.html</a> describes the use case where</p>
+<ul>
+ <li>A producer sends a message with a routing key.</li>
+ <li>The message goes to the queues whose binding key exactly matches the routing key of the message.</li>
+ <li>There are multiple consumers and each consumer is interested in processing only a subset of the messages by binding to the interested keys</li>
+</ul><p>The example provided <a class="externalLink" href="http://www.rabbitmq.com/tutorials/tutorial-four-java.html">here</a> describes how multiple consumers can be started to process all the tasks.</p><p>While this works, in production systems one needs the following * Ability to handle failures: when a consumers fails another consumer must be started or the other consumers must start processing these messages that should have been processed by the failed consumer. * When the existing consumers cannot keep up with the task generation rate, new consumers will be added. The tasks must be redistributed among all the consumers. </p><p>In this sample app, we explain how these set of consumers can be grouped together and handle consumer failures and expansion automatically.</p><p>Mapping this usecase to Helix is pretty easy as the binding key/routing key is equivalent to a partition. </p><p>Lets take a real example. Lets say a topic has 6 partitions, and we have 2 consumers to
process all the queues. What we want is all 6 queues to be evenly divided among 2 consumers. Eventually when the system scales, we add more consumers to keep up. This will make each consumer process tasks from 2 queues. Now lets say that a consumer fails and that the number of active consumers is now reduced to 2. This means each consumer must process 3 queues.</p><p>We showcase how such a dynamic App can be developed using Helix. </p><h1>Try it</h1><p>Before getting into the details on how to develop such an App using Helix, you can try the following steps to get a feel of it.</p>
+<div class="source"><pre class="prettyprint">git clone git@github.com:linkedin/helix.git
+cd helix
+./build
+export HELIX_PKG_ROOT=`pwd`/helix-core/target/helix-core-pkg
+</pre></div><p>OR Download the latest 0.5.28 release tar ball from <a class="externalLink" href="http://linkedin.github.com/helix/download/release-0.5.28//helix-core-pkg-0.5.28.tar.gz">here</a> <tt>
+tar -xzvf helix-core-pkg-0.5.28.tar.gz
+export HELIX_PKG_ROOT=`pwd`/helix-core-pkg
+</tt></p><p>Download the rabbitmq-consumer-group recipe from <a class="externalLink" href="http://linkedin.github.com/helix/download/release-0.5.28/rabbitmq-consumer-group-0.5.28.tar.gz">here</a> <tt>
+tar -xzvf rabbitmq-consumer-group-0.5.28.tar.gz
+export HELIX_RABBITMQ_ROOT=`pwd`/rabbitmq-consumer-group/
+</tt> <tt>
+chmod +x $HELIX_PKG_ROOT/bin/*
+chmod +x $HELIX_RABBITMQ_ROOT/bin/*
+</tt></p><div class="section"><h2>Install Rabbit MQ<a name="Install_Rabbit_MQ"></a></h2><p>Setting up RabbitMQ on a local box is straightforward. You can find the instructions here <a class="externalLink" href="http://www.rabbitmq.com/download.html">http://www.rabbitmq.com/download.html</a></p></div><div class="section"><h2>Start ZK<a name="Start_ZK"></a></h2><p>Start zookeeper at port 2199 <tt>
+$HELIX_PKG_ROOT/bin/start-standalone-zookeeper 2199
+</tt></p></div><div class="section"><h2>Setup the consumer group cluster<a name="Setup_the_consumer_group_cluster"></a></h2><p>This will setup the cluster by creating a rabbitmq-consumer-group cluster and adds a topic resource with 6 queues. <tt>
+$HELIX_RABBITMQ_ROOT/bin/setup-cluster.sh localhost:2199
+</tt></p></div><div class="section"><h2>Add consumers<a name="Add_consumers"></a></h2><p>Start 2 consumers in 2 different terminals. Each consumer is given a unique id. ``` //start-consumer.sh zookeeperAddress (e.g. localhost:2181) consumerId , rabbitmqServer (e.g. localhost) $HELIX_RABBITMQ_ROOT/bin/start-consumer.sh localhost:2199 0 localhost $HELIX_RABBITMQ_ROOT/bin/start-consumer.sh localhost:2199 1 localhost </p>
+<div class="source"><pre class="prettyprint">Start HelixController
+--------------------
+Now start a Helix controller that starts managing the "rabbitmq-consumer-group" cluster.
+</pre></div><p>$HELIX_RABBITMQ_ROOT/bin/start-cluster-manager.sh localhost:2199 ```</p></div><div class="section"><h2>Send messages to the Topic<a name="Send_messages_to_the_Topic"></a></h2><p>Start sending messages to the topic. This script randomly selects a routing key (1-6) and sends the message to topic. Based on the key, messages gets routed to the appropriate queue.</p>
+<div class="source"><pre class="prettyprint">$HELIX_RABBITMQ_ROOT/bin/send-message.sh localhost 20
+</pre></div><p>After running this, you should see all 20 messages being processed by 2 consumers. </p></div><div class="section"><h2>Add another consumer<a name="Add_another_consumer"></a></h2><p>Once a new consumer is started, helix detects it. In order to balance the load between 3 consumers, it deallocates 1 partition from the existing consumers and allocates it to the new consumer. We see that each consumer is now processing only 2 queues. Helix makes sure that old nodes are asked to stop consuming before the new consumer is asked to start consuming for a given partition. But the transitions for each partition can happen in parallel. <tt>
+$HELIX_RABBITMQ_ROOT/bin/start-consumer.sh localhost:2199 2 localhost
+</tt></p><p>Send messages again to the topic. <tt>
+$HELIX_RABBITMQ_ROOT/bin/send-message.sh localhost 100
+</tt> You should see that messages are now received by all 3 consumers.</p></div><div class="section"><h2>Stop a consumer<a name="Stop_a_consumer"></a></h2><p>In any terminal press CTRL^C and notice that Helix detects the consumer failure and distributes the 2 partitions that were processed by failed consumer to the remaining 2 active consumers.</p><h1>How does it work</h1><p>Find the entire code <a class="externalLink" href="https://github.com/linkedin/helix/tree/master/recipes/rabbitmq-consumer-group/src/main/java/com/linkedin/helix/recipes/rabbitmq">here</a>. </p></div><div class="section"><h2>Cluster setup<a name="Cluster_setup"></a></h2><p>This step creates znode on zookeeper for the cluster and adds the state model. We use online offline state model since there is no need for other states. The consumer is either processing a queue or it is not.</p><p>It creates a resource called rabbitmq-consumer-group with 6 partitions. The execution mode is set to AUTO_REBALANCE. Thi
s means that the Helix controls the assignment of partition to consumers and automatically distributes the partitions evenly among the active consumers. When a consumer is added or removed, it ensures that a minimum number of partitions are shuffled.</p>
+<div class="source"><pre class="prettyprint"> zkclient = new ZkClient(zkAddr, ZkClient.DEFAULT_SESSION_TIMEOUT,
+ ZkClient.DEFAULT_CONNECTION_TIMEOUT, new ZNRecordSerializer());
+ ZKHelixAdmin admin = new ZKHelixAdmin(zkclient);
+
+ // add cluster
+ admin.addCluster(clusterName, true);
+
+ // add state model definition
+ StateModelConfigGenerator generator = new StateModelConfigGenerator();
+ admin.addStateModelDef(clusterName, "OnlineOffline",
+ new StateModelDefinition(generator.generateConfigForOnlineOffline()));
+
+ // add resource "topic" which has 6 partitions
+ String resourceName = "rabbitmq-consumer-group";
+ admin.addResource(clusterName, resourceName, 6, "OnlineOffline", "AUTO_REBALANCE");
+</pre></div></div><div class="section"><h2>Starting the consumers<a name="Starting_the_consumers"></a></h2><p>The only thing consumers need to know is the zkaddress, cluster name and consumer id. It does not need to know anything else.</p>
+<div class="source"><pre class="prettyprint"> _manager =
+ HelixManagerFactory.getZKHelixManager(_clusterName,
+ _consumerId,
+ InstanceType.PARTICIPANT,
+ _zkAddr);
+
+ StateMachineEngine stateMach = _manager.getStateMachineEngine();
+ ConsumerStateModelFactory modelFactory =
+ new ConsumerStateModelFactory(_consumerId, _mqServer);
+ stateMach.registerStateModelFactory("OnlineOffline", modelFactory);
+
+ _manager.connect();
+
+</pre></div><p>Once the consumer has registered the statemodel and the controller is started, the consumer starts getting callbacks (onBecomeOnlineFromOffline) for the partition it needs to host. All it needs to do as part of the callback is to start consuming messages from the appropriate queue. Similarly, when the controller deallocates a partitions from a consumer, it fires onBecomeOfflineFromOnline for the same partition. As a part of this transition, the consumer will stop consuming from a that queue.</p>
+<div class="source"><pre class="prettyprint"> @Transition(to = "ONLINE", from = "OFFLINE")
+ public void onBecomeOnlineFromOffline(Message message, NotificationContext context)
+ {
+ LOG.debug(_consumerId + " becomes ONLINE from OFFLINE for " + _partition);
+
+ if (_thread == null)
+ {
+ LOG.debug("Starting ConsumerThread for " + _partition + "...");
+ _thread = new ConsumerThread(_partition, _mqServer, _consumerId);
+ _thread.start();
+ LOG.debug("Starting ConsumerThread for " + _partition + " done");
+
+ }
+ }
+
+ @Transition(to = "OFFLINE", from = "ONLINE")
+ public void onBecomeOfflineFromOnline(Message message, NotificationContext context)
+ throws InterruptedException
+ {
+ LOG.debug(_consumerId + " becomes OFFLINE from ONLINE for " + _partition);
+
+ if (_thread != null)
+ {
+ LOG.debug("Stopping " + _consumerId + " for " + _partition + "...");
+
+ _thread.interrupt();
+ _thread.join(2000);
+ _thread = null;
+ LOG.debug("Stopping " + _consumerId + " for " + _partition + " done");
+
+ }
+ }
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2012
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+ <p id="poweredBy" class="pull-right">
+ <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>
+ </p>
+
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Modified: incubator/helix/site-content/Tutorial.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/Tutorial.html?rev=1487903&r1=1487902&r2=1487903&view=diff
==============================================================================
--- incubator/helix/site-content/Tutorial.html (original)
+++ incubator/helix/site-content/Tutorial.html Thu May 30 16:07:26 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 25, 2013
+ | Generated by Apache Maven Doxia at May 8, 2013
| 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="20130525" />
+ <meta name="Date-Revision-yyyymmdd" content="20130508" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -49,19 +49,22 @@
<li> <a href="index.html" title="Introduction">Introduction</a>
</li>
- <li> <a href="Concepts.html" title="Core concepts">Core concepts</a>
+ <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
</li>
- <li> <a href="Architecture.html" title="Architecture">Architecture</a>
+ <li> <a href="Concepts.html" title="Core concept">Core concept</a>
</li>
- <li> <a href="Quickstart.html" title="Quick Start">Quick Start</a>
+ <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
</li>
- <li> <a href="Tutorial.html" title="Tutorial">Tutorial</a>
+ <li> <a href="Architecture.html" title="Architecture">Architecture</a>
</li>
- <li> <a href="releasenotes/release-0.6.1-incubating.html" title="release 0.6.1-incubating">release 0.6.1-incubating</a>
+ <li> <a href="Features.html" title="Features">Features</a>
+</li>
+
+ <li> <a href="releasenotes/release-0.6.0-incubating.html" title="release 0.6.0-incubating">release 0.6.0-incubating</a>
</li>
<li> <a href="download.html" title="Download">Download</a>
@@ -168,7 +171,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-25</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-08</li>
</ul>
</div>
@@ -193,37 +196,17 @@ software distributed under the License i
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
-under the License. --><h1>Helix Tutorial</h1><p>In this tutorial, we will cover the roles of a Helix-managed cluster, and show the code you need to write to integrate with it. In many cases, there is a simple default behavior that is often appropriate, but you can also customize the behavior.</p><p>Convention: we first cover the <i>basic</i> approach, which is the easiest to implement. Then, well describe <i>advanced</i> options, which give you more control over the system behavior, but require you to write more code.</p><div class="section"><div class="section"><h3>Prerequisites<a name="Prerequisites"></a></h3>
-<ol style="list-style-type: decimal">
- <li>Read <a href="./Concepts.html">Concepts/Terminology</a> and <a href="./Architecture.html">Architecture</a></li>
- <li>Read the <a href="./Quickstart.html">Quickstart guide</a> to learn how Helix models and manages a cluster</li>
- <li>Install Helix source. See: <a href="./Quickstart.html">Quickstart</a> for the steps.</li>
-</ol></div><div class="section"><h3>Tutorial Outline<a name="Tutorial_Outline"></a></h3>
-<ol style="list-style-type: decimal">
- <li><a href="./tutorial_participant.html">Participant</a></li>
- <li><a href="./tutorial_spectator.html">Spectator</a></li>
- <li><a href="./tutorial_controller.html">Controller</a></li>
- <li><a href="./tutorial_rebalance.html">Rebalancing Algorithms</a></li>
- <li><a href="./tutorial_state.html">State Machines</a></li>
- <li><a href="./tutorial_messaging.html">Messaging</a></li>
- <li><a href="./tutorial_health.html">Customized health check</a></li>
- <li><a href="./tutorial_throttling.html">Throttling</a></li>
- <li><a href="./tutorial_propstore.html">Application Property Store</a></li>
- <li><a href="./tutorial_admin.html">Admin Interface</a></li>
-</ol></div><div class="section"><h3>Preliminaries<a name="Preliminaries"></a></h3><p>First, we need to set up the system. Let's walk through the steps in building a distributed system using Helix.</p></div><div class="section"><h3>Start Zookeeper<a name="Start_Zookeeper"></a></h3><p>This starts a zookeeper in standalone mode. For production deployment, see <a class="externalLink" href="http://zookeeper.apache.org">Apache Zookeeper</a> for instructions.</p>
+under the License. --><p>Lets walk through the steps in building a distributed system using Helix.</p><div class="section"><div class="section"><h3>Start zookeeper<a name="Start_zookeeper"></a></h3><p>This starts a zookeeper in standalone mode. For production deployment, see [Apache Zookeeper] page for instructions.</p>
<div class="source"><pre class="prettyprint"> ./start-standalone-zookeeper.sh 2199 &
-</pre></div></div><div class="section"><h3>Create a cluster<a name="Create_a_cluster"></a></h3><p>Creating a cluster will define the cluster in appropriate znodes on zookeeper. </p><p>Using the java API:</p>
-<div class="source"><pre class="prettyprint"> // Create setup tool instance
- // Note: ZK_ADDRESS is the host:port of Zookeeper
- String ZK_ADDRESS = "localhost:2199";
+</pre></div></div><div class="section"><h3>Create cluster<a name="Create_cluster"></a></h3><p>Creating a cluster will create appropriate znodes on zookeeper. </p>
+<div class="source"><pre class="prettyprint"> //Create setuptool instance
admin = new ZKHelixAdmin(ZK_ADDRESS);
-
String CLUSTER_NAME = "helix-demo";
//Create cluster namespace in zookeeper
- admin.addCluster(CLUSTER_NAME);
-</pre></div><p>OR</p><p>Using the command-line interface:</p>
+ admin.addCluster(clusterName);
+</pre></div><p>OR</p>
<div class="source"><pre class="prettyprint"> ./helix-admin.sh --zkSvr localhost:2199 --addCluster helix-demo
-</pre></div></div><div class="section"><h3>Configure the nodes of the cluster<a name="Configure_the_nodes_of_the_cluster"></a></h3><p>First we'll add new nodes to the cluster, then configure the nodes in the cluster. Each node in the cluster must be uniquely identifiable. The most commonly used convention is hostname:port.</p>
+</pre></div></div><div class="section"><h3>Configure nodes<a name="Configure_nodes"></a></h3><p>Add new nodes to the cluster, configure new nodes in the cluster. Each node in the cluster must be uniquely identifiable. Most commonly used convention is hostname:port.</p>
<div class="source"><pre class="prettyprint"> String CLUSTER_NAME = "helix-demo";
int NUM_NODES = 2;
String hosts[] = new String[]{"localhost","localhost"};
@@ -235,35 +218,20 @@ under the License. --><h1>Helix Tutorial
instanceConfig.setHostName(hosts[i]);
instanceConfig.setPort(ports[i]);
instanceConfig.setInstanceEnabled(true);
-
//Add additional system specific configuration if needed. These can be accessed during the node start up.
instanceConfig.getRecord().setSimpleField("key", "value");
admin.addInstance(CLUSTER_NAME, instanceConfig);
}
-</pre></div></div><div class="section"><h3>Configure the resource<a name="Configure_the_resource"></a></h3><p>A <i>resource</i> represents the actual task performed by the nodes. It can be a database, index, topic, queue or any other processing entity. A <i>resource</i> can be divided into many sub-parts known as <i>partitions</i>.</p><div class="section"><h4>Define the <i>state model</i> and <i>constraints</i><a name="Define_the_state_model_and_constraints"></a></h4><p>For scalability and fault tolerance, each partition can have one or more replicas. The <i>state model</i> allows one to declare the system behavior by first enumerating the various STATES, and the TRANSITIONS between them. A simple model is ONLINE-OFFLINE where ONLINE means the task is active and OFFLINE means it's not active. You can also specify how many replicas must be in each state, these are known as <i>constraints</i>. For example, in a search system, one might need more than one node serving the same
index to handle the load.</p><p>The allowed states: </p>
-<ul>
- <li>MASTER</li>
- <li>SLAVE</li>
- <li>OFFLINE</li>
-</ul><p>The allowed transitions: </p>
-<ul>
- <li>OFFLINE to SLAVE</li>
- <li>SLAVE to OFFLINE</li>
- <li>SLAVE to MASTER</li>
- <li>MASTER to SLAVE</li>
-</ul><p>The constraints:</p>
-<ul>
- <li>no more than 1 MASTER per partition</li>
- <li>the rest of the replicas should be slaves</li>
-</ul><p>The following snippet shows how to declare the <i>state model</i> and <i>constraints</i> for the MASTER-SLAVE model.</p>
-<div class="source"><pre class="prettyprint"> StateModelDefinition.Builder builder = new StateModelDefinition.Builder(STATE_MODEL_NAME);
- // Add states and their rank to indicate priority. A lower rank corresponds to a higher priority
+</pre></div></div><div class="section"><h3>Configure the resource<a name="Configure_the_resource"></a></h3><p>Resource represents the actual task performed by the nodes. It can be a database, index, topic, queue or any other processing. A Resource can be divided into many sub parts called as partitions. </p><div class="section"><h4>Define state model and constraints<a name="Define_state_model_and_constraints"></a></h4><p>For scalability and fault tolerance each partition can have one or more replicas. State model allows one to declare the system behavior by first enumerating the various STATES and TRANSITIONS between them. A simple model is ONLINE-OFFLINE where ONLINE means the task is active and OFFLINE means its not active. You can also specify how of replicas must be in each state. For example In a Search System, one might need more than one node serving the same index. Helix allows one to express this via constraints on each STATE. </p><p>The following snippet shows how
to declare the state model and constraints for MASTER-SLAVE model.</p>
+<div class="source"><pre class="prettyprint"> StateModelDefinition.Builder builder = new StateModelDefinition.Builder(
+ STATE_MODEL_NAME);
+ // Add states and their rank to indicate priority. Lower the rank higher the
+ // priority
builder.addState(MASTER, 1);
builder.addState(SLAVE, 2);
builder.addState(OFFLINE);
-
// Set the initial state when the node starts
builder.initialState(OFFLINE);
@@ -274,33 +242,165 @@ under the License. --><h1>Helix Tutorial
builder.addTransition(MASTER, SLAVE);
// set constraints on states.
-
- // static constraint: upper bound of 1 MASTER
+ // static constraint
builder.upperBound(MASTER, 1);
-
- // dynamic constraint: R means it should be derived based on the replication factor for the cluster
- // this allows a different replication factor for each resource without
- // having to define a new state model
- //
+ // dynamic constraint, R means it should be derived based on the replica,
+ // this allows use different replication factor for each resource without
+ //having to define a new state model
builder.dynamicUpperBound(SLAVE, "R");
StateModelDefinition statemodelDefinition = builder.build();
admin.addStateModelDef(CLUSTER_NAME, STATE_MODEL_NAME, myStateModel);
-</pre></div></div><div class="section"><h4>Assigning partitions to nodes<a name="Assigning_partitions_to_nodes"></a></h4><p>The final goal of Helix is to ensure that the constraints on the state model are satisfied. Helix does this by assigning a STATE to a partition (such as MASTER, SLAVE), and placing it on a particular node.</p><p>There are 3 assignment modes Helix can operate on</p>
+
+</pre></div></div><div class="section"><h4>Assigning partitions to nodes<a name="Assigning_partitions_to_nodes"></a></h4><p>The final goal of Helix is to ensure that the constraints on the state model are satisfied. Helix does this by assigning a STATE to a partition and placing it on a particular node.</p><p>There are 3 assignment modes Helix can operate on</p>
<ul>
<li>AUTO_REBALANCE: Helix decides the placement and state of a partition.</li>
<li>AUTO: Application decides the placement but Helix decides the state of a partition.</li>
<li>CUSTOM: Application controls the placement and state of a partition.</li>
-</ul><p>For more info on the assignment modes, see <a href="./tutorial_rebalance.html">Rebalancing Algorithms</a> of the tutorial.</p>
-<div class="source"><pre class="prettyprint"> String RESOURCE_NAME = "MyDB";
- int NUM_PARTITIONS = 6;
+</ul><p>For more info on the modes see the <i>partition placement</i> section on <a href="./Features.html">Features</a> page.</p>
+<div class="source"><pre class="prettyprint"> String RESOURCE_NAME="MyDB";
+ int NUM_PARTITIONs=6;
STATE_MODEL_NAME = "MasterSlave";
String MODE = "AUTO";
int NUM_REPLICAS = 2;
-
admin.addResource(CLUSTER_NAME, RESOURCE_NAME, NUM_PARTITIONS, STATE_MODEL_NAME, MODE);
admin.rebalance(CLUSTER_NAME, RESOURCE_NAME, NUM_REPLICAS);
-</pre></div></div></div></div>
+</pre></div></div></div><div class="section"><h3>Starting a Helix based process<a name="Starting_a_Helix_based_process"></a></h3><p>The first step of using the Helix api will be creating a Helix manager instance. It requires the following parameters:</p>
+<ul>
+ <li>clusterName: A logical name to represent the group of nodes</li>
+ <li>instanceName: A logical name of the process creating the manager instance. Generally this is host:port.</li>
+ <li>instanceType: Type of the process. This can be one of the following types:
+ <ul>
+ <li>CONTROLLER: Process that controls the cluster, any number of controllers can be started but only one will be active at any given time.</li>
+ <li>PARTICIPANT: Process that performs the actual task in the distributed system.</li>
+ <li>SPECTATOR: Process that observes the changes in the cluster.</li>
+ <li>ADMIN: To carry out system admin actions.</li>
+ </ul></li>
+ <li>zkConnectString: Connection string to Zookeeper. This is of the form host1:port1,host2:port2,host3:port3.</li>
+</ul>
+<div class="source"><pre class="prettyprint"> manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ instanceType,
+ zkConnectString);
+</pre></div></div><div class="section"><h3>Participant<a name="Participant"></a></h3><p>Starting up a participant is pretty straightforward. After the Helix manager instance is created, only thing that needs to be registered is the state model factory. The Methods on the State Model will be called when controller sends transitions to the Participant.</p>
+<div class="source"><pre class="prettyprint"> manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.PARTICIPANT,
+ zkConnectString);
+ StateMachineEngine stateMach = manager.getStateMachineEngine();
+ //create a stateModelFactory that returns a statemodel object for each partition.
+ stateModelFactory = new OnlineOfflineStateModelFactory();
+ stateMach.registerStateModelFactory(stateModelType, stateModelFactory);
+ manager.connect();
+</pre></div>
+<div class="source"><pre class="prettyprint">public class OnlineOfflineStateModelFactory extends
+ StateModelFactory<StateModel> {
+ @Override
+ public StateModel createNewStateModel(String stateUnitKey) {
+ OnlineOfflineStateModel stateModel = new OnlineOfflineStateModel();
+ return stateModel;
+ }
+ @StateModelInfo(states = "{'OFFLINE','ONLINE'}", initialState = "OFFINE")
+ public static class OnlineOfflineStateModel extends StateModel {
+ @Transition(from = "OFFLINE", to = "ONLINE")
+ public void onBecomeOnlineFromOffline(Message message,
+ NotificationContext context) {
+ System.out
+ .println("OnlineOfflineStateModel.onBecomeOnlineFromOffline()");
+ //Application logic to handle transition
+ }
+ @Transition(from = "ONLINE", to = "OFFLINE")
+ public void onBecomeOfflineFromOnline(Message message,
+ NotificationContext context) {
+ System.out
+ .println("OnlineOfflineStateModel.onBecomeOfflineFromOnline()");
+ //Application logic to handle transition
+ }
+ }
+}
+</pre></div></div><div class="section"><h3>Controller Code<a name="Controller_Code"></a></h3><p>Controller needs to know about all changes in the cluster. Helix comes with default implementation to handle all changes in the cluster. If you have a need to add additional functionality, see GenericHelixController on how to configure the pipeline.</p>
+<div class="source"><pre class="prettyprint"> manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.CONTROLLER,
+ zkConnectString);
+ manager.connect();
+ GenericHelixController controller = new GenericHelixController();
+ manager.addConfigChangeListener(controller);
+ manager.addLiveInstanceChangeListener(controller);
+ manager.addIdealStateChangeListener(controller);
+ manager.addExternalViewChangeListener(controller);
+ manager.addControllerListener(controller);
+</pre></div><p>This above snippet shows how the controller is started. You can also start the controller using command line interface.</p>
+<div class="source"><pre class="prettyprint">cd helix
+mvn clean install -Dmaven.test.skip=true
+cd helix-core/target/helix-core-pkg/bin
+chmod +x *
+./run-helix-controller.sh --zkSvr <ZookeeperServerAddress(Required)> --cluster <Cluster name (Required)>
+</pre></div><p>See controller deployment modes section in <a href="./Features.html">Features</a> page for different ways to deploy the controller.</p></div><div class="section"><h3>Spectator Code<a name="Spectator_Code"></a></h3><p>A spectator simply observes all cluster is notified when the state of the system changes. Helix consolidates the state of entire cluster in one Znode called ExternalView. Helix provides a default implementation RoutingTableProvider that caches the cluster state and updates it when there is a change in the cluster</p>
+<div class="source"><pre class="prettyprint">manager = HelixManagerFactory.getZKHelixManager(clusterName,
+ instanceName,
+ InstanceType.PARTICIPANT,
+ zkConnectString);
+manager.connect();
+RoutingTableProvider routingTableProvider = new RoutingTableProvider();
+manager.addExternalViewChangeListener(routingTableProvider);
+
+</pre></div><p>In order to figure out who is serving a partition, here are the apis</p>
+<div class="source"><pre class="prettyprint">instances = routingTableProvider.getInstances("DBNAME", "PARITION_NAME", "PARTITION_STATE");
+</pre></div></div><div class="section"><h3>Zookeeper znode layout.<a name="Zookeeper_znode_layout."></a></h3><p>See <i>Helix znode layout</i> section in <a href="./Architecture.html">Architecture</a> page.</p></div><div class="section"><h3>Helix Admin operations<a name="Helix_Admin_operations"></a></h3><p>Helix provides multiple ways to administer the cluster. It has a command line interface and also a REST interface.</p>
+<div class="source"><pre class="prettyprint">cd helix
+mvn clean install -Dmaven.test.skip=true
+cd helix-core/target/helix-core-pkg/bin
+chmod +x *
+./helix-admin.sh --help
+Provide zookeeper address. Required for all commands
+ --zkSvr <ZookeeperServerAddress(Required)>
+
+Add a new cluster
+ --addCluster <clusterName>
+
+Add a new Instance to a cluster
+ --addNode <clusterName InstanceAddress(host:port)>
+
+Add a State model to a cluster
+ --addStateModelDef <clusterName <filename>>
+
+Add a resource to a cluster
+ --addResource <clusterName resourceName partitionNum stateModelRef <mode(AUTO_REBALANCE|AUTO|CUSTOM)>>
+
+Upload an IdealState(Partition to Node Mapping)
+ --addIdealState <clusterName resourceName <filename>>
+
+Delete a cluster
+ --dropCluster <clusterName>
+
+Delete a resource
+ --dropResource <clusterName resourceName> Drop an existing resource from a cluster
+
+Drop an existing Instance from a cluster
+ --dropNode <clusterName InstanceAddress(host:port)>
+
+Enable/disable the entire cluster, this will basically pause the controller which means no transitions will be trigger, but the existing node sin the cluster continue to function
+ --enableCluster <clusterName>
+
+Enable/disable a Instance. Useful to take a faulty node out of the cluster.
+ --enableInstance <clusterName InstanceName true/false>
+
+Enable/disable a partition
+ --enablePartition <clusterName instanceName resourceName partitionName true/false>
+
+
+ --listClusterInfo <clusterName> Query info of a cluster
+ --listClusters List existing clusters
+ --listInstanceInfo <clusterName InstanceName> Query info of a Instance in a cluster
+ --listInstances <clusterName> List Instances in a cluster
+ --listPartitionInfo <clusterName resourceName partitionName> Query info of a partition
+ --listResourceInfo <clusterName resourceName> Query info of a resource
+ --listResources <clusterName> List resources hosted in a cluster
+ --listStateModel <clusterName stateModelName> Query info of a state model in a cluster
+ --listStateModels <clusterName> Query info of state models in a cluster
+
+</pre></div></div></div>
</div>
</div>
Modified: incubator/helix/site-content/UseCases.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/UseCases.html?rev=1487903&r1=1487902&r2=1487903&view=diff
==============================================================================
--- incubator/helix/site-content/UseCases.html (original)
+++ incubator/helix/site-content/UseCases.html Thu May 30 16:07:26 2013
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at May 25, 2013
+ | Generated by Apache Maven Doxia at May 30, 2013
| 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="20130525" />
+ <meta name="Date-Revision-yyyymmdd" content="20130530" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Helix - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -168,7 +168,7 @@
- <li id="publishDate" class="pull-right">Last Published: 2013-05-25</li>
+ <li id="publishDate" class="pull-right">Last Published: 2013-05-30</li>
</ul>
</div>
Added: incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.ConfigScopeProperty.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.ConfigScopeProperty.html?rev=1487903&view=auto
==============================================================================
--- incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.ConfigScopeProperty.html (added)
+++ incubator/helix/site-content/apidocs/reference/org/apache/helix/ConfigScope.ConfigScopeProperty.html Thu May 30 16:07:26 2013
@@ -0,0 +1,1338 @@
+<!DOCTYPE html>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+
+ <meta name="description" content="Javadoc API documentation for Apache Helix." />
+
+<link rel="shortcut icon" type="image/x-icon" href="../../../favicon.ico" />
+<title>
+
+ ConfigScope.ConfigScopeProperty
+
+
+| Apache Helix
+
+</title>
+<link href="../../../../assets/doclava-developer-docs.css" rel="stylesheet" type="text/css" />
+<link href="../../../../assets/customizations.css" rel="stylesheet" type="text/css" />
+<script src="../../../../assets/search_autocomplete.js" type="text/javascript"></script>
+<script src="../../../../assets/jquery-resizable.min.js" type="text/javascript"></script>
+<script src="../../../../assets/doclava-developer-docs.js" type="text/javascript"></script>
+<script src="../../../../assets/prettify.js" type="text/javascript"></script>
+<script type="text/javascript">
+ setToRoot("../../../", "../../../../assets/");
+</script>
+<script src="../../../../assets/doclava-developer-reference.js" type="text/javascript"></script>
+<script src="../../../../assets/navtree_data.js" type="text/javascript"></script>
+<script src="../../../../assets/customizations.js" type="text/javascript"></script>
+<noscript>
+ <style type="text/css">
+ html,body{overflow:auto;}
+ #body-content{position:relative; top:0;}
+ #doc-content{overflow:visible;border-left:3px solid #666;}
+ #side-nav{padding:0;}
+ #side-nav .toggle-list ul {display:block;}
+ #resize-packages-nav{border-bottom:3px solid #666;}
+ </style>
+</noscript>
+</head>
+
+<body class="">
+
+<div id="header">
+ <div id="headerLeft">
+
+ <span id="masthead-title">Apache Helix</span>
+
+ </div>
+ <div id="headerRight">
+
+ <div id="search" >
+ <div id="searchForm">
+ <form accept-charset="utf-8" class="gsc-search-box"
+ onsubmit="return submit_search()">
+ <table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody>
+ <tr>
+ <td class="gsc-input">
+ <input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off"
+ title="search developer docs" name="q"
+ value="search developer docs"
+ onFocus="search_focus_changed(this, true)"
+ onBlur="search_focus_changed(this, false)"
+ onkeydown="return search_changed(event, true, '../../../')"
+ onkeyup="return search_changed(event, false, '../../../')" />
+ <div id="search_filtered_div" class="no-display">
+ <table id="search_filtered" cellspacing=0>
+ </table>
+ </div>
+ </td>
+ <td class="gsc-search-button">
+ <input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" />
+ </td>
+ <td class="gsc-clear-button">
+ <div title="clear results" class="gsc-clear-button"> </div>
+ </td>
+ </tr></tbody>
+ </table>
+ </form>
+ </div><!-- searchForm -->
+ </div><!-- search -->
+
+ </div>
+</div><!-- header -->
+
+
+ <div class="g-section g-tpl-240" id="body-content">
+ <div class="g-unit g-first side-nav-resizable" id="side-nav">
+ <div id="swapper">
+ <div id="nav-panels">
+ <div id="resize-packages-nav">
+ <div id="packages-nav">
+ <div id="index-links"><nobr>
+ <a href="../../../packages.html" >Package Index</a> |
+ <a href="../../../classes.html" >Class Index</a></nobr>
+ </div>
+ <ul>
+
+ <li class="selected api apilevel-">
+ <a href="../../../org/apache/helix/package-summary.html">org.apache.helix</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/alerts/package-summary.html">org.apache.helix.alerts</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/controller/package-summary.html">org.apache.helix.controller</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/controller/pipeline/package-summary.html">org.apache.helix.controller.pipeline</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/controller/restlet/package-summary.html">org.apache.helix.controller.restlet</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/controller/stages/package-summary.html">org.apache.helix.controller.stages</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/examples/package-summary.html">org.apache.helix.examples</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/filestore/package-summary.html">org.apache.helix.filestore</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/healthcheck/package-summary.html">org.apache.helix.healthcheck</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/josql/package-summary.html">org.apache.helix.josql</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/lockmanager/package-summary.html">org.apache.helix.lockmanager</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/manager/zk/package-summary.html">org.apache.helix.manager.zk</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/messaging/package-summary.html">org.apache.helix.messaging</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/messaging/handling/package-summary.html">org.apache.helix.messaging.handling</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/model/package-summary.html">org.apache.helix.model</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/monitoring/package-summary.html">org.apache.helix.monitoring</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/monitoring/mbeans/package-summary.html">org.apache.helix.monitoring.mbeans</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/participant/package-summary.html">org.apache.helix.participant</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/participant/statemachine/package-summary.html">org.apache.helix.participant.statemachine</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/recipes/rabbitmq/package-summary.html">org.apache.helix.recipes.rabbitmq</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/spectator/package-summary.html">org.apache.helix.spectator</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/store/package-summary.html">org.apache.helix.store</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/store/zk/package-summary.html">org.apache.helix.store.zk</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/tools/package-summary.html">org.apache.helix.tools</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/util/package-summary.html">org.apache.helix.util</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/webapp/package-summary.html">org.apache.helix.webapp</a></li>
+ <li class="api apilevel-">
+ <a href="../../../org/apache/helix/webapp/resources/package-summary.html">org.apache.helix.webapp.resources</a></li>
+ </ul><br/>
+ </div> <!-- end packages -->
+ </div> <!-- end resize-packages -->
+ <div id="classes-nav">
+ <ul>
+
+ <li><h2>Interfaces</h2>
+ <ul>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/BaseDataAccessor.html">BaseDataAccessor</a><T></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ClusterMessagingService.html">ClusterMessagingService</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ConfigChangeListener.html">ConfigChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ControllerChangeListener.html">ControllerChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/CurrentStateChangeListener.html">CurrentStateChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ExternalViewChangeListener.html">ExternalViewChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HashFunction.html">HashFunction</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HealthStateChangeListener.html">HealthStateChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixAdmin.html">HelixAdmin</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixConstants.html">HelixConstants</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixDataAccessor.html">HelixDataAccessor</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixManager.html">HelixManager</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/IdealStateChangeListener.html">IdealStateChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/InstanceConfigChangeListener.html">InstanceConfigChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/LiveInstanceChangeListener.html">LiveInstanceChangeListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/MessageListener.html">MessageListener</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/PreConnectCallback.html">PreConnectCallback</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ScopedConfigChangeListener.html">ScopedConfigChangeListener</a></li>
+ </ul>
+ </li>
+
+ <li><h2>Classes</h2>
+ <ul>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/AccessOption.html">AccessOption</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/CMConnector.html">CMConnector</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ConfigAccessor.html">ConfigAccessor</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ConfigScope.html">ConfigScope</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ConfigScopeBuilder.html">ConfigScopeBuilder</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/Criteria.html">Criteria</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/EspressoResource.html">EspressoResource</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/EspressoStorageMockNode.html">EspressoStorageMockNode</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/EspressoStorageMockStateModelFactory.html">EspressoStorageMockStateModelFactory</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/EspressoStorageMockStateModelFactory.EspressoStorageMockStateModel.html">EspressoStorageMockStateModelFactory.EspressoStorageMockStateModel</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/FnvHashFunction.html">FnvHashFunction</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/GroupCommit.html">GroupCommit</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixManagerFactory.html">HelixManagerFactory</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixProperty.html">HelixProperty</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixTimerTask.html">HelixTimerTask</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/MockEspressoService.html">MockEspressoService</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/MockNode.html">MockNode</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/MockNodeFactory.html">MockNodeFactory</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/MockRunner.html">MockRunner</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/NotificationContext.html">NotificationContext</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/PropertyKey.html">PropertyKey</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/PropertyKey.Builder.html">PropertyKey.Builder</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/PropertyPathConfig.html">PropertyPathConfig</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/StopServiceResource.html">StopServiceResource</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecord.html">ZNRecord</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecordAssembler.html">ZNRecordAssembler</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecordBucketizer.html">ZNRecordBucketizer</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecordDelta.html">ZNRecordDelta</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecordUpdater.html">ZNRecordUpdater</a></li>
+ </ul>
+ </li>
+
+
+ <li><h2>Enums</h2>
+ <ul>
+ <li class="selected api apilevel-"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/Criteria.DataSource.html">Criteria.DataSource</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixConstants.ChangeType.html">HelixConstants.ChangeType</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixConstants.ClusterConfigType.html">HelixConstants.ClusterConfigType</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixConstants.StateModelToken.html">HelixConstants.StateModelToken</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixProperty.HelixPropertyAttribute.html">HelixProperty.HelixPropertyAttribute</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/InstanceType.html">InstanceType</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/NotificationContext.MapKey.html">NotificationContext.MapKey</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/NotificationContext.Type.html">NotificationContext.Type</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/PropertyType.html">PropertyType</a></li>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/ZNRecordDelta.MergeOperation.html">ZNRecordDelta.MergeOperation</a></li>
+ </ul>
+ </li>
+
+ <li><h2>Exceptions</h2>
+ <ul>
+ <li class="api apilevel-"><a href="../../../org/apache/helix/HelixException.html">HelixException</a></li>
+ </ul>
+ </li>
+
+ </ul><br/>
+ </div><!-- end classes -->
+ </div><!-- end nav-panels -->
+ <div id="nav-tree" style="display:none">
+ <div id="index-links"><nobr>
+ <a href="../../../packages.html" >Package Index</a> |
+ <a href="../../../classes.html" >Class Index</a></nobr>
+ </div>
+ </div><!-- end nav-tree -->
+ </div><!-- end swapper -->
+ </div> <!-- end side-nav -->
+ <script>
+ if (!isMobile) {
+ $("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav");
+ chooseDefaultNav();
+ if ($("#nav-tree").is(':visible')) {
+ init_default_navtree("../../../");
+ } else {
+ addLoadEvent(function() {
+ scrollIntoView("packages-nav");
+ scrollIntoView("classes-nav");
+ });
+ }
+ $("#swapper").css({borderBottom:"2px solid #aaa"});
+ } else {
+ swapNav(); // tree view should be used on mobile
+ }
+ </script>
+
+
+
+<div class="g-unit" id="doc-content">
+
+<div id="api-info-block">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div class="sum-details-links">
+
+
+Summary:
+
+
+
+
+ <a href="#enumconstants">Enums</a>
+
+
+
+
+
+
+
+
+
+ | <a href="#pubmethods">Methods</a>
+
+
+
+
+ | <a href="#inhmethods">Inherited Methods</a>
+
+| <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
+
+</div><!-- end sum-details-links -->
+<div class="api-level">
+
+
+
+
+
+
+</div>
+</div><!-- end api-info-block -->
+
+
+<!-- ======== START OF CLASS DATA ======== -->
+
+<div id="jd-header">
+ public
+ static
+ final
+
+ enum
+<h1>ConfigScope.ConfigScopeProperty</h1>
+
+
+
+
+
+
+
+
+ extends <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">Enum</a><E extends <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">Enum</a><E>><br/>
+
+
+
+
+
+
+
+
+
+</div><!-- end header -->
+
+<div id="naMessage"></div>
+
+<div id="jd-content" class="api apilevel-">
+<table class="jd-inheritance-table">
+
+
+ <tr>
+
+ <td colspan="3" class="jd-inheritance-class-cell"><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">java.lang.Object</a></td>
+ </tr>
+
+
+ <tr>
+
+ <td class="jd-inheritance-space"> ↳</td>
+
+ <td colspan="2" class="jd-inheritance-class-cell"><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">java.lang.Enum</a><E extends <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">java.lang.Enum</a><E>></td>
+ </tr>
+
+
+ <tr>
+
+ <td class="jd-inheritance-space"> </td>
+
+ <td class="jd-inheritance-space"> ↳</td>
+
+ <td colspan="1" class="jd-inheritance-class-cell">org.apache.helix.ConfigScope.ConfigScopeProperty</td>
+ </tr>
+
+
+</table>
+
+
+
+
+
+
+
+<div class="jd-descr">
+
+
+
+
+
+
+</div><!-- jd-descr -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div class="jd-descr">
+
+
+<h2>Summary</h2>
+
+
+
+
+
+
+
+
+
+
+
+<!-- =========== ENUM CONSTANT SUMMARY =========== -->
+<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-descrcol"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a> </td>
+ <td class="jd-linkcol">CLUSTER </td>
+ <td class="jd-descrcol" width="100%"> </td>
+ </tr>
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-descrcol"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a> </td>
+ <td class="jd-linkcol">CONSTRAINT </td>
+ <td class="jd-descrcol" width="100%"> </td>
+ </tr>
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-descrcol"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a> </td>
+ <td class="jd-linkcol">PARTICIPANT </td>
+ <td class="jd-descrcol" width="100%"> </td>
+ </tr>
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-descrcol"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a> </td>
+ <td class="jd-linkcol">PARTITION </td>
+ <td class="jd-descrcol" width="100%"> </td>
+ </tr>
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-descrcol"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a> </td>
+ <td class="jd-linkcol">RESOURCE </td>
+ <td class="jd-descrcol" width="100%"> </td>
+ </tr>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
+
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+ static
+
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html#valueOf(java.lang.String)">valueOf</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+ static
+
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScopeProperty[]</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad"><a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html#values()">values</a></span>()</nobr>
+
+ </td></tr>
+
+
+
+</table>
+
+
+
+
+
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+<table id="inhmethods" class="jd-sumtable"><tr><th>
+ <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
+ <div style="clear:left;">Inherited Methods</div></th></tr>
+
+
+<tr class="api apilevel-" >
+<td colspan="12">
+ <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Enum" class="jd-expando-trigger closed"
+ ><img id="inherited-methods-java.lang.Enum-trigger"
+ src="../../../../assets/images/triangle-closed.png"
+ class="jd-expando-trigger-img" /></a>
+From class
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">java.lang.Enum</a>
+
+<div id="inherited-methods-java.lang.Enum">
+ <div id="inherited-methods-java.lang.Enum-list"
+ class="jd-inheritedlinks">
+ </div>
+ <div id="inherited-methods-java.lang.Enum-summary" style="display: none;">
+ <table class="jd-sumtable-expando">
+
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">clone</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">compareTo</span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> arg0)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">compareTo</span>(E arg0)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ boolean</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">equals</span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> arg0)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">finalize</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a><E></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">getDeclaringClass</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">hashCode</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">name</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">ordinal</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">toString</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+ static
+ <T extends <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Enum.html">Enum</a><T>>
+ T</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">valueOf</span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a><T> arg0, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> arg1)</nobr>
+
+ </td></tr>
+
+
+</table>
+ </div>
+</div>
+</td></tr>
+
+
+
+<tr class="api apilevel-" >
+<td colspan="12">
+ <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
+ ><img id="inherited-methods-java.lang.Object-trigger"
+ src="../../../../assets/images/triangle-closed.png"
+ class="jd-expando-trigger-img" /></a>
+From class
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">java.lang.Object</a>
+
+<div id="inherited-methods-java.lang.Object">
+ <div id="inherited-methods-java.lang.Object-list"
+ class="jd-inheritedlinks">
+ </div>
+ <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
+ <table class="jd-sumtable-expando">
+
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">clone</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ boolean</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">equals</span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> arg0)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">finalize</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a><?></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">getClass</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">hashCode</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">notify</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">notifyAll</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+
+
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">toString</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">wait</span>()</nobr>
+
+ </td></tr>
+
+
+
+ <tr class=" api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">wait</span>(long arg0, int arg1)</nobr>
+
+ </td></tr>
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+
+
+ final
+
+
+ void</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">wait</span>(long arg0)</nobr>
+
+ </td></tr>
+
+
+</table>
+ </div>
+</div>
+</td></tr>
+
+
+
+
+
+<tr class="api apilevel-" >
+<td colspan="12">
+ <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Comparable" class="jd-expando-trigger closed"
+ ><img id="inherited-methods-java.lang.Comparable-trigger"
+ src="../../../../assets/images/triangle-closed.png"
+ class="jd-expando-trigger-img" /></a>
+From interface
+
+ <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Comparable.html">java.lang.Comparable</a>
+
+<div id="inherited-methods-java.lang.Comparable">
+ <div id="inherited-methods-java.lang.Comparable-list"
+ class="jd-inheritedlinks">
+ </div>
+ <div id="inherited-methods-java.lang.Comparable-summary" style="display: none;">
+ <table class="jd-sumtable-expando">
+
+
+
+
+ <tr class="alt-color api apilevel-" >
+ <td class="jd-typecol"><nobr>
+ abstract
+
+
+
+
+ int</nobr>
+ </td>
+ <td class="jd-linkcol" width="100%"><nobr>
+ <span class="sympad">compareTo</span>(T arg0)</nobr>
+
+ </td></tr>
+
+
+</table>
+ </div>
+</div>
+</td></tr>
+
+
+</table>
+
+
+</div><!-- jd-descr (summary) -->
+
+<!-- Details -->
+
+
+
+
+
+
+
+
+<!-- XML Attributes -->
+
+
+<!-- Enum Values -->
+
+
+<!-- ========= ENUM CONSTANTS DETAIL ======== -->
+<h2>Enum Values</h2>
+
+
+
+
+<A NAME="CLUSTER"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ CLUSTER
+ </h4>
+ <div class="api-level">
+
+
+
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+
+ </div>
+</div>
+
+
+
+<A NAME="CONSTRAINT"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ CONSTRAINT
+ </h4>
+ <div class="api-level">
+
+
+
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+
+ </div>
+</div>
+
+
+
+<A NAME="PARTICIPANT"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ PARTICIPANT
+ </h4>
+ <div class="api-level">
+
+
+
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+
+ </div>
+</div>
+
+
+
+<A NAME="PARTITION"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ PARTITION
+ </h4>
+ <div class="api-level">
+
+
+
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+
+ </div>
+</div>
+
+
+
+<A NAME="RESOURCE"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ RESOURCE
+ </h4>
+ <div class="api-level">
+
+
+
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+
+ </div>
+</div>
+
+
+
+
+<!-- Constants -->
+
+
+<!-- Fields -->
+
+
+<!-- Public ctors -->
+
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<!-- Protected ctors -->
+
+
+
+<!-- ========= METHOD DETAIL ======== -->
+<!-- Public methdos -->
+
+<h2>Public Methods</h2>
+
+
+
+<A NAME="valueOf(java.lang.String)"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+
+
+
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScope.ConfigScopeProperty</a>
+ </span>
+ <span class="sympad">valueOf</span>
+ <span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name)</span>
+ </h4>
+ <div class="api-level">
+ <div>
+
+</div>
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+ </div>
+</div>
+
+
+<A NAME="values()"></A>
+
+<div class="jd-details api apilevel-">
+ <h4 class="jd-details-title">
+ <span class="normal">
+ public
+ static
+ final
+
+
+ <a href="../../../org/apache/helix/ConfigScope.ConfigScopeProperty.html">ConfigScopeProperty[]</a>
+ </span>
+ <span class="sympad">values</span>
+ <span class="normal">()</span>
+ </h4>
+ <div class="api-level">
+ <div>
+
+</div>
+
+
+
+ </div>
+ <div class="jd-details-descr">
+
+ <div class="jd-tagdata jd-tagdescr"><p></p></div>
+
+ </div>
+</div>
+
+
+
+
+
+<!-- ========= METHOD DETAIL ======== -->
+
+
+
+<!-- ========= END OF CLASS DATA ========= -->
+<A NAME="navbar_top"></A>
+
+<div id="footer">
+Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>.
+</div> <!-- end footer -->
+
+</div> <!-- jd-content -->
+
+</div><!-- end doc-content -->
+
+</div> <!-- end body-content -->
+
+<script type="text/javascript">
+init(); /* initialize doclava-developer-docs.js */
+</script>
+
+</body>
+</html>
\ No newline at end of file