hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject svn commit: r1620690 [39/40] - in /hbase/hbase.apache.org/trunk: ./ apidocs/org/apache/hadoop/hbase/client/ apidocs/org/apache/hadoop/hbase/client/class-use/ apidocs/org/apache/hadoop/hbase/coprocessor/ apidocs/org/apache/hadoop/hbase/coprocessor/class...
Date Tue, 26 Aug 2014 18:49:10 GMT
Added: hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html
URL: http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html?rev=1620690&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html (added)
+++ hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html Tue Aug 26 18:49:07 2014
@@ -0,0 +1,56 @@
+<!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>VisibilityExpEvaluator xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> * with the License.  You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> *     <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="12" href="#12">12</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">package</strong> org.apache.hadoop.hbase.security.visibility;
+<a class="jxr_linenumber" name="20" href="#20">20</a>  
+<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="22" href="#22">22</a>  
+<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceAudience;
+<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceStability;
+<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.Cell;
+<a class="jxr_linenumber" name="26" href="#26">26</a>  
+<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * During the read (ie. get/Scan) the VisibilityController calls this interface for each of the</em>
+<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * Cell. Depending on the evaluate() result, a cell can be either included or filtered out from the</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * read results.</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a>  @InterfaceAudience.Public
+<a class="jxr_linenumber" name="33" href="#33">33</a>  @InterfaceStability.Evolving
+<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html">VisibilityExpEvaluator</a> {
+<a class="jxr_linenumber" name="35" href="#35">35</a>  
+<a class="jxr_linenumber" name="36" href="#36">36</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   * Evaluates whether the passed cell passes Scan/Get Authorization.</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * @param cell Cell under evaluation</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * @return true if this cell can be included in the Result. Else false.</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">boolean</strong> evaluate(<a href="../../../../../../org/apache/hadoop/hbase/Cell.html">Cell</a> cell) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="42" href="#42">42</a>  }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html
URL: http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html?rev=1620690&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html (added)
+++ hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html Tue Aug 26 18:49:07 2014
@@ -0,0 +1,156 @@
+<!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>VisibilityLabelService xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * with the License.  You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> *     <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="11" href="#11">11</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.hadoop.hbase.security.visibility;
+<a class="jxr_linenumber" name="19" href="#19">19</a>  
+<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="22" href="#22">22</a>  
+<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceAudience;
+<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceStability;
+<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.conf.Configurable;
+<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.Tag;
+<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;
+<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.regionserver.OperationStatus;
+<a class="jxr_linenumber" name="29" href="#29">29</a>  
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * The interface which deals with visibility labels and user auths admin service as well as the cell</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * visibility expression storage part and read time evaluation.</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a>  @InterfaceAudience.Public
+<a class="jxr_linenumber" name="35" href="#35">35</a>  @InterfaceStability.Evolving
+<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html">VisibilityLabelService</a> <strong class="jxr_keyword">extends</strong> Configurable {
+<a class="jxr_linenumber" name="37" href="#37">37</a>  
+<a class="jxr_linenumber" name="38" href="#38">38</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * System calls this after opening of regions. Gives a chance for the VisibilityLabelService to so</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * any initialization logic.</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * @param e</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   *          the region coprocessor env</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a>    <strong class="jxr_keyword">void</strong> init(<a href="../../../../../../org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html">RegionCoprocessorEnvironment</a> e) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="45" href="#45">45</a>  
+<a class="jxr_linenumber" name="46" href="#46">46</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">   * Adds the set of labels into the system.</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * @param labels</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   *          Labels to add to the system.</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * @return OperationStatus for each of the label addition</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>    <a href="../../../../../../org/apache/hadoop/hbase/regionserver/OperationStatus.html">OperationStatus</a>[] addLabels(List&lt;byte[]&gt; labels) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="53" href="#53">53</a>  
+<a class="jxr_linenumber" name="54" href="#54">54</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * Sets given labels globally authorized for the user.</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   * @param user</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   *          The authorizing user</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   * @param authLabels</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   *          Labels which are getting authorized for the user</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * @return OperationStatus for each of the label auth addition</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a>    <a href="../../../../../../org/apache/hadoop/hbase/regionserver/OperationStatus.html">OperationStatus</a>[] setAuths(byte[] user, List&lt;byte[]&gt; authLabels) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="63" href="#63">63</a>  
+<a class="jxr_linenumber" name="64" href="#64">64</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * Removes given labels from user's globally authorized list of labels.</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   * @param user</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment">   *          The user whose authorization to be removed</em>
+<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment">   * @param authLabels</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   *          Labels which are getting removed from authorization set</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   * @return OperationStatus for each of the label auth removal</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a>    <a href="../../../../../../org/apache/hadoop/hbase/regionserver/OperationStatus.html">OperationStatus</a>[] clearAuths(byte[] user, List&lt;byte[]&gt; authLabels) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="73" href="#73">73</a>  
+<a class="jxr_linenumber" name="74" href="#74">74</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   * @param user</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   *          Name of the user whose authorization to be retrieved</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * @param systemCall</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   *          Whether a system or user originated call.</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * @return Visibility labels authorized for the given user.</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a>    List&lt;String&gt; getAuths(byte[] user, <strong class="jxr_keyword">boolean</strong> systemCall) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="82" href="#82">82</a>  
+<a class="jxr_linenumber" name="83" href="#83">83</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * Creates tags corresponding to given visibility expression.</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * &lt;br&gt;</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * Note: This will be concurrently called from multiple threads and implementation should</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * take care of thread safety.</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   * @param visExpression The Expression for which corresponding Tags to be created.</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">   * @param withSerializationFormat specifies whether a tag, denoting the serialization version</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   *          of the tags, to be added in the list. When this is true make sure to add the</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">   *          serialization format Tag also. The format tag value should be byte type.</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   * @param checkAuths denotes whether to check individual labels in visExpression against user's</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   *          global auth label.</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * @return The list of tags corresponds to the visibility expression. These tags will be stored</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   *         along with the Cells.</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>    List&lt;Tag&gt; createVisibilityExpTags(String visExpression, <strong class="jxr_keyword">boolean</strong> withSerializationFormat,
+<a class="jxr_linenumber" name="98" href="#98">98</a>        <strong class="jxr_keyword">boolean</strong> checkAuths) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="99" href="#99">99</a>  
+<a class="jxr_linenumber" name="100" href="#100">100</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * Creates VisibilityExpEvaluator corresponding to given Authorizations. &lt;br&gt;</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   * Note: This will be concurrently called from multiple threads and implementation should take</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">   * care of thread safety.</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">   * @param authorizations</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">   *          Authorizations for the read request</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * @return The VisibilityExpEvaluator corresponding to the given set of authorization labels.</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="108" href="#108">108</a>   <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityExpEvaluator.html">VisibilityExpEvaluator</a> getVisibilityExpEvaluator(<a href="../../../../../../org/apache/hadoop/hbase/security/visibility/Authorizations.html">Authorizations</a> authorizations)
+<a class="jxr_linenumber" name="109" href="#109">109</a>       <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="110" href="#110">110</a> 
+<a class="jxr_linenumber" name="111" href="#111">111</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment">   * System checks for user auth during admin operations. (ie. Label add, set/clear auth). The</em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">   * operation is allowed only for users having system auth. Also during read, if the requesting</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment">   * user has system auth, he can view all the data irrespective of its labels.</em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment">   * @param user</em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">   *          User for whom system auth check to be done.</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment">   * @return true if the given user is having system/super auth</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a>   <strong class="jxr_keyword">boolean</strong> havingSystemAuth(byte[] user) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="120" href="#120">120</a> 
+<a class="jxr_linenumber" name="121" href="#121">121</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">   * System uses this for deciding whether a Cell can be deleted by matching visibility expression</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">   * in Delete mutation and the cell in consideration. Also system passes the serialization format</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">   * of visibility tags in Put and Delete.&lt;br&gt;</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">   * Note: This will be concurrently called from multiple threads and implementation should take</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">   * care of thread safety.</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">   * @param putVisTags</em>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">   *          The visibility tags present in the Put mutation</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">   * @param putVisTagFormat</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment">   *          The serialization format for the Put visibility tags. A &lt;code&gt;null&lt;/code&gt; value for</em>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment">   *          this format means the tags are written with unsorted label ordinals</em>
+<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">   * @param deleteVisTags</em>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">   *          - The visibility tags in the delete mutation (the specified Cell Visibility)</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">   * @param deleteVisTagFormat</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">   *          The serialization format for the Delete visibility tags. A &lt;code&gt;null&lt;/code&gt; value for</em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">   *          this format means the tags are written with unsorted label ordinals</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">   * @return true if matching tags are found</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">   * @see VisibilityConstants#SORTED_ORDINAL_SERIALIZATION_FORMAT</em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="140" href="#140">140</a>   <strong class="jxr_keyword">boolean</strong> matchVisibility(List&lt;Tag&gt; putVisTags, Byte putVisTagFormat, List&lt;Tag&gt; deleteVisTags,
+<a class="jxr_linenumber" name="141" href="#141">141</a>       Byte deleteVisTagFormat) <strong class="jxr_keyword">throws</strong> IOException;
+<a class="jxr_linenumber" name="142" href="#142">142</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html
URL: http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html?rev=1620690&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html (added)
+++ hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html Tue Aug 26 18:49:07 2014
@@ -0,0 +1,116 @@
+<!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>VisibilityLabelServiceManager xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * with the License.  You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> *     <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="11" href="#11">11</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.hadoop.hbase.security.visibility;
+<a class="jxr_linenumber" name="19" href="#19">19</a>  
+<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<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> org.apache.commons.logging.Log;
+<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
+<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceAudience;
+<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.conf.Configuration;
+<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.util.ReflectionUtils;
+<a class="jxr_linenumber" name="27" href="#27">27</a>  
+<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * Manages singleton instance of {@link VisibilityLabelService}</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a>  @InterfaceAudience.Private
+<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">VisibilityLabelServiceManager</a> {
+<a class="jxr_linenumber" name="33" href="#33">33</a>  
+<a class="jxr_linenumber" name="34" href="#34">34</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log LOG = LogFactory.getLog(VisibilityLabelServiceManager.<strong class="jxr_keyword">class</strong>);
+<a class="jxr_linenumber" name="35" href="#35">35</a>  
+<a class="jxr_linenumber" name="36" href="#36">36</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String VISIBILITY_LABEL_SERVICE_CLASS =
+<a class="jxr_linenumber" name="37" href="#37">37</a>        <span class="jxr_string">"hbase.regionserver.visibility.label.service.class"</span>;
+<a class="jxr_linenumber" name="38" href="#38">38</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">VisibilityLabelServiceManager</a> INSTANCE = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">VisibilityLabelServiceManager</a>();
+<a class="jxr_linenumber" name="39" href="#39">39</a>  
+<a class="jxr_linenumber" name="40" href="#40">40</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html">VisibilityLabelService</a> visibilityLabelService = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="41" href="#41">41</a>    <strong class="jxr_keyword">private</strong> String vlsClazzName = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="42" href="#42">42</a>  
+<a class="jxr_linenumber" name="43" href="#43">43</a>    <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">VisibilityLabelServiceManager</a>() {
+<a class="jxr_linenumber" name="44" href="#44">44</a>  
+<a class="jxr_linenumber" name="45" href="#45">45</a>    }
+<a class="jxr_linenumber" name="46" href="#46">46</a>  
+<a class="jxr_linenumber" name="47" href="#47">47</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelServiceManager.html">VisibilityLabelServiceManager</a> getInstance() {
+<a class="jxr_linenumber" name="48" href="#48">48</a>      <strong class="jxr_keyword">return</strong> INSTANCE;
+<a class="jxr_linenumber" name="49" href="#49">49</a>    }
+<a class="jxr_linenumber" name="50" href="#50">50</a>  
+<a class="jxr_linenumber" name="51" href="#51">51</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * @param conf</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * @return singleton instance of {@link VisibilityLabelService}. The FQCN of the implementation</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   *         class can be specified using "hbase.regionserver.visibility.label.service.class".</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * @throws IOException When VLS implementation, as specified in conf, can not be loaded.</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html">VisibilityLabelService</a> getVisibilityLabelService(Configuration conf) <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="58" href="#58">58</a>      String vlsClassName = conf.get(VISIBILITY_LABEL_SERVICE_CLASS,
+<a class="jxr_linenumber" name="59" href="#59">59</a>          DefaultVisibilityLabelServiceImpl.<strong class="jxr_keyword">class</strong>.getCanonicalName()).trim();
+<a class="jxr_linenumber" name="60" href="#60">60</a>      <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.visibilityLabelService != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="61" href="#61">61</a>        checkForClusterLevelSingleConf(vlsClassName);
+<a class="jxr_linenumber" name="62" href="#62">62</a>        <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.visibilityLabelService;
+<a class="jxr_linenumber" name="63" href="#63">63</a>      }
+<a class="jxr_linenumber" name="64" href="#64">64</a>      <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>) {
+<a class="jxr_linenumber" name="65" href="#65">65</a>        <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.visibilityLabelService != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="66" href="#66">66</a>          checkForClusterLevelSingleConf(vlsClassName);
+<a class="jxr_linenumber" name="67" href="#67">67</a>          <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.visibilityLabelService;
+<a class="jxr_linenumber" name="68" href="#68">68</a>        }
+<a class="jxr_linenumber" name="69" href="#69">69</a>        <strong class="jxr_keyword">this</strong>.vlsClazzName = vlsClassName;
+<a class="jxr_linenumber" name="70" href="#70">70</a>        <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="71" href="#71">71</a>          <strong class="jxr_keyword">this</strong>.visibilityLabelService = (VisibilityLabelService) ReflectionUtils.newInstance(
+<a class="jxr_linenumber" name="72" href="#72">72</a>              Class.forName(vlsClassName), conf);
+<a class="jxr_linenumber" name="73" href="#73">73</a>        } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException e) {
+<a class="jxr_linenumber" name="74" href="#74">74</a>          <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(e);
+<a class="jxr_linenumber" name="75" href="#75">75</a>        }
+<a class="jxr_linenumber" name="76" href="#76">76</a>        <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.visibilityLabelService;
+<a class="jxr_linenumber" name="77" href="#77">77</a>      }
+<a class="jxr_linenumber" name="78" href="#78">78</a>    }
+<a class="jxr_linenumber" name="79" href="#79">79</a>  
+<a class="jxr_linenumber" name="80" href="#80">80</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkForClusterLevelSingleConf(String vlsClassName) {
+<a class="jxr_linenumber" name="81" href="#81">81</a>      assert <strong class="jxr_keyword">this</strong>.vlsClazzName != <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="82" href="#82">82</a>      <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.vlsClazzName.equals(vlsClassName)) {
+<a class="jxr_linenumber" name="83" href="#83">83</a>        LOG.warn(<span class="jxr_string">"Trying to use table specific value for config "</span>
+<a class="jxr_linenumber" name="84" href="#84">84</a>            + <span class="jxr_string">"'hbase.regionserver.visibility.label.service.class' which is not supported."</span>
+<a class="jxr_linenumber" name="85" href="#85">85</a>            + <span class="jxr_string">" Will use the cluster level VisibilityLabelService class "</span> + <strong class="jxr_keyword">this</strong>.vlsClazzName);
+<a class="jxr_linenumber" name="86" href="#86">86</a>      }
+<a class="jxr_linenumber" name="87" href="#87">87</a>    }
+<a class="jxr_linenumber" name="88" href="#88">88</a>  
+<a class="jxr_linenumber" name="89" href="#89">89</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   * @return singleton instance of {@link VisibilityLabelService}.</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">   * @throws IllegalStateException if this called before initialization of singleton instance.</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelService.html">VisibilityLabelService</a> getVisibilityLabelService() {
+<a class="jxr_linenumber" name="94" href="#94">94</a>      <em class="jxr_comment">// By the time this method is called, the singleton instance of visibilityLabelService should</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a>      <em class="jxr_comment">// have been created. And it will be created as getVisibilityLabelService(Configuration conf)</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a>      <em class="jxr_comment">// is called from VC#start() and that will be the 1st thing core code do with any CP.</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>      <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.visibilityLabelService == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="98" href="#98">98</a>        <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"VisibilityLabelService not yet instantiated"</span>);
+<a class="jxr_linenumber" name="99" href="#99">99</a>      }
+<a class="jxr_linenumber" name="100" href="#100">100</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.visibilityLabelService;
+<a class="jxr_linenumber" name="101" href="#101">101</a>   }
+<a class="jxr_linenumber" name="102" href="#102">102</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html
URL: http://svn.apache.org/viewvc/hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html?rev=1620690&view=auto
==============================================================================
--- hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html (added)
+++ hbase/hbase.apache.org/trunk/xref/org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html Tue Aug 26 18:49:07 2014
@@ -0,0 +1,247 @@
+<!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>VisibilityLabelsCache xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * or more contributor license agreements.  See the NOTICE file</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * regarding copyright ownership.  The ASF licenses this file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License.  You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="10" href="#10">10</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="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> org.apache.hadoop.hbase.security.visibility;
+<a class="jxr_linenumber" name="19" href="#19">19</a>  
+<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
+<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.util.HashSet;
+<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
+<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
+<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.util.concurrent.locks.ReentrantReadWriteLock;
+<a class="jxr_linenumber" name="29" href="#29">29</a>  
+<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
+<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
+<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.classification.InterfaceAudience;
+<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.conf.Configuration;
+<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.exceptions.DeserializationException;
+<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.MultiUserAuthorizations;
+<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.UserAuthorizations;
+<a class="jxr_linenumber" name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.protobuf.generated.VisibilityLabelsProtos.VisibilityLabel;
+<a class="jxr_linenumber" name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.util.Bytes;
+<a class="jxr_linenumber" name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.zookeeper.ZooKeeperWatcher;
+<a class="jxr_linenumber" name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.apache.zookeeper.KeeperException;
+<a class="jxr_linenumber" name="41" href="#41">41</a>  
+<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * Maintains the cache for visibility labels and also uses the zookeeper to update the labels in the</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * system. The cache updation happens based on the data change event that happens on the zookeeper</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * znode for labels table</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a>  @InterfaceAudience.Private
+<a class="jxr_linenumber" name="48" href="#48">48</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a> {
+<a class="jxr_linenumber" name="49" href="#49">49</a>  
+<a class="jxr_linenumber" name="50" href="#50">50</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log LOG = LogFactory.getLog(VisibilityLabelsCache.<strong class="jxr_keyword">class</strong>);
+<a class="jxr_linenumber" name="51" href="#51">51</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> NON_EXIST_LABEL_ORDINAL = 0;
+<a class="jxr_linenumber" name="52" href="#52">52</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> List&lt;String&gt; EMPTY_LIST = Collections.emptyList();
+<a class="jxr_linenumber" name="53" href="#53">53</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Set&lt;Integer&gt; EMPTY_SET = Collections.emptySet();
+<a class="jxr_linenumber" name="54" href="#54">54</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a> instance;
+<a class="jxr_linenumber" name="55" href="#55">55</a>  
+<a class="jxr_linenumber" name="56" href="#56">56</a>    <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/ZKVisibilityLabelWatcher.html">ZKVisibilityLabelWatcher</a> zkVisibilityWatcher;
+<a class="jxr_linenumber" name="57" href="#57">57</a>    <strong class="jxr_keyword">private</strong> Map&lt;String, Integer&gt; labels = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Integer&gt;();
+<a class="jxr_linenumber" name="58" href="#58">58</a>    <strong class="jxr_keyword">private</strong> Map&lt;Integer, String&gt; ordinalVsLabels = <strong class="jxr_keyword">new</strong> HashMap&lt;Integer, String&gt;();
+<a class="jxr_linenumber" name="59" href="#59">59</a>    <strong class="jxr_keyword">private</strong> Map&lt;String, Set&lt;Integer&gt;&gt; userAuths = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Set&lt;Integer&gt;&gt;();
+<a class="jxr_linenumber" name="60" href="#60">60</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * This covers the members labels, ordinalVsLabels and userAuths</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">private</strong> ReentrantReadWriteLock lock = <strong class="jxr_keyword">new</strong> ReentrantReadWriteLock();
+<a class="jxr_linenumber" name="64" href="#64">64</a>  
+<a class="jxr_linenumber" name="65" href="#65">65</a>    <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a>(<a href="../../../../../../org/apache/hadoop/hbase/zookeeper/ZooKeeperWatcher.html">ZooKeeperWatcher</a> watcher, Configuration conf) <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="66" href="#66">66</a>      zkVisibilityWatcher = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/ZKVisibilityLabelWatcher.html">ZKVisibilityLabelWatcher</a>(watcher, <strong class="jxr_keyword">this</strong>, conf);
+<a class="jxr_linenumber" name="67" href="#67">67</a>      <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="68" href="#68">68</a>        zkVisibilityWatcher.start();
+<a class="jxr_linenumber" name="69" href="#69">69</a>      } <strong class="jxr_keyword">catch</strong> (KeeperException ke) {
+<a class="jxr_linenumber" name="70" href="#70">70</a>        LOG.error(<span class="jxr_string">"ZooKeeper initialization failed"</span>, ke);
+<a class="jxr_linenumber" name="71" href="#71">71</a>        <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(ke);
+<a class="jxr_linenumber" name="72" href="#72">72</a>      }
+<a class="jxr_linenumber" name="73" href="#73">73</a>    }
+<a class="jxr_linenumber" name="74" href="#74">74</a>  
+<a class="jxr_linenumber" name="75" href="#75">75</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * Creates the singleton instance, if not yet present, and returns the same.</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * @param watcher</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   * @param conf</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   * @return Singleton instance of VisibilityLabelsCache</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   * @throws IOException</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a> createAndGet(<a href="../../../../../../org/apache/hadoop/hbase/zookeeper/ZooKeeperWatcher.html">ZooKeeperWatcher</a> watcher,
+<a class="jxr_linenumber" name="83" href="#83">83</a>        Configuration conf) <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="84" href="#84">84</a>      <em class="jxr_comment">// VisibilityLabelService#init() for different regions (in same RS) passes same instance of</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a>      <em class="jxr_comment">// watcher as all get the instance from RS.</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a>      <em class="jxr_comment">// watcher != instance.zkVisibilityWatcher.getWatcher() - This check is needed only in UTs with</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a>      <em class="jxr_comment">// RS restart. It will be same JVM in which RS restarts and instance will be not null. But the</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a>      <em class="jxr_comment">// watcher associated with existing instance will be stale as the restarted RS will have new</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a>      <em class="jxr_comment">// watcher with it.</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a>      <strong class="jxr_keyword">if</strong> (instance == <strong class="jxr_keyword">null</strong> || watcher != instance.zkVisibilityWatcher.getWatcher()) {
+<a class="jxr_linenumber" name="91" href="#91">91</a>        instance = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a>(watcher, conf);
+<a class="jxr_linenumber" name="92" href="#92">92</a>      }
+<a class="jxr_linenumber" name="93" href="#93">93</a>      <strong class="jxr_keyword">return</strong> instance;
+<a class="jxr_linenumber" name="94" href="#94">94</a>    }
+<a class="jxr_linenumber" name="95" href="#95">95</a>  
+<a class="jxr_linenumber" name="96" href="#96">96</a>    <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * @return Singleton instance of VisibilityLabelsCache</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * @throws IllegalStateException</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   *           when this is called before calling</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   *           {@link #createAndGet(ZooKeeperWatcher, Configuration)}</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/hadoop/hbase/security/visibility/VisibilityLabelsCache.html">VisibilityLabelsCache</a> get() {
+<a class="jxr_linenumber" name="103" href="#103">103</a>     <em class="jxr_comment">// By the time this method is called, the singleton instance of VisibilityLabelsCache should</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a>     <em class="jxr_comment">// have been created.</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a>     <strong class="jxr_keyword">if</strong> (instance == <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="106" href="#106">106</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"VisibilityLabelsCache not yet instantiated"</span>);
+<a class="jxr_linenumber" name="107" href="#107">107</a>     }
+<a class="jxr_linenumber" name="108" href="#108">108</a>     <strong class="jxr_keyword">return</strong> instance;
+<a class="jxr_linenumber" name="109" href="#109">109</a>   }
+<a class="jxr_linenumber" name="110" href="#110">110</a> 
+<a class="jxr_linenumber" name="111" href="#111">111</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> refreshLabelsCache(byte[] data) <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="112" href="#112">112</a>     List&lt;VisibilityLabel&gt; visibilityLabels = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="113" href="#113">113</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="114" href="#114">114</a>       visibilityLabels = VisibilityUtils.readLabelsFromZKData(data);
+<a class="jxr_linenumber" name="115" href="#115">115</a>     } <strong class="jxr_keyword">catch</strong> (DeserializationException dse) {
+<a class="jxr_linenumber" name="116" href="#116">116</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(dse);
+<a class="jxr_linenumber" name="117" href="#117">117</a>     }
+<a class="jxr_linenumber" name="118" href="#118">118</a>     <strong class="jxr_keyword">this</strong>.lock.writeLock().lock();
+<a class="jxr_linenumber" name="119" href="#119">119</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="120" href="#120">120</a>       labels.clear();
+<a class="jxr_linenumber" name="121" href="#121">121</a>       ordinalVsLabels.clear();
+<a class="jxr_linenumber" name="122" href="#122">122</a>       <strong class="jxr_keyword">for</strong> (VisibilityLabel visLabel : visibilityLabels) {
+<a class="jxr_linenumber" name="123" href="#123">123</a>         String label = Bytes.toString(visLabel.getLabel().toByteArray());
+<a class="jxr_linenumber" name="124" href="#124">124</a>         labels.put(label, visLabel.getOrdinal());
+<a class="jxr_linenumber" name="125" href="#125">125</a>         ordinalVsLabels.put(visLabel.getOrdinal(), label);
+<a class="jxr_linenumber" name="126" href="#126">126</a>       }
+<a class="jxr_linenumber" name="127" href="#127">127</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="128" href="#128">128</a>       <strong class="jxr_keyword">this</strong>.lock.writeLock().unlock();
+<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">public</strong> <strong class="jxr_keyword">void</strong> refreshUserAuthsCache(byte[] data) <strong class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="133" href="#133">133</a>     MultiUserAuthorizations multiUserAuths = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="134" href="#134">134</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="135" href="#135">135</a>       multiUserAuths = VisibilityUtils.readUserAuthsFromZKData(data);
+<a class="jxr_linenumber" name="136" href="#136">136</a>     } <strong class="jxr_keyword">catch</strong> (DeserializationException dse) {
+<a class="jxr_linenumber" name="137" href="#137">137</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(dse);
+<a class="jxr_linenumber" name="138" href="#138">138</a>     }
+<a class="jxr_linenumber" name="139" href="#139">139</a>     <strong class="jxr_keyword">this</strong>.lock.writeLock().lock();
+<a class="jxr_linenumber" name="140" href="#140">140</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="141" href="#141">141</a>       <strong class="jxr_keyword">this</strong>.userAuths.clear();
+<a class="jxr_linenumber" name="142" href="#142">142</a>       <strong class="jxr_keyword">for</strong> (UserAuthorizations userAuths : multiUserAuths.getUserAuthsList()) {
+<a class="jxr_linenumber" name="143" href="#143">143</a>         String user = Bytes.toString(userAuths.getUser().toByteArray());
+<a class="jxr_linenumber" name="144" href="#144">144</a>         <strong class="jxr_keyword">this</strong>.userAuths.put(user, <strong class="jxr_keyword">new</strong> HashSet&lt;Integer&gt;(userAuths.getAuthList()));
+<a class="jxr_linenumber" name="145" href="#145">145</a>       }
+<a class="jxr_linenumber" name="146" href="#146">146</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="147" href="#147">147</a>       <strong class="jxr_keyword">this</strong>.lock.writeLock().unlock();
+<a class="jxr_linenumber" name="148" href="#148">148</a>     }
+<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_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">   * @param label Not null label string</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment">   * @return The ordinal for the label. The ordinal starts from 1. Returns 0 when passed a non</em>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">   *         existing label.</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getLabelOrdinal(String label) {
+<a class="jxr_linenumber" name="157" href="#157">157</a>     Integer ordinal = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="158" href="#158">158</a>     <strong class="jxr_keyword">this</strong>.lock.readLock().lock();
+<a class="jxr_linenumber" name="159" href="#159">159</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="160" href="#160">160</a>       ordinal = labels.get(label);
+<a class="jxr_linenumber" name="161" href="#161">161</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="162" href="#162">162</a>       <strong class="jxr_keyword">this</strong>.lock.readLock().unlock();
+<a class="jxr_linenumber" name="163" href="#163">163</a>     }
+<a class="jxr_linenumber" name="164" href="#164">164</a>     <strong class="jxr_keyword">if</strong> (ordinal != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="165" href="#165">165</a>       <strong class="jxr_keyword">return</strong> ordinal.intValue();
+<a class="jxr_linenumber" name="166" href="#166">166</a>     }
+<a class="jxr_linenumber" name="167" href="#167">167</a>     <em class="jxr_comment">// 0 denotes not available</em>
+<a class="jxr_linenumber" name="168" href="#168">168</a>     <strong class="jxr_keyword">return</strong> NON_EXIST_LABEL_ORDINAL;
+<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>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment">   * @param ordinal The ordinal of label which we are looking for.</em>
+<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">   * @return The label having the given ordinal. Returns &lt;code&gt;null&lt;/code&gt; when no label exist in</em>
+<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment">   *         the system with given ordinal</em>
+<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>   <strong class="jxr_keyword">public</strong> String getLabel(<strong class="jxr_keyword">int</strong> ordinal) {
+<a class="jxr_linenumber" name="177" href="#177">177</a>     <strong class="jxr_keyword">this</strong>.lock.readLock().lock();
+<a class="jxr_linenumber" name="178" href="#178">178</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="179" href="#179">179</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ordinalVsLabels.get(ordinal);
+<a class="jxr_linenumber" name="180" href="#180">180</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="181" href="#181">181</a>       <strong class="jxr_keyword">this</strong>.lock.readLock().unlock();
+<a class="jxr_linenumber" name="182" href="#182">182</a>     }
+<a class="jxr_linenumber" name="183" href="#183">183</a>   }
+<a class="jxr_linenumber" name="184" href="#184">184</a> 
+<a class="jxr_linenumber" name="185" href="#185">185</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment">   * @return The total number of visibility labels.</em>
+<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="188" href="#188">188</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getLabelsCount() {
+<a class="jxr_linenumber" name="189" href="#189">189</a>     <strong class="jxr_keyword">this</strong>.lock.readLock().lock();
+<a class="jxr_linenumber" name="190" href="#190">190</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="191" href="#191">191</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.labels.size();
+<a class="jxr_linenumber" name="192" href="#192">192</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="193" href="#193">193</a>       <strong class="jxr_keyword">this</strong>.lock.readLock().unlock();
+<a class="jxr_linenumber" name="194" href="#194">194</a>     }
+<a class="jxr_linenumber" name="195" href="#195">195</a>   }
+<a class="jxr_linenumber" name="196" href="#196">196</a> 
+<a class="jxr_linenumber" name="197" href="#197">197</a>   <strong class="jxr_keyword">public</strong> List&lt;String&gt; getAuths(String user) {
+<a class="jxr_linenumber" name="198" href="#198">198</a>     List&lt;String&gt; auths = EMPTY_LIST;
+<a class="jxr_linenumber" name="199" href="#199">199</a>     <strong class="jxr_keyword">this</strong>.lock.readLock().lock();
+<a class="jxr_linenumber" name="200" href="#200">200</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="201" href="#201">201</a>       Set&lt;Integer&gt; authOrdinals = userAuths.get(user);
+<a class="jxr_linenumber" name="202" href="#202">202</a>       <strong class="jxr_keyword">if</strong> (authOrdinals != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="203" href="#203">203</a>         auths = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;(authOrdinals.size());
+<a class="jxr_linenumber" name="204" href="#204">204</a>         <strong class="jxr_keyword">for</strong> (Integer authOrdinal : authOrdinals) {
+<a class="jxr_linenumber" name="205" href="#205">205</a>           auths.add(ordinalVsLabels.get(authOrdinal));
+<a class="jxr_linenumber" name="206" href="#206">206</a>         }
+<a class="jxr_linenumber" name="207" href="#207">207</a>       }
+<a class="jxr_linenumber" name="208" href="#208">208</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="209" href="#209">209</a>       <strong class="jxr_keyword">this</strong>.lock.readLock().unlock();
+<a class="jxr_linenumber" name="210" href="#210">210</a>     }
+<a class="jxr_linenumber" name="211" href="#211">211</a>     <strong class="jxr_keyword">return</strong> auths;
+<a class="jxr_linenumber" name="212" href="#212">212</a>   }
+<a class="jxr_linenumber" name="213" href="#213">213</a> 
+<a class="jxr_linenumber" name="214" href="#214">214</a>   <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">   * Returns the list of ordinals of authentications associated with the user</em>
+<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment">   *</em>
+<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment">   * @param user Not null value.</em>
+<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment">   * @return the list of ordinals</em>
+<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment">   */</em>
+<a class="jxr_linenumber" name="220" href="#220">220</a>   <strong class="jxr_keyword">public</strong> Set&lt;Integer&gt; getAuthsAsOrdinals(String user) {
+<a class="jxr_linenumber" name="221" href="#221">221</a>     <strong class="jxr_keyword">this</strong>.lock.readLock().lock();
+<a class="jxr_linenumber" name="222" href="#222">222</a>     <strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="223" href="#223">223</a>       Set&lt;Integer&gt; auths = userAuths.get(user);
+<a class="jxr_linenumber" name="224" href="#224">224</a>       <strong class="jxr_keyword">return</strong> (auths == <strong class="jxr_keyword">null</strong>) ? EMPTY_SET : auths;
+<a class="jxr_linenumber" name="225" href="#225">225</a>     } <strong class="jxr_keyword">finally</strong> {
+<a class="jxr_linenumber" name="226" href="#226">226</a>       <strong class="jxr_keyword">this</strong>.lock.readLock().unlock();
+<a class="jxr_linenumber" name="227" href="#227">227</a>     }
+<a class="jxr_linenumber" name="228" href="#228">228</a>   }
+<a class="jxr_linenumber" name="229" href="#229">229</a> 
+<a class="jxr_linenumber" name="230" href="#230">230</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> writeToZookeeper(byte[] data, <strong class="jxr_keyword">boolean</strong> labelsOrUserAuths) {
+<a class="jxr_linenumber" name="231" href="#231">231</a>     <strong class="jxr_keyword">this</strong>.zkVisibilityWatcher.writeToZookeeper(data, labelsOrUserAuths);
+<a class="jxr_linenumber" name="232" href="#232">232</a>   }
+<a class="jxr_linenumber" name="233" href="#233">233</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+



Mime
View raw message