You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@helix.apache.org by ka...@apache.org on 2013/10/17 23:43:20 UTC
svn commit: r1533269 [27/27] - in /incubator/helix/site-content: ./
apidocs/assets/ apidocs/reference/ apidocs/reference/org/apache/helix/
apidocs/reference/org/apache/helix/agent/
apidocs/reference/org/apache/helix/alerts/ apidocs/reference/org/apache...
Added: incubator/helix/site-content/xref/org/apache/helix/model/util/StateModelDefinitionValidator.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/model/util/StateModelDefinitionValidator.html?rev=1533269&view=auto
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/model/util/StateModelDefinitionValidator.html (added)
+++ incubator/helix/site-content/xref/org/apache/helix/model/util/StateModelDefinitionValidator.html Thu Oct 17 21:43:06 2013
@@ -0,0 +1,303 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>StateModelDefinitionValidator xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/helix/model/util/StateModelDefinitionValidator.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.helix.model.util;
+<a class="jxr_linenumber" name="2" href="#2">2</a>
+<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="21" href="#21">21</a>
+<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Set;
+<a class="jxr_linenumber" name="26" href="#26">26</a>
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.helix.HelixDefinedState;
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.helix.model.StateModelDefinition;
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.Logger;
+<a class="jxr_linenumber" name="30" href="#30">30</a>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> com.google.common.collect.Maps;
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> com.google.common.collect.Sets;
+<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"> * Validator logic for a StateModelDefinition.<br/></em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <br/></em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Usage:<br/></em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * StateModelDefinition stateModelDef = ...;<br/></em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * StateModelDefinitionValidator.isStateModelDefinitionValid(stateModelDef);</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/helix/model/util/StateModelDefinitionValidator.html">StateModelDefinitionValidator</a> {
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger _logger = Logger.getLogger(StateModelDefinitionValidator.<strong class="jxr_keyword">class</strong>);
+<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/helix/model/StateModelDefinition.html">StateModelDefinition</a> _stateModelDef;
+<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<String> _statePriorityList;
+<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<String> _transitionPriorityList;
+<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<String> _stateSet;
+<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"> * Instantiate a validator instance</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @param stateModelDef the state model definition to validate</em>
+<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> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/helix/model/util/StateModelDefinitionValidator.html">StateModelDefinitionValidator</a>(<a href="../../../../../org/apache/helix/model/StateModelDefinition.html">StateModelDefinition</a> stateModelDef) {
+<a class="jxr_linenumber" name="53" href="#53">53</a> _stateModelDef = stateModelDef;
+<a class="jxr_linenumber" name="54" href="#54">54</a> _statePriorityList = stateModelDef.getStatesPriorityList();
+<a class="jxr_linenumber" name="55" href="#55">55</a> _transitionPriorityList = stateModelDef.getStateTransitionPriorityList();
+<a class="jxr_linenumber" name="56" href="#56">56</a> _stateSet = Sets.newHashSet(_statePriorityList);
+<a class="jxr_linenumber" name="57" href="#57">57</a> }
+<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"> * Check if the StateModelDefinition passes all validation checks</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return true if state model definition is valid, false otherwise</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isStateModelDefinitionValid() {
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_comment">// has a name</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">if</strong> (_stateModelDef.getId() == <strong class="jxr_keyword">null</strong> || _stateModelDef.getId().isEmpty()) {
+<a class="jxr_linenumber" name="66" href="#66">66</a> _logger.error(<span class="jxr_string">"State model does not have a name"</span>);
+<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="68" href="#68">68</a> }
+<a class="jxr_linenumber" name="69" href="#69">69</a>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_comment">// has an initial state</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> (_stateModelDef.getInitialState() == <strong class="jxr_keyword">null</strong> || _stateModelDef.getInitialState().isEmpty()) {
+<a class="jxr_linenumber" name="72" href="#72">72</a> _logger
+<a class="jxr_linenumber" name="73" href="#73">73</a> .error(<span class="jxr_string">"State model does not contain init state, statemodel:"</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="75" href="#75">75</a> }
+<a class="jxr_linenumber" name="76" href="#76">76</a>
+<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_comment">// has states</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> (_statePriorityList == <strong class="jxr_keyword">null</strong> || _statePriorityList.isEmpty()) {
+<a class="jxr_linenumber" name="79" href="#79">79</a> _logger.error(<span class="jxr_string">"CurrentState does not contain StatesPriorityList, state model : "</span>
+<a class="jxr_linenumber" name="80" href="#80">80</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="82" href="#82">82</a> }
+<a class="jxr_linenumber" name="83" href="#83">83</a>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_comment">// initial state is a state</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (!_stateSet.contains(_stateModelDef.getInitialState())) {
+<a class="jxr_linenumber" name="86" href="#86">86</a> _logger.error(<span class="jxr_string">"Defined states does not include the initial state, state model: "</span>
+<a class="jxr_linenumber" name="87" href="#87">87</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="89" href="#89">89</a> }
+<a class="jxr_linenumber" name="90" href="#90">90</a>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_comment">// has a dropped state</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (!_stateSet.contains(HelixDefinedState.DROPPED.toString())) {
+<a class="jxr_linenumber" name="93" href="#93">93</a> _logger.error(<span class="jxr_string">"Defined states does not include the DROPPED state, state model: "</span>
+<a class="jxr_linenumber" name="94" href="#94">94</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="96" href="#96">96</a> }
+<a class="jxr_linenumber" name="97" href="#97">97</a>
+<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_comment">// make sure individual checks all pass</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (!areStateCountsValid() || !areNextStatesValid() || !isTransitionPriorityListValid()
+<a class="jxr_linenumber" name="100" href="#100">100</a> || !arePathsValid()) {
+<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="102" href="#102">102</a> }
+<a class="jxr_linenumber" name="103" href="#103">103</a>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="105" href="#105">105</a> }
+<a class="jxr_linenumber" name="106" href="#106">106</a>
+<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"> * Check if state counts are properly defined for each state</em>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @return true if state counts valid, false otherwise</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> areStateCountsValid() {
+<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">for</strong> (String state : _statePriorityList) {
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_comment">// all states should have a count</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> String count = _stateModelDef.getNumInstancesPerState(state);
+<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (count == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="116" href="#116">116</a> _logger.error(<span class="jxr_string">"State "</span> + state + <span class="jxr_string">" needs an upper bound constraint, state model: "</span>
+<a class="jxr_linenumber" name="117" href="#117">117</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> false;
+<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="121" href="#121">121</a> <em class="jxr_comment">// count should be a number, N, or R</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="123" href="#123">123</a> Integer.parseInt(count);
+<a class="jxr_linenumber" name="124" href="#124">124</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) {
+<a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">if</strong> (!count.equals(<span class="jxr_string">"N"</span>) && !count.equals(<span class="jxr_string">"R"</span>)) {
+<a class="jxr_linenumber" name="126" href="#126">126</a> _logger.error(<span class="jxr_string">"State "</span> + state + <span class="jxr_string">" has invalid count "</span> + count + <span class="jxr_string">", state model: "</span>
+<a class="jxr_linenumber" name="127" href="#127">127</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="129" href="#129">129</a> }
+<a class="jxr_linenumber" name="130" href="#130">130</a> }
+<a class="jxr_linenumber" name="131" href="#131">131</a> }
+<a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="133" href="#133">133</a> }
+<a class="jxr_linenumber" name="134" href="#134">134</a>
+<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"> * Check if the state transition priority list is properly formed</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @return true if the transition priority list is valid, false otherwise</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isTransitionPriorityListValid() {
+<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">if</strong> (_transitionPriorityList != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">for</strong> (String transition : _transitionPriorityList) {
+<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_comment">// ensure that transition is of form FROM-TO</em>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">int</strong> index = transition.indexOf('-');
+<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">int</strong> lastIndex = transition.indexOf('-');
+<a class="jxr_linenumber" name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> (index <= 0 || index >= transition.length() - 1 || index != lastIndex) {
+<a class="jxr_linenumber" name="146" href="#146">146</a> _logger.error(<span class="jxr_string">"Transition "</span> + transition + <span class="jxr_string">" is not of the form SRC-DEST, state model: "</span>
+<a class="jxr_linenumber" name="147" href="#147">147</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="149" href="#149">149</a> }
+<a class="jxr_linenumber" name="150" href="#150">150</a>
+<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_comment">// from and to states should be valid states</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> String from = transition.substring(0, index);
+<a class="jxr_linenumber" name="153" href="#153">153</a> String to = transition.substring(index + 1);
+<a class="jxr_linenumber" name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (!_stateSet.contains(from)) {
+<a class="jxr_linenumber" name="155" href="#155">155</a> _logger.error(<span class="jxr_string">"State "</span> + from + <span class="jxr_string">" in "</span> + transition
+<a class="jxr_linenumber" name="156" href="#156">156</a> + <span class="jxr_string">" is not a defined state, state model"</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="158" href="#158">158</a> }
+<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (!_stateSet.contains(to)) {
+<a class="jxr_linenumber" name="160" href="#160">160</a> _logger.error(<span class="jxr_string">"State "</span> + to + <span class="jxr_string">" in "</span> + transition
+<a class="jxr_linenumber" name="161" href="#161">161</a> + <span class="jxr_string">" is not a defined state, state model: "</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="162" href="#162">162</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="163" href="#163">163</a> }
+<a class="jxr_linenumber" name="164" href="#164">164</a>
+<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_comment">// the next state for the transition should be the to state</em>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (!to.equals(_stateModelDef.getNextStateForTransition(from, to))) {
+<a class="jxr_linenumber" name="167" href="#167">167</a> _logger.error(<span class="jxr_string">"Transition "</span> + transition + <span class="jxr_string">" must have "</span> + to + <span class="jxr_string">" as the next state"</span>);
+<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="169" href="#169">169</a> }
+<a class="jxr_linenumber" name="170" href="#170">170</a> }
+<a class="jxr_linenumber" name="171" href="#171">171</a> }
+<a class="jxr_linenumber" name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="173" href="#173">173</a> }
+<a class="jxr_linenumber" name="174" href="#174">174</a>
+<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * Check if the "next" states in the state model definition are valid. These check the next values</em>
+<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * at a single level. To check full paths, use {@link #arePathsValid()}.</em>
+<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment"> * @return true if next states are properly defined, false otherwise</em>
+<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="180" href="#180">180</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> areNextStatesValid() {
+<a class="jxr_linenumber" name="181" href="#181">181</a> <strong class="jxr_keyword">for</strong> (String state : _statePriorityList) {
+<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_comment">// all states can reach DROPPED</em>
+<a class="jxr_linenumber" name="183" href="#183">183</a> <strong class="jxr_keyword">if</strong> (!state.equals(HelixDefinedState.DROPPED.toString())
+<a class="jxr_linenumber" name="184" href="#184">184</a> && _stateModelDef.getNextStateForTransition(state, HelixDefinedState.DROPPED.toString()) == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="185" href="#185">185</a> _logger.error(<span class="jxr_string">"State "</span> + state + <span class="jxr_string">" cannot reach the DROPPED state, state model: "</span>
+<a class="jxr_linenumber" name="186" href="#186">186</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="187" href="#187">187</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="188" href="#188">188</a> }
+<a class="jxr_linenumber" name="189" href="#189">189</a>
+<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_comment">// initial state should reach all states (other than error)</em>
+<a class="jxr_linenumber" name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (!state.equals(_stateModelDef.getInitialState())
+<a class="jxr_linenumber" name="192" href="#192">192</a> && !state.equals(HelixDefinedState.ERROR.toString())
+<a class="jxr_linenumber" name="193" href="#193">193</a> && _stateModelDef.getNextStateForTransition(_stateModelDef.getInitialState(), state) == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="194" href="#194">194</a> _logger.error(<span class="jxr_string">"Initial state "</span> + _stateModelDef.getInitialState()
+<a class="jxr_linenumber" name="195" href="#195">195</a> + <span class="jxr_string">" should be able to reach all states, state model: "</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="197" href="#197">197</a> }
+<a class="jxr_linenumber" name="198" href="#198">198</a>
+<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_comment">// validate "next" states</em>
+<a class="jxr_linenumber" name="200" href="#200">200</a> <strong class="jxr_keyword">for</strong> (String destState : _statePriorityList) {
+<a class="jxr_linenumber" name="201" href="#201">201</a> <strong class="jxr_keyword">if</strong> (state.equals(destState)) {
+<a class="jxr_linenumber" name="202" href="#202">202</a> <strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="203" href="#203">203</a> }
+<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_comment">// the next state should exist</em>
+<a class="jxr_linenumber" name="205" href="#205">205</a> String intermediate = _stateModelDef.getNextStateForTransition(state, destState);
+<a class="jxr_linenumber" name="206" href="#206">206</a> <strong class="jxr_keyword">if</strong> (intermediate != <strong class="jxr_keyword">null</strong> && !_stateSet.contains(intermediate)) {
+<a class="jxr_linenumber" name="207" href="#207">207</a> _logger.error(<span class="jxr_string">"Intermediate state "</span> + intermediate + <span class="jxr_string">" for transition "</span> + state + <span class="jxr_string">"-"</span>
+<a class="jxr_linenumber" name="208" href="#208">208</a> + destState + <span class="jxr_string">" is not a valid state, state model: "</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="210" href="#210">210</a> }
+<a class="jxr_linenumber" name="211" href="#211">211</a>
+<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_comment">// the next state should not allow a self loop</em>
+<a class="jxr_linenumber" name="213" href="#213">213</a> <strong class="jxr_keyword">if</strong> (intermediate != <strong class="jxr_keyword">null</strong> && intermediate.equals(state)) {
+<a class="jxr_linenumber" name="214" href="#214">214</a> _logger.error(<span class="jxr_string">"Intermediate state "</span> + intermediate + <span class="jxr_string">" for transition "</span> + state + <span class="jxr_string">"-"</span>
+<a class="jxr_linenumber" name="215" href="#215">215</a> + destState + <span class="jxr_string">" should never be the from state, state model: "</span>
+<a class="jxr_linenumber" name="216" href="#216">216</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="217" href="#217">217</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="218" href="#218">218</a> }
+<a class="jxr_linenumber" name="219" href="#219">219</a> }
+<a class="jxr_linenumber" name="220" href="#220">220</a> }
+<a class="jxr_linenumber" name="221" href="#221">221</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="222" href="#222">222</a> }
+<a class="jxr_linenumber" name="223" href="#223">223</a>
+<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * Check that the state model does not have loops or unreachable states and that next states</em>
+<a class="jxr_linenumber" name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * actually help make progress</em>
+<a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * @return true if the transitions are valid, false otherwise</em>
+<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="229" href="#229">229</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> arePathsValid() {
+<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_comment">// create a map for memoized path checking</em>
+<a class="jxr_linenumber" name="231" href="#231">231</a> Map<String, Set<String>> alreadyChecked = Maps.newHashMap();
+<a class="jxr_linenumber" name="232" href="#232">232</a> <strong class="jxr_keyword">for</strong> (String state : _statePriorityList) {
+<a class="jxr_linenumber" name="233" href="#233">233</a> alreadyChecked.put(state, <strong class="jxr_keyword">new</strong> HashSet<String>());
+<a class="jxr_linenumber" name="234" href="#234">234</a> }
+<a class="jxr_linenumber" name="235" href="#235">235</a>
+<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_comment">// check all pairs for paths</em>
+<a class="jxr_linenumber" name="237" href="#237">237</a> <strong class="jxr_keyword">for</strong> (String from : _statePriorityList) {
+<a class="jxr_linenumber" name="238" href="#238">238</a> <strong class="jxr_keyword">for</strong> (String to : _statePriorityList) {
+<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_comment">// ignore self transitions</em>
+<a class="jxr_linenumber" name="240" href="#240">240</a> <strong class="jxr_keyword">if</strong> (from.equals(to)) {
+<a class="jxr_linenumber" name="241" href="#241">241</a> <strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="242" href="#242">242</a> }
+<a class="jxr_linenumber" name="243" href="#243">243</a>
+<a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_comment">// see if a path is claimed to exist</em>
+<a class="jxr_linenumber" name="245" href="#245">245</a> Set<String> used = Sets.newHashSet(from);
+<a class="jxr_linenumber" name="246" href="#246">246</a> String next = _stateModelDef.getNextStateForTransition(from, to);
+<a class="jxr_linenumber" name="247" href="#247">247</a> <strong class="jxr_keyword">if</strong> (next == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (from.equals(_stateModelDef.getInitialState())
+<a class="jxr_linenumber" name="249" href="#249">249</a> && !to.equals(HelixDefinedState.ERROR.toString())) {
+<a class="jxr_linenumber" name="250" href="#250">250</a> _logger.error(<span class="jxr_string">"Initial state "</span> + from + <span class="jxr_string">" cannot reach "</span> + to + <span class="jxr_string">", state model: "</span>
+<a class="jxr_linenumber" name="251" href="#251">251</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="252" href="#252">252</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="253" href="#253">253</a> }
+<a class="jxr_linenumber" name="254" href="#254">254</a> <strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="255" href="#255">255</a> }
+<a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_comment">// if a path exists, follow it all the way</em>
+<a class="jxr_linenumber" name="257" href="#257">257</a> <strong class="jxr_keyword">while</strong> (!to.equals(next)) {
+<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_comment">// no need to proceed if this path has already been traversed</em>
+<a class="jxr_linenumber" name="259" href="#259">259</a> <strong class="jxr_keyword">if</strong> (alreadyChecked.get(next).contains(to)) {
+<a class="jxr_linenumber" name="260" href="#260">260</a> <strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="261" href="#261">261</a> }
+<a class="jxr_linenumber" name="262" href="#262">262</a> <strong class="jxr_keyword">if</strong> (used.contains(next)) {
+<a class="jxr_linenumber" name="263" href="#263">263</a> _logger.error(<span class="jxr_string">"Path from "</span> + from + <span class="jxr_string">" to "</span> + to
+<a class="jxr_linenumber" name="264" href="#264">264</a> + <span class="jxr_string">" contains an infinite loop, state model: "</span> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="265" href="#265">265</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="266" href="#266">266</a> }
+<a class="jxr_linenumber" name="267" href="#267">267</a> alreadyChecked.get(next).add(to);
+<a class="jxr_linenumber" name="268" href="#268">268</a> used.add(next);
+<a class="jxr_linenumber" name="269" href="#269">269</a> next = _stateModelDef.getNextStateForTransition(next, to);
+<a class="jxr_linenumber" name="270" href="#270">270</a> <strong class="jxr_keyword">if</strong> (next == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="271" href="#271">271</a> _logger.error(<span class="jxr_string">"Path from "</span> + from + <span class="jxr_string">" to "</span> + to + <span class="jxr_string">" is incomplete, state model: "</span>
+<a class="jxr_linenumber" name="272" href="#272">272</a> + _stateModelDef.getId());
+<a class="jxr_linenumber" name="273" href="#273">273</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="274" href="#274">274</a> }
+<a class="jxr_linenumber" name="275" href="#275">275</a> }
+<a class="jxr_linenumber" name="276" href="#276">276</a> alreadyChecked.get(from).add(to);
+<a class="jxr_linenumber" name="277" href="#277">277</a> }
+<a class="jxr_linenumber" name="278" href="#278">278</a> }
+<a class="jxr_linenumber" name="279" href="#279">279</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="280" href="#280">280</a> }
+<a class="jxr_linenumber" name="281" href="#281">281</a>
+<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * Validate a StateModelDefinition instance</em>
+<a class="jxr_linenumber" name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * @param stateModelDef the state model definition to validate</em>
+<a class="jxr_linenumber" name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * @return true if the state model definition is valid, false otherwise</em>
+<a class="jxr_linenumber" name="286" href="#286">286</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="287" href="#287">287</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isStateModelDefinitionValid(<a href="../../../../../org/apache/helix/model/StateModelDefinition.html">StateModelDefinition</a> stateModelDef) {
+<a class="jxr_linenumber" name="288" href="#288">288</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/helix/model/util/StateModelDefinitionValidator.html">StateModelDefinitionValidator</a>(stateModelDef).isStateModelDefinitionValid();
+<a class="jxr_linenumber" name="289" href="#289">289</a> }
+<a class="jxr_linenumber" name="290" href="#290">290</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
Added: incubator/helix/site-content/xref/org/apache/helix/model/util/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/model/util/package-frame.html?rev=1533269&view=auto
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/model/util/package-frame.html (added)
+++ incubator/helix/site-content/xref/org/apache/helix/model/util/package-frame.html Thu Oct 17 21:43:06 2013
@@ -0,0 +1,24 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Apache Helix 0.6.2-incubating-SNAPSHOT Reference Package org.apache.helix.model.util</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">org.apache.helix.model.util</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="StateModelDefinitionValidator.html" target="classFrame">StateModelDefinitionValidator</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/helix/site-content/xref/org/apache/helix/model/util/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/org/apache/helix/model/util/package-summary.html?rev=1533269&view=auto
==============================================================================
--- incubator/helix/site-content/xref/org/apache/helix/model/util/package-summary.html (added)
+++ incubator/helix/site-content/xref/org/apache/helix/model/util/package-summary.html Thu Oct 17 21:43:06 2013
@@ -0,0 +1,67 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Apache Helix 0.6.2-incubating-SNAPSHOT Reference Package org.apache.helix.model.util</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package org.apache.helix.model.util</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="StateModelDefinitionValidator.html" target="classFrame">StateModelDefinitionValidator</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2013 The Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Modified: incubator/helix/site-content/xref/overview-frame.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/overview-frame.html?rev=1533269&r1=1533268&r2=1533269&view=diff
==============================================================================
--- incubator/helix/site-content/xref/overview-frame.html (original)
+++ incubator/helix/site-content/xref/overview-frame.html Thu Oct 17 21:43:06 2013
@@ -79,6 +79,9 @@
<a href="org/apache/helix/model/builder/package-frame.html" target="packageFrame">org.apache.helix.model.builder</a>
</li>
<li>
+ <a href="org/apache/helix/model/util/package-frame.html" target="packageFrame">org.apache.helix.model.util</a>
+ </li>
+ <li>
<a href="org/apache/helix/monitoring/package-frame.html" target="packageFrame">org.apache.helix.monitoring</a>
</li>
<li>
Modified: incubator/helix/site-content/xref/overview-summary.html
URL: http://svn.apache.org/viewvc/incubator/helix/site-content/xref/overview-summary.html?rev=1533269&r1=1533268&r2=1533269&view=diff
==============================================================================
--- incubator/helix/site-content/xref/overview-summary.html (original)
+++ incubator/helix/site-content/xref/overview-summary.html Thu Oct 17 21:43:06 2013
@@ -140,6 +140,11 @@
</tr>
<tr>
<td>
+ <a href="org/apache/helix/model/util/package-summary.html">org.apache.helix.model.util</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
<a href="org/apache/helix/monitoring/package-summary.html">org.apache.helix.monitoring</a>
</td>
</tr>