http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableRecordReader.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableRecordReader.html b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableRecordReader.html index 0bb299e..16573e4 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableRecordReader.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableRecordReader.html @@ -59,114 +59,102 @@ <span class="sourceLineNo">051</span> this.recordReaderImpl.restart(firstRow);<a name="line.51"></a> <span class="sourceLineNo">052</span> }<a name="line.52"></a> <span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span> /**<a name="line.55"></a> -<span class="sourceLineNo">056</span> * Sets the HBase table.<a name="line.56"></a> -<span class="sourceLineNo">057</span> *<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param htable The table to scan.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @deprecated Use setTable() instead.<a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span> @Deprecated<a name="line.61"></a> -<span class="sourceLineNo">062</span> public void setHTable(Table htable) {<a name="line.62"></a> -<span class="sourceLineNo">063</span> this.setTable(htable);<a name="line.63"></a> -<span class="sourceLineNo">064</span> }<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @param table the {@link Table} to scan.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> public void setTable(Table table) {<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.recordReaderImpl.setHTable(table);<a name="line.70"></a> -<span class="sourceLineNo">071</span> }<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * Sets the scan defining the actual details like columns etc.<a name="line.74"></a> -<span class="sourceLineNo">075</span> *<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param scan The scan to set.<a name="line.76"></a> -<span class="sourceLineNo">077</span> */<a name="line.77"></a> -<span class="sourceLineNo">078</span> public void setScan(Scan scan) {<a name="line.78"></a> -<span class="sourceLineNo">079</span> this.recordReaderImpl.setScan(scan);<a name="line.79"></a> -<span class="sourceLineNo">080</span> }<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * Closes the split.<a name="line.83"></a> -<span class="sourceLineNo">084</span> *<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @see org.apache.hadoop.mapreduce.RecordReader#close()<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> @Override<a name="line.87"></a> -<span class="sourceLineNo">088</span> public void close() {<a name="line.88"></a> -<span class="sourceLineNo">089</span> this.recordReaderImpl.close();<a name="line.89"></a> -<span class="sourceLineNo">090</span> }<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * Returns the current key.<a name="line.93"></a> -<span class="sourceLineNo">094</span> *<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @return The current key.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * @throws IOException<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @throws InterruptedException When the job is aborted.<a name="line.97"></a> -<span class="sourceLineNo">098</span> * @see org.apache.hadoop.mapreduce.RecordReader#getCurrentKey()<a name="line.98"></a> -<span class="sourceLineNo">099</span> */<a name="line.99"></a> -<span class="sourceLineNo">100</span> @Override<a name="line.100"></a> -<span class="sourceLineNo">101</span> public ImmutableBytesWritable getCurrentKey() throws IOException,<a name="line.101"></a> -<span class="sourceLineNo">102</span> InterruptedException {<a name="line.102"></a> -<span class="sourceLineNo">103</span> return this.recordReaderImpl.getCurrentKey();<a name="line.103"></a> -<span class="sourceLineNo">104</span> }<a name="line.104"></a> -<span class="sourceLineNo">105</span><a name="line.105"></a> -<span class="sourceLineNo">106</span> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Returns the current value.<a name="line.107"></a> -<span class="sourceLineNo">108</span> *<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @return The current value.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @throws IOException When the value is faulty.<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @throws InterruptedException When the job is aborted.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @see org.apache.hadoop.mapreduce.RecordReader#getCurrentValue()<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> @Override<a name="line.114"></a> -<span class="sourceLineNo">115</span> public Result getCurrentValue() throws IOException, InterruptedException {<a name="line.115"></a> -<span class="sourceLineNo">116</span> return this.recordReaderImpl.getCurrentValue();<a name="line.116"></a> -<span class="sourceLineNo">117</span> }<a name="line.117"></a> -<span class="sourceLineNo">118</span><a name="line.118"></a> -<span class="sourceLineNo">119</span> /**<a name="line.119"></a> -<span class="sourceLineNo">120</span> * Initializes the reader.<a name="line.120"></a> -<span class="sourceLineNo">121</span> *<a name="line.121"></a> -<span class="sourceLineNo">122</span> * @param inputsplit The split to work with.<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param context The current task context.<a name="line.123"></a> -<span class="sourceLineNo">124</span> * @throws IOException When setting up the reader fails.<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @throws InterruptedException When the job is aborted.<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @see org.apache.hadoop.mapreduce.RecordReader#initialize(<a name="line.126"></a> -<span class="sourceLineNo">127</span> * org.apache.hadoop.mapreduce.InputSplit,<a name="line.127"></a> -<span class="sourceLineNo">128</span> * org.apache.hadoop.mapreduce.TaskAttemptContext)<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> @Override<a name="line.130"></a> -<span class="sourceLineNo">131</span> public void initialize(InputSplit inputsplit,<a name="line.131"></a> -<span class="sourceLineNo">132</span> TaskAttemptContext context) throws IOException,<a name="line.132"></a> -<span class="sourceLineNo">133</span> InterruptedException {<a name="line.133"></a> -<span class="sourceLineNo">134</span> this.recordReaderImpl.initialize(inputsplit, context);<a name="line.134"></a> -<span class="sourceLineNo">135</span> }<a name="line.135"></a> -<span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Positions the record reader to the next record.<a name="line.138"></a> -<span class="sourceLineNo">139</span> *<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @return <code>true</code> if there was another record.<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @throws IOException When reading the record failed.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @throws InterruptedException When the job was aborted.<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @see org.apache.hadoop.mapreduce.RecordReader#nextKeyValue()<a name="line.143"></a> -<span class="sourceLineNo">144</span> */<a name="line.144"></a> -<span class="sourceLineNo">145</span> @Override<a name="line.145"></a> -<span class="sourceLineNo">146</span> public boolean nextKeyValue() throws IOException, InterruptedException {<a name="line.146"></a> -<span class="sourceLineNo">147</span> return this.recordReaderImpl.nextKeyValue();<a name="line.147"></a> -<span class="sourceLineNo">148</span> }<a name="line.148"></a> -<span class="sourceLineNo">149</span><a name="line.149"></a> -<span class="sourceLineNo">150</span> /**<a name="line.150"></a> -<span class="sourceLineNo">151</span> * The current progress of the record reader through its data.<a name="line.151"></a> -<span class="sourceLineNo">152</span> *<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return A number between 0.0 and 1.0, the fraction of the data read.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * @see org.apache.hadoop.mapreduce.RecordReader#getProgress()<a name="line.154"></a> -<span class="sourceLineNo">155</span> */<a name="line.155"></a> -<span class="sourceLineNo">156</span> @Override<a name="line.156"></a> -<span class="sourceLineNo">157</span> public float getProgress() {<a name="line.157"></a> -<span class="sourceLineNo">158</span> return this.recordReaderImpl.getProgress();<a name="line.158"></a> -<span class="sourceLineNo">159</span> }<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span>}<a name="line.161"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param table the {@link Table} to scan.<a name="line.55"></a> +<span class="sourceLineNo">056</span> */<a name="line.56"></a> +<span class="sourceLineNo">057</span> public void setTable(Table table) {<a name="line.57"></a> +<span class="sourceLineNo">058</span> this.recordReaderImpl.setHTable(table);<a name="line.58"></a> +<span class="sourceLineNo">059</span> }<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * Sets the scan defining the actual details like columns etc.<a name="line.62"></a> +<span class="sourceLineNo">063</span> *<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @param scan The scan to set.<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> public void setScan(Scan scan) {<a name="line.66"></a> +<span class="sourceLineNo">067</span> this.recordReaderImpl.setScan(scan);<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * Closes the split.<a name="line.71"></a> +<span class="sourceLineNo">072</span> *<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @see org.apache.hadoop.mapreduce.RecordReader#close()<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> @Override<a name="line.75"></a> +<span class="sourceLineNo">076</span> public void close() {<a name="line.76"></a> +<span class="sourceLineNo">077</span> this.recordReaderImpl.close();<a name="line.77"></a> +<span class="sourceLineNo">078</span> }<a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> /**<a name="line.80"></a> +<span class="sourceLineNo">081</span> * Returns the current key.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The current key.<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @throws IOException<a name="line.84"></a> +<span class="sourceLineNo">085</span> * @throws InterruptedException When the job is aborted.<a name="line.85"></a> +<span class="sourceLineNo">086</span> * @see org.apache.hadoop.mapreduce.RecordReader#getCurrentKey()<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span> @Override<a name="line.88"></a> +<span class="sourceLineNo">089</span> public ImmutableBytesWritable getCurrentKey() throws IOException,<a name="line.89"></a> +<span class="sourceLineNo">090</span> InterruptedException {<a name="line.90"></a> +<span class="sourceLineNo">091</span> return this.recordReaderImpl.getCurrentKey();<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> /**<a name="line.94"></a> +<span class="sourceLineNo">095</span> * Returns the current value.<a name="line.95"></a> +<span class="sourceLineNo">096</span> *<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @return The current value.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @throws IOException When the value is faulty.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @throws InterruptedException When the job is aborted.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @see org.apache.hadoop.mapreduce.RecordReader#getCurrentValue()<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> @Override<a name="line.102"></a> +<span class="sourceLineNo">103</span> public Result getCurrentValue() throws IOException, InterruptedException {<a name="line.103"></a> +<span class="sourceLineNo">104</span> return this.recordReaderImpl.getCurrentValue();<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> /**<a name="line.107"></a> +<span class="sourceLineNo">108</span> * Initializes the reader.<a name="line.108"></a> +<span class="sourceLineNo">109</span> *<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @param inputsplit The split to work with.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @param context The current task context.<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @throws IOException When setting up the reader fails.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @throws InterruptedException When the job is aborted.<a name="line.113"></a> +<span class="sourceLineNo">114</span> * @see org.apache.hadoop.mapreduce.RecordReader#initialize(<a name="line.114"></a> +<span class="sourceLineNo">115</span> * org.apache.hadoop.mapreduce.InputSplit,<a name="line.115"></a> +<span class="sourceLineNo">116</span> * org.apache.hadoop.mapreduce.TaskAttemptContext)<a name="line.116"></a> +<span class="sourceLineNo">117</span> */<a name="line.117"></a> +<span class="sourceLineNo">118</span> @Override<a name="line.118"></a> +<span class="sourceLineNo">119</span> public void initialize(InputSplit inputsplit,<a name="line.119"></a> +<span class="sourceLineNo">120</span> TaskAttemptContext context) throws IOException,<a name="line.120"></a> +<span class="sourceLineNo">121</span> InterruptedException {<a name="line.121"></a> +<span class="sourceLineNo">122</span> this.recordReaderImpl.initialize(inputsplit, context);<a name="line.122"></a> +<span class="sourceLineNo">123</span> }<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Positions the record reader to the next record.<a name="line.126"></a> +<span class="sourceLineNo">127</span> *<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @return <code>true</code> if there was another record.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @throws IOException When reading the record failed.<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @throws InterruptedException When the job was aborted.<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @see org.apache.hadoop.mapreduce.RecordReader#nextKeyValue()<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span> @Override<a name="line.133"></a> +<span class="sourceLineNo">134</span> public boolean nextKeyValue() throws IOException, InterruptedException {<a name="line.134"></a> +<span class="sourceLineNo">135</span> return this.recordReaderImpl.nextKeyValue();<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> +<span class="sourceLineNo">138</span> /**<a name="line.138"></a> +<span class="sourceLineNo">139</span> * The current progress of the record reader through its data.<a name="line.139"></a> +<span class="sourceLineNo">140</span> *<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @return A number between 0.0 and 1.0, the fraction of the data read.<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @see org.apache.hadoop.mapreduce.RecordReader#getProgress()<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> @Override<a name="line.144"></a> +<span class="sourceLineNo">145</span> public float getProgress() {<a name="line.145"></a> +<span class="sourceLineNo">146</span> return this.recordReaderImpl.getProgress();<a name="line.146"></a> +<span class="sourceLineNo">147</span> }<a name="line.147"></a> +<span class="sourceLineNo">148</span><a name="line.148"></a> +<span class="sourceLineNo">149</span>}<a name="line.149"></a>
http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableSplit.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableSplit.html b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableSplit.html index 8c863df..5cb57d5 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableSplit.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TableSplit.html @@ -51,7 +51,7 @@ <span class="sourceLineNo">043</span>@InterfaceStability.Evolving<a name="line.43"></a> <span class="sourceLineNo">044</span>public class TableSplit extends InputSplit<a name="line.44"></a> <span class="sourceLineNo">045</span>implements Writable, Comparable<TableSplit> {<a name="line.45"></a> -<span class="sourceLineNo">046</span> /** @deprecated LOG variable would be made private. */<a name="line.46"></a> +<span class="sourceLineNo">046</span> /** @deprecated LOG variable would be made private. fix in hbase 3.0 */<a name="line.46"></a> <span class="sourceLineNo">047</span> @Deprecated<a name="line.47"></a> <span class="sourceLineNo">048</span> public static final Log LOG = LogFactory.getLog(TableSplit.class);<a name="line.48"></a> <span class="sourceLineNo">049</span><a name="line.49"></a> http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TextSortReducer.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TextSortReducer.html b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TextSortReducer.html index 233bfb8..2542539 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TextSortReducer.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/mapreduce/TextSortReducer.html @@ -52,7 +52,7 @@ <span class="sourceLineNo">044</span><a name="line.44"></a> <span class="sourceLineNo">045</span>/**<a name="line.45"></a> <span class="sourceLineNo">046</span> * Emits Sorted KeyValues. Parse the passed text and creates KeyValues. Sorts them before emit.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @see HFileOutputFormat<a name="line.47"></a> +<span class="sourceLineNo">047</span> * @see HFileOutputFormat2<a name="line.47"></a> <span class="sourceLineNo">048</span> * @see KeyValueSortReducer<a name="line.48"></a> <span class="sourceLineNo">049</span> * @see PutSortReducer<a name="line.49"></a> <span class="sourceLineNo">050</span> */<a name="line.50"></a> http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/mob/mapreduce/Sweeper.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/mob/mapreduce/Sweeper.html b/apidocs/src-html/org/apache/hadoop/hbase/mob/mapreduce/Sweeper.html index 2a60d76..497e202 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/mob/mapreduce/Sweeper.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/mob/mapreduce/Sweeper.html @@ -37,94 +37,103 @@ <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a> <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.30"></a> <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.HBaseAdmin;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.util.Tool;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.util.ToolRunner;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.zookeeper.KeeperException;<a name="line.36"></a> -<span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span>import com.google.protobuf.ServiceException;<a name="line.38"></a> -<span class="sourceLineNo">039</span><a name="line.39"></a> -<span class="sourceLineNo">040</span>/**<a name="line.40"></a> -<span class="sourceLineNo">041</span> * The sweep tool. It deletes the mob files that are not used and merges the small mob files to<a name="line.41"></a> -<span class="sourceLineNo">042</span> * bigger ones. Each run of this sweep tool only handles one column family. The runs on<a name="line.42"></a> -<span class="sourceLineNo">043</span> * the same column family are mutually exclusive. And the major compaction and sweep tool on the<a name="line.43"></a> -<span class="sourceLineNo">044</span> * same column family are mutually exclusive too.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span>@InterfaceAudience.Public<a name="line.46"></a> -<span class="sourceLineNo">047</span>@InterfaceStability.Evolving<a name="line.47"></a> -<span class="sourceLineNo">048</span>public class Sweeper extends Configured implements Tool {<a name="line.48"></a> -<span class="sourceLineNo">049</span><a name="line.49"></a> -<span class="sourceLineNo">050</span> /**<a name="line.50"></a> -<span class="sourceLineNo">051</span> * Sweeps the mob files on one column family. It deletes the unused mob files and merges<a name="line.51"></a> -<span class="sourceLineNo">052</span> * the small mob files into bigger ones.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @param tableName The current table name in string format.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param familyName The column family name.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @return 0 if success, 2 if job aborted with an exception, 3 if unable to start due to<a name="line.55"></a> -<span class="sourceLineNo">056</span> * other compaction,4 if mr job was unsuccessful<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @throws IOException<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @throws InterruptedException<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @throws ClassNotFoundException<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @throws KeeperException<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @throws ServiceException<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> int sweepFamily(String tableName, String familyName) throws IOException, InterruptedException,<a name="line.63"></a> -<span class="sourceLineNo">064</span> ClassNotFoundException, KeeperException, ServiceException {<a name="line.64"></a> -<span class="sourceLineNo">065</span> Configuration conf = getConf();<a name="line.65"></a> -<span class="sourceLineNo">066</span> // make sure the target HBase exists.<a name="line.66"></a> -<span class="sourceLineNo">067</span> HBaseAdmin.checkHBaseAvailable(conf);<a name="line.67"></a> -<span class="sourceLineNo">068</span> HBaseAdmin admin = new HBaseAdmin(conf);<a name="line.68"></a> -<span class="sourceLineNo">069</span> try {<a name="line.69"></a> -<span class="sourceLineNo">070</span> FileSystem fs = FileSystem.get(conf);<a name="line.70"></a> -<span class="sourceLineNo">071</span> TableName tn = TableName.valueOf(tableName);<a name="line.71"></a> -<span class="sourceLineNo">072</span> HTableDescriptor htd = admin.getTableDescriptor(tn);<a name="line.72"></a> -<span class="sourceLineNo">073</span> HColumnDescriptor family = htd.getFamily(Bytes.toBytes(familyName));<a name="line.73"></a> -<span class="sourceLineNo">074</span> if (family == null || !family.isMobEnabled()) {<a name="line.74"></a> -<span class="sourceLineNo">075</span> throw new IOException("Column family " + familyName + " is not a MOB column family");<a name="line.75"></a> -<span class="sourceLineNo">076</span> }<a name="line.76"></a> -<span class="sourceLineNo">077</span> SweepJob job = new SweepJob(conf, fs);<a name="line.77"></a> -<span class="sourceLineNo">078</span> // Run the sweeping<a name="line.78"></a> -<span class="sourceLineNo">079</span> return job.sweep(tn, family);<a name="line.79"></a> -<span class="sourceLineNo">080</span> } catch (Exception e) {<a name="line.80"></a> -<span class="sourceLineNo">081</span> System.err.println("Job aborted due to exception " + e);<a name="line.81"></a> -<span class="sourceLineNo">082</span> return 2; // job failed<a name="line.82"></a> -<span class="sourceLineNo">083</span> } finally {<a name="line.83"></a> -<span class="sourceLineNo">084</span> try {<a name="line.84"></a> -<span class="sourceLineNo">085</span> admin.close();<a name="line.85"></a> -<span class="sourceLineNo">086</span> } catch (IOException e) {<a name="line.86"></a> -<span class="sourceLineNo">087</span> System.out.println("Failed to close the HBaseAdmin: " + e.getMessage());<a name="line.87"></a> -<span class="sourceLineNo">088</span> }<a name="line.88"></a> -<span class="sourceLineNo">089</span> }<a name="line.89"></a> -<span class="sourceLineNo">090</span> }<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> public static void main(String[] args) throws Exception {<a name="line.92"></a> -<span class="sourceLineNo">093</span> Configuration conf = HBaseConfiguration.create();<a name="line.93"></a> -<span class="sourceLineNo">094</span> int ret = ToolRunner.run(conf, new Sweeper(), args);<a name="line.94"></a> -<span class="sourceLineNo">095</span> System.exit(ret);<a name="line.95"></a> -<span class="sourceLineNo">096</span> }<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> private void printUsage() {<a name="line.98"></a> -<span class="sourceLineNo">099</span> System.err.println("Usage:\n" + "--------------------------\n" + Sweeper.class.getName()<a name="line.99"></a> -<span class="sourceLineNo">100</span> + " tableName familyName");<a name="line.100"></a> -<span class="sourceLineNo">101</span> System.err.println(" tableName The table name");<a name="line.101"></a> -<span class="sourceLineNo">102</span> System.err.println(" familyName The column family name");<a name="line.102"></a> -<span class="sourceLineNo">103</span> }<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> /**<a name="line.105"></a> -<span class="sourceLineNo">106</span> * Main method for the tool.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * @return 0 if success, 1 for bad args. 2 if job aborted with an exception,<a name="line.107"></a> -<span class="sourceLineNo">108</span> * 3 if unable to start due to other compaction, 4 if mr job was unsuccessful<a name="line.108"></a> -<span class="sourceLineNo">109</span> */<a name="line.109"></a> -<span class="sourceLineNo">110</span> public int run(String[] args) throws Exception {<a name="line.110"></a> -<span class="sourceLineNo">111</span> if (args.length != 2) {<a name="line.111"></a> -<span class="sourceLineNo">112</span> printUsage();<a name="line.112"></a> -<span class="sourceLineNo">113</span> return 1;<a name="line.113"></a> -<span class="sourceLineNo">114</span> }<a name="line.114"></a> -<span class="sourceLineNo">115</span> String table = args[0];<a name="line.115"></a> -<span class="sourceLineNo">116</span> String family = args[1];<a name="line.116"></a> -<span class="sourceLineNo">117</span> return sweepFamily(table, family);<a name="line.117"></a> -<span class="sourceLineNo">118</span> }<a name="line.118"></a> -<span class="sourceLineNo">119</span>}<a name="line.119"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.HBaseAdmin;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.hadoop.util.Tool;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.util.ToolRunner;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.zookeeper.KeeperException;<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span>import com.google.protobuf.ServiceException;<a name="line.41"></a> +<span class="sourceLineNo">042</span><a name="line.42"></a> +<span class="sourceLineNo">043</span>/**<a name="line.43"></a> +<span class="sourceLineNo">044</span> * The sweep tool. It deletes the mob files that are not used and merges the small mob files to<a name="line.44"></a> +<span class="sourceLineNo">045</span> * bigger ones. Each run of this sweep tool only handles one column family. The runs on<a name="line.45"></a> +<span class="sourceLineNo">046</span> * the same column family are mutually exclusive. And the major compaction and sweep tool on the<a name="line.46"></a> +<span class="sourceLineNo">047</span> * same column family are mutually exclusive too.<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span>@InterfaceAudience.Public<a name="line.49"></a> +<span class="sourceLineNo">050</span>@InterfaceStability.Evolving<a name="line.50"></a> +<span class="sourceLineNo">051</span>public class Sweeper extends Configured implements Tool {<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> /**<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Sweeps the mob files on one column family. It deletes the unused mob files and merges<a name="line.54"></a> +<span class="sourceLineNo">055</span> * the small mob files into bigger ones.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param tableName The current table name in string format.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param familyName The column family name.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return 0 if success, 2 if job aborted with an exception, 3 if unable to start due to<a name="line.58"></a> +<span class="sourceLineNo">059</span> * other compaction,4 if mr job was unsuccessful<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @throws IOException<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @throws InterruptedException<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @throws ClassNotFoundException<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @throws KeeperException<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @throws ServiceException<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> int sweepFamily(String tableName, String familyName) throws IOException, InterruptedException,<a name="line.66"></a> +<span class="sourceLineNo">067</span> ClassNotFoundException, KeeperException, ServiceException {<a name="line.67"></a> +<span class="sourceLineNo">068</span> Configuration conf = getConf();<a name="line.68"></a> +<span class="sourceLineNo">069</span> // make sure the target HBase exists.<a name="line.69"></a> +<span class="sourceLineNo">070</span> HBaseAdmin.checkHBaseAvailable(conf);<a name="line.70"></a> +<span class="sourceLineNo">071</span> Connection connection = ConnectionFactory.createConnection(getConf());<a name="line.71"></a> +<span class="sourceLineNo">072</span> Admin admin = connection.getAdmin();<a name="line.72"></a> +<span class="sourceLineNo">073</span> try {<a name="line.73"></a> +<span class="sourceLineNo">074</span> FileSystem fs = FileSystem.get(conf);<a name="line.74"></a> +<span class="sourceLineNo">075</span> TableName tn = TableName.valueOf(tableName);<a name="line.75"></a> +<span class="sourceLineNo">076</span> HTableDescriptor htd = admin.getTableDescriptor(tn);<a name="line.76"></a> +<span class="sourceLineNo">077</span> HColumnDescriptor family = htd.getFamily(Bytes.toBytes(familyName));<a name="line.77"></a> +<span class="sourceLineNo">078</span> if (family == null || !family.isMobEnabled()) {<a name="line.78"></a> +<span class="sourceLineNo">079</span> throw new IOException("Column family " + familyName + " is not a MOB column family");<a name="line.79"></a> +<span class="sourceLineNo">080</span> }<a name="line.80"></a> +<span class="sourceLineNo">081</span> SweepJob job = new SweepJob(conf, fs);<a name="line.81"></a> +<span class="sourceLineNo">082</span> // Run the sweeping<a name="line.82"></a> +<span class="sourceLineNo">083</span> return job.sweep(tn, family);<a name="line.83"></a> +<span class="sourceLineNo">084</span> } catch (Exception e) {<a name="line.84"></a> +<span class="sourceLineNo">085</span> System.err.println("Job aborted due to exception " + e);<a name="line.85"></a> +<span class="sourceLineNo">086</span> return 2; // job failed<a name="line.86"></a> +<span class="sourceLineNo">087</span> } finally {<a name="line.87"></a> +<span class="sourceLineNo">088</span> try {<a name="line.88"></a> +<span class="sourceLineNo">089</span> admin.close();<a name="line.89"></a> +<span class="sourceLineNo">090</span> } catch (IOException e) {<a name="line.90"></a> +<span class="sourceLineNo">091</span> System.out.println("Failed to close the HBaseAdmin: " + e.getMessage());<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span> try {<a name="line.93"></a> +<span class="sourceLineNo">094</span> connection.close();<a name="line.94"></a> +<span class="sourceLineNo">095</span> } catch (IOException e) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> System.out.println("Failed to close the connection: " + e.getMessage());<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> +<span class="sourceLineNo">098</span> }<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> public static void main(String[] args) throws Exception {<a name="line.101"></a> +<span class="sourceLineNo">102</span> Configuration conf = HBaseConfiguration.create();<a name="line.102"></a> +<span class="sourceLineNo">103</span> int ret = ToolRunner.run(conf, new Sweeper(), args);<a name="line.103"></a> +<span class="sourceLineNo">104</span> System.exit(ret);<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> private void printUsage() {<a name="line.107"></a> +<span class="sourceLineNo">108</span> System.err.println("Usage:\n" + "--------------------------\n" + Sweeper.class.getName()<a name="line.108"></a> +<span class="sourceLineNo">109</span> + " tableName familyName");<a name="line.109"></a> +<span class="sourceLineNo">110</span> System.err.println(" tableName The table name");<a name="line.110"></a> +<span class="sourceLineNo">111</span> System.err.println(" familyName The column family name");<a name="line.111"></a> +<span class="sourceLineNo">112</span> }<a name="line.112"></a> +<span class="sourceLineNo">113</span><a name="line.113"></a> +<span class="sourceLineNo">114</span> /**<a name="line.114"></a> +<span class="sourceLineNo">115</span> * Main method for the tool.<a name="line.115"></a> +<span class="sourceLineNo">116</span> * @return 0 if success, 1 for bad args. 2 if job aborted with an exception,<a name="line.116"></a> +<span class="sourceLineNo">117</span> * 3 if unable to start due to other compaction, 4 if mr job was unsuccessful<a name="line.117"></a> +<span class="sourceLineNo">118</span> */<a name="line.118"></a> +<span class="sourceLineNo">119</span> public int run(String[] args) throws Exception {<a name="line.119"></a> +<span class="sourceLineNo">120</span> if (args.length != 2) {<a name="line.120"></a> +<span class="sourceLineNo">121</span> printUsage();<a name="line.121"></a> +<span class="sourceLineNo">122</span> return 1;<a name="line.122"></a> +<span class="sourceLineNo">123</span> }<a name="line.123"></a> +<span class="sourceLineNo">124</span> String table = args[0];<a name="line.124"></a> +<span class="sourceLineNo">125</span> String family = args[1];<a name="line.125"></a> +<span class="sourceLineNo">126</span> return sweepFamily(table, family);<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span>}<a name="line.128"></a> http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlClient.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlClient.html b/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlClient.html deleted file mode 100644 index 4327d0a..0000000 --- a/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlClient.html +++ /dev/null @@ -1,285 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> -<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> -<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> -<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> -<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> -<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> -<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> -<span class="sourceLineNo">009</span> *<a name="line.9"></a> -<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> -<span class="sourceLineNo">011</span> *<a name="line.11"></a> -<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> -<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> -<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> -<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> -<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> -<span class="sourceLineNo">017</span> */<a name="line.17"></a> -<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.security.access;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.util.regex.Pattern;<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HConstants;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HTableDescriptor;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.MasterNotRunningException;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.ZooKeeperConnectionException;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.Table;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.security.SecurityCapability;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.protobuf.ProtobufUtil;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.AccessControlService.BlockingInterface;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.41"></a> -<span class="sourceLineNo">042</span><a name="line.42"></a> -<span class="sourceLineNo">043</span>/**<a name="line.43"></a> -<span class="sourceLineNo">044</span> * Utility client for doing access control admin operations.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span>@InterfaceAudience.Public<a name="line.46"></a> -<span class="sourceLineNo">047</span>@InterfaceStability.Evolving<a name="line.47"></a> -<span class="sourceLineNo">048</span>public class AccessControlClient {<a name="line.48"></a> -<span class="sourceLineNo">049</span> public static final TableName ACL_TABLE_NAME =<a name="line.49"></a> -<span class="sourceLineNo">050</span> TableName.valueOf(NamespaceDescriptor.SYSTEM_NAMESPACE_NAME_STR, "acl");<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Return true if authorization is supported and enabled<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param connection The connection to use<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @return true if authorization is supported and enabled, false otherwise<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @throws IOException<a name="line.56"></a> -<span class="sourceLineNo">057</span> */<a name="line.57"></a> -<span class="sourceLineNo">058</span> public static boolean isAuthorizationEnabled(Connection connection) throws IOException {<a name="line.58"></a> -<span class="sourceLineNo">059</span> return connection.getAdmin().getSecurityCapabilities()<a name="line.59"></a> -<span class="sourceLineNo">060</span> .contains(SecurityCapability.AUTHORIZATION);<a name="line.60"></a> -<span class="sourceLineNo">061</span> }<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span> /**<a name="line.63"></a> -<span class="sourceLineNo">064</span> * Return true if cell authorization is supported and enabled<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @param connection The connection to use<a name="line.65"></a> -<span class="sourceLineNo">066</span> * @return true if cell authorization is supported and enabled, false otherwise<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @throws IOException<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> public static boolean isCellAuthorizationEnabled(Connection connection) throws IOException {<a name="line.69"></a> -<span class="sourceLineNo">070</span> return connection.getAdmin().getSecurityCapabilities()<a name="line.70"></a> -<span class="sourceLineNo">071</span> .contains(SecurityCapability.CELL_AUTHORIZATION);<a name="line.71"></a> -<span class="sourceLineNo">072</span> }<a name="line.72"></a> -<span class="sourceLineNo">073</span><a name="line.73"></a> -<span class="sourceLineNo">074</span> private static BlockingInterface getAccessControlServiceStub(Table ht)<a name="line.74"></a> -<span class="sourceLineNo">075</span> throws IOException {<a name="line.75"></a> -<span class="sourceLineNo">076</span> CoprocessorRpcChannel service = ht.coprocessorService(HConstants.EMPTY_START_ROW);<a name="line.76"></a> -<span class="sourceLineNo">077</span> BlockingInterface protocol =<a name="line.77"></a> -<span class="sourceLineNo">078</span> AccessControlProtos.AccessControlService.newBlockingStub(service);<a name="line.78"></a> -<span class="sourceLineNo">079</span> return protocol;<a name="line.79"></a> -<span class="sourceLineNo">080</span> }<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * Grants permission on the specified table for the specified user<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @param connection The Connection instance to use<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @param tableName<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @param userName<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @param family<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param qual<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @param actions<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @throws Throwable<a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> public static void grant(Connection connection, final TableName tableName,<a name="line.92"></a> -<span class="sourceLineNo">093</span> final String userName, final byte[] family, final byte[] qual,<a name="line.93"></a> -<span class="sourceLineNo">094</span> final Permission.Action... actions) throws Throwable {<a name="line.94"></a> -<span class="sourceLineNo">095</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.95"></a> -<span class="sourceLineNo">096</span> ProtobufUtil.grant(getAccessControlServiceStub(table), userName, tableName, family, qual,<a name="line.96"></a> -<span class="sourceLineNo">097</span> actions);<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> /**<a name="line.101"></a> -<span class="sourceLineNo">102</span> * Grants permission on the specified namespace for the specified user.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param connection The Connection instance to use<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param namespace<a name="line.104"></a> -<span class="sourceLineNo">105</span> * @param userName<a name="line.105"></a> -<span class="sourceLineNo">106</span> * @param actions<a name="line.106"></a> -<span class="sourceLineNo">107</span> * @throws Throwable<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public static void grant(Connection connection, final String namespace,<a name="line.109"></a> -<span class="sourceLineNo">110</span> final String userName, final Permission.Action... actions) throws Throwable {<a name="line.110"></a> -<span class="sourceLineNo">111</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.111"></a> -<span class="sourceLineNo">112</span> ProtobufUtil.grant(getAccessControlServiceStub(table), userName, namespace, actions);<a name="line.112"></a> -<span class="sourceLineNo">113</span> }<a name="line.113"></a> -<span class="sourceLineNo">114</span> }<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> -<span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param connection The Connection instance to use<a name="line.117"></a> -<span class="sourceLineNo">118</span> * Grant global permissions for the specified user.<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> public static void grant(Connection connection, final String userName,<a name="line.120"></a> -<span class="sourceLineNo">121</span> final Permission.Action... actions) throws Throwable {<a name="line.121"></a> -<span class="sourceLineNo">122</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> ProtobufUtil.grant(getAccessControlServiceStub(table), userName, actions);<a name="line.123"></a> -<span class="sourceLineNo">124</span> }<a name="line.124"></a> -<span class="sourceLineNo">125</span> }<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> public static boolean isAccessControllerRunning(Connection connection)<a name="line.127"></a> -<span class="sourceLineNo">128</span> throws MasterNotRunningException, ZooKeeperConnectionException, IOException {<a name="line.128"></a> -<span class="sourceLineNo">129</span> try (Admin admin = connection.getAdmin()) {<a name="line.129"></a> -<span class="sourceLineNo">130</span> return admin.isTableAvailable(ACL_TABLE_NAME);<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span> }<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> /**<a name="line.134"></a> -<span class="sourceLineNo">135</span> * Revokes the permission on the table<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @param connection The Connection instance to use<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param tableName<a name="line.137"></a> -<span class="sourceLineNo">138</span> * @param username<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param family<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @param qualifier<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @param actions<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @throws Throwable<a name="line.142"></a> -<span class="sourceLineNo">143</span> */<a name="line.143"></a> -<span class="sourceLineNo">144</span> public static void revoke(Connection connection, final TableName tableName,<a name="line.144"></a> -<span class="sourceLineNo">145</span> final String username, final byte[] family, final byte[] qualifier,<a name="line.145"></a> -<span class="sourceLineNo">146</span> final Permission.Action... actions) throws Throwable {<a name="line.146"></a> -<span class="sourceLineNo">147</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> ProtobufUtil.revoke(getAccessControlServiceStub(table), username, tableName, family,<a name="line.148"></a> -<span class="sourceLineNo">149</span> qualifier, actions);<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span><a name="line.152"></a> -<span class="sourceLineNo">153</span> /**<a name="line.153"></a> -<span class="sourceLineNo">154</span> * Revokes the permission on the table for the specified user.<a name="line.154"></a> -<span class="sourceLineNo">155</span> * @param connection The Connection instance to use<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param namespace<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param userName<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @param actions<a name="line.158"></a> -<span class="sourceLineNo">159</span> * @throws Throwable<a name="line.159"></a> -<span class="sourceLineNo">160</span> */<a name="line.160"></a> -<span class="sourceLineNo">161</span> public static void revoke(Connection connection, final String namespace,<a name="line.161"></a> -<span class="sourceLineNo">162</span> final String userName, final Permission.Action... actions) throws Throwable {<a name="line.162"></a> -<span class="sourceLineNo">163</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.163"></a> -<span class="sourceLineNo">164</span> ProtobufUtil.revoke(getAccessControlServiceStub(table), userName, namespace, actions);<a name="line.164"></a> -<span class="sourceLineNo">165</span> }<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * Revoke global permissions for the specified user.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @param connection The Connection instance to use<a name="line.170"></a> -<span class="sourceLineNo">171</span> */<a name="line.171"></a> -<span class="sourceLineNo">172</span> public static void revoke(Connection connection, final String userName,<a name="line.172"></a> -<span class="sourceLineNo">173</span> final Permission.Action... actions) throws Throwable {<a name="line.173"></a> -<span class="sourceLineNo">174</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.174"></a> -<span class="sourceLineNo">175</span> ProtobufUtil.revoke(getAccessControlServiceStub(table), userName, actions);<a name="line.175"></a> -<span class="sourceLineNo">176</span> }<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> }<a name="line.178"></a> -<span class="sourceLineNo">179</span><a name="line.179"></a> -<span class="sourceLineNo">180</span> /**<a name="line.180"></a> -<span class="sourceLineNo">181</span> * List all the userPermissions matching the given pattern. If pattern is null, the behavior is<a name="line.181"></a> -<span class="sourceLineNo">182</span> * dependent on whether user has global admin privileges or not. If yes, the global permissions<a name="line.182"></a> -<span class="sourceLineNo">183</span> * along with the list of superusers would be returned. Else, no rows get returned.<a name="line.183"></a> -<span class="sourceLineNo">184</span> * @param connection The Connection instance to use<a name="line.184"></a> -<span class="sourceLineNo">185</span> * @param tableRegex The regular expression string to match against<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @return - returns an array of UserPermissions<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @throws Throwable<a name="line.187"></a> -<span class="sourceLineNo">188</span> */<a name="line.188"></a> -<span class="sourceLineNo">189</span> public static List<UserPermission> getUserPermissions(Connection connection, String tableRegex)<a name="line.189"></a> -<span class="sourceLineNo">190</span> throws Throwable {<a name="line.190"></a> -<span class="sourceLineNo">191</span> List<UserPermission> permList = new ArrayList<UserPermission>();<a name="line.191"></a> -<span class="sourceLineNo">192</span> try (Table table = connection.getTable(ACL_TABLE_NAME)) {<a name="line.192"></a> -<span class="sourceLineNo">193</span> try (Admin admin = connection.getAdmin()) {<a name="line.193"></a> -<span class="sourceLineNo">194</span> CoprocessorRpcChannel service = table.coprocessorService(HConstants.EMPTY_START_ROW);<a name="line.194"></a> -<span class="sourceLineNo">195</span> BlockingInterface protocol =<a name="line.195"></a> -<span class="sourceLineNo">196</span> AccessControlProtos.AccessControlService.newBlockingStub(service);<a name="line.196"></a> -<span class="sourceLineNo">197</span> HTableDescriptor[] htds = null;<a name="line.197"></a> -<span class="sourceLineNo">198</span> if (tableRegex == null || tableRegex.isEmpty()) {<a name="line.198"></a> -<span class="sourceLineNo">199</span> permList = ProtobufUtil.getUserPermissions(protocol);<a name="line.199"></a> -<span class="sourceLineNo">200</span> } else if (tableRegex.charAt(0) == '@') {<a name="line.200"></a> -<span class="sourceLineNo">201</span> String namespace = tableRegex.substring(1);<a name="line.201"></a> -<span class="sourceLineNo">202</span> permList = ProtobufUtil.getUserPermissions(protocol, Bytes.toBytes(namespace));<a name="line.202"></a> -<span class="sourceLineNo">203</span> } else {<a name="line.203"></a> -<span class="sourceLineNo">204</span> htds = admin.listTables(Pattern.compile(tableRegex), true);<a name="line.204"></a> -<span class="sourceLineNo">205</span> for (HTableDescriptor hd : htds) {<a name="line.205"></a> -<span class="sourceLineNo">206</span> permList.addAll(ProtobufUtil.getUserPermissions(protocol, hd.getTableName()));<a name="line.206"></a> -<span class="sourceLineNo">207</span> }<a name="line.207"></a> -<span class="sourceLineNo">208</span> }<a name="line.208"></a> -<span class="sourceLineNo">209</span> }<a name="line.209"></a> -<span class="sourceLineNo">210</span> }<a name="line.210"></a> -<span class="sourceLineNo">211</span> return permList;<a name="line.211"></a> -<span class="sourceLineNo">212</span> }<a name="line.212"></a> -<span class="sourceLineNo">213</span>}<a name="line.213"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlConstants.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlConstants.html b/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlConstants.html deleted file mode 100644 index ae48a35..0000000 --- a/apidocs/src-html/org/apache/hadoop/hbase/security/access/AccessControlConstants.html +++ /dev/null @@ -1,127 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> -<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> -<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> -<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> -<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> -<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> -<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> -<span class="sourceLineNo">009</span> *<a name="line.9"></a> -<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> -<span class="sourceLineNo">011</span> *<a name="line.11"></a> -<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> -<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> -<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> -<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> -<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> -<span class="sourceLineNo">017</span> */<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.security.access;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.22"></a> -<span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>@InterfaceAudience.Public<a name="line.24"></a> -<span class="sourceLineNo">025</span>@InterfaceStability.Evolving<a name="line.25"></a> -<span class="sourceLineNo">026</span>public interface AccessControlConstants {<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span> /**<a name="line.28"></a> -<span class="sourceLineNo">029</span> * Configuration option that toggles whether EXEC permission checking is<a name="line.29"></a> -<span class="sourceLineNo">030</span> * performed during coprocessor endpoint invocations.<a name="line.30"></a> -<span class="sourceLineNo">031</span> */<a name="line.31"></a> -<span class="sourceLineNo">032</span> public static final String EXEC_PERMISSION_CHECKS_KEY = "hbase.security.exec.permission.checks";<a name="line.32"></a> -<span class="sourceLineNo">033</span> /** Default setting for hbase.security.exec.permission.checks; false */<a name="line.33"></a> -<span class="sourceLineNo">034</span> public static final boolean DEFAULT_EXEC_PERMISSION_CHECKS = false;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span> /**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Configuration or CF schema option for early termination of access checks<a name="line.37"></a> -<span class="sourceLineNo">038</span> * if table or CF permissions grant access. Pre-0.98 compatible behavior<a name="line.38"></a> -<span class="sourceLineNo">039</span> */<a name="line.39"></a> -<span class="sourceLineNo">040</span> public static final String CF_ATTRIBUTE_EARLY_OUT = "hbase.security.access.early_out";<a name="line.40"></a> -<span class="sourceLineNo">041</span> /** Default setting for hbase.security.access.early_out */<a name="line.41"></a> -<span class="sourceLineNo">042</span> public static final boolean DEFAULT_ATTRIBUTE_EARLY_OUT = true;<a name="line.42"></a> -<span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span> // Operation attributes for cell level security<a name="line.44"></a> -<span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> /** Cell level ACL */<a name="line.46"></a> -<span class="sourceLineNo">047</span> public static final String OP_ATTRIBUTE_ACL = "acl";<a name="line.47"></a> -<span class="sourceLineNo">048</span> /** Cell level ACL evaluation strategy */<a name="line.48"></a> -<span class="sourceLineNo">049</span> public static final String OP_ATTRIBUTE_ACL_STRATEGY = "acl.strategy";<a name="line.49"></a> -<span class="sourceLineNo">050</span> /** Default cell ACL evaluation strategy: Table and CF first, then ACL */<a name="line.50"></a> -<span class="sourceLineNo">051</span> public static final byte[] OP_ATTRIBUTE_ACL_STRATEGY_DEFAULT = new byte[] { 0 };<a name="line.51"></a> -<span class="sourceLineNo">052</span> /** Alternate cell ACL evaluation strategy: Cell ACL first, then table and CF */<a name="line.52"></a> -<span class="sourceLineNo">053</span> public static final byte[] OP_ATTRIBUTE_ACL_STRATEGY_CELL_FIRST = new byte[] { 1 };<a name="line.53"></a> -<span class="sourceLineNo">054</span><a name="line.54"></a> -<span class="sourceLineNo">055</span>}<a name="line.55"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html> http://git-wip-us.apache.org/repos/asf/hbase/blob/fc29f802/apidocs/src-html/org/apache/hadoop/hbase/security/access/Permission.Action.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/security/access/Permission.Action.html b/apidocs/src-html/org/apache/hadoop/hbase/security/access/Permission.Action.html deleted file mode 100644 index a4f6e1b..0000000 --- a/apidocs/src-html/org/apache/hadoop/hbase/security/access/Permission.Action.html +++ /dev/null @@ -1,281 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<html lang="en"> -<head> -<title>Source code</title> -<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> -</head> -<body> -<div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> -<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> -<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> -<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> -<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> -<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> -<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> -<span class="sourceLineNo">009</span> *<a name="line.9"></a> -<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> -<span class="sourceLineNo">011</span> *<a name="line.11"></a> -<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> -<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> -<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> -<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> -<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> -<span class="sourceLineNo">017</span> */<a name="line.17"></a> -<span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.security.access;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.io.DataInput;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import java.io.DataOutput;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a> -<span class="sourceLineNo">026</span><a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.commons.logging.Log;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.commons.logging.LogFactory;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.classification.InterfaceStability;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.io.VersionedWritable;<a name="line.32"></a> -<span class="sourceLineNo">033</span><a name="line.33"></a> -<span class="sourceLineNo">034</span>import com.google.common.collect.Maps;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span>/**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Base permissions instance representing the ability to perform a given set<a name="line.37"></a> -<span class="sourceLineNo">038</span> * of actions.<a name="line.38"></a> -<span class="sourceLineNo">039</span> *<a name="line.39"></a> -<span class="sourceLineNo">040</span> * @see TablePermission<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span>@InterfaceAudience.Public<a name="line.42"></a> -<span class="sourceLineNo">043</span>@InterfaceStability.Evolving<a name="line.43"></a> -<span class="sourceLineNo">044</span>public class Permission extends VersionedWritable {<a name="line.44"></a> -<span class="sourceLineNo">045</span> protected static final byte VERSION = 0;<a name="line.45"></a> -<span class="sourceLineNo">046</span><a name="line.46"></a> -<span class="sourceLineNo">047</span> @InterfaceAudience.Public<a name="line.47"></a> -<span class="sourceLineNo">048</span> @InterfaceStability.Evolving<a name="line.48"></a> -<span class="sourceLineNo">049</span> public enum Action {<a name="line.49"></a> -<span class="sourceLineNo">050</span> READ('R'), WRITE('W'), EXEC('X'), CREATE('C'), ADMIN('A');<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> private byte code;<a name="line.52"></a> -<span class="sourceLineNo">053</span> Action(char code) {<a name="line.53"></a> -<span class="sourceLineNo">054</span> this.code = (byte)code;<a name="line.54"></a> -<span class="sourceLineNo">055</span> }<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> public byte code() { return code; }<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> private static final Log LOG = LogFactory.getLog(Permission.class);<a name="line.60"></a> -<span class="sourceLineNo">061</span> protected static final Map<Byte,Action> ACTION_BY_CODE = Maps.newHashMap();<a name="line.61"></a> -<span class="sourceLineNo">062</span><a name="line.62"></a> -<span class="sourceLineNo">063</span> protected Action[] actions;<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> static {<a name="line.65"></a> -<span class="sourceLineNo">066</span> for (Action a : Action.values()) {<a name="line.66"></a> -<span class="sourceLineNo">067</span> ACTION_BY_CODE.put(a.code(), a);<a name="line.67"></a> -<span class="sourceLineNo">068</span> }<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /** Empty constructor for Writable implementation. <b>Do not use.</b> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> public Permission() {<a name="line.72"></a> -<span class="sourceLineNo">073</span> super();<a name="line.73"></a> -<span class="sourceLineNo">074</span> }<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> public Permission(Action... assigned) {<a name="line.76"></a> -<span class="sourceLineNo">077</span> if (assigned != null && assigned.length > 0) {<a name="line.77"></a> -<span class="sourceLineNo">078</span> actions = Arrays.copyOf(assigned, assigned.length);<a name="line.78"></a> -<span class="sourceLineNo">079</span> }<a name="line.79"></a> -<span class="sourceLineNo">080</span> }<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> public Permission(byte[] actionCodes) {<a name="line.82"></a> -<span class="sourceLineNo">083</span> if (actionCodes != null) {<a name="line.83"></a> -<span class="sourceLineNo">084</span> Action acts[] = new Action[actionCodes.length];<a name="line.84"></a> -<span class="sourceLineNo">085</span> int j = 0;<a name="line.85"></a> -<span class="sourceLineNo">086</span> for (int i=0; i<actionCodes.length; i++) {<a name="line.86"></a> -<span class="sourceLineNo">087</span> byte b = actionCodes[i];<a name="line.87"></a> -<span class="sourceLineNo">088</span> Action a = ACTION_BY_CODE.get(b);<a name="line.88"></a> -<span class="sourceLineNo">089</span> if (a == null) {<a name="line.89"></a> -<span class="sourceLineNo">090</span> LOG.error("Ignoring unknown action code '"+<a name="line.90"></a> -<span class="sourceLineNo">091</span> Bytes.toStringBinary(new byte[]{b})+"'");<a name="line.91"></a> -<span class="sourceLineNo">092</span> continue;<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span> acts[j++] = a;<a name="line.94"></a> -<span class="sourceLineNo">095</span> }<a name="line.95"></a> -<span class="sourceLineNo">096</span> this.actions = Arrays.copyOf(acts, j);<a name="line.96"></a> -<span class="sourceLineNo">097</span> }<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span><a name="line.99"></a> -<span class="sourceLineNo">100</span> public Action[] getActions() {<a name="line.100"></a> -<span class="sourceLineNo">101</span> return actions;<a name="line.101"></a> -<span class="sourceLineNo">102</span> }<a name="line.102"></a> -<span class="sourceLineNo">103</span><a name="line.103"></a> -<span class="sourceLineNo">104</span> public boolean implies(Action action) {<a name="line.104"></a> -<span class="sourceLineNo">105</span> if (this.actions != null) {<a name="line.105"></a> -<span class="sourceLineNo">106</span> for (Action a : this.actions) {<a name="line.106"></a> -<span class="sourceLineNo">107</span> if (a == action) {<a name="line.107"></a> -<span class="sourceLineNo">108</span> return true;<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span> }<a name="line.111"></a> -<span class="sourceLineNo">112</span><a name="line.112"></a> -<span class="sourceLineNo">113</span> return false;<a name="line.113"></a> -<span class="sourceLineNo">114</span> }<a name="line.114"></a> -<span class="sourceLineNo">115</span><a name="line.115"></a> -<span class="sourceLineNo">116</span> @Override<a name="line.116"></a> -<span class="sourceLineNo">117</span> public boolean equals(Object obj) {<a name="line.117"></a> -<span class="sourceLineNo">118</span> if (!(obj instanceof Permission)) {<a name="line.118"></a> -<span class="sourceLineNo">119</span> return false;<a name="line.119"></a> -<span class="sourceLineNo">120</span> }<a name="line.120"></a> -<span class="sourceLineNo">121</span> Permission other = (Permission)obj;<a name="line.121"></a> -<span class="sourceLineNo">122</span> // check actions<a name="line.122"></a> -<span class="sourceLineNo">123</span> if (actions == null && other.getActions() == null) {<a name="line.123"></a> -<span class="sourceLineNo">124</span> return true;<a name="line.124"></a> -<span class="sourceLineNo">125</span> } else if (actions != null && other.getActions() != null) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> Action[] otherActions = other.getActions();<a name="line.126"></a> -<span class="sourceLineNo">127</span> if (actions.length != otherActions.length) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> return false;<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span><a name="line.130"></a> -<span class="sourceLineNo">131</span> outer:<a name="line.131"></a> -<span class="sourceLineNo">132</span> for (Action a : actions) {<a name="line.132"></a> -<span class="sourceLineNo">133</span> for (Action oa : otherActions) {<a name="line.133"></a> -<span class="sourceLineNo">134</span> if (a == oa) continue outer;<a name="line.134"></a> -<span class="sourceLineNo">135</span> }<a name="line.135"></a> -<span class="sourceLineNo">136</span> return false;<a name="line.136"></a> -<span class="sourceLineNo">137</span> }<a name="line.137"></a> -<span class="sourceLineNo">138</span> return true;<a name="line.138"></a> -<span class="sourceLineNo">139</span> }<a name="line.139"></a> -<span class="sourceLineNo">140</span><a name="line.140"></a> -<span class="sourceLineNo">141</span> return false;<a name="line.141"></a> -<span class="sourceLineNo">142</span> }<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> @Override<a name="line.144"></a> -<span class="sourceLineNo">145</span> public int hashCode() {<a name="line.145"></a> -<span class="sourceLineNo">146</span> final int prime = 37;<a name="line.146"></a> -<span class="sourceLineNo">147</span> int result = 23;<a name="line.147"></a> -<span class="sourceLineNo">148</span> for (Action a : actions) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> result = prime * result + a.code();<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span> return result;<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span><a name="line.153"></a> -<span class="sourceLineNo">154</span> @Override<a name="line.154"></a> -<span class="sourceLineNo">155</span> public String toString() {<a name="line.155"></a> -<span class="sourceLineNo">156</span> StringBuilder str = new StringBuilder("[Permission: ")<a name="line.156"></a> -<span class="sourceLineNo">157</span> .append("actions=");<a name="line.157"></a> -<span class="sourceLineNo">158</span> if (actions != null) {<a name="line.158"></a> -<span class="sourceLineNo">159</span> for (int i=0; i<actions.length; i++) {<a name="line.159"></a> -<span class="sourceLineNo">160</span> if (i > 0)<a name="line.160"></a> -<span class="sourceLineNo">161</span> str.append(",");<a name="line.161"></a> -<span class="sourceLineNo">162</span> if (actions[i] != null)<a name="line.162"></a> -<span class="sourceLineNo">163</span> str.append(actions[i].toString());<a name="line.163"></a> -<span class="sourceLineNo">164</span> else<a name="line.164"></a> -<span class="sourceLineNo">165</span> str.append("NULL");<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span> }<a name="line.167"></a> -<span class="sourceLineNo">168</span> str.append("]");<a name="line.168"></a> -<span class="sourceLineNo">169</span><a name="line.169"></a> -<span class="sourceLineNo">170</span> return str.toString();<a name="line.170"></a> -<span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span><a name="line.172"></a> -<span class="sourceLineNo">173</span> /** @return the object version number */<a name="line.173"></a> -<span class="sourceLineNo">174</span> @Override<a name="line.174"></a> -<span class="sourceLineNo">175</span> public byte getVersion() {<a name="line.175"></a> -<span class="sourceLineNo">176</span> return VERSION;<a name="line.176"></a> -<span class="sourceLineNo">177</span> }<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> @Override<a name="line.179"></a> -<span class="sourceLineNo">180</span> public void readFields(DataInput in) throws IOException {<a name="line.180"></a> -<span class="sourceLineNo">181</span> super.readFields(in);<a name="line.181"></a> -<span class="sourceLineNo">182</span> int length = (int)in.readByte();<a name="line.182"></a> -<span class="sourceLineNo">183</span> if (length > 0) {<a name="line.183"></a> -<span class="sourceLineNo">184</span> actions = new Action[length];<a name="line.184"></a> -<span class="sourceLineNo">185</span> for (int i = 0; i < length; i++) {<a name="line.185"></a> -<span class="sourceLineNo">186</span> byte b = in.readByte();<a name="line.186"></a> -<span class="sourceLineNo">187</span> Action a = ACTION_BY_CODE.get(b);<a name="line.187"></a> -<span class="sourceLineNo">188</span> if (a == null) {<a name="line.188"></a> -<span class="sourceLineNo">189</span> throw new IOException("Unknown action code '"+<a name="line.189"></a> -<span class="sourceLineNo">190</span> Bytes.toStringBinary(new byte[]{b})+"' in input");<a name="line.190"></a> -<span class="sourceLineNo">191</span> }<a name="line.191"></a> -<span class="sourceLineNo">192</span> this.actions[i] = a;<a name="line.192"></a> -<span class="sourceLineNo">193</span> }<a name="line.193"></a> -<span class="sourceLineNo">194</span> } else {<a name="line.194"></a> -<span class="sourceLineNo">195</span> actions = new Action[0];<a name="line.195"></a> -<span class="sourceLineNo">196</span> }<a name="line.196"></a> -<span class="sourceLineNo">197</span> }<a name="line.197"></a> -<span class="sourceLineNo">198</span><a name="line.198"></a> -<span class="sourceLineNo">199</span> @Override<a name="line.199"></a> -<span class="sourceLineNo">200</span> public void write(DataOutput out) throws IOException {<a name="line.200"></a> -<span class="sourceLineNo">201</span> super.write(out);<a name="line.201"></a> -<span class="sourceLineNo">202</span> out.writeByte(actions != null ? actions.length : 0);<a name="line.202"></a> -<span class="sourceLineNo">203</span> if (actions != null) {<a name="line.203"></a> -<span class="sourceLineNo">204</span> for (Action a: actions) {<a name="line.204"></a> -<span class="sourceLineNo">205</span> out.writeByte(a.code());<a name="line.205"></a> -<span class="sourceLineNo">206</span> }<a name="line.206"></a> -<span class="sourceLineNo">207</span> }<a name="line.207"></a> -<span class="sourceLineNo">208</span> }<a name="line.208"></a> -<span class="sourceLineNo">209</span>}<a name="line.209"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</pre> -</div> -</body> -</html>
